awardByIdExtended

GET /v4/awards/:id/extended

This method returns a single extended award record. For official documentation of the endpoint, please refer to the Swagger documentation.

Parameters

Params	Type	Required	Description
id	string	Yes	The award id

Example

import { TheTVDB } from '@untidy/thetvdb';

const client = new TheTVDB('access token');
const data = await client.awardByIdExtended('1');

Successful response output

{
  status: 'success',
  data: {
    id: 1,
    name: 'Academy Awards',
    categories: [
      {
        id: 1,
        name: 'Best Picture',
        allowCoNominees: false,
        forSeries: false,
        forMovies: true,
        award: {
          id: 1,
          name: 'Academy Awards',
        },
      },
      {
        id: 2,
        name: 'Actor in a Leading Role',
        allowCoNominees: false,
        forSeries: false,
        forMovies: true,
        award: {
          id: 1,
          name: 'Academy Awards',
        },
      },
      // ...
    ],
    score: 0,
  },
};