Skip to main content

API

The API can by accessed on ofdb.cc/api. You can find out more here on how Drupal’s JSON:API is implemented and content can be accessed. On this side you only find the specific documentation regarding the OFDb.

You don’t need to register to access the API, nor do you need a token. Access is not limited.

Each relevant content type is listed, with information regarding the field and their content.

Character

Machine name: character

A “character” is a someone depicted in a film, usually played by an actor, e.g. Indiana Jones in the movie of the same name.

Name

Machine name: title

Type: text (plain)

Native name

Machine name: field_native_name

Type: text (plain)

Bio

Machine name: body

Type: text (formatted, long, with summary)

omdb

Machine name: field_omdb

Type: Number (integer)

Wikidata

Machine name: field_wikidata

Type: Text (plain)

Wikipedia

Machine name: field_wikipedia

Type: Link (external only)

Episode

Machine name: episode

An episode is a single part of a TV show.

Title

Machine name: title

Type: text (plain)

Original title

Machine name: field_original_title

Type: text (plain)

Plot

Machine name: body

Type: text (formatted, long, with summary)

Release date

Machine name: field_release_date

Date (date only)

Runtime

Machine name: field_episode_runtime

Type: number (integer)

Script

Machine name: field_script

Type: Link (external)

IMDb

Machine name: field_imdb

Type: Text (plain)

TheTVDB

Machine name: field_thetvdb

Type: Date (date only)

Wikidata

Machine name: field_wikidata

Type: Text (plain)

Wikipedia

Machine name: field_wikipedia
Type: Link (external)

Cast

Machine name: field_cast

Type: entity reference of type paragraph, paragraph:

Cast

Machine name: cast

Type: entity reference of type paragraph, paragraph

Character

Machine name: field_character

Fields:

  • Reference (field_character_ref, entity reference of type content, content type Character (machine name: character) or Person (pmachine name: erson))
  • Text (field_character_txt, text (plain))
  • Credited as (field_credited_as, text (plain))
  • Person (field_person, entity reference of content type Person (machine name: person))

Crew

Machine name: field_crew

Type: entity reference of type paragraph, paragraph:

Crew

Machine name: crew

Fields:

  • Person (field_person, entity reference of type content, content type Person (machine name: person))
  • Credited as (field_credited_as, text (plain))
  • Position (field_position, entity reference of type taxonomy, vocabulary Position (machine name: position))

Movie

Machine name: movie

A movie is pretty much what the name suggest: a movie entity, e.g. Star Wars or Starship Trooper.

Title

Machine name: title

Type: text (plain)

Alternative title

Machine name: field_alternative_title

Type: text (plain)

Original title

Machine name: field_original_title

Type: text (plain)

Plot

Machine name: body

Type: text (formatted, long, with summary)

Aspect ratio

Machine name: field_aspect_ratio

Type: entity reference of type taxonomy, vocabulary Aspect ratio (machine name: aspect_ratio)

Audio format

Machine name: field_audio_format

Type: entity reference of type taxonomy, vocabulary Audio format (machine name: audio_format)

Budget

Machine name: field_budget

Type: entity reference of type paragraph, paragraph:

Budget

Machine name: budget

Fields:

  • Amount (field_amount, type number (integer))
  • Currency: country, entity reference of type paragraph, paragraph Currency (machine name: currency)
    • Currency (field_currency, entity reference of type taxonomy, vocabulary Currency (machine name: currency))
    • Estimated (field_estimated, boolean (Yes/No))

Collection

Machine name: field_collection

Type: entity reference of type taxonomy, vocabulary Collection (machine name: collection)

Colour

Machine name: field_colour

Type: entity reference of type taxonomy, vocabulary Colour (machine name: colour)

Country

Machine name: field_country

Type: country (provided by the Address module)

Distributor

Machine name: field_distributor

Type: entity reference of type taxonomy, vocabulary Company (machine name: company) or Network (machine name: network)

Filmed in

Machine name: field_filmed_in

Type: address (provided by the Address module)

Film stock

Machine name: field_film_stock

Type: entity reference of type taxonomy, vocabulary Film stock (machine name: film_stock)

Genre

Machine name: field_genre

Type: entity reference of type taxonomy, vocabulary Genre (machine name: genre)

Independent

Machine name: field_independent

Type: Boolean (Yes/No)

Language

Machine name: field_language

Type: language (provided by the Language Field module)

Maturity rating

Machine name: field_maturity_rating

Type: entity reference of type paragraph, paragraph:

Classification

Machine name: maturity_rating

Fields:

  • Classification (field_classification, entity reference of type taxonomy, vocabulary Classification (machine name: classification))
  • Country (field_country, type country provided by the Address module)

Poster

Machine name: field_poster

Type: Link (external only)

Press kit

Machine name: field_press_kit

Type: Link (external only)

Production company

Machine name: field_production_company

Type: entity reference of type taxonomy, vocabulary Company (machine name: company) or Network (machine name: network)

Release date

Machine name: field_release_date

Type: Date (date only)

Runtime

Machine name: field_runtime

Type: entity reference of type paragraph, paragraph:

Runtime

Machine name: runtime

Fields:

  • Runtime (field_runtime, number (integer))
  • Version (field_version, entity reference of type taxonomy, vocabulary Version (machine name: version))

Sales agent

Machine name: field_sales_agent

Type: entity reference of type taxonomy, vocabulary Company (company) or Network (network)

Script

Machine name: field_script

Type: Link (external only)

Short

Machine name: field_is_short

Type: Boolean (Yes/No)

Tagline

Machine name: field_wikidata

Type: Text (plain)

Visual effects company

Machine name: field_visual_effects_company

Type: entity reference of type taxonomy, vocabulary Company (machine name: company)

Website

Machine name: field_website

Type: Link (external only)

IMDb

Machine name: field_imdb

Type: Text (plain)

Metacritic

Machine name: field_metacritic

Type: Link (external only)

omdb

Machine name: field_omdb

Type: Number (integer)

Rotten Tomatoes

Machine name: field_rotten_tomatoes

Type: Link (external only)

TheTVDB

Machine name: field_thetvdb

Type: Number (integer)

TMDb

Machine name: field_tmdb

Type: Number (integer)

Wikidata

Machine name: field_wikidata

Type: Text (plain)

Wikipedia

Machine name: field_wikipedia

Type: Link (external only)

Cast

Machine name: field_cast

Type: entity reference of type paragraph, paragraph

Cast

Machine name: cast

Type: entity reference of type paragraph, paragraph

Character

Machine name: field_character

Fields:

  • Reference (field_character_ref, entity reference of type content, content type Character (machine name: character) or Person (pmachine name: erson))
  • Text (field_character_txt, text (plain))
  • Credited as (field_credited_as, text (plain))
  • Person (field_person, entity reference of content type Person (machine name: person))

Crew

Machine name: field_crew

Type: entity reference of type paragraph, paragraph

Crew

Machine name: crew

Fields:

  • Person (field_person, entity reference of type content, content type Person (machine name: person))
  • Credited as (field_credited_as, text (plain))
  • Position (field_position, entity reference of type taxonomy, vocabulary Position (machine name: position))

Person

Machine name: person

A person is someone being part of a movie or TV show, whether as an actor (human or non-human), or as part of the crew.

Name

Machine name: title

Type: text (plain)

Native name

Machine name: field_native_name

Type: text (plain)

Alternative name

Machine name: field_alternative_name

Type: text (plain)

Bio

Machine name: body

Type: text (formatted, long, with summary)

Awards

Machine name: field_awards

Type: entity reference of type paragraph, paragraph

Award

Machine name: award

Fields:

  • Award (field_award, entity reference of type taxonomy, vocabulary Award (machine name: award))
  • Category (field_award_category, entity reference of type taxonomy, vocabulary Award category (machine name: award_category))
  • Film/TV show (field_media, entity reference of type content, content type Movie (machine name: movie) or TV show (machine name: tv_show))
  • Result (field_result, List (text), allowed values: Nominated/Won)
  • Year (field_year, number (integer))

Birthday

Machine name: field_birthday

Type: Date (date only)

Date of death

Machine name: field_date_of_death

Type: Date (date only)

Height

Machine name: field_height

Type: Number (integer)

Photo

Machine name: field_photo

Type: Link (external only)

Place of birth

Machine name: field_place_of_birth

Type: address (provided by the Address module)

Place of death

Machine name: field_place_of_death

Type: address (provided by the Address module)

Website

Machine name: field_website

Type: Link (external only)

IMDb

Machine name: field_imdb

Type: Text (plain)

Metacritic

Machine name: field_metacritic

Type: Link (external only)

omdb

Machine name: field_omdb

Type: Number (integer)

Rotten Tomatoes

Machine name: field_rotten_tomatoes

Type: Link (external only)

TMDb

Machine name: field_tmdb

Type: Number (integer)

TheTVDB

Machine name: field_thetvdb

Type: Date (date only)

Wikidata

Machine name: field_wikidata

Type: Text (plain)

Wikipedia

Machine name: field_wikipedia

Type: Link (external only)

TV show

Machine name: tv_show

A TV show is exactly what the name suggest: a TV show entity, e.g. Doctor Who or Clone Wars.

Title

Machine name: title

Type: text (plain)

Original title

Machine name: field_original_title

Type: text (plain)

Alternative title

Machine name: field_alternative_title

Type: text (plain)

Plot

Machine name: body

Type: text (formatted, long, with summary)

Aspect ratio

Machine name: field_aspect_ratio

Type: entity reference of type taxonomy, vocabulary Aspect ratio (aspect_ratio)

Audio format

Machine name: field_audio_format

Type: entity reference of type taxonomy, vocabulary Audio format (audio_format)

Collection

Machine name: field_collection

Type: entity reference of type taxonomy, vocabulary Collection (collection)

Colour

Machine name: field_colour

Type: entity reference of type taxonomy, vocabulary Colour (colour)

Country

Machine name: field_country

Type: country (provided by the Address module)

Episodes

Machine name: field_budget

Type: entity reference of type paragraph, paragraph:

Season

Machine name: season

Fields:

  • Episodes: field_episodes, entity reference of type paragraph, paragraph Episode (episode), see below
  • Season number (field_season, type number (integer))
  • Season title (field_season_title, text (plain))

Episode

Machine name: episode

Fields:

  • Episode number (field_episode_number, type number (integer))
  • Episode title: field_episode_title, entity reference of type content, content type Episode (episode)
  • Season (field_season, type number (integer))

Filmed in

Machine name: field_filmed_in

Type: address (provided by the Address module)

Genre

Machine name: field_genre

Type: entity reference of type taxonomy, vocabulary Genre (genre)

Language

Machine name: field_language

Type: language (provided by the Language Field module)

Maturity rating

Machine name: field_maturity_rating

Type: entity reference of type paragraph, paragraph:

Classification

Machine name: maturity_rating

Fields:

  • Classification (field_classification, entity reference of type taxonomy, vocabulary Classification (classification))
  • Country (field_country, type country provided by the Address module)

Network

Machine name: field_network

Type: entity reference of type taxonomy, vocabulary Network (network)

Poster

Machine name: field_poster

Type: Link (external only)

Press kit

Machine name: field_press_kit

Type: Link (external only)

Production company

Machine name: field_production_company

Type: entity reference of type taxonomy, vocabulary Company (company) or Network (network)

Status

Machine name: field_status

List (text), allowed values: Continuing/Ended/Cancelled

Tagline

Machine name: field_wikidata

Type: Text (plain)

Visual effects company

Machine name: field_visual_effects_company

Type: entity reference of type taxonomy, vocabulary Company (company)

Website

Machine name: field_website

Type: Link (external only)

IMDb

Machine name: field_imdb

Type: Text (plain)

Metacritic

Machine name: field_metacritic

Type: Link (external only)

omdb

Machine name: field_omdb

Type: Number (integer)

Rotten Tomatoes

Machine name: field_rotten_tomatoes

Type: Link (external only)

TMDb

Machine name: field_tmdb

Type: Number (integer)

TheTVDB

Machine name: field_thetvdb

Type: Number (integer)

Wikidata

Machine name: field_wikidata

Type: Text (plain)

Wikipedia

Machine name: field_wikipedia

Type: Link (external only)