What you get#
Onekey exposes TVmaze as 14 endpoints behind one API key: 6 endpoints return one record (data is an object) and 8 endpoints return a list (data is an array). Every answer uses the same envelope (success, data, metadata, error), the cost is reported in metadata.credits_charged, and fields are mapped onto the unified schema so the code you write for TVmaze also works for the rest of the entertainment, art & culture category.
Endpoints#
| Endpoint | What it does | Parameters | Credits | Status |
|---|---|---|---|---|
episode | One episode by season and number. | id*, season*, number* | 1 | stable |
episode_by_id | Episode by TVmaze episode id. | id* | 1 | stable |
people_search | Search people in TV. | q* | 5 | stable |
person | Person (actor/crew) by TVmaze id. | id* | 1 | stable |
person_cast_credits | Cast credits (shows) of a person. | id* | 5 | stable |
schedule | TV schedule for a country and date. | date*, country | 5 | stable |
search | Search TV shows. | q* | 5 | stable |
show | TV show by TVmaze id. | id* | 1 | stable |
show_by_imdb | TV show by IMDb id. | imdb* | 1 | stable |
show_cast | Cast of a TV show. | id* | 5 | stable |
show_crew | Crew of a TV show. | id* | 5 | stable |
show_episodes | All episodes of a TV show. | id* | 5 | stable |
show_seasons | Seasons of a TV show. | id* | 5 | stable |
show_single_search | Best-matching TV show for a name. | q* | 1 | stable |
A * marks a required parameter. Each endpoint name links to its reference page with the full parameter table, caching window and a recorded response.
Make a request#
This calls tvmaze.episode (1 credit, stable). Replace YOUR_API_KEY with your key; sign up, no card. 1,000 free credits cover the open-platform endpoints. Hard-to-reach platforms (X, TikTok, Instagram, Reddit, and others marked on their page) need a verified email and a purchased pack.
curl "https://api.onekey.dev/v1/tvmaze/episode?id=169&season=1&number=1" \
-H "x-api-key: YOUR_API_KEY"Fields you get back#
These unified fields come back from TVmaze, with the same names as on every other platform. The count is how many of its 14 mapped endpoints return the field; a field the source lacks is null, never missing. 12 platform-specific fields (ext.<name>) come on top, documented on each endpoint page.
| Field | Type | Endpoints |
|---|---|---|
media.thumbnailUrl | URL | 9 |
content.id | string | 5 |
content.url | URL | 5 |
entity.id | string | 5 |
entity.name | string | 5 |
entity.url | URL | 5 |
author.avatarUrl | URL | 4 |
author.birthDate | ISO 8601 date | 4 |
author.country | string | 4 |
author.displayName | string | 4 |
author.id | string | 4 |
author.url | URL | 4 |
content.createdAt | ISO 8601 date | 4 |
content.text | string | 4 |
content.title | string | 4 |
entity.category | string | 4 |
entity.description | string | 4 |
entity.language | string | 4 |
entity.stats.rating | number | 4 |
entity.status | string | 4 |
media.url | URL | 4 |
entity.stats.score | number | 1 |
The full schema is in Unified schema.
Pricing#
TVmaze calls cost 1 to 5 credits, flat per endpoint. Free when served from cache (0.2 credit for a cached response over 100 KB). Invalid, failed or not-found calls are not charged. See pricing for credit packs.