TheTVDB v4 API

https://thetvdb.github.io/v4-api/
Admin
The TheTVDB v4 API provides programmatic access to a comprehensive database of television series,...
Tokens:7,756
Snippets:71
Trust Score:8.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET /inspiration/types

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves a list of all available inspiration types.

```APIDOC
## GET /inspiration/types

### Description
Returns list of inspiration types records.

### Method
GET

### Endpoint
/inspiration/types

### Response
#### Success Response (200)
- **data** (array) - List of InspirationType records
- **status** (string) - Response status
```

--------------------------------

### GET /search

Source: https://thetvdb.github.io/v4-api

Searches for entities within the database.

```APIDOC
## GET /search

### Description
Searches for entities within the database.

### Method
GET

### Endpoint
/search
```

--------------------------------

### GET /user

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns the current user's information.

```APIDOC
## GET /user

### Description
Returns user info.

### Method
GET

### Endpoint
/user

### Response
#### Success Response (200)
- **data** (array) - User information records
- **status** (string) - Response status
```

--------------------------------

### GET /genres

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns a list of all available genre records.

```APIDOC
## GET /genres

### Description
returns list of genre records

### Method
GET

### Endpoint
/genres

### Response
#### Success Response (200)
- **data** (array) - List of GenreBaseRecord records.
- **status** (string) - The status of the request.
```

--------------------------------

### GET /episodes

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves a paginated list of episode base records.

```APIDOC
## GET /episodes

### Description
Returns a list of episodes base records with the basic attributes. Note that all episodes are returned, even those that may not be included in a series' default season order.

### Method
GET

### Endpoint
/episodes

### Parameters
#### Query Parameters
- **page** (number) - Optional - Page number

### Response
#### Success Response (200)
- **data** (array) - List of EpisodeBaseRecord objects
- **status** (string) - Response status
- **links** (object) - Pagination links
```

--------------------------------

### GET /movies

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves a list of movie base records.

```APIDOC
## GET /movies

### Description
Returns list of movie base records.

### Method
GET

### Endpoint
/movies

### Parameters
#### Query Parameters
- **page** (number) - Optional - page number
```

--------------------------------

### GET /artwork/{id}

Source: https://thetvdb.github.io/v4-api

Retrieves artwork details by ID.

```APIDOC
## GET /artwork/{id}

### Description
Retrieves artwork details by ID.

### Method
GET

### Endpoint
/artwork/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the artwork
```

--------------------------------

### GET /lists

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves a paginated list of list base records.

```APIDOC
## GET /lists

### Description
Returns list of list base records.

### Method
GET

### Endpoint
/lists

### Parameters
#### Query Parameters
- **page** (number) - Optional - page number

### Response
#### Success Response (200)
- **data** (array) - List of ListBaseRecord records
- **status** (string) - Response status
- **links** (Links) - Pagination links
```

--------------------------------

### GET /entities

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves the currently active entity types.

```APIDOC
## GET /entities

### Description
Returns the active entity types.

### Method
GET

### Endpoint
/entities

### Response
#### Success Response (200)
- **data** (array) - List of EntityType objects
- **status** (string) - Response status
```

--------------------------------

### GET /languages

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves a list of all supported language records.

```APIDOC
## GET /languages

### Description
Returns list of language records.

### Method
GET

### Endpoint
/languages

### Response
#### Success Response (200)
- **data** (array) - List of Language records
- **status** (string) - Response status
```

--------------------------------

### GET /user/favorites

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns the list of favorites for the current user.

```APIDOC
## GET /user/favorites

### Description
Returns user favorites.

### Method
GET

### Endpoint
/user/favorites

### Response
#### Success Response (200)
- **data** (array) - User favorites records
- **status** (string) - Response status
```

--------------------------------

### GET /countries

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves a list of all country records.

```APIDOC
## GET /countries

### Description
Returns list of country records.

### Method
GET

### Endpoint
/countries

### Response
#### Success Response (200)
- **data** (array) - List of Country objects
- **status** (string) - Response status
```

--------------------------------

### GET /genders

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns a list of all available gender records.

```APIDOC
## GET /genders

### Description
returns list of gender records

### Method
GET

### Endpoint
/genders

### Response
#### Success Response (200)
- **data** (array) - List of Gender records.
- **status** (string) - The status of the request.
```

--------------------------------

### GET /series

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns a paginated list of series base records.

```APIDOC
## GET /series

### Description
returns list of series base records.

### Method
GET

### Endpoint
/series

### Parameters
#### Query Parameters
- **page** (number) - Optional - page number

### Response
#### Success Response (200)
- **data** (array) - List of SeriesBaseRecord objects
- **status** (string) - Status of the request
- **links** (Links) - Pagination links
```

--------------------------------

### GET /sources/types

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns a list of all available source type records.

```APIDOC
## GET /sources/types

### Description
returns list of sourceType records.

### Method
GET

### Endpoint
/sources/types

### Response
#### Success Response (200)
- **data** (array) - List of source type records
- **status** (string) - Response status
```

--------------------------------

### GET /seasons

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieve a list of season base records.

```APIDOC
## GET /seasons

### Description
Returns list of seasons base records.

### Method
GET

### Endpoint
/seasons

### Parameters
#### Query Parameters
- **page** (number) - Optional - page number
```

--------------------------------

### GET /series/{id}

Source: https://thetvdb.github.io/v4-api

Retrieves detailed information for a specific series.

```APIDOC
## GET /series/{id}

### Description
Retrieves detailed information for a specific series.

### Method
GET

### Endpoint
/series/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the series
```

--------------------------------

### GET /content/ratings

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves a list of all content rating records.

```APIDOC
## GET /content/ratings

### Description
Returns list content rating records.

### Method
GET

### Endpoint
/content/ratings

### Response
#### Success Response (200)
- **data** (array) - List of ContentRating objects
- **status** (string) - Response status
```

--------------------------------

### GET /series/filter

Source: https://thetvdb.github.io/v4-api/swagger.yml

Search series based on filter parameters.

```APIDOC
## GET /series/filter

### Description
Search series based on filter parameters.

### Method
GET

### Endpoint
/series/filter

### Parameters
#### Query Parameters
- **company** (number) - Optional - production company
- **contentRating** (number) - Optional - content rating id base on a country
- **country** (string) - Required - country of origin
- **genre** (number) - Optional - Genre id. This id can be found using /genres endpoint.
- **lang** (string) - Required - original language
- **sort** (string) - Optional - sort by results
- **sortType** (string) - Optional - sort type ascending or descending
- **status** (number) - Optional - status
- **year** (number) - Optional - release year

### Response
#### Success Response (200)
- **data** (array) - List of filtered series
```

--------------------------------

### GET /artwork/statuses

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves a list of all available artwork status records.

```APIDOC
## GET /artwork/statuses

### Description
Returns list of artwork status records.

### Method
GET

### Endpoint
/artwork/statuses

### Response
#### Success Response (200)
- **data** (array) - List of artwork status records
- **status** (string) - Status message
```

--------------------------------

### GET /genres/{id}

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves a specific genre record by its unique identifier.

```APIDOC
## GET /genres/{id}

### Description
Returns genre record.

### Method
GET

### Endpoint
/genres/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - id

### Response
#### Success Response (200)
- **data** (GenreBaseRecord) - Genre record details
- **status** (string) - Response status
```

--------------------------------

### GET /movies/statuses

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves a list of all available movie status records.

```APIDOC
## GET /movies/statuses

### Description
Returns a list of status records for movies.

### Method
GET

### Endpoint
/movies/statuses

### Response
#### Success Response (200)
- **data** (array) - List of status objects
- **status** (string) - Response status
```

--------------------------------

### GET /artwork/types

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves a list of all available artwork type records.

```APIDOC
## GET /artwork/types

### Description
Returns a list of artworkType records

### Method
GET

### Endpoint
/artwork/types

### Response
#### Success Response (200)
- **data** (array) - List of artwork type records
- **status** (string) - Status message
```

--------------------------------

### GET /series/{id}/episodes/{season-type}/{lang}

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns series base record with episodes from the specified season type and language. Default returns the episodes in the series default season type.

```APIDOC
## GET /series/{id}/episodes/{season-type}/{lang}

### Description
Returns series base record with episodes from the specified season type and language. Default returns the episodes in the series default season type.

### Method
GET

### Endpoint
/series/{id}/episodes/{season-type}/{lang}

### Parameters
#### Path Parameters
- **id** (number) - Required - id
- **season-type** (string) - Required - season-type
- **lang** (string) - Required - lang

#### Query Parameters
- **page** (integer) - Required - page

### Response
#### Success Response (200)
- **data** (object) - Response data containing series information
- **status** (string) - Status message
```

--------------------------------

### GET /series/statuses

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns a list of all available series status records.

```APIDOC
## GET /series/statuses

### Description
returns list of status records.

### Method
GET

### Endpoint
/series/statuses

### Response
#### Success Response (200)
- **data** (array) - List of status records
- **status** (string) - Response status
```

--------------------------------

### GET /episodes/{id}

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves a specific episode base record by its unique identifier.

```APIDOC
## GET /episodes/{id}

### Description
Returns episode base record.

### Method
GET

### Endpoint
/episodes/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - The unique identifier of the episode
```

--------------------------------

### GET /people

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves a list of people base records with basic attributes.

```APIDOC
## GET /people

### Description
Returns a list of people base records with the basic attributes.

### Method
GET

### Endpoint
/people

### Parameters
#### Query Parameters
- **page** (number) - Optional - page number

### Response
#### Success Response (200)
- **data** (array) - List of people base records
- **status** (string) - Response status
- **links** (object) - Pagination links
```

--------------------------------

### GET /awards

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns a list of award base records.

```APIDOC
## GET /awards

### Description
Returns a list of award base records.

### Method
GET

### Endpoint
/awards

### Response
#### Success Response (200)
- **data** (array) - List of AwardBaseRecord
- **status** (string) - Response status
```

--------------------------------

### GET /seasons/types

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns a list of available season type records.

```APIDOC
## GET /seasons/types

### Description
Returns season type records.

### Method
GET

### Endpoint
/seasons/types

### Response
#### Success Response (200)
- **data** (array) - List of SeasonType objects
- **status** (string) - Status of the request
```

--------------------------------

### GET /movies/{id}

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves a movie base record by its unique identifier.

```APIDOC
## GET /movies/{id}

### Description
Returns movie base record.

### Method
GET

### Endpoint
/movies/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - id
```

--------------------------------

### GET /movies/slug/{slug}

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns a movie base record by searching with its slug.

```APIDOC
## GET /movies/slug/{slug}

### Description
Returns movie base record search by slug.

### Method
GET

### Endpoint
/movies/slug/{slug}

### Parameters
#### Path Parameters
- **slug** (string) - Required - slug

### Response
#### Success Response (200)
- **data** (MovieBaseRecord) - Movie base record
- **status** (string) - Status of the request
```

--------------------------------

### GET /characters/{id}

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns character base record by its ID.

```APIDOC
## GET /characters/{id}

### Description
Returns character base record.

### Method
GET

### Endpoint
/characters/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - The ID of the character

### Response
#### Success Response (200)
- **data** (object) - Character
- **status** (string) - Response status
```

--------------------------------

### GET /seasons/{id}

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns the base record for a specific season.

```APIDOC
## GET /seasons/{id}

### Description
Returns season base record.

### Method
GET

### Endpoint
/seasons/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - id

### Response
#### Success Response (200)
- **data** (SeasonBaseRecord) - Season base record
- **status** (string) - Status of the request
```

--------------------------------

### GET /lists/slug/{slug}

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves a list base record by searching with a slug.

```APIDOC
## GET /lists/slug/{slug}

### Description
Returns a list base record search by slug.

### Method
GET

### Endpoint
/lists/slug/{slug}

### Parameters
#### Path Parameters
- **slug** (string) - Required - slug
```

--------------------------------

### GET /episodes/{id}/translations/{language}

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns the translation record for a specific episode in a given language.

```APIDOC
## GET /episodes/{id}/translations/{language}

### Description
Returns episode translation record.

### Method
GET

### Endpoint
/episodes/{id}/translations/{language}

### Parameters
#### Path Parameters
- **id** (number) - Required - id
- **language** (string) - Required - language

### Response
#### Success Response (200)
- **data** (Translation) - The translation record.
- **status** (string) - The status of the request.
```

--------------------------------

### GET /people/types

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves a list of all available people type records.

```APIDOC
## GET /people/types

### Description
Returns a list of all available peopleType records.

### Method
GET

### Endpoint
/people/types
```

--------------------------------

### GET /user/{id}

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns user information for a specific user ID.

```APIDOC
## GET /user/{id}

### Description
Returns user info by user id.

### Method
GET

### Endpoint
/user/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - id

### Response
#### Success Response (200)
- **data** (array) - User information records
- **status** (string) - Response status
```

--------------------------------

### GET /search/remoteid/{remoteId}

Source: https://thetvdb.github.io/v4-api/swagger.yml

Search for a specific entity by its remote ID.

```APIDOC
## GET /search/remoteid/{remoteId}

### Description
Search a series, movie, people, episode, company or season by specific remote id and returns a base record for that entity.

### Method
GET

### Endpoint
/search/remoteid/{remoteId}

### Parameters
#### Path Parameters
- **remoteId** (string) - Required - Search for a specific remote id.

### Response
#### Success Response (200)
- **data** (array) - List of search results.
- **status** (string) - Status message.
```

--------------------------------

### GET /series/slug/{slug}

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns the base record for a series identified by its slug.

```APIDOC
## GET /series/slug/{slug}

### Description
Returns series base record searched by slug.

### Method
GET

### Endpoint
/series/slug/{slug}

### Parameters
#### Path Parameters
- **slug** (string) - Required - slug

### Response
#### Success Response (200)
- **data** (SeriesBaseRecord) - Series base record
- **status** (string) - Response status
```

--------------------------------

### GET /companies/types

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves a list of all company type records available in the system.

```APIDOC
## GET /companies/types

### Description
Returns all company type records.

### Method
GET

### Endpoint
/companies/types

### Response
#### Success Response (200)
- **data** (array) - List of CompanyType objects
- **status** (string) - Response status
```

--------------------------------

### GET /people/{id}

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves the base record for a specific person by their ID.

```APIDOC
## GET /people/{id}

### Description
Returns the base record for a person identified by the provided ID.

### Method
GET

### Endpoint
/people/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - The unique identifier of the person.
```

--------------------------------

### GET /search

Source: https://thetvdb.github.io/v4-api/swagger.yml

Search the TVDB index for series, movies, people, and companies. Results are limited to 5,000.

```APIDOC
## GET /search

### Description
Our search index includes series, movies, people, and companies. Search is limited to 5k results max.

### Method
GET

### Endpoint
/search

### Parameters
#### Query Parameters
- **query** (string) - Optional - The primary search string, which can include the main title for a record including all translations and aliases.
- **q** (string) - Optional - Alias of the "query" parameter. Recommend using query instead as this field will eventually be deprecated.
- **type** (string) - Optional - Restrict results to a specific entity type. Can be movie, series, person, or company.
- **year** (number) - Optional - Restrict results to a specific year. Currently only used for series and movies.
- **company** (string) - Optional - Restrict results to a specific company (original network, production company, studio, etc).
- **country** (string) - Optional - Restrict results to a specific country of origin. Should contain a 3 character country code.
- **director** (string) - Optional - Restrict results to a specific director. Generally only used for movies.
- **language** (string) - Optional - Restrict results to a specific primary language. Should include the 3 character language code.
- **primaryType** (string) - Optional - Restrict results to a specific type of company.
- **network** (string) - Optional - Restrict results to a specific network.
- **remote_id** (string) - Optional - Search for a specific remote id.
- **offset** (number) - Optional - Offset results.
- **limit** (number) - Optional - Limit results.

### Response
#### Success Response (200)
- **data** (array) - List of search results.
- **status** (string) - Status message.
- **links** (object) - Pagination links.
```

--------------------------------

### GET /companies/{id}

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves a specific company record by its unique identifier.

```APIDOC
## GET /companies/{id}

### Description
Returns a company record.

### Method
GET

### Endpoint
/companies/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - The unique identifier of the company

### Response
#### Success Response (200)
- **data** (object) - Company record
- **status** (string) - Response status
```

--------------------------------

### GET /movies/{id}/translations/{language}

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns the translation record for a specific movie in a given language.

```APIDOC
## GET /movies/{id}/translations/{language}

### Description
Returns movie translation record.

### Method
GET

### Endpoint
/movies/{id}/translations/{language}

### Parameters
#### Path Parameters
- **id** (number) - Required - id
- **language** (string) - Required - language

### Response
#### Success Response (200)
- **data** (object) - Movie translation record
```

--------------------------------

### GET /lists/{id}

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves a list base record by its unique identifier.

```APIDOC
## GET /lists/{id}

### Description
Returns a list base record.

### Method
GET

### Endpoint
/lists/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - id
```

--------------------------------

### GET /awards/{id}

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns a single award base record by its ID.

```APIDOC
## GET /awards/{id}

### Description
Returns a single award base record.

### Method
GET

### Endpoint
/awards/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - The ID of the award

### Response
#### Success Response (200)
- **data** (object) - AwardBaseRecord
- **status** (string) - Response status
```

--------------------------------

### GET /episodes/{id}/extended

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns the extended record for a specific episode.

```APIDOC
## GET /episodes/{id}/extended

### Description
Returns episode extended record.

### Method
GET

### Endpoint
/episodes/{id}/extended

### Parameters
#### Path Parameters
- **id** (number) - Required - id

#### Query Parameters
- **meta** (string) - Optional - meta (enum: translations)

### Response
#### Success Response (200)
- **data** (EpisodeExtendedRecord) - The episode extended record.
- **status** (string) - The status of the request.
```

--------------------------------

### GET /series/{id}/episodes/{season-type}

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns series episodes from the specified season type.

```APIDOC
## GET /series/{id}/episodes/{season-type}

### Description
Returns series episodes from the specified season type, default returns the episodes in the series default season type

### Method
GET

### Endpoint
/series/{id}/episodes/{season-type}

### Parameters
#### Path Parameters
- **id** (number) - Required - id
- **season-type** (string) - Required - season-type

#### Query Parameters
- **page** (integer) - Required - page
- **season** (integer) - Optional - season
- **episodeNumber** (integer) - Optional - episodeNumber
```

--------------------------------

### GET /updates

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns a list of updated entities based on the provided timestamp and filters.

```APIDOC
## GET /updates

### Description
Returns updated entities. methodInt indicates a created record (1), an updated record (2), or a deleted record (3).

### Method
GET

### Endpoint
/updates

### Parameters
#### Query Parameters
- **since** (number) - Required - Timestamp to check updates from
- **type** (string) - Optional - Entity type filter
- **action** (string) - Optional - Action filter (delete, update)
- **page** (number) - Optional - Page number

### Response
#### Success Response (200)
- **data** (array) - List of entity updates
- **status** (string) - Response status
```

--------------------------------

### GET /seasons/{id}/extended

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns the extended record for a specific season.

```APIDOC
## GET /seasons/{id}/extended

### Description
Returns season extended record.

### Method
GET

### Endpoint
/seasons/{id}/extended

### Parameters
#### Path Parameters
- **id** (number) - Required - id

### Response
#### Success Response (200)
- **data** (SeasonExtendedRecord) - Season extended record
- **status** (string) - Status of the request
```

--------------------------------

### GET /series/{id}/artworks

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns series artworks based on language and type. Artwork type is an id that can be found using the /artwork/types endpoint.

```APIDOC
## GET /series/{id}/artworks

### Description
Returns series artworks base on language and type. Note: Artwork type is an id that can be found using /artwork/types endpoint.

### Method
GET

### Endpoint
/series/{id}/artworks

### Parameters
#### Path Parameters
- **id** (number) - Required - id

#### Query Parameters
- **lang** (string) - Optional - lang
- **type** (integer) - Optional - type

### Response
#### Success Response (200)
- **data** (SeriesExtendedRecord) - response
- **status** (string) - response
```

--------------------------------

### GET /series/{id}/extended

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns the extended record for a specific series.

```APIDOC
## GET /series/{id}/extended

### Description
Returns series extended record

### Method
GET

### Endpoint
/series/{id}/extended

### Parameters
#### Path Parameters
- **id** (number) - Required - id

#### Query Parameters
- **meta** (string) - Optional - meta
- **short** (boolean) - Optional - reduce the payload and returns the short version of this record without characters and artworks

### Response
#### Success Response (200)
- **data** (SeriesExtendedRecord) - response
- **status** (string) - response
```

--------------------------------

### GET /movies/{id}/extended

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns the extended record for a specific movie by its ID.

```APIDOC
## GET /movies/{id}/extended

### Description
Returns movie extended record.

### Method
GET

### Endpoint
/movies/{id}/extended

### Parameters
#### Path Parameters
- **id** (number) - Required - id

#### Query Parameters
- **meta** (string) - Optional - meta
- **short** (boolean) - Optional - reduce the payload and returns the short version of this record without characters, artworks and trailers.

### Response
#### Success Response (200)
- **data** (MovieExtendedRecord) - Movie extended record
- **status** (string) - Status of the request
```

--------------------------------

### GET /artwork/{id}/extended

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves a single artwork extended record by its ID.

```APIDOC
## GET /artwork/{id}/extended

### Description
Returns a single artwork extended record.

### Method
GET

### Endpoint
/artwork/{id}/extended

### Parameters
#### Path Parameters
- **id** (number) - Required - The artwork ID

### Response
#### Success Response (200)
- **data** (object) - Artwork extended record
- **status** (string) - Status message
```

--------------------------------

### GET /lists/{id}/extended

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves an extended record for a specific list.

```APIDOC
## GET /lists/{id}/extended

### Description
Returns a list extended record.

### Method
GET

### Endpoint
/lists/{id}/extended

### Parameters
#### Path Parameters
- **id** (number) - Required - id
```

--------------------------------

### GET /seasons/{id}/translations/{language}

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns the translation record for a specific season and language.

```APIDOC
## GET /seasons/{id}/translations/{language}

### Description
Returns season translation record.

### Method
GET

### Endpoint
/seasons/{id}/translations/{language}

### Parameters
#### Path Parameters
- **id** (number) - Required - id
- **language** (string) - Required - language

### Response
#### Success Response (200)
- **data** (Translation) - Translation record
- **status** (string) - Status of the request
```

--------------------------------

### GET /movies/filter

Source: https://thetvdb.github.io/v4-api/swagger.yml

Search for movies based on specific filter parameters like company, country, and language.

```APIDOC
## GET /movies/filter

### Description
Search movies based on filter parameters.

### Method
GET

### Endpoint
/movies/filter

### Parameters
#### Query Parameters
- **company** (number) - Optional - production company
- **contentRating** (number) - Optional - content rating id base on a country
- **country** (string) - Required - country of origin
- **genre** (number) - Optional - genre
- **lang** (string) - Required - original language
- **sort** (string) - Optional - sort by results
- **status** (number) - Optional - status
- **year** (number) - Optional - release year

### Response
#### Success Response (200)
- **data** (array) - List of MovieBaseRecord
- **status** (string) - Status of the request
```

--------------------------------

### GET /people/{id}/extended

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves the extended record for a person, with optional metadata.

```APIDOC
## GET /people/{id}/extended

### Description
Returns the extended record for a person. Optionally filter by metadata types.

### Method
GET

### Endpoint
/people/{id}/extended

### Parameters
#### Path Parameters
- **id** (number) - Required - The unique identifier of the person.

#### Query Parameters
- **meta** (string) - Optional - Metadata type, e.g., 'translations'.
```

--------------------------------

### GET /people/{id}/translations/{language}

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves the translation record for a person in a specific language.

```APIDOC
## GET /people/{id}/translations/{language}

### Description
Returns the translation record for a specific person in the requested language.

### Method
GET

### Endpoint
/people/{id}/translations/{language}

### Parameters
#### Path Parameters
- **id** (number) - Required - The unique identifier of the person.
- **language** (string) - Required - The language code for the translation.
```

--------------------------------

### GET /awards/{id}/extended

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns a single award extended record by its ID.

```APIDOC
## GET /awards/{id}/extended

### Description
Returns a single award extended record.

### Method
GET

### Endpoint
/awards/{id}/extended

### Parameters
#### Path Parameters
- **id** (number) - Required - The ID of the award

### Response
#### Success Response (200)
- **data** (object) - AwardExtendedRecord
- **status** (string) - Response status
```

--------------------------------

### GET /lists/{id}/translations/{language}

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves translation records for a specific list and language.

```APIDOC
## GET /lists/{id}/translations/{language}

### Description
Returns list translation record.

### Method
GET

### Endpoint
/lists/{id}/translations/{language}

### Parameters
#### Path Parameters
- **id** (number) - Required - id
- **language** (string) - Required - language
```

--------------------------------

### GET /series/{id}/translations/{language}

Source: https://thetvdb.github.io/v4-api/swagger.yml

Retrieves the translation record for a specific series in a given language.

```APIDOC
## GET /series/{id}/translations/{language}

### Description
Returns series translation record.

### Method
GET

### Endpoint
/series/{id}/translations/{language}

### Parameters
#### Path Parameters
- **id** (number) - Required - id
- **language** (string) - Required - language

### Response
#### Success Response (200)
- **data** (Translation) - Translation record
- **status** (string) - Response status
```

--------------------------------

### GET /awards/categories/{id}

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns a single award category base record by its ID.

```APIDOC
## GET /awards/categories/{id}

### Description
Returns a single award category base record.

### Method
GET

### Endpoint
/awards/categories/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - The ID of the category

### Response
#### Success Response (200)
- **data** (object) - AwardCategoryBaseRecord
- **status** (string) - Response status
```

--------------------------------

### GET /series/{id}/nextAired

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns series base record including the nextAired field.

```APIDOC
## GET /series/{id}/nextAired

### Description
Returns series base record including the nextAired field. Note: nextAired was included in the base record endpoint but that field will deprecated in the future so developers should use the nextAired endpoint.

### Method
GET

### Endpoint
/series/{id}/nextAired

### Parameters
#### Path Parameters
- **id** (number) - Required - id

### Response
#### Success Response (200)
- **data** (SeriesBaseRecord) - response
- **status** (string) - response
```

--------------------------------

### POST /login

Source: https://thetvdb.github.io/v4-api

Creates an authentication token for accessing the API. The token is valid for one month.

```APIDOC
## POST /login

### Description
Creates an auth token. The token has one month validation length.

### Method
POST

### Endpoint
/login
```

--------------------------------

### GET /awards/categories/{id}/extended

Source: https://thetvdb.github.io/v4-api/swagger.yml

Returns a single award category extended record by its ID.

```APIDOC
## GET /awards/categories/{id}/extended

### Description
Returns a single award category extended record.

### Method
GET

### Endpoint
/awards/categories/{id}/extended

### Parameters
#### Path Parameters
- **id** (number) - Required - The ID of the category

### Response
#### Success Response (200)
- **data** (object) - AwardCategoryExtendedRecord
- **status** (string) - Response status
```

--------------------------------

### POST /user/favorites

Source: https://thetvdb.github.io/v4-api/swagger.yml

Creates a new favorite record for the current user.

```APIDOC
## POST /user/favorites

### Description
Creates a new user favorite.

### Method
POST

### Endpoint
/user/favorites

### Request Body
- **FavoriteRecord** (object) - Required - The favorite record to create

### Response
#### Success Response (200)
- **description** (string) - Ok
```
Tokens:
Raw