{"@context": "https://schema.org", "@type": "WebAPI", "name": "TVmaze user API API", "description": "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. Authentication uses HTTP Basic. Use the TVmaze username as authentication username, and the TVmaze API key as authentication password. Your API key ", "provider": {"@type": "Organization", "name": "tvmaze.com"}, "documentation": "http://static.tvmaze.com/apidoc/v1.yaml"}
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. Authentication uses HTTP Basic. Use the TVmaze username as authentication username, and the TVmaze API key as authentication password. Your API key
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.tvmaze.com/v1 http://api.tvmaze.com/v1
auth: b a s i c
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
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. 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](http://www.tvmaze.com/dashboard). To try out these API calls from t
| method | path | what the vendor says it does |
|---|---|---|
POST | /auth/poll | Poll whether an authentication request was confirmed Using the token acquired in the `start` endpoint, you can |
POST | /auth/start | Start an authentication request If you want to access the TVmaze API on behalf of a user without querying them |
GET | /auth/validate | Validate your authentication credentials If the credentials supplied as HTTP basic are valid, the user's level |
POST | /scrobble/episodes | Mark episodes as acquired or watched based on their IDs This endpoint can be used by all users, even without p |
PUT | /scrobble/episodes/{episode_id} | Mark an episode as acquired or watched based on its ID This endpoint can be used by all users, even without pr |
POST | /scrobble/shows | Mark episodes within a show as acquired or watched based on their attributes To specify a show, supply either |
GET | /scrobble/shows/{show_id} | List watched and acquired episodes for a show This endpoint can be used by all users, even without premium scr |
GET | /user/episodes | List the marked episodes marked episodes |
GET | /user/episodes/{episode_id} | Check if an episode is marked marked episodes |
PUT | /user/episodes/{episode_id} | Mark an episode Set `marked_at` to `NULL` or leave it out to use the current time. marked episodes |
DELETE | /user/episodes/{episode_id} | Unmark an episode marked episodes |
GET | /user/follows/networks | List the followed networks followed networks |
GET | /user/follows/networks/{network_id} | Check if a network is followed followed networks |
PUT | /user/follows/networks/{network_id} | Follow a network followed networks |
DELETE | /user/follows/networks/{network_id} | Unfollow a network followed networks |
GET | /user/follows/people | List the followed people followed people |
GET | /user/follows/people/{person_id} | Check if a person is followed followed people |
PUT | /user/follows/people/{person_id} | Follow a person followed people |
DELETE | /user/follows/people/{person_id} | Unfollow a person followed people |
GET | /user/follows/shows | List the followed shows followed shows |
GET | /user/follows/shows/{show_id} | Check if a show is followed followed shows |
PUT | /user/follows/shows/{show_id} | Follow a show followed shows |
DELETE | /user/follows/shows/{show_id} | Unfollow a show followed shows |
GET | /user/follows/webchannels | List the followed webchannels followed webchannels |
GET | /user/follows/webchannels/{webchannel_id} | Check if a webchannel is followed followed webchannels |
PUT | /user/follows/webchannels/{webchannel_id} | Follow a webchannel followed webchannels |
DELETE | /user/follows/webchannels/{webchannel_id} | Unfollow a webchannel followed webchannels |
GET | /user/tags | List all tags tagged shows |
POST | /user/tags | Create a new tag tagged shows |
PATCH | /user/tags/{tag_id} | Update a specific tag tagged shows |
DELETE | /user/tags/{tag_id} | Delete a specific tag tagged shows |
GET | /user/tags/{tag_id}/shows | List all shows under this tag tagged shows |
PUT | /user/tags/{tag_id}/shows/{show_id} | Tag a show tagged shows |
DELETE | /user/tags/{tag_id}/shows/{show_id} | Untag a show tagged shows |
GET | /user/votes/episodes | List the episodes voted for voted episodes |
GET | /user/votes/episodes/{episode_id} | Check if an episode is voted for voted episodes |
PUT | /user/votes/episodes/{episode_id} | Vote for an episode voted episodes |
DELETE | /user/votes/episodes/{episode_id} | Remove an episode vote voted episodes |
GET | /user/votes/shows | List the shows voted for voted shows |
GET | /user/votes/shows/{show_id} | Check if a show is voted for voted shows |
and 2 more operation(s) in this specification, all searchable.
specification origin: http://static.tvmaze.com/apidoc/v1.yaml
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.