Docs
View as Markdown

tvmaze.schedule

stable Advanced

TV schedule for a country and date.

GET /v1/tvmaze/schedule

What you get#

A list of Tvmaze results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

  • Advanced · 5 credits for a fresh fetch, charged only when it succeeds.
  • Free when served from cache (0.2 credit for a cached response over 100 KB).
  • Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

NameTypeRequiredDefaultWhat it isConstraints
countrystringnoUS2-letter country code, e.g. USmax 2 chars; must match [A-Z]{2}; trimmed
datestringyes(required)Date YYYY-MM-DDmax 10 chars; must match [0-9]{4}-[0-9]{2}-[0-9]{2}; trimmed

Request#

curl "https://api.onekey.dev/v1/tvmaze/schedule?country=US&date=2026-09-28" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Tvmaze response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": [
    {
      "content": {
        "id": "3718466",
        "title": "Episode 188",
        "url": "https://www.tvmaze.com/episodes/3718466/way-too-early-2026-09-28-episode-188",
        "createdAt": "2026-09-28T09:00:00Z",
        "text": "Trump sats he expects U.S.-Iran talks this week: AXIOS 5 arrested in UK on suspicion of preparing a terror plot NYT: U.S. Ambassador says Trump offered to sell arms to China Trump's taxpayer-funded political ads draw criticism"
      },
      "ext": {
        "season": 2026,
        "number": 188,
        "airDate": "2026-09-28",
        "runtime": 60,
        "show": "Way Too Early"
      },
      "media": {
        "thumbnailUrl": null
      }
    },
    {
      "content": {
        "id": "3723852",
        "title": "Episode 193",
        "url": "https://www.tvmaze.com/episodes/3723852/fox-friends-first-2026-09-28-episode-193",
        "createdAt": "2026-09-28T09:00:00Z",
        "text": null
      },
      "ext": {
        "season": 2026,
        "number": 193,
        "airDate": "2026-09-28",
        "runtime": 60,
        "show": "FOX & Friends First"
      },
      "media": {
        "thumbnailUrl": null
      }
    }
  ],
  "metadata": {
    "platform": "tvmaze",
    "endpoint": "schedule",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source pathOnekey fieldTransform
idcontent.idtoString
namecontent.title-
urlcontent.urlsafeUrl
seasonext.seasontoNumber
numberext.numbertoNumber
airdateext.airDate-
airstampcontent.createdAttoIsoDate
summarycontent.textstripHtml
runtimeext.runtimetoNumber
image.mediummedia.thumbnailUrlsafeUrl
show.nameext.show-

Caching and freshness#

  • Fresh for about 30 seconds. Repeat calls in that window are served from cache and are free.
  • Between 30 seconds and 5 minutes the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
  • If the source is down when a refresh is needed, the last copy can be served for up to 10 minutes more (marked stale).
  • A "not found" is remembered for 1 minute and is free.
  • The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundUnknown endpoint path.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).