> ## Documentation Index
> Fetch the complete documentation index at: https://api.simkl.org/llms.txt
> Use this file to discover all available pages before exploring further.
# TV shows airing today, tomorrow, or on a specific date
> Currently airing TV shows — same data that powers the [Simkl TV calendar](https://simkl.com/tv/airing/). No `access_token` required.
Same shape and parameters as [`/anime/airing`](/api-reference/simkl/get-anime-airing) but for the TV catalog: no `anime_type` field, and the per-item `episode` block includes a `season` integer.
**Prefer the cached calendar endpoints for high-traffic use cases.** `/tv/airing` is **uncached** — every request hits the origin. For widgets, mobile-app home screens, or anything that fetches this on app launch / wake / timer, use the CDN-cached [Calendar data files](/api-reference/calendar) on `data.simkl.in` instead — both the rolling-window `/calendar/{type}.json` (yesterday + next 33 days) and the monthly archive `/calendar/{year}/{month}/{type}.json` serve the same per-day airing data, edge-cached so most requests don't even reach origin. Reserve `/tv/airing` for ad-hoc queries by a specific date that the calendar files don't pre-bake.
Both forms still need the standard URL params on every request — `client_id`, `app-name`, `app-version` (and the `User-Agent` header) — same as every other Simkl endpoint. See [Headers and required parameters](/conventions/headers).
#### Query parameters
| Param | Default | Notes |
|---|---|---|
| `date` | `today` | `today`, `tomorrow`, or `DD-MM-YYYY`. Bogus values silently fall back to `today`. |
| `sort` | `time` | `time`, `rank`, `popularity`. Bogus values silently fall back to `time`. |
#### Item shape
```json
{
"title": "string",
"year": "integer | null (extracted from the episode air time)",
"date": "ISO-8601 string with -05:00 offset | null",
"poster": "string (relative path; prepend https://simkl.in/posters/ + size)",
"rank": "integer | null (Simkl popularity rank; null when not yet ranked)",
"url": "string (relative simkl.com URL)",
"ids": {
"simkl_id": "integer",
"slug": "string"
},
"episode": {
"season": "integer",
"episode": "integer",
"url": "string"
}
}
```
#### Nulls — what they mean
| Field | When null | Type |
|---|---|---|
| `date` | Catalog has no `Airs_Time` on file for this episode (rare — usually older or low-data titles) | [Type 4](/conventions/null-values#type-4) |
| `rank` | Item not yet ranked, or rank value >= 999999 sentinel | [Type 4](/conventions/null-values#type-4) |
#### Error responses
| Status | When |
|---|---|
| `412 client_id_failed` | Missing or invalid `client_id` |
| `500` | Server error |
No `400` — invalid `date`/`sort` values silently fall back to defaults. No `404` — empty result is `[]` with status `200`.
## OpenAPI
````yaml /openapi.json get /tv/airing
openapi: 3.1.0
info:
title: Simkl API
version: 1.0.0
description: >-
The **Simkl API** lets you build apps that track Movies, TV Shows, and Anime
— scrobble playback, sync watch history, and pull rich metadata.
All requests use HTTPS and return JSON. The base URL is
`https://api.simkl.com`.
**Every request needs three URL parameters and a `User-Agent` header:**
```
/endpoint?client_id=YOUR_CLIENT_ID&app-name=my-app&app-version=1.0
```
See [Headers and required parameters](/conventions/headers) for the full
reference. Endpoints that read or modify a user's data also need an
`Authorization: Bearer ` header — see [OAuth
2.0](/api-reference/oauth) or the [PIN flow](/api-reference/pin).
> ⚠️ **About the auto-rendered cURL examples on each endpoint page:** they
omit `?client_id=…&app-name=…&app-version=…` from the URL for brevity. **You
must add them yourself when copy-pasting**, or use the interactive **"Try
it"** playground (it fills them in for you). This is a Mintlify rendering
convention — every Mintlify-built API doc behaves the same way.
**Get started**
- [Quickstart](/quickstart) — first request in 60 seconds
- [API rules](/api-rules) — what's allowed, what isn't
- [Standard media objects](/conventions/standard-media-objects) — the shapes
every endpoint speaks
- [Errors](/conventions/errors) — every status code Simkl returns
contact:
name: Simkl Developer Support
url: https://support.simkl.com
termsOfService: https://simkl.com/about/policies/terms/
license:
name: Simkl API Terms of Use
url: https://simkl.com/about/policies/terms/
x-logo:
url: https://i.simkl.com/img_tv/apiary_logo_api.png
backgroundColor: '#0E5DAB'
altText: Simkl
servers:
- url: https://api.simkl.com
description: Production API
- url: https://data.simkl.in
description: CDN for static, public data files (Calendar + Trending). No auth required.
security:
- clientId: []
- simklApiKey: []
tags:
- name: OAuth 2.0
description: >-
OAuth 2.0 authorization-code flow for web and mobile apps. The user is
redirected to Simkl, signs in, approves your app, and is redirected back
with a `code` you exchange for an `access_token`. Long-lived tokens — no
refresh-token flow needed.
externalDocs:
description: OAuth 2.0 walkthrough
url: https://api.simkl.org/api-reference/oauth
- name: PIN
description: >-
Device flow for TVs, consoles, smart watches, CLI tools — anywhere typing
a URL is hard. Show a 5-character code; user enters it on simkl.com/pin;
you poll for the access token. **No `client_secret` required.**
externalDocs:
description: PIN flow walkthrough
url: https://api.simkl.org/api-reference/pin
- name: Redirect
description: >-
Helper redirects for one-click "mark as watched", trailers, sharing, and
more.
- name: Search
description: Find shows, movies, and anime by ID, text query, file name, or randomly.
externalDocs:
description: Search guide
url: https://api.simkl.org/guides/search
- name: Movies
description: >-
Browse the Simkl movies catalog: details, premieres, top-of-best, and
genre filters.
- name: TV
description: >-
Browse the Simkl TV catalog: details, episodes, what's airing, premieres,
top-of-best, and genre filters.
- name: Anime
description: >-
Browse the Simkl anime catalog: details, episodes, what's airing,
premieres, top-of-best, and genre filters.
- name: Ratings
description: >-
Read Simkl's average community rating, rank, drop rate, and external
ratings (IMDB, MAL) for any item, or for every item in a user's lists.
- name: Scrobble
description: >-
Report real-time playback to Simkl with `start`, `pause`, and `stop`. At ≥
80 % progress Simkl marks the item as watched automatically; below 80 %
the session is saved as a paused playback the user can resume from any
device.
See [Standard media objects](/conventions/standard-media-objects) for the
supported ID keys.
### Supported ID keys
Inside any `ids` object, pass as many of these as you have. Simkl resolves
to the canonical record.
| ID key | Type | Example |
|---|---|---|
| `simkl` | integer | `49108`. Simkl's canonical ID. Most reliable. |
| `imdb` | string | `tt1520211` |
| `tmdb` | integer | `76757` (for TV, specify `type`) |
| `tvdb` | int / string | `153021` or `the-walking-dead` |
| `mal` | integer | `4246` (MyAnimeList) |
| `anidb` | integer | `10846`. Specifying just this is enough for anime
lookups. |
| `anilist` | integer | `21` |
| `kitsu` | integer | `12` |
| `anisearch` | integer | `2227` |
| `animeplanet` | string | `one-piece` |
| `livechart` | integer | `321` |
| `letterboxd` | string | `the-truman-show` |
| `netflix` | integer | `70210890` (movie ID) |
| `traktslug` | string | `john-wick-chapter-4-2023` |
> 📖 Full reference: [Standard media
objects](/conventions/standard-media-objects)
externalDocs:
description: Scrobble guide
url: https://api.simkl.org/guides/scrobble
- name: Sync
description: >-
Use Simkl as a cloud backup for the user's watch history and lists
(Watching, Plan to Watch, On Hold, Dropped, Completed). **Always check
[`/sync/activities`](/api-reference/simkl/get-activities) first** and sync
only the lists that have moved.
All write endpoints accept arrays — batch aggressively. See [Standard
media objects](/conventions/standard-media-objects) for the supported ID
keys.
### Supported ID keys
Inside any `ids` object, pass as many of these as you have. Simkl resolves
to the canonical record.
| ID key | Type | Example |
|---|---|---|
| `simkl` | integer | `49108`. Simkl's canonical ID. Most reliable. |
| `imdb` | string | `tt1520211` |
| `tmdb` | integer | `76757` (for TV, specify `type`) |
| `tvdb` | int / string | `153021` or `the-walking-dead` |
| `mal` | integer | `4246` (MyAnimeList) |
| `anidb` | integer | `10846`. Specifying just this is enough for anime
lookups. |
| `anilist` | integer | `21` |
| `kitsu` | integer | `12` |
| `anisearch` | integer | `2227` |
| `animeplanet` | string | `one-piece` |
| `livechart` | integer | `321` |
| `letterboxd` | string | `the-truman-show` |
| `netflix` | integer | `70210890` (movie ID) |
| `traktslug` | string | `john-wick-chapter-4-2023` |
> 📖 Full reference: [Standard media
objects](/conventions/standard-media-objects)
externalDocs:
description: Sync guide
url: https://api.simkl.org/guides/sync
- name: Users
description: User profile, settings, and watch statistics.
externalDocs:
description: Simkl API documentation
url: https://api.simkl.org
paths:
/tv/airing:
get:
tags:
- TV
summary: TV shows airing today, tomorrow, or on a specific date
description: >
Currently airing TV shows — same data that powers the [Simkl TV
calendar](https://simkl.com/tv/airing/). No `access_token` required.
Same shape and parameters as
[`/anime/airing`](/api-reference/simkl/get-anime-airing) but for the TV
catalog: no `anime_type` field, and the per-item `episode` block
includes a `season` integer.
**Prefer the cached calendar endpoints for high-traffic use cases.**
`/tv/airing` is **uncached** — every request hits the origin. For
widgets, mobile-app home screens, or anything that fetches this on app
launch / wake / timer, use the CDN-cached [Calendar data
files](/api-reference/calendar) on `data.simkl.in` instead — both the
rolling-window `/calendar/{type}.json` (yesterday + next 33 days) and
the monthly archive `/calendar/{year}/{month}/{type}.json` serve the
same per-day airing data, edge-cached so most requests don't even reach
origin. Reserve `/tv/airing` for ad-hoc queries by a specific date that
the calendar files don't pre-bake.
Both forms still need the standard URL params on every request —
`client_id`, `app-name`, `app-version` (and the `User-Agent` header) —
same as every other Simkl endpoint. See [Headers and required
parameters](/conventions/headers).
#### Query parameters
| Param | Default | Notes |
|---|---|---|
| `date` | `today` | `today`, `tomorrow`, or `DD-MM-YYYY`. Bogus values
silently fall back to `today`. |
| `sort` | `time` | `time`, `rank`, `popularity`. Bogus values silently
fall back to `time`. |
#### Item shape
```json
{
"title": "string",
"year": "integer | null (extracted from the episode air time)",
"date": "ISO-8601 string with -05:00 offset | null",
"poster": "string (relative path; prepend https://simkl.in/posters/ + size)",
"rank": "integer | null (Simkl popularity rank; null when not yet ranked)",
"url": "string (relative simkl.com URL)",
"ids": {
"simkl_id": "integer",
"slug": "string"
},
"episode": {
"season": "integer",
"episode": "integer",
"url": "string"
}
}
```
#### Nulls — what they mean
| Field | When null | Type |
|---|---|---|
| `date` | Catalog has no `Airs_Time` on file for this episode (rare —
usually older or low-data titles) | [Type
4](/conventions/null-values#type-4) |
| `rank` | Item not yet ranked, or rank value >= 999999 sentinel | [Type
4](/conventions/null-values#type-4) |
#### Error responses
| Status | When |
|---|---|
| `412 client_id_failed` | Missing or invalid `client_id` |
| `500` | Server error |
No `400` — invalid `date`/`sort` values silently fall back to defaults.
No `404` — empty result is `[]` with status `200`.
operationId: get-tv-airing-date
parameters:
- name: date
in: query
description: only data within this date
schema:
type: string
pattern: ^(today|tomorrow|\d{2}-\d{2}-\d{4})$
example: 22-08-2026
required: false
- name: sort
in: query
description: sort the results by the specified option
schema:
type: string
enum:
- time
- rank
- popularity
example: time
- $ref: '#/components/parameters/ClientIdQuery'
- $ref: '#/components/parameters/AppNameQuery'
- $ref: '#/components/parameters/AppVersionQuery'
- $ref: '#/components/parameters/UserAgentHeader'
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
type: object
properties:
title:
type: string
year:
type:
- integer
- 'null'
description: >-
Year extracted from the episode's `Airs_Time`. Type 4
null when no air time on file. See [Null and missing
values](/conventions/null-values).
date:
type:
- string
- 'null'
format: date-time
description: >-
Episode air time as ISO-8601 with `-05:00` offset
(Simkl's server timezone). Type 4 null — catalog has no
`Airs_Time` for this episode (rare; older or low-data
titles). See [Null and missing
values](/conventions/null-values).
poster:
type: string
description: >-
Image path fragment. Combine with the prefixes in [Image
conventions](/conventions/images) — for example
`https://wsrv.nl/?url=https://simkl.in/posters/{poster}_m.webp&q=90`.
rank:
type:
- integer
- 'null'
description: >-
Simkl popularity rank. Type 4 null when not yet ranked
or when the catalog sentinel value (>= 999999) is
present. See [Null and missing
values](/conventions/null-values).
url:
type: string
description: Relative simkl.com URL.
ids:
type: object
properties:
simkl_id:
type: integer
slug:
type: string
required:
- simkl_id
- slug
episode:
type: object
properties:
season:
type: integer
description: Season number.
episode:
type: integer
description: Episode number within the season.
url:
type: string
required:
- episode
- url
required:
- title
- year
- date
- poster
- rank
- url
- ids
- episode
example:
- title: Men on a Mission
year: 2026
date: '2026-05-16T09:00:00-04:00'
poster: 83/8303720832bdd35c5
rank: 3728
url: /tv/584618/men-on-a-mission
ids:
simkl_id: 584618
slug: men-on-a-mission
episode:
season: 12
episode: 18
url: /tv/584618/men-on-a-mission/season-12/episode-18/
- title: Silence, ça pousse !
year: 2026
date: null
poster: 10/1004590825e591792b
rank: null
url: /tv/2587369/silence-%C3%A7a-pousse
ids:
simkl_id: 2587369
slug: silence-%C3%A7a-pousse
episode:
season: 2025
episode: 36
url: /tv/2587369/silence-%C3%A7a-pousse/season-2025/episode-36/
'412':
$ref: '#/components/responses/ClientIdFailed'
'500':
$ref: '#/components/responses/ServerError'
security:
- simklApiKey: []
components:
parameters:
ClientIdQuery:
name: client_id
in: query
required: true
description: >-
Your **`client_id`** from your [Simkl developer
settings](https://simkl.com/settings/developer/). Required on every
request.
schema:
type: string
example: YOUR_CLIENT_ID
AppNameQuery:
name: app-name
in: query
required: true
description: >-
Short, lowercase identifier for your app (e.g. `plex-scrobbler`,
`kodi-bridge`). Helps Simkl identify which apps are using the API.
schema:
type: string
example: my-app
AppVersionQuery:
name: app-version
in: query
required: true
description: >-
Your app's current version (e.g. `1.0`, `2.4.1`). Helps Simkl debug
issues you report.
schema:
type: string
example: '1.0'
UserAgentHeader:
name: User-Agent
in: header
required: true
description: >-
Descriptive identifier for your app, ideally `name/version`. Examples:
`PlexMediaServer/1.43.1.10540`, `kodi-simkl/0.9.2`, `MyApp/2.4.1
(https://myapp.com)`.
schema:
type: string
example: my-app/1.0
responses:
ClientIdFailed:
description: >-
Your `client_id` is missing, wrong, disabled, or has hit a request
limit. Verify in your [developer
settings](https://simkl.com/settings/developer/).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: client_id_failed
code: 412
message: Your client_id is wrong. Try another one
ServerError:
description: >-
Something is broken on Simkl's side. Retry after a short delay. If it
persists, report on the [Simkl Discord](https://discord.gg/MJsWNE4).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: internal
code: 500
schemas:
ErrorResponse:
type: object
description: >-
Standard error envelope for 4xx and 5xx responses. Branch on `error`
(machine-readable identifier) — `message`, when present, is
human-readable guidance and is **not stable across releases**.
properties:
error:
type: string
description: >-
Machine-readable error identifier. Stable across responses — use
this for programmatic branching in client code. Examples:
`user_token_failed`, `client_id_failed`, `empty_field`,
`wrong_parameter`, `id_err`, `rate_limit`.
example: user_token_failed
code:
type: integer
description: >-
HTTP status code echoed in the body for convenience — same value as
the response status line. Always an integer.
example: 401
message:
type: string
description: >-
Human-readable error guidance. Optional — present on most errors,
but not guaranteed. May reference the specific field or value that
triggered the error. NOT stable; do not parse.
example: Your client_id is wrong. Try another one
required:
- error
- code
securitySchemes:
clientId:
type: apiKey
in: query
name: client_id
description: >-
Preferred form: your `client_id` as a URL query parameter on every
request. Self-describing in logs and curl commands. See [Headers and
required parameters](/conventions/headers).
x-default: YOUR_CLIENT_ID
simklApiKey:
type: apiKey
in: header
name: simkl-api-key
description: >-
Optional alias for the `client_id` query parameter. Simkl accepts your
`client_id` either as the `simkl-api-key` request header **or** as the
`?client_id=…` query parameter — pick one. The query-parameter form is
preferred because it makes the request fully self-describing in URL
form.
x-default: YOUR_CLIENT_ID
````