Skip to main content

External providers

Generated directly from the app's provider catalog — the same one that powers matching, Quick Capture, and the Settings credential editors — so it always matches the version you're running. A provider is wired into a type through an externalRef field (and optionally externalFields / external body sections); see External Metadata.

On self-hosted web, credentials come from the listed KIZUNASHELF_* environment variables; on desktop use Settings → Provider Credentials, and on iOS use More → Provider Credentials. Both store credentials in the OS keychain.

ProviderexternalRef idSearchEpisode/track syncCredentials
Bangumibangumisearch + resolveyesnone
IGDBigdbsearch + resolve—IGDB Client ID, IGDB Client Secret
TheTVDBthetvdbsearch + resolveyesTheTVDB API Key, TheTVDB PIN (optional)
Google Booksgooglebookssearch + resolve—Google Books API Key
Open Libraryopenlibrarysearch + resolve—none
Apple Podcastsapplepodcastsearch + resolveyesnone
Apple Musicapplemusicsearch + resolveyesnone
Steamsteamresolve URL/id only—none
MusicBrainzmusicbrainzsearch + resolveyesnone
BoardGameGeekbggsearch + resolve—BGG XML API Token
TMDBtmdbsearch + resolveyesTMDB API Key
Discogsdiscogssearch + resolveyesDiscogs Personal Access Token (optional), Discogs Consumer Key (optional), Discogs Consumer Secret (optional)
MyAnimeListmyanimelistsearch + resolveyesMyAnimeList Client ID
MangaUpdatesmangaupdatessearch + resolve—none
Comic Vinecomicvinesearch + resolveyesComic Vine API Key
Hardcoverhardcoversearch + resolve—Hardcover API Token
NeoDBneodbsearch + resolve—none
AniListanilistsearch + resolveyesnone

Bangumi​

externalRef: bangumi — Supports free-text search and resolving a pasted URL/id. Can pull an episode/track list into an entity's episodes body section.

externalTypes values (defaults marked ✓):

ValueMeaningDefault
1Book (1)
2Anime (2)
3Music (3)
4Game (4)
6Real (6)
characterCharacter
personPerson

Mappable fields (for externalFields and external body sections):

FieldMeaning
nameName
name_cnChinese name
cover_urlCover URL
dateRelease date
platformPlatform
epsEpisodes (declared)
total_episodesEpisodes (in database)
volumesVolumes
scoreScore
rankRank
languageLanguage
publisherPublisher
official_siteOfficial site
isbnISBN
aliasesAliases
directorDirector
authorAuthor
genreGenre
tagsTags
meta_tagsMeta tags
genderGender
birthdayBirthday
careerCareer
voice_actorsVoice actors
summarySummary

IGDB​

externalRef: igdb — Supports free-text search and resolving a pasted URL/id.

CredentialKeyEnv var (web)Required
IGDB Client IDigdb_client_idKIZUNASHELF_IGDB_CLIENT_IDrequired
IGDB Client Secretigdb_client_secretKIZUNASHELF_IGDB_CLIENT_SECRETrequired

externalTypes values (defaults marked ✓):

ValueMeaningDefault
gameGame✓

Mappable fields (for externalFields and external body sections):

FieldMeaning
nameName
cover_urlCover URL
first_release_dateFirst release date
ratingUser rating
aggregated_ratingCritic rating
total_ratingTotal rating
total_rating_countTotal rating count
formatType
franchiseFranchise
official_siteOfficial site
alternative_namesAlternative names
genresGenres
platformsPlatforms
themesThemes
game_modesGame modes
player_perspectivesPlayer perspectives
game_enginesGame engines
developersDevelopers
publishersPublishers
summarySummary
storylineStoryline

TheTVDB​

externalRef: thetvdb — Supports free-text search and resolving a pasted URL/id. Can pull an episode/track list into an entity's episodes body section.

CredentialKeyEnv var (web)Required
TheTVDB API Keytvdb_api_keyKIZUNASHELF_TVDB_API_KEYrequired
TheTVDB PIN (optional)tvdb_pinKIZUNASHELF_TVDB_PINoptional

externalTypes values (defaults marked ✓):

ValueMeaningDefault
seriesSeries
movieMovie

Mappable fields (for externalFields and external body sections):

FieldMeaning
nameName
cover_urlCover URL
first_air_timeFirst air time
yearYear
statusStatus
primary_languagePrimary language
countryRegion
networkNetwork
directorDirector
slugSlug
imdb_codeIMDb id
tmdb_idTheMovieDB id
genresGenres
studiosStudios
aliasesAliases
overviewOverview

Google Books​

externalRef: googlebooks — Supports free-text search and resolving a pasted URL/id.

CredentialKeyEnv var (web)Required
Google Books API Keygoogle_books_api_keyKIZUNASHELF_GOOGLE_BOOKS_API_KEYrequired

externalTypes values (defaults marked ✓):

ValueMeaningDefault
bookBook✓

Mappable fields (for externalFields and external body sections):

FieldMeaning
titleTitle
cover_urlCover URL
subtitleSubtitle
publisherPublisher
published_datePublished date
pagesPages
isbnISBN
languageLanguage
authorsAuthors
categoriesCategories
descriptionDescription

Open Library​

externalRef: openlibrary — Supports free-text search and resolving a pasted URL/id.

externalTypes values (defaults marked ✓):

ValueMeaningDefault
bookBook✓

Mappable fields (for externalFields and external body sections):

FieldMeaning
titleTitle
cover_urlCover URL
subtitleSubtitle
published_datePublished date
first_publishedFirst published
pagesPages
isbnISBN
languageLanguage
physical_formatPhysical format
descriptionDescription
authorsAuthors
publishersPublishers

Apple Podcasts​

externalRef: applepodcast — Supports free-text search and resolving a pasted URL/id. Can pull an episode/track list into an entity's episodes body section.

externalTypes values (defaults marked ✓):

ValueMeaningDefault
podcastPodcast✓

Mappable fields (for externalFields and external body sections):

FieldMeaning
titleTitle
cover_urlCover URL
hostHost
feed_urlFeed URL
genreGenres

Apple Music​

externalRef: applemusic — Supports free-text search and resolving a pasted URL/id. Can pull an episode/track list into an entity's episodes body section.

externalTypes values (defaults marked ✓):

ValueMeaningDefault
albumAlbum✓

Mappable fields (for externalFields and external body sections):

FieldMeaning
titleTitle
cover_urlCover URL
release_dateRelease date
track_countTrack count
artistsArtists
genreGenres

Steam​

externalRef: steam — Resolves a pasted URL/id only — free-text search returns nothing.

externalTypes values (defaults marked ✓):

ValueMeaningDefault
gameGame✓

Mappable fields (for externalFields and external body sections):

FieldMeaning
nameName
cover_urlCover URL
release_dateRelease date
platformPlatform
developersDevelopers
publishersPublishers
genresGenres
descriptionDescription

MusicBrainz​

externalRef: musicbrainz — Supports free-text search and resolving a pasted URL/id. Can pull an episode/track list into an entity's episodes body section.

externalTypes values (defaults marked ✓):

ValueMeaningDefault
releaseRelease (album)
release-groupRelease group
artistArtist

Mappable fields (for externalFields and external body sections):

FieldMeaning
titleTitle / Name
cover_urlCover URL
release_dateRelease / begin date
end_dateEnd date
countryRegion
barcodeBarcode
typeType
disambiguationDisambiguation
official_siteOfficial site
artistsArtists
labelLabels
genresGenres

BoardGameGeek​

externalRef: bgg — Supports free-text search and resolving a pasted URL/id.

CredentialKeyEnv var (web)Required
BGG XML API Tokenbgg_api_tokenKIZUNASHELF_BGG_API_TOKENrequired

externalTypes values (defaults marked ✓):

ValueMeaningDefault
boardgameBoard game
boardgameexpansionExpansion

Mappable fields (for externalFields and external body sections):

FieldMeaning
nameName
cover_urlCover URL
yearYear published
platformPlatform
playersPlayers
playtimePlaying time
min_ageMinimum age
scoreScore
score_countScore count
rankRank
descriptionDescription
designersDesigners
artistsArtists
publishersPublishers
developersDevelopers
categoriesCategories

TMDB​

externalRef: tmdb — Supports free-text search and resolving a pasted URL/id. Can pull an episode/track list into an entity's episodes body section.

CredentialKeyEnv var (web)Required
TMDB API Keytmdb_api_keyKIZUNASHELF_TMDB_API_KEYrequired

externalTypes values (defaults marked ✓):

ValueMeaningDefault
movieMovie
tvTV
personPerson

Mappable fields (for externalFields and external body sections):

FieldMeaning
titleTitle / Name
cover_urlCover URL
original_titleOriginal title
yearYear
release_dateRelease / air date
runtimeRuntime (minutes)
statusStatus
season_countSeason count
episode_countEpisode count
last_air_dateLast air date
countryRegion
original_languageOriginal language
scoreScore
score_countScore count
imdb_codeIMDb id
tvdb_idTheTVDB id
wikidata_idWikidata id
official_siteOfficial site
birthdayBirthday
death_dateDeath date
known_forKnown for
overviewOverview
genresGenres
languageLanguages
studiosStudios
directorsDirectors
writersWriters
producersProducers
castCast

Discogs​

externalRef: discogs — Supports free-text search and resolving a pasted URL/id. Can pull an episode/track list into an entity's episodes body section.

CredentialKeyEnv var (web)Required
Discogs Personal Access Tokendiscogs_tokenKIZUNASHELF_DISCOGS_TOKENoptional
Discogs Consumer Keydiscogs_consumer_keyKIZUNASHELF_DISCOGS_CONSUMER_KEYoptional
Discogs Consumer Secretdiscogs_consumer_secretKIZUNASHELF_DISCOGS_CONSUMER_SECREToptional

externalTypes values (defaults marked ✓):

ValueMeaningDefault
releaseRelease
masterMaster

Mappable fields (for externalFields and external body sections):

FieldMeaning
titleTitle
cover_urlCover URL
yearYear
formatFormat
artistsArtists
genresGenres
stylesStyles
labelLabels
companyCompanies

MyAnimeList​

externalRef: myanimelist — Supports free-text search and resolving a pasted URL/id. Can pull an episode/track list into an entity's episodes body section.

CredentialKeyEnv var (web)Required
MyAnimeList Client IDmal_client_idKIZUNASHELF_MAL_CLIENT_IDrequired

externalTypes values (defaults marked ✓):

ValueMeaningDefault
animeAnime
mangaManga

Mappable fields (for externalFields and external body sections):

FieldMeaning
titleTitle
cover_urlCover URL
formatType
start_dateStart date
end_dateEnd date
statusStatus
episodesEpisodes
chaptersChapters
runtimeRuntime (minutes)
seasonSeason
sourceSource material
scoreScore
synopsisSynopsis
genresGenres
studiosStudios

MangaUpdates​

externalRef: mangaupdates — Supports free-text search and resolving a pasted URL/id.

externalTypes values (defaults marked ✓):

ValueMeaningDefault
mangaManga✓

Mappable fields (for externalFields and external body sections):

FieldMeaning
titleTitle
cover_urlCover URL
formatType
yearYear
statusStatus
latest_chapterLatest chapter
scoreScore
synopsisSynopsis
authorsAuthors
genresGenres

Comic Vine​

externalRef: comicvine — Supports free-text search and resolving a pasted URL/id. Can pull an episode/track list into an entity's episodes body section.

CredentialKeyEnv var (web)Required
Comic Vine API Keycomicvine_api_keyKIZUNASHELF_COMICVINE_API_KEYrequired

externalTypes values (defaults marked ✓):

ValueMeaningDefault
comicComic✓

Mappable fields (for externalFields and external body sections):

FieldMeaning
titleTitle
cover_urlCover URL
publisherPublisher
start_yearStart year
issues_countIssue count
descriptionDescription
genresGenres
peoplePeople

Hardcover​

externalRef: hardcover — Supports free-text search and resolving a pasted URL/id.

CredentialKeyEnv var (web)Required
Hardcover API Tokenhardcover_api_keyKIZUNASHELF_HARDCOVER_API_KEYrequired

externalTypes values (defaults marked ✓):

ValueMeaningDefault
bookBook✓

Mappable fields (for externalFields and external body sections):

FieldMeaning
titleTitle
cover_urlCover URL
formatFormat
pagesPages
publish_datePublish date
publisherPublisher
isbnISBN
scoreScore
synopsisSynopsis
authorsAuthors
genresGenres

NeoDB​

externalRef: neodb — Supports free-text search and resolving a pasted URL/id.

externalTypes values (defaults marked ✓):

ValueMeaningDefault
bookBook
movieMovie
tvTv
musicMusic
gameGame
podcastPodcast
performancePerformance

Mappable fields (for externalFields and external body sections):

FieldMeaning
titleTitle
original_titleOriginal title
cover_urlCover URL
descriptionDescription
ratingRating
rating_countRating count
release_dateRelease date
published_datePublished date
pagesPages
isbnISBN
languageLanguage
seriesSeries
formatFormat
episode_countEpisode count
season_countSeason count
season_numberSeason number
official_siteOfficial site
opening_dateOpening date
closing_dateClosing date
tagsTags
authorsAuthors
translatorsTranslators
publishersPublishers
directorsDirectors
playwrightsPlaywrights
original_creatorsOriginal creators
composersComposers
choreographersChoreographers
performersPerformers
actorsActors
crewCrew
genresGenres
artistsArtists
developersDevelopers
platformsPlatforms
hostsHosts
companyCompany

AniList​

externalRef: anilist — Supports free-text search and resolving a pasted URL/id. Can pull an episode/track list into an entity's episodes body section.

externalTypes values (defaults marked ✓):

ValueMeaningDefault
animeAnime
mangaManga

Mappable fields (for externalFields and external body sections):

FieldMeaning
titleTitle
romaji_titleRomaji title
native_titleNative title
cover_urlCover URL
formatType
start_dateStart date
end_dateEnd date
statusStatus
episodesEpisodes
chaptersChapters
volumesVolumes
runtimeRuntime (minutes)
seasonSeason
sourceSource material
scoreScore
synopsisSynopsis
genresGenres
studiosStudios