TheTVDB · Schema
EpisodeBaseRecord
base episode record
EntertainmentMoviesTelevisionMedia MetadataPublic APIsVideo
Properties
| Name | Type | Description |
|---|---|---|
| absoluteNumber | integer | |
| aired | string | |
| airsAfterSeason | integer | |
| airsBeforeEpisode | integer | |
| airsBeforeSeason | integer | |
| finaleType | string | season, midseason, or series |
| id | integer | |
| image | string | |
| imageType | integer | |
| isMovie | integer | |
| lastUpdated | string | |
| linkedMovie | integer | |
| name | string | |
| nameTranslations | array | |
| number | integer | |
| overview | string | |
| overviewTranslations | array | |
| runtime | integer | |
| seasonNumber | integer | |
| seasons | array | |
| seriesId | integer | |
| seasonName | string | |
| year | string |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/tvdb/refs/heads/main/json-schema/tvdb-episode-base-record-schema.json",
"title": "EpisodeBaseRecord",
"description": "base episode record",
"properties": {
"absoluteNumber": {
"type": "integer",
"example": 1
},
"aired": {
"type": "string",
"example": "example"
},
"airsAfterSeason": {
"type": "integer",
"example": 1
},
"airsBeforeEpisode": {
"type": "integer",
"example": 1
},
"airsBeforeSeason": {
"type": "integer",
"example": 1
},
"finaleType": {
"description": "season, midseason, or series",
"type": "string",
"example": "example"
},
"id": {
"format": "int64",
"type": "integer",
"x-go-name": "ID",
"example": 12345
},
"image": {
"type": "string",
"example": "https://artworks.thetvdb.com/banners/example.jpg"
},
"imageType": {
"type": "integer",
"nullable": true,
"example": 1
},
"isMovie": {
"format": "int64",
"type": "integer",
"x-go-name": "IsMovie",
"example": 12345
},
"lastUpdated": {
"type": "string",
"example": "2024-01-15"
},
"linkedMovie": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "Example Name"
},
"nameTranslations": {
"items": {
"type": "string"
},
"type": "array",
"x-go-name": "NameTranslations",
"example": [
"example"
]
},
"number": {
"type": "integer",
"example": 1
},
"overview": {
"type": "string",
"example": "A descriptive paragraph of text."
},
"overviewTranslations": {
"items": {
"type": "string"
},
"type": "array",
"x-go-name": "OverviewTranslations",
"example": [
"example"
]
},
"runtime": {
"type": "integer",
"nullable": true,
"example": 1
},
"seasonNumber": {
"type": "integer",
"example": 1
},
"seasons": {
"items": {
"description": "season genre record",
"properties": {
"id": {
"type": "integer",
"example": 12345
},
"image": {
"type": "string",
"example": "https://artworks.thetvdb.com/banners/example.jpg"
},
"imageType": {
"type": "integer",
"example": 1
},
"lastUpdated": {
"type": "string",
"example": "2024-01-15"
},
"name": {
"type": "string",
"example": "Example Name"
},
"nameTranslations": {
"items": {
"type": "string"
},
"type": "array",
"x-go-name": "NameTranslations",
"example": [
"example"
]
},
"number": {
"format": "int64",
"type": "integer",
"x-go-name": "Number",
"example": 12345
},
"overviewTranslations": {
"items": {
"type": "string"
},
"type": "array",
"x-go-name": "OverviewTranslations",
"example": [
"example"
]
},
"companies": {
"type": "object",
"description": "Companies by type record",
"properties": {
"studio": {
"type": "array",
"items": {
"description": "A company record",
"properties": {
"activeDate": {
"type": "string",
"example": "2024-01-15"
},
"aliases": {
"items": {
"description": "An alias model, which can be associated with a series, season, movie, person, or list.",
"properties": {
"language": {
"type": "string",
"maximum": 4,
"description": "A 3-4 character string indicating the language of the alias, as defined in Language.",
"example": "eng"
},
"name": {
"type": "string",
"maximum": 100,
"description": "A string containing the alias itself.",
"example": "Example Name"
}
},
"type": "object"
},
"type": "array",
"x-go-name": "Aliases"
},
"country": {
"type": "string",
"example": "usa"
},
"id": {
"format": "int64",
"type": "integer",
"x-go-name": "ID",
"example": 12345
},
"inactiveDate": {
"type": "string",
"example": "2024-01-15"
},
"name": {
"type": "string",
"example": "Example Name"
},
"nameTranslations": {
"items": {
"type": "string"
},
"type": "array",
"x-go-name": "NameTranslations",
"example": [
"example"
]
},
"overviewTranslations": {
"items": {
"type": "string"
},
"type": "array",
"x-go-name": "OverviewTranslations",
"example": [
"example"
]
},
"primaryCompanyType": {
"format": "int64",
"type": "integer",
"x-go-name": "PrimaryCompanyType",
"nullable": true,
"example": 12345
},
"slug": {
"type": "string",
"x-go-name": "Slug",
"example": "example-slug"
},
"parentCompany": {
"type": "object",
"description": "A parent company record",
"properties": {
"id": {
"type": "integer",
"nullable": true,
"example": 12345
},
"name": {
"type": "string",
"example": "Example Name"
},
"relation": {
"type": "object",
"description": "A company relationship",
"properties": {
"id": {
"type": "integer",
"nullable": true,
"example": 12345
},
"typeName": {
"type": "string",
"example": "example"
}
}
}
}
},
"tagOptions": {
"items": {
"description": "tag option record",
"properties": {
"helpText": {
"type": "string",
"example": "example"
},
"id": {
"format": "int64",
"type": "integer",
"x-go-name": "ID",
"example": 12345
},
"name": {
"type": "string",
"x-go-name": "Name",
"example": "Example Name"
},
"tag": {
"format": "int64",
"type": "integer",
"x-go-name": "Tag",
"example": 12345
},
"tagName": {
"type": "string",
"x-go-name": "TagName",
"example": "example"
}
},
"type": "object",
"x-go-package": "github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model"
},
"type": "array",
"x-go-name": "TagOptions"
}
},
"type": "object",
"x-go-package": "github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model"
}
},
"network": {
"type": "array",
"items": {
"description": "A company record",
"properties": {
"activeDate": {
"type": "string",
"example": "2024-01-15"
},
"aliases": {
"items": {
"description": "An alias model, which can be associated with a series, season, movie, person, or list.",
"properties": {
"language": {
"type": "string",
"maximum": 4,
"description": "A 3-4 character string indicating the language of the alias, as defined in Language.",
"example": "eng"
},
"name": {
"type": "string",
"maximum": 100,
"description": "A string containing the alias itself.",
"example": "Example Name"
}
},
"type": "object"
},
"type": "array",
"x-go-name": "Aliases"
},
"country": {
"type": "string",
"example": "usa"
},
"id": {
"format": "int64",
"type": "integer",
"x-go-name": "ID",
"example": 12345
},
"inactiveDate": {
"type": "string",
"example": "2024-01-15"
},
"name": {
"type": "string",
"example": "Example Name"
},
"nameTranslations": {
"items": {
"type": "string"
},
"type": "array",
"x-go-name": "NameTranslations",
"example": [
"example"
]
},
"overviewTranslations": {
"items": {
"type": "string"
},
"type": "array",
"x-go-name": "OverviewTranslations",
"example": [
"example"
]
},
"primaryCompanyType": {
"format": "int64",
"type": "integer",
"x-go-name": "PrimaryCompanyType",
"nullable": true,
"example": 12345
},
"slug": {
"type": "string",
"x-go-name": "Slug",
"example": "example-slug"
},
"parentCompany": {
"type": "object",
"description": "A parent company record",
"properties": {
"id": {
"type": "integer",
"nullable": true,
"example": 12345
},
"name": {
"type": "string",
"example": "Example Name"
},
"relation": {
"type": "object",
"description": "A company relationship",
"properties": {
"id": {
"type": "integer",
"nullable": true,
"example": 12345
},
"typeName": {
"type": "string",
"example": "example"
}
}
}
}
},
"tagOptions": {
"items": {
"description": "tag option record",
"properties": {
"helpText": {
"type": "string",
"example": "example"
},
"id": {
"format": "int64",
"type": "integer",
"x-go-name": "ID",
"example": 12345
},
"name": {
"type": "string",
"x-go-name": "Name",
"example": "Example Name"
},
"tag": {
"format": "int64",
"type": "integer",
"x-go-name": "Tag",
"example": 12345
},
"tagName": {
"type": "string",
"x-go-name": "TagName",
"example": "example"
}
},
"type": "object",
"x-go-package": "github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model"
},
"type": "array",
"x-go-name": "TagOptions"
}
},
"type": "object",
"x-go-package": "github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model"
}
},
"production": {
"type": "array",
"items": {
"description": "A company record",
"properties": {
"activeDate": {
"type": "string",
"example": "2024-01-15"
},
"aliases": {
"items": {
"description": "An alias model, which can be associated with a series, season, movie, person, or list.",
"properties": {
"language": {
"type": "string",
"maximum": 4,
"description": "A 3-4 character string indicating the language of the alias, as defined in Language.",
"example": "eng"
},
"name": {
"type": "string",
"maximum": 100,
"description": "A string containing the alias itself.",
"example": "Example Name"
}
},
"type": "object"
},
"type": "array",
"x-go-name": "Aliases"
},
"country": {
"type": "string",
"example": "usa"
},
"id": {
"format": "int64",
"type": "integer",
"x-go-name": "ID",
"example": 12345
},
"inactiveDate": {
"type": "string",
"example": "2024-01-15"
},
"name": {
"type": "string",
"example": "Example Name"
},
"nameTranslations": {
"items": {
"type": "string"
},
"type": "array",
"x-go-name": "NameTranslations",
"example": [
"example"
]
},
"overviewTranslations": {
"items": {
"type": "string"
},
"type": "array",
"x-go-name": "OverviewTranslations",
"example": [
"example"
]
},
"primaryCompanyType": {
"format": "int64",
"type": "integer",
"x-go-name": "PrimaryCompanyType",
"nullable": true,
"example": 12345
},
"slug": {
"type": "string",
"x-go-name": "Slug",
"example": "example-slug"
},
"parentCompany": {
"type": "object",
"description": "A parent company record",
"properties": {
"id": {
"type": "integer",
"nullable": true,
"example": 12345
},
"name": {
"type": "string",
"example": "Example Name"
},
"relation": {
"type": "object",
"description": "A company relationship",
"properties": {
"id": {
"type": "integer",
"nullable": true,
"example": 12345
},
"typeName": {
"type": "string",
"example": "example"
}
}
}
}
},
"tagOptions": {
"items": {
"description": "tag option record",
"properties": {
"helpText": {
"type": "string",
"example": "example"
},
"id": {
"format": "int64",
"type": "integer",
"x-go-name": "ID",
"example": 12345
},
"name": {
"type": "string",
"x-go-name": "Name",
"example": "Example Name"
},
"tag": {
"format": "int64",
"type": "integer",
"x-go-name": "Tag",
"example": 12345
},
"tagName": {
"type": "string",
"x-go-name": "TagName",
"example": "example"
}
},
"type": "object",
"x-go-package": "github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model"
},
"type": "array",
"x-go-name": "TagOptions"
}
},
"type": "object",
"x-go-package": "github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model"
}
},
"distributor": {
"type": "array",
"items": {
"description": "A company record",
"properties": {
"activeDate": {
"type": "string",
"example": "2024-01-15"
},
"aliases": {
"items": {
"description": "An alias model, which can be associated with a series, season, movie, person, or list.",
"properties": {
"language": {
"type": "string",
"maximum": 4,
"description": "A 3-4 character string indicating the language of the alias, as defined in Language.",
"example": "eng"
},
"name": {
"type": "string",
"maximum": 100,
"description": "A string containing the alias itself.",
"example": "Example Name"
}
},
"type": "object"
},
"type": "array",
"x-go-name": "Aliases"
},
"country": {
"type": "string",
"example": "usa"
},
"id": {
"format": "int64",
"type": "integer",
"x-go-name": "ID",
"example": 12345
},
"inactiveDate": {
"type": "string",
"example": "2024-01-15"
},
"name": {
"type": "string",
"example": "Example Name"
},
"nameTranslations": {
"items": {
"type": "string"
},
"type": "array",
"x-go-name": "NameTranslations",
"example": [
"example"
]
},
"overviewTranslations": {
"items": {
"type": "string"
},
"type": "array",
"x-go-name": "OverviewTranslations",
"example": [
"example"
]
},
"primaryCompanyType": {
"format": "int64",
"type": "integer",
"x-go-name": "PrimaryCompanyType",
"nullable": true,
"example": 12345
},
"slug": {
"type": "string",
"x-go-name": "Slug",
"example": "example-slug"
},
"parentCompany": {
"type": "object",
"description": "A parent company record",
"properties": {
"id": {
"type": "integer",
"nullable": true,
"example": 12345
},
"name": {
"type": "string",
"example": "Example Name"
},
"relation": {
"type": "object",
"description": "A company relationship",
"properties": {
"id": {
"type": "integer",
"nullable": true,
"example": 12345
},
"typeName": {
"type": "string",
"example": "example"
}
}
}
}
},
"tagOptions": {
"items": {
"description": "tag option record",
"properties": {
"helpText": {
"type": "string",
"example": "example"
},
"id": {
"format": "int64",
"type": "integer",
"x-go-name": "ID",
"example": 12345
},
"name": {
"type": "string",
"x-go-name": "Name",
"example": "Example Name"
},
"tag": {
"format": "int64",
"type": "integer",
"x-go-name": "Tag",
"example": 12345
},
"tagName": {
"type": "string",
"x-go-name": "TagName",
"example": "example"
}
},
"type": "object",
"x-go-package": "github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model"
},
"type": "array",
"x-go-name": "TagOptions"
}
},
"type": "object",
"x-go-package": "github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model"
}
},
"special_effects": {
"type": "array",
"items": {
"description": "A company record",
"properties": {
"activeDate": {
"type": "string",
"example": "2024-01-15"
},
"aliases": {
"items": {
"description": "An alias model, which can be associated with a series, season, movie, person, or list.",
"properties": {
"language": {
"type": "string",
"maximum": 4,
"description": "A 3-4 character string indicating the language of the alias, as defined in Language.",
"example": "eng"
},
"name": {
"type": "string",
"maximum": 100,
"description": "A string containing the alias itself.",
"example": "Example Name"
}
},
"type": "object"
},
"type": "array",
"x-go-name": "Aliases"
},
"country": {
"type": "string",
"example": "usa"
},
"id": {
"format": "int64",
"type": "integer",
"x-go-name": "ID",
"example": 12345
},
"inactiveDate": {
"type": "string",
"example": "2024-01-15"
},
"name": {
"type": "string",
"example": "Example Name"
},
"nameTranslations": {
"items": {
"type": "string"
},
"type": "array",
"x-go-name": "NameTranslations",
"example": [
"example"
]
},
"overviewTranslations": {
"items": {
"type": "string"
},
"type": "array",
"x-go-name": "OverviewTranslations",
"example": [
"example"
]
},
"primaryCompanyType": {
"format": "int64",
"type": "integer",
"x-go-name": "PrimaryCompanyType",
"nullable": true,
"example": 12345
},
"slug": {
"type": "string",
"x-go-name": "Slug",
"example": "example-slug"
},
"parentCompany": {
"type": "object",
"description": "A parent company record",
"properties": {
"id": {
"type": "integer",
"nullable": true,
"example": 12345
},
"name": {
"type": "string",
"example": "Example Name"
},
"relation": {
"type": "object",
"description": "A company relationship",
"properties": {
"id": {
"type": "integer",
"nullable": true,
"example": 12345
},
"typeName": {
"type": "string",
"example": "example"
}
}
}
}
},
"tagOptions": {
# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tvdb/refs/heads/main/json-schema/tvdb-episode-base-record-schema.json