TVmaze user API
Access to the user API is only possible for users with a account. A user can only access their own user data.
Authentication uses HTTP Basic. Use the TVmaze username as authentication username, and the TVmaze API key as authentication password. Your API key can be found on your . To try out these API calls from this page, click the "Authorize" button on top and input your credentials.
- Homepage
- https://api.apis.guru/v2/specs/tvmaze.com/1.0.json
- Provider
- tvmaze.com
- OpenAPI version
- 3.0.0
- Spec (JSON)
- https://api.apis.guru/v2/specs/tvmaze.com/1.0/openapi.json
- Spec (YAML)
- https://api.apis.guru/v2/specs/tvmaze.com/1.0/openapi.yaml
Tools (44)
Extracted live via the executor SDK.
-
auth.getAuthValidateIf the credentials supplied as HTTP basic are valid, the user's level of premium - if any - is returned.
-
auth.postAuthPollUsing the token acquired in the
startendpoint, you can start polling this endpoint once every 10 seconds.When the user has confirmed the authentication request on their end, this endpoint will return the user's API key that you can use in subsequent authenticated endpoints. Note that it'll do so only once, subsequent requests after the initial 200 response will return a 404.
For as long as the user did not yet confirm their authentication request, this endpoint will return a 403.
-
auth.postAuthStartIf you want to access the TVmaze API on behalf of a user without querying them for their password, use this endpoint.
To get started, send a POST request containing the user's email address. The response will contain a
token, which you can use as input to thepollendpoint. The user will receive an email prompting them to confirm the authentication request.Alternatively, if you expect the user to be logged in to TVmaze on the device they are currently interacting with, you can set
email_confirmationto false and redirect them to theconfirm_urlURL. If they are logged in to TVmaze, they will be able to confirm the authentication request instantly. -
followedNetworks.deleteUserFollowsNetworksNetworkIdUnfollow a network
-
followedNetworks.getUserFollowsNetworksList the followed networks
-
followedNetworks.getUserFollowsNetworksNetworkIdCheck if a network is followed
-
followedNetworks.putUserFollowsNetworksNetworkIdFollow a network
-
followedPeople.deleteUserFollowsPeoplePersonIdUnfollow a person
-
followedPeople.getUserFollowsPeopleList the followed people
-
followedPeople.getUserFollowsPeoplePersonIdCheck if a person is followed
-
followedPeople.putUserFollowsPeoplePersonIdFollow a person
-
followedShows.deleteUserFollowsShowsShowIdUnfollow a show
-
followedShows.getUserFollowsShowsList the followed shows
-
followedShows.getUserFollowsShowsShowIdCheck if a show is followed
-
followedShows.putUserFollowsShowsShowIdFollow a show
-
followedWebchannels.deleteUserFollowsWebchannelsWebchannelIdUnfollow a webchannel
-
followedWebchannels.getUserFollowsWebchannelsList the followed webchannels
-
followedWebchannels.getUserFollowsWebchannelsWebchannelIdCheck if a webchannel is followed
-
followedWebchannels.putUserFollowsWebchannelsWebchannelIdFollow a webchannel
-
markedEpisodes.deleteUserEpisodesEpisodeIdUnmark an episode
-
markedEpisodes.getUserEpisodesList the marked episodes
-
markedEpisodes.getUserEpisodesEpisodeIdCheck if an episode is marked
-
markedEpisodes.putUserEpisodesEpisodeIdSet
marked_attoNULLor leave it out to use the current time. -
scrobbling.getScrobbleShowsShowIdThis endpoint can be used by all users, even without premium
-
scrobbling.postScrobbleEpisodesThis endpoint can be used by all users, even without premium
-
scrobbling.postScrobbleShowsTo specify a show, supply either
tvmaze_id,thetvdb_idorimdb_id. To specify an episode, supply either bothseasonandepisode, orairdate.This endpoint can be used by all users, even without premium.
-
scrobbling.putScrobbleEpisodesEpisodeIdThis endpoint can be used by all users, even without premium
-
taggedShows.deleteUserTagsTagIdDelete a specific tag
-
taggedShows.deleteUserTagsTagIdShowsShowIdUntag a show
-
taggedShows.getUserTagsList all tags
-
taggedShows.getUserTagsTagIdShowsList all shows under this tag
-
taggedShows.patchUserTagsTagIdUpdate a specific tag
-
taggedShows.postUserTagsCreate a new tag
-
taggedShows.putUserTagsTagIdShowsShowIdTag a show
-
votedEpisodes.deleteUserVotesEpisodesEpisodeIdRemove an episode vote
-
votedEpisodes.getUserVotesEpisodesList the episodes voted for
-
votedEpisodes.getUserVotesEpisodesEpisodeIdCheck if an episode is voted for
-
votedEpisodes.putUserVotesEpisodesEpisodeIdVote for an episode
-
votedShows.deleteUserVotesShowsShowIdRemove a show vote
-
votedShows.getUserVotesShowsList the shows voted for
-
votedShows.getUserVotesShowsShowIdCheck if a show is voted for
-
votedShows.putUserVotesShowsShowIdSet
voted_attoNULLor leave it out to use the current time. -
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools