Tvmaze

TVmaze user API

Access to the user API is only possible for users with a [premium](http://www.tvmaze.com/premium) account. A user can only access their own user data.…

Media & content#openapi#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Access to the user API is only possible for users with a premium 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 dashboard. To try out these API calls from this page, click the "Authorize" button on top and input your credentials.

Endpoints 42

auth

  • POSTPoll whether an authentication request was confirmed/auth/pollUsing the token acquired in the start endpoint, you can start polling this endpoint once every 10 seconds. When the user has confirmed the authentication…
  • POSTStart an authentication request/auth/startIf 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…
  • GETValidate your authentication credentials/auth/validateIf the credentials supplied as HTTP basic are valid, the user's level of premium - if any - is returned.

scrobbling

  • POSTMark episodes as acquired or watched based on their IDs/scrobble/episodesThis endpoint can be used by all users, even without premium
  • PUTMark an episode as acquired or watched based on its ID/scrobble/episodes/:episode_idThis endpoint can be used by all users, even without premium
  • POSTMark episodes within a show as acquired or watched based on their attributes/scrobble/shows?tvmaze_id=0&thetvdb_id=0&imdb_id=0To specify a show, supply either tvmaze_id, thetvdb_id or imdb_id. To specify an episode, supply either both season and episode, or airdate. This endpoint can…
  • GETList watched and acquired episodes for a show/scrobble/shows/:show_id?embed=episodeThis endpoint can be used by all users, even without premium

marked episodes

  • GETList the marked episodes/user/episodes?show_id=0
  • GETCheck if an episode is marked/user/episodes/:episode_id
  • PUTMark an episode/user/episodes/:episode_idSet marked_at to NULL or leave it out to use the current time.
  • DELETEUnmark an episode/user/episodes/:episode_id

followed networks

  • GETList the followed networks/user/follows/networks?embed=network
  • GETCheck if a network is followed/user/follows/networks/:network_id
  • PUTFollow a network/user/follows/networks/:network_id
  • DELETEUnfollow a network/user/follows/networks/:network_id

followed people

  • GETList the followed people/user/follows/people?embed=person
  • GETCheck if a person is followed/user/follows/people/:person_id
  • PUTFollow a person/user/follows/people/:person_id
  • DELETEUnfollow a person/user/follows/people/:person_id

followed shows

  • GETList the followed shows/user/follows/shows?embed=show
  • GETCheck if a show is followed/user/follows/shows/:show_id
  • PUTFollow a show/user/follows/shows/:show_id
  • DELETEUnfollow a show/user/follows/shows/:show_id

followed webchannels

  • GETList the followed webchannels/user/follows/webchannels?embed=webchannel
  • GETCheck if a webchannel is followed/user/follows/webchannels/:webchannel_id
  • PUTFollow a webchannel/user/follows/webchannels/:webchannel_id
  • DELETEUnfollow a webchannel/user/follows/webchannels/:webchannel_id

tagged shows

  • GETList all tags/user/tags
  • POSTCreate a new tag/user/tags
  • DELETEDelete a specific tag/user/tags/:tag_id
  • PATCHUpdate a specific tag/user/tags/:tag_id
  • GETList all shows under this tag/user/tags/:tag_id/shows?embed=show
  • PUTTag a show/user/tags/:tag_id/shows/:show_id
  • DELETEUntag a show/user/tags/:tag_id/shows/:show_id

voted episodes

  • GETList the episodes voted for/user/votes/episodes
  • GETCheck if an episode is voted for/user/votes/episodes/:episode_id
  • PUTVote for an episode/user/votes/episodes/:episode_id
  • DELETERemove an episode vote/user/votes/episodes/:episode_id

voted shows

  • GETList the shows voted for/user/votes/shows?embed=show
  • GETCheck if a show is voted for/user/votes/shows/:show_id
  • PUTVote for a show/user/votes/shows/:show_idSet voted_at to NULL or leave it out to use the current time.
  • DELETERemove a show vote/user/votes/shows/:show_id

API details

Base URL
https://api.tvmaze.com/v1
http://api.tvmaze.com/v1
Authentication
HTTP Basic authentication (username and password)
Operations
42 operations on 25 pathsGET 18PUT 9DELETE 9POST 5PATCH 1
Main resources
tagged shows 7followed networks 4followed people 4followed shows 4followed webchannels 4marked episodes 4scrobbling 4voted episodes 4voted shows 4auth 3
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 1.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the TVmaze user API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the TVmaze user API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Poll whether an authentication request was confirmed” (POST /auth/poll), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the TVmaze user API?

Access to the user API is only possible for users with a [premium](http://www.tvmaze.com/premium) account. A user can only access their own user data.… It is listed under Media & content and has 42 endpoints.

Who publishes the TVmaze user API?

It is listed from Tvmaze's public API description (an OpenAPI document), not published by Tvmaze on Swastik Codes. Anyone who controls tvmaze.com can claim the profile by adding a DNS TXT record.

What is the base URL of the TVmaze user API?

Its description lists 2 base URLs: https://api.tvmaze.com/v1, http://api.tvmaze.com/v1. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the TVmaze user API?

With HTTP Basic authentication (username and password).

How many endpoints does the TVmaze user API have?

42 operations on 25 paths (18 GET, 9 PUT, 9 DELETE, 5 POST, 1 PATCH). The largest groups are tagged shows, followed networks, followed people, followed shows.

Is forking the TVmaze user API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.