tvmaze.show_single_search

stable Standard

Best-matching TV show for a name.

GET /v1/tvmaze/show_single_search

What you get#

One Tvmaze record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

What it costs#

Standard · 1 credit 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#

Name	Type	Required	Default	What it is	Constraints
`q`	string	yes	(required)	Search query	max 200 chars; must match `[^\x00-\x1f\x7f]{1,200}`; trimmed, repeated spaces collapsed

Request#

curl "https://api.onekey.dev/v1/tvmaze/show_single_search?q=girls" \
  -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": {
    "entity": {
      "id": "139",
      "name": "Girls",
      "url": "https://www.tvmaze.com/shows/139/girls",
      "description": "This Emmy winning series is a comic look at the assorted humiliations and rare triumphs of a group of girls in their 20s.",
      "language": "English",
      "status": "Ended",
      "category": "Drama",
      "stats": {
        "rating": 6.5
      }
    },
    "ext": {
      "premiered": "2012-04-15",
      "runtime": 30,
      "network": "HBO",
      "imdbId": "tt1723816"
    },
    "media": {
      "thumbnailUrl": "https://static.tvmaze.com/uploads/images/medium_portrait/31/78286.jpg",
      "url": "https://static.tvmaze.com/uploads/images/original_untouched/31/78286.jpg"
    }
  },
  "metadata": {
    "platform": "tvmaze",
    "endpoint": "show_single_search",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "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 path	Onekey field	Transform
`id`	`entity.id`	`toString`
`name`	`entity.name`	-
`url`	`entity.url`	`safeUrl`
`summary`	`entity.description`	`stripHtml`
`language`	`entity.language`	-
`status`	`entity.status`	-
`premiered`	`ext.premiered`	-
`genres.0`	`entity.category`	-
`runtime`	`ext.runtime`	`toNumber`
`rating.average`	`entity.stats.rating`	`toNumber`
`network.name`	`ext.network`	-
`externals.imdb`	`ext.imdbId`	-
`image.medium`	`media.thumbnailUrl`	`safeUrl`
`image.original`	`media.url`	`safeUrl`

Caching and freshness#

Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
Between 2 minutes and 15 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 1 hour 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#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	That record does not exist. Free; do not retry.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).