TheTVDB Series API

openapi: 3.0.0
info:
  description: 'Documentation of [TheTVDB](https://thetvdb.com/) API V4. All related information is linked from our [Github repo](https://github.com/thetvdb/v4-api). You might also want to use our [Postman collection] (https://www.getpostman.com/collections/7a9397ce69ff246f74d0)

    ## Authentication

    1. Use the /login endpoint and provide your API key as "apikey". If you have a user-supported key, also provide your subscriber PIN as "pin". Otherwise completely remove "pin" from your call.

    2. Executing this call will provide you with a bearer token, which is valid for 1 month.

    3. Provide your bearer token for subsequent API calls by clicking Authorize below or including in the header of all direct API calls: `Authorization: Bearer [your-token]`


    ## Notes

    1. "score" is a field across almost all entities.  We generate scores for different types of entities in various ways, so no assumptions should be made about the meaning of this value.  It is simply used to hint at relative popularity for sorting purposes.

    '
  title: TVDB API V4 Artwork Series API
  version: 4.7.10
  x-last-validated: '2026-05-30'
  x-spec-source: https://github.com/thetvdb/v4-api/blob/main/docs/swagger.yml
servers:
- url: https://api4.thetvdb.com/v4
  description: TheTVDB v4 API production
security:
- bearerAuth: []
tags:
- name: Series
paths:
  /series:
    get:
      description: returns list of series base records
      operationId: getAllSeries
      parameters:
      - description: page number
        in: query
        name: page
        schema:
          type: number
        example: 1.0
      responses:
        '200':
          description: response
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/SeriesBaseRecord'
                    type: array
                  status:
                    type: string
                  links:
                    $ref: '#/components/schemas/Links'
                type: object
              examples:
                GetAllSeries200Example:
                  summary: Default getAllSeries 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - aliases:
                      - language: eng
                        name: Example Name
                      averageRuntime: 1
                      country: usa
                      defaultSeasonType: 12345
                      episodes:
                      - absoluteNumber: 1
                        aired: example
                        airsAfterSeason: 1
                        airsBeforeEpisode: 1
                        airsBeforeSeason: 1
                        finaleType: example
                        id: 12345
                        image: https://artworks.thetvdb.com/banners/example.jpg
                        imageType: 1
                        isMovie: 12345
                        lastUpdated: '2024-01-15'
                        linkedMovie: 1
                        name: Example Name
                        nameTranslations:
                        - example
                        number: 1
                        overview: A descriptive paragraph of text.
                        overviewTranslations:
                        - example
                        runtime: 1
                        seasonNumber: 1
                        seasons:
                        - id: 12345
                          image: https://artworks.thetvdb.com/banners/example.jpg
                          imageType: 1
                          lastUpdated: '2024-01-15'
                          name: Example Name
                          nameTranslations:
                          - example
                          number: 12345
                          overviewTranslations:
                          - example
                          companies:
                            studio:
                            - {}
                            network:
                            - {}
                            production:
                            - {}
                            distributor:
                            - {}
                            special_effects:
                            - {}
                          seriesId: 12345
                          type:
                            alternateName: null
                            id: null
                            name: null
                            type: null
                          year: '2024'
                        seriesId: 12345
                        seasonName: example
                        year: '2024'
                      firstAired: example
                      id: 12345
                      image: https://artworks.thetvdb.com/banners/example.jpg
                      isOrderRandomized: true
                      lastAired: example
                      lastUpdated: '2024-01-15'
                      name: Example Name
                      nameTranslations:
                      - example
                      nextAired: example
                      originalCountry: example
                      originalLanguage: example
                      overviewTranslations:
                      - example
                      score: 100
                      slug: example-slug
                      status:
                        id: 12345
                        keepUpdated: '2024-01-15'
                        name: Example Name
                        recordType: example
                      year: '2024'
                    status: Continuing
                    links:
                      prev: example
                      self: example
                      next: example
                      total_items: 1
                      page_size: 1
        '401':
          description: Unauthorized
      tags:
      - Series
      summary: TheTVDB Get All Series
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /series/{id}:
    get:
      description: Returns series base record
      operationId: getSeriesBase
      parameters:
      - description: id
        in: path
        name: id
        required: true
        schema:
          type: number
        example: 12345
      responses:
        '200':
          description: response
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/SeriesBaseRecord'
                  status:
                    type: string
                type: object
              examples:
                GetSeriesBase200Example:
                  summary: Default getSeriesBase 200 response
                  x-microcks-default: true
                  value:
                    data:
                      aliases:
                      - language: eng
                        name: Example Name
                      averageRuntime: 1
                      country: usa
                      defaultSeasonType: 12345
                      episodes:
                      - absoluteNumber: 1
                        aired: example
                        airsAfterSeason: 1
                        airsBeforeEpisode: 1
                        airsBeforeSeason: 1
                        finaleType: example
                        id: 12345
                        image: https://artworks.thetvdb.com/banners/example.jpg
                        imageType: 1
                        isMovie: 12345
                        lastUpdated: '2024-01-15'
                        linkedMovie: 1
                        name: Example Name
                        nameTranslations:
                        - example
                        number: 1
                        overview: A descriptive paragraph of text.
                        overviewTranslations:
                        - example
                        runtime: 1
                        seasonNumber: 1
                        seasons:
                        - id: 12345
                          image: https://artworks.thetvdb.com/banners/example.jpg
                          imageType: 1
                          lastUpdated: '2024-01-15'
                          name: Example Name
                          nameTranslations:
                          - example
                          number: 12345
                          overviewTranslations:
                          - example
                          companies:
                            studio:
                            - {}
                            network:
                            - {}
                            production:
                            - {}
                            distributor:
                            - {}
                            special_effects:
                            - {}
                          seriesId: 12345
                          type:
                            alternateName: null
                            id: null
                            name: null
                            type: null
                          year: '2024'
                        seriesId: 12345
                        seasonName: example
                        year: '2024'
                      firstAired: example
                      id: 12345
                      image: https://artworks.thetvdb.com/banners/example.jpg
                      isOrderRandomized: true
                      lastAired: example
                      lastUpdated: '2024-01-15'
                      name: Example Name
                      nameTranslations:
                      - example
                      nextAired: example
                      originalCountry: example
                      originalLanguage: example
                      overviewTranslations:
                      - example
                      score: 100
                      slug: example-slug
                      status:
                        id: 12345
                        keepUpdated: '2024-01-15'
                        name: Example Name
                        recordType: example
                      year: '2024'
                    status: Continuing
        '400':
          description: Invalid series id
        '401':
          description: Unauthorized
        '404':
          description: Series not found
      tags:
      - Series
      summary: TheTVDB Get Series Base
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /series/{id}/artworks:
    get:
      description: Returns series artworks base on language and type. <br> Note&#58; Artwork type is an id that can be found using **/artwork/types** endpoint.
      operationId: getSeriesArtworks
      parameters:
      - description: id
        in: path
        name: id
        required: true
        schema:
          type: number
        example: 12345
      - description: lang
        in: query
        name: lang
        required: false
        schema:
          type: string
          example: eng, spa
        example: eng, spa
      - description: type
        in: query
        name: type
        required: false
        schema:
          type: integer
          example: 1,2,3
        example: 1,2,3
      responses:
        '200':
          description: response
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/SeriesExtendedRecord'
                  status:
                    type: string
                type: object
              examples:
                GetSeriesArtworks200Example:
                  summary: Default getSeriesArtworks 200 response
                  x-microcks-default: true
                  value:
                    data:
                      abbreviation: example
                      airsDays:
                        friday: true
                        monday: true
                        saturday: true
                        sunday: true
                        thursday: true
                        tuesday: true
                        wednesday: true
                      airsTime: example
                      aliases:
                      - language: eng
                        name: Example Name
                      artworks:
                      - episodeId: 12345
                        height: 12345
                        id: 12345
                        image: https://artworks.thetvdb.com/banners/example.jpg
                        includesText: true
                        language: eng
                        movieId: 12345
                        networkId: 12345
                        peopleId: 12345
                        score: 100
                        seasonId: 12345
                        seriesId: 12345
                        seriesPeopleId: 12345
                        status:
                          id: 12345
                          name: Example Name
                        tagOptions:
                        - helpText: example
                          id: 12345
                          name: Example Name
                          tag: 12345
                          tagName: example
                        thumbnail: example
                        thumbnailHeight: 12345
                        thumbnailWidth: 12345
                        type: 12345
                        updatedAt: '2024-01-15'
                        width: 12345
                      averageRuntime: 1
                      characters:
                      - aliases:
                        - language: eng
                          name: Example Name
                        episode:
                          image: https://artworks.thetvdb.com/banners/example.jpg
                          name: Example Name
                          year: '2024'
                        episodeId: 12345
                        id: 12345
                        image: https://artworks.thetvdb.com/banners/example.jpg
                        isFeatured: true
                        movieId: 12345
                        movie:
                          image: https://artworks.thetvdb.com/banners/example.jpg
                          name: Example Name
                          year: '2024'
                        name: Example Name
                        nameTranslations:
                        - example
                        overviewTranslations:
                        - example
                        peopleId: 12345
                        personImgURL: https://artworks.thetvdb.com/banners/example.jpg
                        peopleType: example
                        seriesId: 12345
                        series:
                          image: https://artworks.thetvdb.com/banners/example.jpg
                          name: Example Name
                          year: '2024'
                        sort: 12345
                        tagOptions:
                        - helpText: example
                          id: 12345
                          name: Example Name
                          tag: 12345
                          tagName: example
                        type: 12345
                        url: https://artworks.thetvdb.com/banners/example.jpg
                        personName: example
                      contentRatings:
                      - id: 12345
                        name: Example Name
                        description: A descriptive paragraph of text.
                        country: usa
                        contentType: example
                        order: 1
                        fullName: example
                      country: usa
                      defaultSeasonType: 12345
                      episodes:
                      - absoluteNumber: 1
                        aired: example
                        airsAfterSeason: 1
                        airsBeforeEpisode: 1
                        airsBeforeSeason: 1
                        finaleType: example
                        id: 12345
                        image: https://artworks.thetvdb.com/banners/example.jpg
                        imageType: 1
                        isMovie: 12345
                        lastUpdated: '2024-01-15'
                        linkedMovie: 1
                        name: Example Name
                        nameTranslations:
                        - example
                        number: 1
                        overview: A descriptive paragraph of text.
                        overviewTranslations:
                        - example
                        runtime: 1
                        seasonNumber: 1
                        seasons:
                        - id: 12345
                          image: https://artworks.thetvdb.com/banners/example.jpg
                          imageType: 1
                          lastUpdated: '2024-01-15'
                          name: Example Name
                          nameTranslations: &id003
                          - example
                          number: 12345
                          overviewTranslations: &id004
                          - example
                          companies:
                            studio:
                            - {}
                            network:
                            - {}
                            production:
                            - {}
                            distributor:
                            - {}
                            special_effects:
                            - {}
                          seriesId: 12345
                          type:
                            alternateName: null
                            id: null
                            name: null
                            type: null
                          year: '2024'
                        seriesId: 12345
                        seasonName: example
                        year: '2024'
                      firstAired: example
                      lists: null
                      genres:
                      - id: 12345
                        name: Example Name
                        slug: example-slug
                      id: 12345
                      image: https://artworks.thetvdb.com/banners/example.jpg
                      isOrderRandomized: true
                      lastAired: example
                      lastUpdated: '2024-01-15'
                      name: Example Name
                      nameTranslations:
                      - example
                      companies:
                      - activeDate: '2024-01-15'
                        aliases:
                        - language: eng
                          name: Example Name
                        country: usa
                        id: 12345
                        inactiveDate: '2024-01-15'
                        name: Example Name
                        nameTranslations: &id001
                        - example
                        overviewTranslations: &id002
                        - example
                        primaryCompanyType: 12345
                        slug: example-slug
                        parentCompany:
                          id: 12345
                          name: Example Name
                          relation:
                            id: null
                            typeName: null
                        tagOptions:
                        - helpText: example
                          id: 12345
                          name: Example Name
                          tag: 12345
                          tagName: example
                      nextAired: example
                      originalCountry: example
                      originalLanguage: example
                      originalNetwork:
                        activeDate: '2024-01-15'
                        aliases:
                        - language: eng
                          name: Example Name
                        country: usa
                        id: 12345
                        inactiveDate: '2024-01-15'
                        name: Example Name
                        nameTranslations: *id001
                        overviewTranslations: *id002
                        primaryCompanyType: 12345
                        slug: example-slug
                        parentCompany:
                          id: 12345
                          name: Example Name
                          relation:
                            id: null
                            typeName: null
                        tagOptions:
                        - helpText: example
                          id: 12345
                          name: Example Name
                          tag: 12345
                          tagName: example
                      overview: A descriptive paragraph of text.
                      latestNetwork:
                        activeDate: '2024-01-15'
                        aliases:
                        - language: eng
                          name: Example Name
                        country: usa
                        id: 12345
                        inactiveDate: '2024-01-15'
                        name: Example Name
                        nameTranslations: *id001
                        overviewTranslations: *id002
                        primaryCompanyType: 12345
                        slug: example-slug
                        parentCompany:
                          id: 12345
                          name: Example Name
                          relation:
                            id: null
                            typeName: null
                        tagOptions:
                        - helpText: example
                          id: 12345
                          name: Example Name
                          tag: 12345
                          tagName: example
                      overviewTranslations:
                      - example
                      remoteIds:
                      - id: abc123
                        type: 12345
                        sourceName: example
                      score: 100
                      seasons:
                      - id: 12345
                        image: https://artworks.thetvdb.com/banners/example.jpg
                        imageType: 1
                        lastUpdated: '2024-01-15'
                        name: Example Name
                        nameTranslations: *id003
                        number: 12345
                        overviewTranslations: *id004
                        companies:
                          studio:
                          - activeDate: null
                            aliases:
                            - {}
                            country: null
                            id: null
                            inactiveDate: null
                            name: null
                            nameTranslations: null
                            overviewTranslations: null
                            primaryCompanyType: null
                            slug: null
                            parentCompany: {}
                            tagOptions:
                            - {}
                          network:
                          - activeDate: null
                            aliases:
                            - {}
                            country: null
                            id: null
                            inactiveDate: null
                            name: null
                            nameTranslations: null
                            overviewTranslations: null
                            primaryCompanyType: null
                            slug: null
                            parentCompany: {}
                            tagOptions:
                            - {}
                          production:
                          - activeDate: null
                            aliases:
                            - {}
                            country: null
                            id: null
                            inactiveDate: null
                            name: null
                            nameTranslations: null
                            overviewTranslations: null
                            primaryCompanyType: null
                            slug: null
                            parentCompany: {}
                            tagOptions:
                            - {}
                          distributor:
                          - activeDate: null
                            aliases:
                            - {}
                            country: null
                            id: null
                            inactiveDate: null
                            name: null
                            nameTranslations: null
                            overviewTranslations: null
                            primaryCompanyType: null
                            slug: null
                            parentCompany: {}
                            tagOptions:
                            - {}
                          special_effects:
                          - activeDate: null
                            aliases:
                            - {}
                            country: null
                            id: null
                            inactiveDate: null
                            name: null
                            nameTranslations: null
                            overviewTranslations: null
                            primaryCompanyType: null
                            slug: null
                            parentCompany: {}
                            tagOptions:
                            - {}
                        seriesId: 12345
                        type:
                          alternateName: example
                          id: 12345
                          name: Example Name
                          type: example
                        year: '2024'
                      seasonTypes:
                      - alternateName: example
                        id: 12345
                        name: Example Name
                        type: example
                      slug: example-slug
                      status:
                        id: 12345
                        keepUpdated: '2024-01-15'
                        name: Example Name
                        recordType: example
                      tags:
                      - helpText: example
                        id: 12345
                        name: Example Name
                        tag: 12345
                        tagName: example
                      trailers:
                      - id: 12345
                        language: eng
                        name: Example Name
                        url: https://artworks.thetvdb.com/banners/example.jpg
                        runtime: 1
                      translations:
                        nameTranslations:
                        - aliases: &id005
                          - example
                          isAlias: true
                          isPrimary: true
                          language: eng
                          name: Example Name
                          overview: A descriptive paragraph of text.
                          tagline: example
                        overviewTranslations:
                        - aliases: *id005
                          isAlias: true
                          isPrimary: true
                          language: eng
                          name: Example Name
                          overview: A descriptive paragraph of text.
                          tagline: example
                        alias:
                        - example
                      year: '2024'
                    status: Continuing
        '400':
          description: Invalid series id
        '401':
          description: Unauthorized
        '404':
          description: Series not found
      tags:
      - Series
      summary: TheTVDB Get Series Artworks
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /series/{id}/nextAired:
    get:
      description: Returns series base record including the nextAired field. <br> Note&#58; nextAired was included in the base record endpoint but that field will deprecated in the future so developers should use the nextAired endpoint.
      operationId: getSeriesNextAired
      parameters:
      - description: id
        in: path
        name: id
        required: true
        schema:
          type: number
        example: 12345
      responses:
        '200':
          description: response
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/SeriesBaseRecord'
                  status:
                    type: string
                type: object
              examples:
                GetSeriesNextAired200Example:
                  summary: Default getSeriesNextAired 200 response
                  x-microcks-default: true
                  value:
                    data:
                      aliases:
                      - language: eng
                        name: Example Name
                      averageRuntime: 1
                      country: usa
                      defaultSeasonType: 12345
                      episodes:
                      - absoluteNumber: 1
                        aired: example
                        airsAfterSeason: 1
                        airsBeforeEpisode: 1
                        airsBeforeSeason: 1
                        finaleType: example
                        id: 12345
                        image: https://artworks.thetvdb.com/banners/example.jpg
                        imageType: 1
                        isMovie: 12345
                        lastUpdated: '2024-01-15'
                        linkedMovie: 1
                        name: Example Name
                        nameTranslations:
                        - example
                        number: 1
                        overview: A descriptive paragraph of text.
                        overviewTranslations:
                        - example
                        runtime: 1
                        seasonNumber: 1
                        seasons:
                        - id: 12345
                          image: https://artworks.thetvdb.com/banners/example.jpg
                          imageType: 1
                          lastUpdated: '2024-01-15'
                          name: Example Name
                          nameTranslations:
                          - example
                          number: 12345
                          overviewTranslations:
                          - example
                          companies:
                            studio:
                            - {}
                            network:
                            - {}
                            production:
                            - {}
                            distributor:
                            - {}
                            special_effects:
                            - {}
                          seriesId: 12345
                          type:
                            alternateName: null
                            id: null
                            name: null
                            type: null
                          year: '2024'
                        seriesId: 12345
                        seasonName: example
                        year: '2024'
                      firstAired: example
                      id: 12345
                      image: https://artworks.thetvdb.com/banners/example.jpg
                      isOrderRandomized: true
                      lastAired: example
                      lastUpdated: '2024-01-15'
                      name: Example Name
                      nameTranslations:
                      - example
                      nextAired: example
                      originalCountry: example
                      originalLanguage: example
                      overviewTranslations:
                      - example
                      score: 100
                      slug: example-slug
  

# --- truncated at 32 KB (102 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tvdb/refs/heads/main/openapi/tvdb-series-api-openapi.yml