IMDb RealTime API - Schema

Documentation
IMDb RealTime API - Schema Documentation

IMDb RealTime API - Schema Documentation

The schema documentation for the IMDb RealTime GraphQL API!

Contact IMDb licensing support

[email protected]

Understanding this Documentation

This documentation details the types included in the IMDb API schema, it should be used alongside the Getting Started
with the IMDb API documentation and assumes a prior knowledge of basic GraphQl concepts. The types are grouped by
category.

Queries

advancedTitleSearch - (Query)

This field provides advanced search capabilities for titles through the use of many different search constraints and sorts.
Documentation about constrains can be found under the AdvancedTitleSearchConstraints type. Documenta-
tion about the available sorts can be found under the AdvancedTitleSearchSort type.

Response Returns an AdvancedTitleSearchConnection

Arguments

Name Description

constraints - AdvancedTitleSearchConstraints
sort - AdvancedTitleSearchSort
first - Int!
after - String

Example

query AdvancedTitleSearch(
$constraints: AdvancedTitleSearchConstraints,
$sort: AdvancedTitleSearchSort,

2
IMDb RealTime API - Schema Documentation

$first: Int!,
$after: String
) {
advancedTitleSearch(
constraints: $constraints,
sort: $sort,
first: $first,
after: $after
) {
edges {
node {
...AdvancedTitleSearchResultFragment
}
cursor
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
total
}
}

Response

{
"data": {
"advancedTitleSearch": {
"edges": [AdvancedTitleSearchEdge],
"pageInfo": PageInfo,
"total": 987
}
}
}

boxOfficeWeekendChart - (Query)

Highest-grossing titles at the domestic box office over the most recent weekend. At most 10 titles.

3
IMDb RealTime API - Schema Documentation

Response Returns a BoxOfficeWeekendChart

Arguments

Name Description

limit - Int

Example

query BoxOfficeWeekendChart($limit: Int) {

boxOfficeWeekendChart(limit: $limit) {
entries {
title {
...TitleFragment
}
weekendGross {
...BoxOfficeGrossFragment
}
}
weekendEndDate
weekendStartDate
}
}

Response

{
"data": {
"boxOfficeWeekendChart": {
"entries": [ChartEntry],
"weekendEndDate": "2007-12-03",
"weekendStartDate": "2007-12-03"
}
}
}

companyMetadata - (Query)

Details about metadata for Company.

Response Returns a CompanyMetadata

4
IMDb RealTime API - Schema Documentation

Example

query CompanyMetadata {
companyMetadata {
companyCreditCategories {
id
text
}
}
}

Response

{
"data": {
"companyMetadata": {
"companyCreditCategories": [CompanyCreditCategory]
}
}
}

eventMetadata - (Query)

Details about metadata for Event.

Response Returns an EventMetadata

Example

query EventMetadata {
eventMetadata {
events {
edges {
...EventEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total
}
}
}

5
IMDb RealTime API - Schema Documentation

Response

{"data": {"eventMetadata": {"events": EventConnection}}}

keywordMetadata - (Query)

Details about metadata for Keyword.

Response Returns a KeywordMetadata

Example

query KeywordMetadata {
keywordMetadata {
keywordCategories {
id
}
}
}

Response

{
"data": {
"keywordMetadata": {
"keywordCategories": [KeywordCategory]
}
}
}

mainSearch - (Query)

This field is what provides search within the IMDb nav bar. mainSearch returns results matching a particular search
term. Results may be constrained (e.g. to names, titles, keywords) and the search results are returned in the same order
as the IMDb nav bar search.

Response Returns a MainSearchConnection

Arguments

6
IMDb RealTime API - Schema Documentation

Name Description

after - String
first - Int!
options - MainSearchOptions!

Example

query MainSearch(
$after: String,
$first: Int!,
$options: MainSearchOptions!
) {
mainSearch(
after: $after,
first: $first,
options: $options
) {
edges {
cursor
node {
...MainSearchNodeFragment
}
position
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}

Response

{
"data": {
"mainSearch": {
"edges": [MainSearchEdge],
"pageInfo": PageInfo

7
IMDb RealTime API - Schema Documentation

}
}
}

name - (Query)

Details regarding a specific name. The id is the unique IMDb name id for the name in question, e.g. nm2225369 for
Jennifer Lawrence.

Response Returns a Name

Arguments

Name Description

id - ID!

Example

query Name($id: ID!) {

name(id: $id) {
id
meta {
canonicalId
publicationStatus
}
akas {
edges {
...NameAkaEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total
}
credits {
edges {
...CreditEdgeFragment
}
orderBy {

8
IMDb RealTime API - Schema Documentation

...CreditsOrderedByFragment
}
pageInfo {
...PageInfoFragment
}
total
restriction {
...CreditRestrictionFragment
}
}
creditSummary {
categories {
...CreditCategorySummaryFragment
}
}
deathCause {
text
displayableProperty {
...DisplayableNameDeathCausePropertyFragment
}
}
deathDate {
date
dateComponents {
...DateComponentsFragment
}
displayableProperty {
...DisplayableDatePropertyFragment
}
}
deathLocation {
text
displayableProperty {
...DisplayableLocationPropertyFragment
}
}
deathStatus
knownFor {
edges {
...NameKnownForEdgeFragment

9
IMDb RealTime API - Schema Documentation

}
pageInfo {
...PageInfoFragment
}
total
restriction {
...NameKnownForRestrictionFragment
}
}
awardNominations {
edges {
...AwardNominationEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total
}
nameText {
text
}
canonicalUrl
primaryProfessions {
category {
...CreditCategoryFragment
}
profession {
...ProfessionFragment
}
}
}
}

Response

{
"data": {
"name": {
"id": 4,
"meta": NameMeta,
"akas": NameAkaConnection,

10
IMDb RealTime API - Schema Documentation

"credits": NameCreditConnection,
"creditSummary": NameCreditSummary,
"deathCause": DisplayableNameDeathCause,
"deathDate": DisplayableDate,
"deathLocation": DisplayableLocation,
"deathStatus": "ALIVE",
"knownFor": NameKnownForConnection,
"awardNominations": AwardNominationConnection,
"nameText": NameText,
"canonicalUrl": "abc123",
"primaryProfessions": [PrimaryProfession]
}
}
}

nameMetadata - (Query)

Details about metadata for Name.

Response Returns a NameMetadata

Example

query NameMetadata {
nameMetadata {
nameCreditCategories {
id
text
}
}
}

Response

{
"data": {
"nameMetadata": {
"nameCreditCategories": [NameCreditCategory]
}
}
}

11
IMDb RealTime API - Schema Documentation

names - (Query)

A list of details about multiple names. Ids are the unique IMDb name ids for the names in question, and passed in as an
array. Resulting items are also returned in array-format.

Response Returns [Name]!

Arguments

Name Description

ids - [ID!]!

Example

query Names($ids: [ID!]!) {

names(ids: $ids) {
id
meta {
canonicalId
publicationStatus
}
akas {
edges {
...NameAkaEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total
}
credits {
edges {
...CreditEdgeFragment
}
orderBy {
...CreditsOrderedByFragment
}
pageInfo {
...PageInfoFragment
}

12
IMDb RealTime API - Schema Documentation

total
restriction {
...CreditRestrictionFragment
}
}
creditSummary {
categories {
...CreditCategorySummaryFragment
}
}
deathCause {
text
displayableProperty {
...DisplayableNameDeathCausePropertyFragment
}
}
deathDate {
date
dateComponents {
...DateComponentsFragment
}
displayableProperty {
...DisplayableDatePropertyFragment
}
}
deathLocation {
text
displayableProperty {
...DisplayableLocationPropertyFragment
}
}
deathStatus
knownFor {
edges {
...NameKnownForEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total

13
IMDb RealTime API - Schema Documentation

restriction {
...NameKnownForRestrictionFragment
}
}
awardNominations {
edges {
...AwardNominationEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total
}
nameText {
text
}
canonicalUrl
primaryProfessions {
category {
...CreditCategoryFragment
}
profession {
...ProfessionFragment
}
}
}
}

Response

{
"data": {
"names": [
{
"id": "4",
"meta": NameMeta,
"akas": NameAkaConnection,
"credits": NameCreditConnection,
"creditSummary": NameCreditSummary,
"deathCause": DisplayableNameDeathCause,
"deathDate": DisplayableDate,

14
IMDb RealTime API - Schema Documentation

"deathLocation": DisplayableLocation,
"deathStatus": "ALIVE",
"knownFor": NameKnownForConnection,
"awardNominations": AwardNominationConnection,
"nameText": NameText,
"canonicalUrl": "xyz789",
"primaryProfessions": [PrimaryProfession]
}
]
}
}

title - (Query)

Details regarding a specific title. The id is the unique IMDb title id for the title in question, e.g. tt0111161 for The
Shawshank Redemption.

Response Returns a Title

Arguments

Name Description

id - ID!

Example

query Title($id: ID!) {

title(id: $id) {
id
akas {
edges {
...AkaEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total
}
countriesOfOrigin {

15
IMDb RealTime API - Schema Documentation

countries {
...CountryOfOriginFragment
}
}
taglines {
edges {
...TaglineEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total
}
plots {
edges {
...PlotEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total
restriction {
...PlotRestrictionFragment
}
}
titleType {
canHaveEpisodes
categories {
...TitleTypeCategoryFragment
}
displayableProperty {
...DisplayableTitleTypePropertyFragment
}
id
isEpisode
isSeries
text
}
companyCredits {
edges {

16
IMDb RealTime API - Schema Documentation

...CompanyCreditEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total
restriction {
...CompanyCreditRestrictionFragment
}
}
certificate {
attributes {
...DisplayableAttributeFragment
}
country {
...DisplayableCountryFragment
}
id
rating
ratingReason
ratingsBody {
...RatingsBodyFragment
}
}
connections {
edges {
...TitleConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total
}
certificates {
edges {
...CertificatesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total

17
IMDb RealTime API - Schema Documentation

}
spokenLanguages {
spokenLanguages {
...SpokenLanguageFragment
}
}
releaseDates {
edges {
...ReleaseDateEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total
}
credits {
edges {
...CreditEdgeFragment
}
orderBy {
...CreditsOrderedByFragment
}
pageInfo {
...PageInfoFragment
}
total
restriction {
...CreditRestrictionFragment
}
}
principalCredits {
category {
...CreditCategoryFragment
}
credits {
...CreditFragment
}
totalCredits
restriction {
...CreditRestrictionFragment

18
IMDb RealTime API - Schema Documentation

}
}
runtime {
country {
...DisplayableCountryFragment
}
displayableProperty {
...DisplayableTitleRuntimePropertyFragment
}
id
seconds
}
filmingLocations {
edges {
...FilmingLocationEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total
restriction {
...FilmingLocationRestrictionFragment
}
}
keywords {
edges {
...TitleKeywordEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total
}
externalLinks {
edges {
...ExternalLinkEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total

19
IMDb RealTime API - Schema Documentation

restriction {
...ExternalLinkRestrictionFragment
}
}
awardNominations {
edges {
...AwardNominationEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total
}
titleGenres {
genres {
...TitleGenreFragment
}
}
genres {
genres {
...GenreFragment
}
}
releaseYear {
endYear
year
}
isAdult
releaseDate {
country {
...DisplayableCountryFragment
}
day
displayableProperty {
...DisplayableTitleReleaseDatePropertyFragment
}
month
year
restriction {
...ReleaseDateRestrictionFragment

20
IMDb RealTime API - Schema Documentation

}
attributes {
...DisplayableAttributeFragment
}
}
titleText {
isOriginalTitle
text
}
productionStatus {
currentProductionStage {
...ProductionStageFragment
}
productionStatusHistory {
...ProductionStatusHistoryFragment
}
announcements {
...ProductionAnnouncementFragment
}
restriction {
...ProductionStatusHistoryRestrictionFragment
}
}
originalTitleText {
isOriginalTitle
text
}
technicalSpecifications {
colorations {
...ColorationsFragment
}
}
episodes {
episodes {
...EpisodeConnectionFragment
}
isOngoing
seasons {
...EpisodesSeasonFragment
}

21
IMDb RealTime API - Schema Documentation

years {
...EpisodesYearFragment
}
}
series {
episodeNumber {
...EpisodeNumberFragment
}
nextEpisode {
...TitleFragment
}
previousEpisode {
...TitleFragment
}
series {
...TitleFragment
}
}
primaryImage {
height
id
url
width
}
meta {
canonicalId
publicationStatus
restrictions {
...TitleMetaRestrictionsFragment
}
}
canonicalUrl
ratingsSummary {
aggregateRating
voteCount
}
openingWeekendGross {
gross {
...BoxOfficeGrossFragment
}
weekendEndDate

22
IMDb RealTime API - Schema Documentation

theaterCount
weekendStartDate
}
productionBudget {
budget {
...MoneyFragment
}
}
lifetimeGross {
total {
...MoneyFragment
}
}
rankedLifetimeGross {
boxOfficeAreaType {
...BoxOfficeAreaTypeFragment
}
rank
total {
...MoneyFragment
}
}
rankedLifetimeGrosses {
edges {
...RankedLifetimeBoxOfficeGrossEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total
}
}
}

Response

{
"data": {
"title": {
"id": 4,
"akas": AkaConnection,

23
IMDb RealTime API - Schema Documentation

"countriesOfOrigin": CountriesOfOrigin,
"taglines": TaglineConnection,
"plots": PlotConnection,
"titleType": TitleType,
"companyCredits": CompanyCreditConnection,
"certificate": Certificate,
"connections": TitleConnectionConnection,
"certificates": CertificatesConnection,
"spokenLanguages": SpokenLanguages,
"releaseDates": ReleaseDateConnection,
"credits": CreditConnection,
"principalCredits": [PrincipalCreditsForCategory],
"runtime": Runtime,
"filmingLocations": FilmingLocationConnection,
"keywords": TitleKeywordConnection,
"externalLinks": ExternalLinkConnection,
"awardNominations": AwardNominationConnection,
"titleGenres": TitleGenres,
"genres": Genres,
"releaseYear": YearRange,
"isAdult": true,
"releaseDate": ReleaseDate,
"titleText": TitleText,
"productionStatus": ProductionStatusDetails,
"originalTitleText": TitleText,
"technicalSpecifications": TechnicalSpecifications,
"episodes": Episodes,
"series": Series,
"primaryImage": Image,
"meta": TitleMeta,
"canonicalUrl": "abc123",
"ratingsSummary": RatingsSummary,
"openingWeekendGross": OpeningWeekendGross,
"productionBudget": ProductionBudget,
"lifetimeGross": BoxOfficeGross,
"rankedLifetimeGross": RankedLifetimeBoxOfficeGross,
"rankedLifetimeGrosses": RankedLifetimeBoxOfficeGrossConnection
}
}
}

24
IMDb RealTime API - Schema Documentation

titleMetadata - (Query)

Details about metadata for Title.

Response Returns a TitleMetadata

Example

query TitleMetadata {
titleMetadata {
titleConnectionCategories {
id
text
}
titleGenres {
id
text
genreId
displayableProperty {
...DisplayableTitleGenrePropertyFragment
}
}
titleTypeCategories {
category {
...TitleTypeCategoryFragment
}
titleTypes {
...TitleTypeFragment
}
}
titleTypes {
canHaveEpisodes
categories {
...TitleTypeCategoryFragment
}
displayableProperty {
...DisplayableTitleTypePropertyFragment
}
id
isEpisode
isSeries

25
IMDb RealTime API - Schema Documentation

text
}
}
}

Response

{
"data": {
"titleMetadata": {
"titleConnectionCategories": [
TitleConnectionCategory
],
"titleGenres": [GenreItem],
"titleTypeCategories": [
TitleTypeCategoryWithTitleTypes
],
"titleTypes": [TitleType]
}
}
}

titles - (Query)

A list of details about multiple titles. Ids are the unique IMDb title ids for the titles in question, and passed in as an array.
Resulting items are also returned in array-format.

Response Returns [Title]!

Arguments

Name Description

ids - [ID!]!

Example

query Titles($ids: [ID!]!) {

titles(ids: $ids) {
id
akas {

26
IMDb RealTime API - Schema Documentation

edges {
...AkaEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total
}
countriesOfOrigin {
countries {
...CountryOfOriginFragment
}
}
taglines {
edges {
...TaglineEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total
}
plots {
edges {
...PlotEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total
restriction {
...PlotRestrictionFragment
}
}
titleType {
canHaveEpisodes
categories {
...TitleTypeCategoryFragment
}
displayableProperty {

27
IMDb RealTime API - Schema Documentation

...DisplayableTitleTypePropertyFragment
}
id
isEpisode
isSeries
text
}
companyCredits {
edges {
...CompanyCreditEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total
restriction {
...CompanyCreditRestrictionFragment
}
}
certificate {
attributes {
...DisplayableAttributeFragment
}
country {
...DisplayableCountryFragment
}
id
rating
ratingReason
ratingsBody {
...RatingsBodyFragment
}
}
connections {
edges {
...TitleConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total

28
IMDb RealTime API - Schema Documentation

}
certificates {
edges {
...CertificatesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total
}
spokenLanguages {
spokenLanguages {
...SpokenLanguageFragment
}
}
releaseDates {
edges {
...ReleaseDateEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total
}
credits {
edges {
...CreditEdgeFragment
}
orderBy {
...CreditsOrderedByFragment
}
pageInfo {
...PageInfoFragment
}
total
restriction {
...CreditRestrictionFragment
}
}
principalCredits {

29
IMDb RealTime API - Schema Documentation

category {
...CreditCategoryFragment
}
credits {
...CreditFragment
}
totalCredits
restriction {
...CreditRestrictionFragment
}
}
runtime {
country {
...DisplayableCountryFragment
}
displayableProperty {
...DisplayableTitleRuntimePropertyFragment
}
id
seconds
}
filmingLocations {
edges {
...FilmingLocationEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total
restriction {
...FilmingLocationRestrictionFragment
}
}
keywords {
edges {
...TitleKeywordEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total

30
IMDb RealTime API - Schema Documentation

}
externalLinks {
edges {
...ExternalLinkEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total
restriction {
...ExternalLinkRestrictionFragment
}
}
awardNominations {
edges {
...AwardNominationEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total
}
titleGenres {
genres {
...TitleGenreFragment
}
}
genres {
genres {
...GenreFragment
}
}
releaseYear {
endYear
year
}
isAdult
releaseDate {
country {
...DisplayableCountryFragment

31
IMDb RealTime API - Schema Documentation

}
day
displayableProperty {
...DisplayableTitleReleaseDatePropertyFragment
}
month
year
restriction {
...ReleaseDateRestrictionFragment
}
attributes {
...DisplayableAttributeFragment
}
}
titleText {
isOriginalTitle
text
}
productionStatus {
currentProductionStage {
...ProductionStageFragment
}
productionStatusHistory {
...ProductionStatusHistoryFragment
}
announcements {
...ProductionAnnouncementFragment
}
restriction {
...ProductionStatusHistoryRestrictionFragment
}
}
originalTitleText {
isOriginalTitle
text
}
technicalSpecifications {
colorations {
...ColorationsFragment
}

32
IMDb RealTime API - Schema Documentation

}
episodes {
episodes {
...EpisodeConnectionFragment
}
isOngoing
seasons {
...EpisodesSeasonFragment
}
years {
...EpisodesYearFragment
}
}
series {
episodeNumber {
...EpisodeNumberFragment
}
nextEpisode {
...TitleFragment
}
previousEpisode {
...TitleFragment
}
series {
...TitleFragment
}
}
primaryImage {
height
id
url
width
}
meta {
canonicalId
publicationStatus
restrictions {
...TitleMetaRestrictionsFragment
}
}
canonicalUrl

33
IMDb RealTime API - Schema Documentation

ratingsSummary {
aggregateRating
voteCount
}
openingWeekendGross {
gross {
...BoxOfficeGrossFragment
}
weekendEndDate
theaterCount
weekendStartDate
}
productionBudget {
budget {
...MoneyFragment
}
}
lifetimeGross {
total {
...MoneyFragment
}
}
rankedLifetimeGross {
boxOfficeAreaType {
...BoxOfficeAreaTypeFragment
}
rank
total {
...MoneyFragment
}
}
rankedLifetimeGrosses {
edges {
...RankedLifetimeBoxOfficeGrossEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total
}

34
IMDb RealTime API - Schema Documentation

}
}

Response

{
"data": {
"titles": [
{
"id": "4",
"akas": AkaConnection,
"countriesOfOrigin": CountriesOfOrigin,
"taglines": TaglineConnection,
"plots": PlotConnection,
"titleType": TitleType,
"companyCredits": CompanyCreditConnection,
"certificate": Certificate,
"connections": TitleConnectionConnection,
"certificates": CertificatesConnection,
"spokenLanguages": SpokenLanguages,
"releaseDates": ReleaseDateConnection,
"credits": CreditConnection,
"principalCredits": [PrincipalCreditsForCategory],
"runtime": Runtime,
"filmingLocations": FilmingLocationConnection,
"keywords": TitleKeywordConnection,
"externalLinks": ExternalLinkConnection,
"awardNominations": AwardNominationConnection,
"titleGenres": TitleGenres,
"genres": Genres,
"releaseYear": YearRange,
"isAdult": true,
"releaseDate": ReleaseDate,
"titleText": TitleText,
"productionStatus": ProductionStatusDetails,
"originalTitleText": TitleText,
"technicalSpecifications": TechnicalSpecifications,
"episodes": Episodes,
"series": Series,
"primaryImage": Image,
"meta": TitleMeta,

35
IMDb RealTime API - Schema Documentation

"canonicalUrl": "abc123",
"ratingsSummary": RatingsSummary,
"openingWeekendGross": OpeningWeekendGross,
"productionBudget": ProductionBudget,
"lifetimeGross": BoxOfficeGross,
"rankedLifetimeGross": RankedLifetimeBoxOfficeGross,
"rankedLifetimeGrosses": RankedLifetimeBoxOfficeGrossConnection
}
]
}
}

Enums

AdvancedTitleSearchSortBy - (Enum)

An enum that allows you to change the sorting of the advanced title search results (e.g sort by USER_RATING).

Values

Enum Value Description

TITLE_REGIONAL Alphabetical sorting based on the title text.

USER_RATING Weighted IMDb Star Rating as determined by users.
Note: IMDb maintains a threshold to a minimum number
of ratings before it is considered.
ASC: Lower star rating means the title is rated more
poorly, so titles with worse ratings will be first.
USER_RATING_COUNT Count of ratings given by users.
Note: IMDb maintains a threshold to a minimum number
of ratings before it is considered.
ASC: Lower count of ratings means the title has been
rated a fewer number of times, so titles with least ratings
will be first.
RELEASE_DATE Earliest wide release date of a title. Titles without a
release date are placed at the end when using ASC sort
order.
ASC: Earlier (older) released title will be first.

36
IMDb RealTime API - Schema Documentation

Enum Value Description

RUNTIME The length of the title in terms of runtime.

ASC: Lower runtime means the title is shorter, so shortest
titles will be first.
YEAR The recognized year of the title. Typically, the release
year, but guidelines can be found here.
ASC: Earlier (older) titles will be first.

AkaFilter - (Enum)

An enum that can be used to filter AKAs.

Example:

akas(first: 5, filter: EXCLUDE_IF_SAME_AS_PRIMARY) { ... }

Values

Enum Value Description

EXCLUDE_IF_SAME_AS_PRIMARY excludes the aka from the result set if it is the same as
the primary title text.

AkaSortBy - (Enum)

An enum that can be used to sort pages of AKAs.

Example:

akas(first: 5, sort: { by: COUNTRY, order: DESC }) { ... }

Values

Enum Value Description

COUNTRY sort pages of AKAs by the country of the AKA.

RELEVANCE sort pages of AKAs by the relevance of the AKA.

37
IMDb RealTime API - Schema Documentation

AwardWinnerSearchFilter - (Enum)

An enum that can be used to constrain advanced titles search results to those that won or lost for a particular award event
nomination.

Values

Enum Value Description

NON_WINNER_ONLY Include only non-winners in the result set.

WINNER_ONLY Include only winners in the result set.

BoxOfficeArea - (Enum)

Values

Enum Value Description

DOMESTIC North America (U.S., Canada, and Puerto Rico).

INTERNATIONAL The entire world excluding Domestic
WORLDWIDE The entire world.

CreditedOrUncreditedFilter - (Enum)

Filter credits according to whether the person was credited or uncredited.

Example:

credits(first: 5, filter: CREDITED_ONLY) { ... }

Values

Enum Value Description

ALL_CREDITS Those who worked on a film, but whose name did not
appear in the on-screen credits.
CREDITED_ONLY Name appears on-screen in a title’s opening or end
credits.
UNCREDITED_ONLY Include both credited and uncredited credits.

38
IMDb RealTime API - Schema Documentation

EpisodesSortBy - (Enum)

An enum that allows you to change the sort of returned episodes.

Example:

episodes(first: 10, sort: { by: RELEASE_DATE, order: ASC }) { ... }

Values

Enum Value Description

RATING Sort episodes by IMDb star rating.

RELEASE_DATE Sort episodes by release date.

ExplicitContentFilter - (Enum)

An enum that can be used to alter advanced titles search behavior to include adult titles.

Values

Enum Value Description

INCLUDE_ADULT Include titles with the ’isAdult’ flag in search results.

They are excluded by default.

FilterSpoilers - (Enum)

An enum denoting the filtering based on spoilers.

Example:

plots(first: 3, filter: {spoilers: EXCLUDE_SPOILERS}) {...}

plots(first: 3, filter: {spoilers: SPOILERS_ONLY}) {...}

Values

Enum Value Description

EXCLUDE_SPOILERS Exclude all spoilers.

SPOILERS_ONLY Include only spoilers.

39
IMDb RealTime API - Schema Documentation

FilterVersions - (Enum)

An enum denoting the filtering based on versions.

Values

Enum Value Description

ALL_VERSIONS Include original version of a title only.

ORIGINAL_ONLY Include all versions of a title.

GenreSortBy - (Enum)

An enum that allows you to change the sort order of returned genres.

Values

Enum Value Description

DEFAULT Sort genres alphabetically by English value.

RELEVANCE Sort genres by the relevanceRanking.

MainSearchTitleType - (Enum)

An enum, used when the MainSearchType field is set to TITLE, to specify which types of titles should be returned in
the search results.

Example:

mainSearch(first: 5 options: { searchTerm: "Goodfellas" isExactMatch: false type:

TITLE titleSearchOptions: { type: MOVIE }}) { ... }

Values

Enum Value Description

MOVIE Returns only movies.

TV Returns only TV shows.
TV_EPISODE Returns only TV Episodes.

40
IMDb RealTime API - Schema Documentation

Enum Value Description

VIDEO_GAME Returns only video games.

MainSearchType - (Enum)

An enum, denoting what type of entities should be matched by the search term

Values

Enum Value Description

KEYWORD Include Keywords in the main search

NAME Include Names in the main search
TITLE Include Titles in the main search

NameDeathStatus - (Enum)

An enum that is used to represent the status of someone’s death status.

Values

Enum Value Description

ALIVE The name is marked as alive.

DEAD The name is marked as dead.
PRESUMED_DEAD The name is presumed dead.

PlotType - (Enum)

An enum denoting the type of plot. Either a plot outline, a plot summary or a plot synopsis.

For more details see the IMDb Help page here.

Values

41
IMDb RealTime API - Schema Documentation

Enum Value Description

OUTLINE A short plot text

SUMMARY A medium length plot text
SYNOPSIS A long plot text

PublicationStatus - (Enum)

An enum denoting the publication status.

Values

Enum Value Description

NOT_PUBLISHED The title is not published.

PUBLISHED The title is published.
REDIRECTED The API automatically follows re-directions, so this Enum
value will never appear.

SortOrder - (Enum)

An enum that allows you to change the sort by ascending or descending.

Values

Enum Value Description

ASC Sort the results in ascending order.

DESC Sort the results in descending order.

TitleKeywordsSortBy - (Enum)

An enum that allows you to change the sort of returned title keywords.

Example:

keywords(first: 10, sort: { by: ALPHABETICAL }) { ... }

42
IMDb RealTime API - Schema Documentation

Values

Enum Value Description

ALPHABETICAL Alphabetical sort order (ascending)

TitleTypeCategoryValue - (Enum)

An enum denoting a title type category.

Values

Enum Value Description

gaming The title type category is a game.

movie The title type category is a movie.
other The title type category can’t be represented by the other
values, so the title type category is other.
tv The title type category is tv.
video The title type category is video.

UnknownReleaseDateFilter - (Enum)

An enum that allows you to filter episode based on whether the release date of the episode is known.

Values

Enum Value Description

UNKNOWN_ONLY Only include episodes with an unknown release date in

the result set.
If UNKNOWN_ONLY is used with releasedOnOrBefore or
releasedOnOrAfter filters then an empty array will be
returned.
EXCLUDE_UNKNOWN Remove episodes with an unknown release date from
the result set.

43
IMDb RealTime API - Schema Documentation

WinsFilter - (Enum)

An enum to restrict award nominations.

Values

Enum Value Description

EXCLUDE_WINS Include items which were nominated for, but exclude

items which were won.
WINS_ONLY Include only items which were won.

Inputs

AdvancedTitleSearchConstraints - (Input)

Fields

Input Field Description

awardConstraint - AwardSearchConstraint Match titles based on awards they have been nominated
for and/or won.
Use query
searchMetadata.advancedSearchAwardOptions
to fetch a curated list of options to use for this constraint.
certificateConstraint - Match titles based on the certificate ratings they are
CertificateSearchConstraint assigned
creditedNameConstraint - Match titles based on cast/crew names
CreditedNameConstraint
explicitContentConstraint - Match titles based on their explicit content classification
ExplicitContentSearchConstraint
genreConstraint - GenreSearchConstraint Match titles based on their genre
keywordConstraint - Match titles based on keywords
KeywordSearchConstraint
releaseDateConstraint - Match titles based on when they were released
ReleaseDateSearchConstraint
runtimeConstraint - Match titles based on their runtime
RuntimeSearchConstraint

44
IMDb RealTime API - Schema Documentation

Input Field Description

titleTextConstraint - Match titles based on their name (title text)

TitleTextSearchConstraint
titleTypeConstraint - Match titles based on their type (tv, movie, etc.)
TitleTypeSearchConstraint
userRatingsConstraint - Match titles based on their user ratings
UserRatingsSearchConstraint

AdvancedTitleSearchSort - (Input)

An optional sort which can be applied to the advancedTitleSearch field to return results in a sorted order.

Fields

Input Field Description

sortBy - AdvancedTitleSearchSortBy! Sort the results by one of the values specified in the
AdvancedTitleSearchSortBy enum (e.g
USER_RATING).
sortOrder - SortOrder! Specifies the sort order (e.g. ascending, descending).

AkaSort - (Input)

An optional sort which can be applied to the akas field to return akas in a sorted order.

Example:

To sort akas by country:

akas(first: 5, sort: { by: COUNTRY, order: ASC }) { ... }

Fields

Input Field Description

by - AkaSortBy! Sort the akas by one of the values specified in the

AkaSortBy enum (e.g. by country name).
order - SortOrder! Specifies the sort order (e.g. ascending, descending).

45
IMDb RealTime API - Schema Documentation

AwardEventNominationSearchInput - (Input)

Award event nomination search input for use in the AwardSearchConstraint.

Fields

Input Field Description

eventId - ID! Event Id associated with an award.

For example, specify ev0000003 to match titles that
have been nominated for an Oscar.
winnerFilter - AwardWinnerSearchFilter Optionally specify whether a title can only be matched if
it was, or was not, selected as a winner of an award.
If omitted, a title will be matched if it was nominated for
the award, regardless of whether it won or not.

AwardNominationsFilter - (Input)

An optional filter which can be applied to the award nominations field in order to refine the result set.

Examples:

To filter only the awards which were won:

awardNominations(first: 5, filter: { wins: WINS_ONLY }) { ... }

To retrieve results for only the Academy Awards:

awardNominations(first: 5, filter: { events: ["ev0000003"] }) { ... }

To retrieve results for a specific award id:

awardNominations(first: 5, filter: { awards: ["an1478473"] }) { ... }

Fields

Input Field Description

awards - [ID!] Filter awards by award id.

events - [ID!] Filter awards by event id.
A list of all events can be found on the IMDb website and
through the eventMetadata field.
wins - WinsFilter Filter nominations on win status.

46
IMDb RealTime API - Schema Documentation

AwardSearchConstraint - (Input)

Match titles based on awards they have been nominated for and/or won.

Use query searchMetadata.advancedSearchAwardOptions to fetch a curated list of options to use for this
constraint.

Fields

Input Field Description

allEventNominations - A title must match all of the specified award event

[AwardEventNominationSearchInput!] nominations.
anyEventNominations - A title must match at least one of the specified award
[AwardEventNominationSearchInput!] event nominations.

CertificateSearchConstraint - (Input)

Match titles based on the certificate ratings they are assigned

Fields

Input Field Description

anyRegionCertificateRatings - Specify certificates by their region and rating name.

[RegionCertificateRatingInput!] For example: region US and rating name R.
excludeRegionCertificateRatings - Titles with any of the specified certificates will not be
[RegionCertificateRatingInput!] matched.

CertificatesFilter - (Input)

An optional filter which can be applied to the certificates field to refine the result set.

The ratingsBody field can only take the value "MPAA".

Example:

To return only "MPAA" certificates:

certificates(first: 10, filter: { ratingsBody: "MPAA" }) { ... }

Fields

47
IMDb RealTime API - Schema Documentation

Input Field Description

ratingsBody - ID Filter certificates by rating body.

CompanyCreditsFilter - (Input)

An optional filter applied to the company credits field in order to refine the result set.

Categories:

The categories field can take the following values:

• distribution
• miscellaneous
• production
• sales
• specialEffects

The categories can also be retrieved with the following query:

{
companyMetadata {
companyCreditCategories {
id
}
}
}

Example:

companyCredits(first: 5, filter: { categories: ["production"] })

Fields

Input Field Description

categories - [ID!] Filter company credits by credit categories.

ConnectionsFilter - (Input)

An optional filter applied to the connections field in order to refine the result set.

Categories:

48
IMDb RealTime API - Schema Documentation

The categories field can take the following values:

• alternate_language_version_of
• edited_from
• edited_into
• featured_in
• features
• followed_by
• follows
• referenced_in
• references
• remade_as
• remake_of
• spin_off
• spin_off_from
• spoofed_in
• spoofs
• version_of

Example:

To limit title connections to only those where the connection type is "spoofed_in":

connections(first: 5, filter: { categories: ["spoofed_in"] }) { ... }

Fields

Input Field Description

categories - [ID!] Filter connections by connection category ID, e.g.

"spoofed_in", "remake_of".

CreditedNameConstraint - (Input)

Match titles based on cast/crew names

Fields

Input Field Description

allNameIds - [ID!] A title match must contain all of these names.

anyNameIds - [ID!] A title match must contain at least one of these names.

49
IMDb RealTime API - Schema Documentation

DateRange - (Input)

A type used to represent a date range.

Fields

Input Field Description

start - Date The start date e.g 2020-06-19

end - Date The start date e.g 2023-04-19

EpisodeReleaseDate - (Input)

Episode release date input for use in episode filters.

Fields

Input Field Description

day - Int Day of the month.

month - Int Month (e.g. 1 for January, 2 for February, etc.).
year - Int! Year (e.g. 2020).

EpisodesFilter - (Input)

An optional filter applied to the episodes field in order to restrict the result set to episodes before or after a specified
date.

Example:

To filter episodes to those released on or before 20th May 2018:

episodes(first: 3 filter: { releasedOnOrBefore: { day: 20, month: 5, year: 2018 }

}) { ... }

To filter episodes to those released on or after 1st January 2019:

episodes(first: 3 filter: { releasedOnOrAfter: { day: 1, month: 1, year: 2019 } })

{ ... }

Note that these filters can be combined. For example, to filter episodes to those released in the entire month of January
2020:

50
IMDb RealTime API - Schema Documentation

episodes(first: 3 filter: { releasedOnOrAfter: { day: 1, month: 1, year: 2020 },

releasedOnOrBefore: { day: 31, month: 1, year: 2020 } } ) { ... }

Fields

Input Field Description

releasedOnOrAfter - EpisodeReleaseDate Filter episodes to those released on or after a specific

date.
releasedOnOrBefore - EpisodeReleaseDate Filter episodes to those released on or before a specific
date.
unknownReleaseDate - Filter for episodes with unknown release date
UnknownReleaseDateFilter
includeSeasons - [String!] Filter for season values e.g. [’1’, ’2’, ’unknown’]
excludeSeasons - [String!] Filter out season values e.g. [’1’, ’2’, ’unknown’]

EpisodesSort - (Input)

An optional sort which can be applied to the episodes field to retun episodes in a sorted order.

Example:

To sort episodes by release date in ascending order:

episodes(first: 3, sort: { by: RELEASE_DATE, order: ASC }) { ... }

Fields

Input Field Description

by - EpisodesSortBy! Sort the episodes by one of the values specified in the

EpisodesSortBy enum (e.g. by release date).
order - SortOrder! Specifies the sort order (e.g. ascending, descending).
Values for sort order are determined by the SortOrder
enum.

ExplicitContentSearchConstraint - (Input)

Match titles based on their explicit content classification.

51
IMDb RealTime API - Schema Documentation

Fields

Input Field Description

explicitContentFilter - Allow titles that are flagged as adult to be included in

ExplicitContentFilter results.
By default, no titles flagged as adult will be matched.

ExternalLinksFilter - (Input)

An optional filter applied to the external links field in order to restrict the result set.

Categories:

The categories and excludeCategories field can take the following values:

• misc
• official
• photo
• review
• sound
• video

Example:

To restrict external links to only "Official Sites":

externalLinks(first: 5, filter: { categories: ["official"] }) { ... }

To exclude miscellaneous external links:

externalLinks(first: 50, filter: { excludeCategories: ["misc"] }) { ... }

Fields

Input Field Description

categories - [ID!] Filter external links by category.

excludeCategories - [ID!] Filter external links by excluding specific categories.

FilterPlots - (Input)

An optional filter applied to the plots field in order to restrict the result set.

Examples:

52
IMDb RealTime API - Schema Documentation

• Filter to only return plots marked as not a spoiler:

plots(first: 3, filter: {spoilers: EXCLUDE_SPOILERS}) {...}

• Filter to only return plots marked as a spoiler:

plots(first: 3, filter: {spoilers: SPOILERS_ONLY}) {...}

• Filter to only include plot outlines:

plots(first: 3, filter: {type: [OUTLINE]}) { ... }

• Filter to only include plot summaries that are marked as not a spoiler:

plots(first: 3, filter: {type: [SUMMARY], spoilers: SPOILERS_ONLY}) { ... }

Fields

Input Field Description

spoilers - FilterSpoilers Filter based on if a spoiler contains plots.

type - [PlotType!] Filter based on a given plot type.

FloatRangeInput - (Input)

A type used to represent a range where the range is bounded by floating point values.

Fields

Input Field Description

min - Float The start of the range (e.g 4.5)

max - Float The end of the range (e.g 7.2)

GenreSearchConstraint - (Input)

Match titles based on their genre

Fields

53
IMDb RealTime API - Schema Documentation

Input Field Description

allGenreIds - [String!] A title match must contain ALL of the specified genres.
Number of genres specified should not exceed the
optional maxRelevantGenres parameter.
anyGenreIds - [String!] A title match must contain at least one of the specified
genres.
excludeGenreIds - [String!] Titles that include the specified genres will not be
matched.
Not affected by maxRelevantGenres.
maxRelevantGenres - Int Specify a number as the n most relevant genres
associated with a title to match against when also
specifying allGenreIds and/or anyGenreIds. For
example, if you provide a maxRelevantGenres of 2, only
the two most relevant genres associated with a title will
be considered for your search, and all others are ignored.
Must be a positive non-zero number. Has no effect on
excludeGenreIds. Has no effect if no genres are
specified.
Throws InvalidParameterError if
maxRelevantGenres is lower than the number of
genres specified under allGenreIds.

GenreSort - (Input)

An optional sort which can be applied to the genres field to return TitleGenres in a sorted order.

Example:

To sort genres by relevance in ascending order:

titleGenres { genres(first: 3, sort: { by: RELEVANCE, order: ASC }) { ... } }

Fields

Input Field Description

order - SortOrder Specifies the sort order (e.g. ascending, descending).

Values for sort order are determined by the SortOrder
enum.
by - GenreSortBy Sort the genres by one of the values specified in the
GenreSortBy enum (e.g. by release date).

54
IMDb RealTime API - Schema Documentation

IntRangeInput - (Input)

A type used to represent a range where the range is bounded by integer values.

Fields

Input Field Description

min - Int The start of the range (e.g 4)

max - Int The end of the range (e.g 7)

KeywordSearchConstraint - (Input)

Match titles based on keywords.

Fields

Input Field Description

allKeywords - [String!] A title match must contain all of these keywords

anyKeywords - [String!] A title match must contain at least one of these keywords

MainSearchOptions - (Input)

Parameters applied to the mainSearch field when searching for a specific term.

Example:

mainSearch(first: 5 options: { searchTerm: "Goodfellas" isExactMatch: false type:

TITLE titleSearchOptions: { type: MOVIE } }) { ... }

Fields

Input Field Description

includeAdult - Boolean A boolean flag to include or remove adult/pornographic

items from the result set.
isExactMatch - Boolean If specified and set to true will only return exact match
results. Otherwise, results will be matched in a fuzzy
manner (e.g. a search for "Inception" may return results
for "Exception", "Deception", "Conception" etc.)

55
IMDb RealTime API - Schema Documentation

Input Field Description

searchTerm - String! Required field, specifying the search term. This could be
a title (e.g. "Goodfellas"), a name (e.g. "Jennifer
Lawrence") or a keyword (e.g. "war").
titleSearchOptions - TitleSearchOptions An input to add additional filters when searching for
titles.
type - [MainSearchType!] Optionally restrict the results to the types defined in the
MainSearchType enum. For example, you could
restrict results to only titles, names, keywords, or a
combination.

NameCreditsFilter - (Input)

An optional filter applied to the name credits field in order to restrict the result set.

Note that these filters are only applied to top level credits; episodes under series have their own filters.

Fields

Input Field Description

categories - [ID!] Filter for specific credit categories. For example, to filter
credits to only those where the name was listed as
director.
credited - CreditedOrUncreditedFilter Filter for credited or uncredited credits only. For example
to fetch uncredited items for a given name.
excludeCategories - [ID!] Filter out specific credit categories. For example, to
exclude credits where the name was listed as "director"
titles - [ID!] Filter credits on these specific titles.

PrincipalCreditsFilter - (Input)

An optional filter applied to the principal credits field in order to restrict the result set.

Example:

To filter for credits where the named person was listed as "actor", "actress" or "self":

principalCredits(filter: { categories: ["cast"] }) { ... }

56
IMDb RealTime API - Schema Documentation

Fields

Input Field Description

categories - [ID!] A list of job category ids. User can input "cast" to filter for
"actor", "actress" or "self".

RankedLifetimeBoxOfficeGrossFilter - (Input)

An optional filter applied to the ranked lifetime box office grosses field in order to refine the result set.

Fields

Input Field Description

boxOfficeAreaCodes - [String!] Individual areas (e.g. ‘US’), area rollups (e.g. ‘XWW’) or
special areas (e.g. ‘XS4’). See
https://developer.imdb.com/documentation/bulk-data-
documentation/data-dictionary/box-office
Example:

rankedLifetimeGrosses: rankedLifetimeGrosses(

RegionCertificateRatingInput - (Input)

Match titles based on the certificate given in a particular region.

Fields

Input Field Description

rating - String! For example: PG-13

region - String! For example: US

ReleaseDateSearchConstraint - (Input)

Match titles based on when they were released.

57
IMDb RealTime API - Schema Documentation

Fields

Input Field Description

releaseDateRange - DateRange The earliest release date for a title must fall within the
specified range.

RuntimeSearchConstraint - (Input)

Match titles based on their runtime

Fields

Input Field Description

runtimeRangeMinutes - IntRangeInput A title match must have a runtime within the specified
range

TechnicalSpecificationsFilter - (Input)

Allows filtering of technical specifications based on different versions of a title.

Example:

To filter technical specifications to only the original version of a title:

technicalSpecifications(filter: { versions: ORIGINAL_ONLY }) { ... }

Fields

Input Field Description

versions - FilterVersions Filter versions according to the values defined in the

FilterVersions enum.

TitleCreditsFilter - (Input)

Optional filters applied to the title credits field in order to restrict the result set.

Fields

58
IMDb RealTime API - Schema Documentation

Input Field Description

categories - [ID!] The connection text.

credited - CreditedOrUncreditedFilter Filter credits according to whether the names were
credited or not.
excludeCategories - [ID!] Filter out specific credit categories.
excludePrincipal - Boolean Exclude principal credits from the results.
names - [ID!] Filter credits on specific names.

TitleKeywordsSort - (Input)

An optional sort which can be applied to the title keywords field to return keywords in a sorted order.

Example:

To sort keywords alphabetically:

keywords(first: 5, sort: { by: ALPHABETICAL }) { ... }

Fields

Input Field Description

by - TitleKeywordsSortBy! Sort keywords by the values defined in the

TitleKeywordsSortBy.

TitleSearchOptions - (Input)

Additional options when searching for titles through the mainSearch field.

Fields

Input Field Description

type - [MainSearchTitleType!] The types of titles to include in results.

By default, all title types are included in the search.

59
IMDb RealTime API - Schema Documentation

Input Field Description

releaseDateRange - DateRange The earliest release date for a title must fall within the
specified range
By default, titles are filtered by release year provided in
the search term, if applicable.
If a releaseDate is provided, the search term based
release year filter is not applied.

TitleTextSearchConstraint - (Input)

Match titles based on their name (title text)

Fields

Input Field Description

searchTerm - String Matches titles based on their original name as well as

en-US based name. There is no fuzzy matching, for
example: ’Toy Story’ will be matched by ’Toy’ and ’Story’
but not ’Toy Stor’

TitleTypeSearchConstraint - (Input)

Match titles based on their type (tv, movie, etc.)

Fields

Input Field Description

anyTitleTypeIds - [String!] Match titles based on any of the title types specified.
Title type ids can be obtained by querying
titleMetadata.titleType.id For example:
movie, tvSeries, videoGame, etc.

UserRatingsSearchConstraint - (Input)

Match titles based on their user ratings

60
IMDb RealTime API - Schema Documentation

Fields

Input Field Description

ratingsCountRange - IntRangeInput Match titles based on the number of user ratings they
have received
aggregateRatingRange - FloatRangeInput Match titles based on their weighted IMDb star rating

Interfaces

Connection - (Interface)

An interface that other types can implement to provide pagination.

Fields

Field Name Description

edges - [Edge!]! return a list type that wraps an type that implements the
Edge interface.
pageInfo - PageInfo! Provides information about the current list of results.

Possible Types

Connection Types

AkaConnection
AwardNominationConnection
CertificatesConnection
CompanyCreditConnection
CreditConnection
EpisodeConnection
EventConnection
ExternalLinkConnection
FilmingLocationConnection
NameAkaConnection

61
IMDb RealTime API - Schema Documentation

Connection Types

NameCreditConnection
NameKnownForConnection
PlotConnection
ReleaseDateConnection
TaglineConnection
TitleConnectionConnection
TitleKeywordConnection
MainSearchConnection
AdvancedTitleSearchConnection
RankedLifetimeBoxOfficeGrossConnection

ContentRestriction - (Interface)

Some fields may be restricted due to the production status of the title. This interface is used when fields may have content
restrictions applied. More information can be found in the restrictions section.

Fields

Field Name Description

explanations - List of explanations for the restriction.

[RestrictionExplanation!]!

Possible Types

ContentRestriction Types

CompanyCreditRestriction
CreditRestriction
ExternalLinkRestriction
FilmingLocationRestriction
NameKnownForRestriction
PlotRestriction

62
IMDb RealTime API - Schema Documentation

ContentRestriction Types

ProductionStatusHistoryRestriction
ReleaseDateRestriction
TechnicalSpecificationsRestriction
TitleMetaRestrictions

Credit - (Interface)

An interface which represents credit information.

Fields

Field Name Description Arguments

attributes - Miscellaneous attributes (e.g. limit - Int

[CreditAttribute!] "Archive Footage").
category - CreditCategory! The credit category (e.g.
"Producer").
name - Name! The person credited.
title - Title! The title on which this credit
appears.

Possible Types

Credit Types

Cast
Crew

CreditAttribute - (Interface)

A miscellaneous credit attribute.

Fields

63
IMDb RealTime API - Schema Documentation

Field Name Description

id - ID! Attribute ID.

text - String! Attribute text (e.g. "Archive Footage").

Possible Types

CreditAttribute Types

CreditedAsCreditAttribute
JobCreditAttribute
MiscellaneousCreditAttribute

DisplayableConcept - (Interface)

Generic interface for a concept which has an ID or token and associated display text.

Fields

Field Name Description

id - ID! The display id.

text - String! The display text.

Possible Types

DisplayableConcept Types

AwardDetails
AwardsEvent
Coloration
CompanyCreditCategory
CreditsOrderedBy
DisplayableCountry
DisplayableLanguage
NameCreditCategory

64
IMDb RealTime API - Schema Documentation

DisplayableConcept Types

RatingsBody
TitleConnectionCategory

DisplayableProperty - (Interface)

The display-ready common interface for all DisplayableProperty types to implement

Fields

Field Name Description

value - Markdown! The value for this displayable property

Possible Types

DisplayableProperty Types

DisplayableExternalLinkProperty
DisplayableNameAkaProperty
DisplayableTechnicalSpecificationProperty
DisplayableTitleAkaProperty
DisplayableTitleCompanyCreditProperty
DisplayableTitleCountryOfOriginProperty
DisplayableTitleFilmingLocationProperty
DisplayableTitleGenreProperty
DisplayableTitleReleaseDateProperty
DisplayableTitleRuntimeProperty
DisplayableTitleSpokenLanguageProperty
DisplayableTitleTaglineProperty
DisplayableTitleTypeProperty
DisplayableDateProperty
DisplayableLocationProperty

65
IMDb RealTime API - Schema Documentation

DisplayableProperty Types

DisplayableNameDeathCauseProperty

Edge - (Interface)

A common interface that represents a page of data. All Edge types will implement this interface.

Fields

Field Name Description

cursor - ID! Cursor ID.

Possible Types

Edge Types

AkaEdge
AwardNominationEdge
CertificatesEdge
CompanyCreditEdge
CreditEdge
EpisodeEdge
EventEdge
ExternalLinkEdge
FilmingLocationEdge
NameAkaEdge
NameKnownForEdge
PlotEdge
ReleaseDateEdge
TaglineEdge
TitleConnectionEdge
TitleKeywordEdge
MainSearchEdge

66
IMDb RealTime API - Schema Documentation

Edge Types

AdvancedTitleSearchEdge
RankedLifetimeBoxOfficeGrossEdge

HasDisplayableProperty - (Interface)

Common interface for types which provide a displayable property version as a field.

Fields

Field Name Description

displayableProperty - A version of the item in question as a standardized

DisplayableProperty! displayableProperty.

Possible Types

HasDisplayableProperty Types

Aka
Coloration
CompanyCredit
CountryOfOrigin
ExternalLink
FilmingLocation
Genre
GenreItem
NameAka
ReleaseDate
Runtime
SpokenLanguage
Tagline
TitleType
DisplayableDate

67
IMDb RealTime API - Schema Documentation

HasDisplayableProperty Types

DisplayableLocation
DisplayableNameDeathCause

HasDisplayablePropertyKey - (Interface)

Common interface for displayable properties that have both a key and a value to display.

Fields

Field Name Description

key - Markdown! The key to be displayed for this property.

Possible Types

HasDisplayablePropertyKey Types

DisplayableTitleAkaProperty
DisplayableTitleReleaseDateProperty

ImageObject - (Interface)

Common interface an image types.

Fields

Field Name Description

height - Int Original height of the image resource, in pixels.

url - String URL for the image resource.
width - Int Original width of the image resource, in pixels.

Possible Types

68
IMDb RealTime API - Schema Documentation

ImageObject Types

Image

Link - (Interface)

Fields

Field Name Description

label - String
url - String!

Possible Types

Link Types

ExternalLink

Meta - (Interface)

A common interface for providing meta information.

Fields

Field Name Description

canonicalId - ID! It is possible that two IMDb IDs can be created for a single
entity within our system before IMDb identify that they
actually represent the same name. When this happens,
we maintain the data associated with both identifiers,
duplicating the data. If there are duplicate entries that
actually represent the same entity, canonicalId
provides the IMDb ID of the primary entry.
publicationStatus - PublicationStatus! The publication status of a given entity.

Possible Types

69
IMDb RealTime API - Schema Documentation

Meta Types

NameMeta
TitleMeta

PrimaryConst - (Interface)

A common interface used by types that can be looked up by an ID.

Fields

Field Name Description

id - ID! The ID to lookup an entity by.

Possible Types

PrimaryConst Types

Name
Title

Scalars

Boolean - (Scalar)

The Boolean scalar type represents true or false.

Date - (Scalar)

A date string in the ISO-8601 format, for example ’2020-06-19’

Example

"2007-12-03"

70
IMDb RealTime API - Schema Documentation

Float - (Scalar)

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example

123.45

ID - (Scalar)

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears
in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any
string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example

Int - (Scalar)

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2ˆ31) and
2ˆ31 - 1.

Example

987

String - (Scalar)

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often
used by GraphQL to represent free-form human-readable text.

Example

"abc123"

Types

AdvancedTitleSearchConnection - (Type)

Pagination for advanced title search results which always has a known total number of edges.

71
IMDb RealTime API - Schema Documentation

Fields

Field Name Description

edges - [AdvancedTitleSearchEdge!]! Pages of advanced title search results.

pageInfo - PageInfo! Details of the page.
total - Int! Total number of objects in the entire set.

AdvancedTitleSearchEdge - (Type)

A single page representing an advanced title search result.

Fields

Field Name Description

node - AdvancedTitleSearchResult! An advanced title search result node.

cursor - ID! Cursor ID.

AdvancedTitleSearchResult - (Type)

A single advanced title search result.

Fields

Field Name Description

title - Title! The title associated with an advanced title search result.

Aka - (Type)

Alternative title texts by which this title is also known. Contains title text, along with which country it is from and what
language it is written in.

Fields

72
IMDb RealTime API - Schema Documentation

Field Name Description

country - DisplayableCountry The country where this was the title text.
displayableProperty - The displayable property for the Aka.
DisplayableTitleAkaProperty!
language - DisplayableLanguage The language of this title text.
text - String! The alternative title text.

AkaConnection - (Type)

Pagination for AKA types which always has a known total number of edges.

Fields

Field Name Description

edges - [AkaEdge!]! Pages of AKAs.

pageInfo - PageInfo! Details of the page.
total - Int! Total number of objects in the entire set

AkaEdge - (Type)

Page of AKAs.

Fields

Field Name Description

cursor - ID! Cursor ID.

node - Aka! An AKA node.
position - Int! Position of the node in this context, eg: AKA 4 out of 31.

AwardCategory - (Type)

The category in which the award was given.

73
IMDb RealTime API - Schema Documentation

Fields

Field Name Description

text - String The category text (e.g. "Best Motion Picture of the Year").

AwardDetails - (Type)

Details of an award for a name or title.

Fields

Field Name Description

category - AwardCategory The category in which the award was given, such as "Best
Motion Picture of the Year".
event - AwardsEvent! The event at which the award is presented (e.g.
"Academy Awards").
id - ID! The award ID (e.g. "an0048962").
text - String! The award name (e.g. "Oscar").
year - Int! The year of the award.

AwardNomination - (Type)

An award that a title or name has won or been nominated for.

Fields

Field Name Description

award - AwardDetails! Details about the award, such as the name and year.
id - ID! Award ID (e.g. "an0048962").
isWinner - Boolean! Specifies whether the award nomination was a winner.

AwardNominationConnection - (Type)

Pagination for award types which always has a known total number of edges.

74
IMDb RealTime API - Schema Documentation

Fields

Field Name Description

edges - [AwardNominationEdge!]! Pages of award nominations.

pageInfo - PageInfo! Details of the page.
total - Int! Total number of objects in the entire set.

AwardNominationEdge - (Type)

Page of awards.

Fields

Field Name Description

cursor - ID! Cursor ID.

node - AwardNomination! An award nomination node.
position - Int! Position of the node in this context, eg: Award 4 out of 31.

AwardsEvent - (Type)

Details about the award event.

Fields

Field Name Description

id - ID! Event ID (e.g. "ev0000301").

text - String! Event name (e.g. "Golden Globes", "Grammy Awards").

BoxOfficeAreaType - (Type)

The BoxOfficeAreaType for the RankedLifetimeBoxOfficeGross. See sections ‘Area Rollups and Special Areas’ and ‘Individual
Areas’ at https://developer.imdb.com/documentation/bulk-data- documentation/data-dictionary/box-office.

Fields

75
IMDb RealTime API - Schema Documentation

Field Name Description

code - String! A non-localized field representing the BoxOfficeAreaType

code, e.g. XDOM.
id - ID! An Opaque unique Identifier for the BoxOfficeAreaType.
text - String! The displayable BoxOfficeAreaType, e.g. ‘Domestic’.

BoxOfficeGross - (Type)

Details about the box office gross for the given title.

Fields

Field Name Description

total - Money! Gross amount.

BoxOfficeWeekendChart - (Type)

Highest-grossing titles at the domestic box office over the most recent weekend. At most 10 titles.

Fields

Field Name Description

entries - [ChartEntry!]! Title entries for the respective highest-grossing titles.

weekendEndDate - Date! The last day of the opening weekend for that title.
weekendStartDate - Date! The first day of the opening weekend for that title.

Cast - (Type)

A concrete type that implements the Credit interface.

If you are querying a field that returns a Credit interface, you will need to use inline fragments to access the fields of
the underlying concrete implementations of the Credit type (... on <Type>). For instance, in the query below, the
Cast type specific fields can be accessed using an inline fragment on the Credit interface.

76
IMDb RealTime API - Schema Documentation

name(id: "nm0000093") {
credits(first: 5) {
edges {
node {
title {
id
}
name {
id
}
category {
id
text
}
... on Cast {
characters {
name
__typename
}
}
... on Crew {
jobs {
id
text
__typename
}
}
}
}
}
}
}

Fields

Field Name Description Arguments

attributes - Miscellaneous attributes (e.g. limit - Int

[CreditAttribute!] "Archive Footage").
category - CreditCategory! The credit category (e.g.
"Producer").

77
IMDb RealTime API - Schema Documentation

Field Name Description Arguments

characters - [Character!] The characters that this cast limit - Int

member was credited for.
name - Name! The person credited.
title - Title! The title on which this credit
appears.
position - Int A cast credit may have an optional
position attribute indicating the
order of appearance within the
title’s ending credits. This position
can be null for some or all of the
title’s credits. By default the cast
credit that has a value in their
position field will be ordered first
(by that number), then all other
cast credits that have a null in their
position field will be ordered
alphabetically.

Certificate - (Type)

The rating certificate for a title.

Fields

Field Name Description Arguments

attributes - Additional descriptive attributes limit - Int

[DisplayableAttribute!]! about the rating.
country - DisplayableCountry! The rating region (e.g. "United
States").
id - String! ID associated with the rating (e.g.
"ce0397782").
rating - String! The rating text (e.g. "PG-13").
ratingReason - String Reasons for the rating provided by
the rating organization (e.g. "Rated
PG-13 for sequences of violence
and action throughout").

78
IMDb RealTime API - Schema Documentation

Field Name Description Arguments

ratingsBody - RatingsBody The ratings body for a given

certificate.

CertificatesConnection - (Type)

Pagination for certificates types which always has a known total number of edges.

Fields

Field Name Description

edges - [CertificatesEdge!]! Pages of certificates.

pageInfo - PageInfo! Details of the page.
total - Int! Total number of objects in the entire set.

CertificatesEdge - (Type)

Page of certificates.

Fields

Field Name Description

cursor - ID! Cursor ID.

node - Certificate! A certificate node.
position - Int! Position of the node in this context, eg: Certificate 4 out
of 23.

Character - (Type)

The character that a given cast member was credited for.

Fields

79
IMDb RealTime API - Schema Documentation

Field Name Description

name - String! The name of a given character.

ChartEntry - (Type)

A title associated with a particular weekendGross.

Fields

Field Name Description

title - Title! The title that a given entry is.

weekendGross - BoxOfficeGross! The BoxOfficeGross for a given title.

Coloration - (Type)

A coloration, along with any attributes. For example, we could have a color picture that used technicolor, with black and
white flashback scenes.

Fields

Field Name Description

displayableProperty - The display text as a displayable property.

DisplayableTechnicalSpecificationProperty!
id - ID! Coloration ID (e.g. "black_and_white").
text - String! The display text (e.g. "Black and White").

Colorations - (Type)

Colorations for a given title.

Fields

Field Name Description

items - [Coloration!]! The list of coloration items.

80
IMDb RealTime API - Schema Documentation

Field Name Description

total - Int! Total number of coloration items.

restriction - Details of any restrictions on field.
TechnicalSpecificationsRestriction

Company - (Type)

Details about a company associated with the making or subsequent distribution of this title.

Fields

Field Name Description

companyText - CompanyText Name of company.

id - ID! Company ID (e.g. "co0023400").

CompanyCredit - (Type)

Details about the company credit.

Fields

Field Name Description Arguments

category - The category of the company

CompanyCreditCategory! credit.
company - Company! The company credited.
countries - This field is null for all limit - Int
[DisplayableCountry!] CompanyCredit categories other
than “Distribution" and "Sales
Representatives / ISA”. This field
contains a list of countries where
the company has distribution
rights or sales representatives for
the queried title.
displayableProperty - The displayable property for the
DisplayableTitleCompanyCreditProperty!
company credit.

81
IMDb RealTime API - Schema Documentation

Field Name Description Arguments

title - Title! The title in which this credit

appears.
yearsInvolved - YearRange Start and optionally end year(s)
that this company was involved
with this title.
distributionFormats - For distribution company credits,
[DistributionFormat!] this field contains the distribution
formats (theatrical, DVD, ...) that
the title is distributed in. For other
types of company credits, this field
is null.

CompanyCreditCategory - (Type)

A company credit category.

Fields

Field Name Description

id - ID! A unique id for a given company credit category (e.g

distribution).
text - String! Text for a given company credit category (e.g
Distributors).

CompanyCreditConnection - (Type)

Pagination for CompanyCredit type.

Fields

Field Name Description

edges - [CompanyCreditEdge!]! Pages of credits.

pageInfo - PageInfo! Details of the page.
total - Int! Total number of objects in the entire set.

82
IMDb RealTime API - Schema Documentation

Field Name Description

restriction - CompanyCreditRestriction Details of any restrictions on field.

CompanyCreditEdge - (Type)

Page of credits.

Fields

Field Name Description

cursor - ID! Cursor ID.

node - CompanyCredit! A CompanyCredit node.
position - Int! Position of the node in this context (e.g. Credit 4 out of
312).

CompanyCreditRestriction - (Type)

Some company credits may be restricted due to the production status of the title. More information can be found in the
restrictions section.

Fields

Field Name Description

unrestrictedTotal - Int The total number of items if there was no restriction.

explanations - List of explanations for the restriction.
[RestrictionExplanation!]!

CompanyMetadata - (Type)

Metadata for the Company type.

Fields

83
IMDb RealTime API - Schema Documentation

Field Name Description

companyCreditCategories - All of the company credit categories.

[CompanyCreditCategory!]!

CompanyText - (Type)

Details about the company name.

Fields

Field Name Description

text - String! Company name text (e.g. "Paramount Pictures").

CountriesOfOrigin - (Type)

Countries of origin details for the title.

Fields

Field Name Description Arguments

countries - A list of the countries of origin for limit - Int

[CountryOfOrigin!]! the title.

CountryOfOrigin - (Type)

Country of origin details for the title.

Fields

Field Name Description

displayableProperty - The country of origin details as a displayable property.

DisplayableTitleCountryOfOriginProperty!
id - ID! The country code - either an ISO 3166 code or an
internally defined code if no ISO code exists for that
country.

84
IMDb RealTime API - Schema Documentation

Field Name Description

text - String! Display text for the country (e.g. "United States").

CreditCategory - (Type)

Details about a credit category.

Fields

Field Name Description

id - ID! Category ID.

text - String! Category text (e.g. "Producer").

CreditCategorySummary - (Type)

Summary of the credit category for a name

Fields

Field Name Description

category - CreditCategory! The credit category

total - Int! The total number of credits for the category

CreditConnection - (Type)

Pagination for Credit type on a Title.

Fields

Field Name Description

edges - [CreditEdge!]! Pages of credits.

orderBy - CreditsOrderedBy How the credits are ordered.
pageInfo - PageInfo! Details of the page.

85
IMDb RealTime API - Schema Documentation

Field Name Description

total - Int! Total number of objects in the entire set.

restriction - CreditRestriction Details of any restrictions on field.

CreditEdge - (Type)

Page of credits.

Fields

Field Name Description

cursor - ID! Cursor ID.

node - Credit! A Credit node.
position - Int! Position of the node in this context (e.g. Credit 4 out of
31).

CreditRestriction - (Type)

Some credits may be restricted due to the production status of the title. More information can be found in the restrictions
section.

Fields

Field Name Description

unrestrictedTotal - Int The total number of items if there was no restriction.

explanations - List of explanations for the restriction.
[RestrictionExplanation!]!

CreditedAsCreditAttribute - (Type)

Fields

Field Name Description

creditedAs - String!

86
IMDb RealTime API - Schema Documentation

Field Name Description

id - ID!
text - String!

CreditsOrderedBy - (Type)

Details of how the credits are ordered. If a title has been released, credits are sorted by billing order (the order they appear
in the title’s credits), then alphabetically (if the name does not appear in the title’s credits - i.e. "uncredited" credits).

If a title has not yet been released, credits are sorted by STARmeter, highest ranked first.

Fields

Field Name Description

id - ID! ID field for order by type.

text - String! Text field for how the credits are ordered.

Crew - (Type)

A concrete type that implements the Credit interface.

If you are querying a field that returns a Credit interface, you will need to use inline fragments to access the fields of
the underlying concrete implementations of the Credit type (... on <Type>). For instance, in the query below, the
Cast type specific fields can be accessed using an inline fragment on the Credit interface.

{
name(id: "nm0000093") {
credits(first: 5) {
edges {
node {
title {
id
}
name {
id
}
category {
id

87
IMDb RealTime API - Schema Documentation

text
}
... on Cast {
characters {
name
__typename
}
}
... on Crew {
jobs {
id
text
__typename
}
}
}
}
}
}
}

Fields

Field Name Description Arguments

attributes - Miscellaneous attributes (e.g. limit - Int

[CreditAttribute!] "uncredited")
category - CreditCategory! The credit category (e.g.
"Producer").
jobs - [CrewJob!] The job that this crew member was limit - Int
credited for.
name - Name! The person credited.
title - Title! The title on which this credit
appears.

CrewJob - (Type)

Details about a Job for a given Crew Credit.

88
IMDb RealTime API - Schema Documentation

Fields

Field Name Description

id - ID! The ID for a Job for a given Crew Credit.

text - String! The text for a Job for a given Crew Credit.

DateComponents - (Type)

An object containing details of the individual date components.

Fields

Field Name Description

year - Int The year of the date as per Gregorian calendar.

partialYear - String The year of the date as per Gregorian calendar, can
contain non-numerical wildcard to signify decade or
century.
month - Int The month of the date as per Gregorian calendar with a
1-based index, e.g January is represented by 1.
day - Int The day of the month as per Gregorian calendar.
isBCE - Boolean! If the date is before Common Era as per Gregorian
calendar.
isApproximate - Boolean! If the date is approximate.

DisplayableAttribute - (Type)

Generic type for a concept which has display text and an optional ID.

Fields

Field Name Description

id - ID The display id.

text - String! The display text.

89
IMDb RealTime API - Schema Documentation

DisplayableCountry - (Type)

A high-level object containing information about a country, including the ISO country code and displayable text.

Fields

Field Name Description

id - ID! The country code - either an ISO 3166 code or an

internally defined code if no ISO code exists for that
country.
text - String! Display text for the country (e.g. "United States").

DisplayableDate - (Type)

A high-level object containing information about a date.

Fields

Field Name Description

date - Date A date in ISO 8601.

dateComponents - DateComponents Details of the individual date components.
displayableProperty - The date as a displayable property, e.g. ’23 June 1970’.
DisplayableDateProperty!

DisplayableDateProperty - (Type)

A high-level object containing information about a date.

Fields

Field Name Description

value - Markdown! A complete, formatted date that can be displayed, e.g

"June 22, 1987".

90
IMDb RealTime API - Schema Documentation

DisplayableExternalLinkProperty - (Type)

A displayable property for External Links.

Fields

Field Name Description

value - Markdown! An external link label and its link as a Markdown

formatted text.

DisplayableLanguage - (Type)

A high-level object containing information about a language, including the ISO language code and displayable text.

Fields

Field Name Description

id - ID! The language code - either an ISO 639 code or an

internally defined code if no ISO code exists for the
language.
text - String! Display text for the language (e.g. "American English").

DisplayableLocation - (Type)

An object containing details about a location.

Fields

Field Name Description

text - String The text representing the location.

displayableProperty - The displayable property for the location.
DisplayableLocationProperty!

91
IMDb RealTime API - Schema Documentation

DisplayableLocationProperty - (Type)

A displayable property for locations.

Fields

Field Name Description

value - Markdown! A location that may contain Markdown formatted text.

DisplayableNameAkaProperty - (Type)

A displayable property for name AKAs.

Fields

Field Name Description

value - Markdown! A name AKA that may contain Markdown formatted text.

DisplayableNameDeathCause - (Type)

A high-level object containing information about the cause of death for a given name.

Fields

Field Name Description

text - String The text representing the death cause for a given name.
displayableProperty - The displayable property for the death cause of a given
DisplayableNameDeathCauseProperty! name.

DisplayableNameDeathCauseProperty - (Type)

A displayable property for the death cause of a particular name.

Fields

92
IMDb RealTime API - Schema Documentation

Field Name Description

value - Markdown! A death cause for a particular name that may contain
Markdown formatted text.

DisplayableTechnicalSpecificationProperty - (Type)

A displayable property for technical specifications.

Fields

Field Name Description

value - Markdown! A technical specification in a Markdown formatted text.

DisplayableTitleAkaProperty - (Type)

A displayable property for Aka.

Fields

Field Name Description

key - Markdown! The country where this was the text for a title given in a
Markdown format.
value - Markdown! The alternative title text provided in Markdown
formatted text.

DisplayableTitleCompanyCreditProperty - (Type)

A displayable property for a company credit.

Fields

Field Name Description

value - Markdown! A company credit in Markdown formatted text.

93
IMDb RealTime API - Schema Documentation

DisplayableTitleCountryOfOriginProperty - (Type)

A displayable property for a country of origin.

Fields

Field Name Description

value - Markdown! A countries name in Markdown formatted text.

DisplayableTitleFilmingLocationProperty - (Type)

A displayable property for a filming location.

Fields

Field Name Description

value - Markdown! The filming location in Markdown formatted text.

DisplayableTitleGenreProperty - (Type)

A displayable property for a title’s genre.

Fields

Field Name Description

value - Markdown! A title’s genre in Markdown formatted text.

DisplayableTitleReleaseDateProperty - (Type)

A displayable property for title’s release date.

Fields

94
IMDb RealTime API - Schema Documentation

Field Name Description

key - Markdown! The country where this title was released in a Markdown
format.
value - Markdown! The release date as a Markdown formatted text (e.g.
October 14, 1994).

DisplayableTitleRuntimeProperty - (Type)

A displayable property for a title’s runtime.

Fields

Field Name Description

value - Markdown! A title’s runtime as a Markdown formatted text. (e.g. 2h

22m).

DisplayableTitleSpokenLanguageProperty - (Type)

A displayable property for a title’s spoken language.

Fields

Field Name Description

value - Markdown! A title’s spoken language as Markdown formatted text.

(e.g. English).

DisplayableTitleTaglineProperty - (Type)

A displayable property for a title’s tagline.

Fields

Field Name Description

value - Markdown! A title’s tagline as Markdown formatted text.

95
IMDb RealTime API - Schema Documentation

DisplayableTitleTypeProperty - (Type)

A displayable property for a title’s type.

Fields

Field Name Description

value - Markdown! A title’s type as a Markdown formatted text.

DistributionFormat - (Type)

The distribution format of a title.

Fields

Field Name Description

id - ID! The id of the distribution format.

text - String! Display text for the distribution format (e.g. ’Blu-ray’).

EpisodeConnection - (Type)

Pagination for Episodes which always has a known total number of edges.

Fields

Field Name Description

edges - [EpisodeEdge!]! Pages of episodes.

pageInfo - PageInfo! Details of the page.
total - Int! Total number of objects in the entire set.

EpisodeEdge - (Type)

Page of episodes.

Fields

96
IMDb RealTime API - Schema Documentation

Field Name Description

cursor - ID! Cursor ID.

node - Title! An episode node.
position - Int! Position of the node in this context.

EpisodeNumber - (Type)

For titles that are episodes, returns a high-level object containing the episode and season number. If the title is not an
episode, this object will return null.

Fields

Field Name Description

episodeNumber - Int! The episode number within the season. For instance, if
the title is Season 8, Episode 1 this will be 1.
seasonNumber - Int! The season.

Episodes - (Type)

Details about episode for a given title.

Fields

Field Name Description Arguments

episodes - EpisodeConnection The entire list of episodes. after - ID

before - ID
filter - EpisodesFilter
first - Int
jumpTo - ID
last - Int
sort - EpisodesSort
isOngoing - Boolean If a series is still ongoing.
seasons - [EpisodesSeason!]! A list of details about episode limit - Int
seasons.

97
IMDb RealTime API - Schema Documentation

Field Name Description Arguments

years - [EpisodesYear!]! A list of years that episodes were limit - Int

released.

EpisodesSeason - (Type)

Details about the episodes season.

Fields

Field Name Description

number - Int! An episode season number.

EpisodesYear - (Type)

Details about the year of release of an episode.

Fields

Field Name Description

year - Int! The year of release of an episode.

EventConnection - (Type)

Fields

Field Name Description

edges - [EventEdge!]!
pageInfo - PageInfo! Details of the page.
total - Int! Total number of objects in the entire set.

EventEdge - (Type)

Page of events.

98
IMDb RealTime API - Schema Documentation

Fields

Field Name Description

cursor - ID! Cursor ID.

node - AwardsEvent! An Event node.
position - Int! Position of the node in this context (e.g. Event 4 out of
31).

EventMetadata - (Type)

Provides metadata about events. Useful for fetching an exhaustive list of all event IDs.

Fields

Field Name Description Arguments

events - EventConnection All of the different events. after - ID

before - ID
first - Int
last - Int

ExternalLink - (Type)

External link details.

Fields

Field Name Description

displayableProperty - The link’s displayable property.

DisplayableExternalLinkProperty!
externalLinkLanguages - The languages of the link’s content.
[DisplayableLanguage!]
externalLinkRegion - DisplayableCountry The region of the link’s content.
label - String The link’s label (e.g. "New York Times").
url - String! The URL of the site.

99
IMDb RealTime API - Schema Documentation

ExternalLinkConnection - (Type)

Pagination for external link types which always has a known total number of edges.

Fields

Field Name Description

edges - [ExternalLinkEdge!]! Pages of external links.

pageInfo - PageInfo! Details of the page.
total - Int! Total number of objects in the entire set.
restriction - ExternalLinkRestriction Details of any restrictions within the result set.

ExternalLinkEdge - (Type)

Page of external links.

Fields

Field Name Description

cursor - ID! Cursor ID.

node - ExternalLink! An External link node.
position - Int! Position of the node in this context (e.g. external link 4
out of 31).

ExternalLinkRestriction - (Type)

Some external links may be restricted due to the production status of the title. More information can be found in the
restrictions section.

Fields

Field Name Description

unrestrictedTotal - Int The total number of items if there was no restriction.

explanations - List of explanations for the restriction.
[RestrictionExplanation!]!

100
IMDb RealTime API - Schema Documentation

FilmingLocation - (Type)

Filming location details.

Fields

Field Name Description Arguments

attributes - A list of filming location attributes, limit - Int

[DisplayableAttribute!] can contain:

• Free text attributes e.g. {

id: 'freeText',
text: 'Butch in his
car encounters
Marsellus Wallace'
}
• Location properties e.g. {
id: 'exterior',
text: 'Exterior' }

displayableProperty - The displayable property of a

DisplayableTitleFilmingLocationProperty!
filming location.
id - ID! Filming location ID (e.g.
lc0449596).
text - String! The filming location text (e.g.
Dubrovnik, Croatia).

FilmingLocationConnection - (Type)

Pagination for filming locations which always has a known total number of edges.

Fields

Field Name Description

edges - [FilmingLocationEdge!]! Pages of locations.

pageInfo - PageInfo! Details of the page.
total - Int! Total number of objects in the entire set.

101
IMDb RealTime API - Schema Documentation

Field Name Description

restriction - FilmingLocationRestriction Details of any restrictions within the result set.

FilmingLocationEdge - (Type)

Page of filming locations.

Fields

Field Name Description

cursor - ID! Cursor ID.

node - FilmingLocation! A FilmingLocation node.
position - Int! Position of the node in this context (e.g. Filming Location
4 out of 46).

FilmingLocationRestriction - (Type)

Some filming locations may be restricted due to the production status of the title. More information can be found in the
restrictions section.

Fields

Field Name Description

unrestrictedTotal - Int The total number of items if there was no restriction.

explanations - List of explanations for the restriction.
[RestrictionExplanation!]!

Genre - (Type)

Fields

Field Name Description

displayableProperty -
DisplayableTitleGenreProperty!

102
IMDb RealTime API - Schema Documentation

Field Name Description

id - ID!
text - String!

GenreItem - (Type)

Details about the genre.

Fields

Field Name Description

id - ID! A token representing the genreItem.

text - String! Display text for the genre (e.g. "Action").
genreId - String! A non-localized token representing the genre. Used for
querying the API.
displayableProperty - The displayable property of a genre.
DisplayableTitleGenreProperty!

Genres - (Type)

Fields

Field Name Description Arguments

genres - [Genre!]! limit - Int

Image - (Type)

Details about the image.

Fields

Field Name Description

height - Int Original height of the image resource, in pixels.

id - ID! A unique id associated with the image.

103
IMDb RealTime API - Schema Documentation

Field Name Description

url - String URL for the image resource.

width - Int Original width of the image resource, in pixels.

InterestScore - (Type)

Votes from users about whether an item is interesting.

Fields

Field Name Description

usersInterested - Int! The number of users who found this interesting.

usersVoted - Int! The total number of users who have voted on this item
being interesting or not.

JobCreditAttribute - (Type)

Fields

Field Name Description

id - ID!
job - String!
text - String!

Keyword - (Type)

Details about the keyword associated with a title. More information about keywords and guidance for how they might be
associated with at title can be found on IMDb’s help site.

Fields

Field Name Description

id - ID! The unique IMDb ID for the keyword in question (e.g.

"kw0011402").

104
IMDb RealTime API - Schema Documentation

Field Name Description

text - KeywordText The keyword text.

category - KeywordCategory The keyword category.

KeywordCategory - (Type)

Keyword category details.

Fields

Field Name Description

id - ID! The keyword category ID.

KeywordMetadata - (Type)

Details about metadata for keywords.

Fields

Field Name Description Arguments

keywordCategories - All of the different valid keyword limit - Int

[KeywordCategory!]! categories.

KeywordText - (Type)

Keyword text details.

Fields

Field Name Description

id - ID! The Keyword ID kwconst.

text - String! The keyword text.

105
IMDb RealTime API - Schema Documentation

MainSearchConnection - (Type)

Pagination for main search results.

Fields

Field Name Description

edges - [MainSearchEdge!]! Pages of main search results.

pageInfo - PageInfo! Details of the page.

MainSearchEdge - (Type)

Page of main search results.

Fields

Field Name Description

cursor - ID! Cursor ID.

node - MainSearchNode! Main search result node.
position - Int! Position of the node in this context.

MainSearchNode - (Type)

A single main search result.

Fields

Field Name Description

entity - MainSearchEntity! Main search results can be of various types such as

Title, Name and Keyword
id - ID! The entity id. If the entity is a title, this will be the title id,
if the entity is a name, this will be the name id, etc.

106
IMDb RealTime API - Schema Documentation

Markdown - (Type)

A wrapper for text which can be rendered as markdown or as plain text.

Fields

Field Name Description

markdown - String! IMDb markdown format.

plainText - String The text with most formatting removed. Links to other
IMDb titles, names etc. are replaced with text.

MiscellaneousCreditAttribute - (Type)

Fields

Field Name Description

id - ID!
text - String!

Money - (Type)

A high-level object containing information about the value amount and currency

Fields

Field Name Description

amount - Float! The value amount.

currency - String! ISO-4217 alphabetic currency code (e.g. “USD”).

Name - (Type)

Details about a name.

Fields

107
IMDb RealTime API - Schema Documentation

Field Name Description Arguments

id - ID! The unique IMDb ID for the name in

question (e.g. "nm2225369" for
Jennifer Lawrence).
meta - NameMeta Metadata about this name.
akas - NameAkaConnection Other name texts that this name is first - Int
known by. after - ID
last - Int
before - ID
credits - The entire list of credits for the first - Int
NameCreditConnection name. after - ID
last - Int
before - ID
filter -
NameCreditsFilter
creditSummary - Summary for the name credits
NameCreditSummary
deathCause - The cause of death for a given
DisplayableNameDeathCause name. To determine whether
someone is alive or not, use the
name.deathStatus field.
deathDate - DisplayableDate The date of death for a given name.
To determine whether someone is
alive or not, use the
name.deathStatus field.
deathLocation - The place of death for a given
DisplayableLocation name. To determine whether
someone is alive or not, use the
name.deathStatus field.
deathStatus - NameDeathStatus The status of death for a given
name, e.g ALIVE.
knownFor - A list of IMDb titles in which this first - Int
NameKnownForConnection person is most well known for after - ID
being involved, and the category of last - Int
job that they had on that title (e.g. before - ID
"actor" or "director"). jumpTo - ID

108
IMDb RealTime API - Schema Documentation

Field Name Description Arguments

awardNominations - The awards that the name has won first - Int
AwardNominationConnection or been nominated for. after - ID
last - Int
before - ID
jumpTo - ID
filter -
AwardNominationsFilter
nameText - NameText The person’s name as it appears on
IMDb.
canonicalUrl - String The full URL to see the name on
www.imdb.com.
primaryProfessions - The primary professions of the limit - Int
[PrimaryProfession!] name

NameAka - (Type)

Alternative name texts by which a given name is also known by.

Fields

Field Name Description

displayableProperty - An alternative name text that may contain Markdown

DisplayableNameAkaProperty! formatted text.
text - String! The alternative name text.

NameAkaConnection - (Type)

Pagination for Name AKA types which always has a known total number of edges.

Fields

Field Name Description

edges - [NameAkaEdge!]! Pages of Name AKAs.

pageInfo - PageInfo! Details of the page.

109
IMDb RealTime API - Schema Documentation

Field Name Description

total - Int! Total number of objects in the entire set.

NameAkaEdge - (Type)

A page of a Name AKA.

Fields

Field Name Description

cursor - ID! Cursor ID.

node - NameAka! A Name AKA node.
position - Int! Position of the node in this context, eg: Name AKA 4 out
of 31.

NameCreditCategory - (Type)

Name Credit Category Details.

Fields

Field Name Description

id - ID! The ID of a name credit category.

text - String! The text value for a name credit category.

NameCreditConnection - (Type)

Pagination for Credit type on a Name.

Fields

Field Name Description

edges - [CreditEdge!]! Pages of credits.

orderBy - CreditsOrderedBy How the credits are ordered.

110
IMDb RealTime API - Schema Documentation

Field Name Description

pageInfo - PageInfo! Details of the page.

total - Int! Total number of objects in the entire set.
restriction - CreditRestriction Details of any restrictions within the result set.

NameCreditSummary - (Type)

Summary of the name credits.

Fields

Field Name Description

categories - [CreditCategorySummary!] List of categories the name has credits on

NameKnownFor - (Type)

Details about the title for which a given person is most well known for being involved, together with their credits on that
title.

Fields

Field Name Description

summary - NameKnownForSummary! The summary for a given name knownFor.

title - Title! The title this name is known for.

NameKnownForConnection - (Type)

Pagination for Known For titles which always has a known total number of edges.

Fields

Field Name Description

edges - [NameKnownForEdge!]! Pages of Known For Titles.

111
IMDb RealTime API - Schema Documentation

Field Name Description

pageInfo - PageInfo! Details of the page.

total - Int! Total number of objects in the entire set.
restriction - NameKnownForRestriction Details of any restrictions within the result set.

NameKnownForEdge - (Type)

Page of Titles a Name is most well known for.

Fields

Field Name Description

cursor - ID! Cursor ID.

node - NameKnownFor! A Name Known For node.
position - Int! Position of the node in this context (e.g. KnownFor 4 out
of 100).

NameKnownForRestriction - (Type)

Some known for credits may be restricted due to the production status of the title. More information can be found in the
restrictions section.

Fields

Field Name Description

unrestrictedTotal - Int The total number of items if there was no restriction.

explanations - List of explanations for the restriction.
[RestrictionExplanation!]!

NameKnownForSummary - (Type)

The summary for a given name knownFor.

Fields

112
IMDb RealTime API - Schema Documentation

Field Name Description Arguments

principalCategory - The principal category for a given

CreditCategory! nameKnownFor (e.g
Producer).
principalCharacters - The principal character for a given limit - Int
[Character!] knownFor.
principalJobs - [CrewJob!] The principal job for a given limit - Int
nameKnownFor (e.g
Producer).
yearRange - YearRange The year range that a name was
known for this nameKnownFor.

NameMeta - (Type)

Metadata for a given Name.

Fields

Field Name Description

canonicalId - ID! It is possible that two IMDb IDs can be created for a single
entity within our system before IMDb identify that they
actually represent the same name. When this happens,
we maintain the data associated with both identifiers,
duplicating the data. If there are duplicate name entities
for a name, canonicalId provides the IMDb ID of the
primary name entity for this name.
publicationStatus - PublicationStatus! The publication status for a given name.

NameMetadata - (Type)

Metadata about Names.

Fields

113
IMDb RealTime API - Schema Documentation

Field Name Description

nameCreditCategories - All of the name credit categories.

[NameCreditCategory!]!

NameText - (Type)

Details about a person’s name.

Fields

Field Name Description

text - String! The person’s name as it appears on IMDb. This will be the
primary name by which this person is known, and
usually the one by which they are most often credited.

OpeningWeekendGross - (Type)

Details about the opening weekend gross for a given title. Affected by the specified box office area (e.g. domestic,
international, worldwide).

Fields

Field Name Description

gross - BoxOfficeGross! The gross for the title within the specified box office area.
weekendEndDate - Date! The last day of the opening weekend for that title.
theaterCount - Int The theater count for the title within the relevant area,
between the start and end dates.
weekendStartDate - Date The first day of the opening weekend for that title.

PageInfo - (Type)

For paginated queries, contains info about the current list of results.

Fields

114
IMDb RealTime API - Schema Documentation

Field Name Description

endCursor - ID Returns the cursor id for the last item in the paginated
result set.
hasNextPage - Boolean! Returns true if there are more results available after the
endCursor, and false otherwise.
hasPreviousPage - Boolean! Returns true if there are more results available before
the startCursor, and false otherwise.
startCursor - ID Returns the cursor id for the first item in the paginated
result set.

Plot - (Type)

Plot descriptions for a given title.

Fields

Field Name Description

author - String The author of a plot.

id - ID! The plot id (e.g. "po0949709").
isSpoiler - Boolean A boolean flag that indicates if a plot contains a spoiler.
plotText - Markdown The plot text. Most plot texts will be just a couple of
sentences long, however some may be longer. Plot text
may contain markdown, such as links to other titles or
names.
plotType - PlotType The type of plot. Either a plot outline, a plot summary or
a plot synopsis. For more details see the IMDb Help page
here.
title - Title The title that a given plot is associated with.

PlotConnection - (Type)

Pagination for Plot type on a Title.

Fields

115
IMDb RealTime API - Schema Documentation

Field Name Description

edges - [PlotEdge!]! Pages of plots.

pageInfo - PageInfo! Details of the page.
total - Int! Total number of objects in the entire set.
restriction - PlotRestriction Details of any restrictions within the result set.

PlotEdge - (Type)

Page of plots.

Fields

Field Name Description

cursor - ID! Cursor ID.

node - Plot! A Plot node.
position - Int! Position of the node in this context (e.g. Plot 2 out of 3).

PlotRestriction - (Type)

Some plots may be restricted due to the production status of the title. More information can be found in the restrictions
section.

Fields

Field Name Description

explanations - List of explanations for the restriction.

[RestrictionExplanation!]!

PrimaryProfession - (Type)

Primary profession

Fields

116
IMDb RealTime API - Schema Documentation

Field Name Description

category - CreditCategory! The category of the profession

profession - Profession

PrincipalCreditsForCategory - (Type)

An array of credits associated with a particular credit category.

Fields

Field Name Description Arguments

category - CreditCategory! Credit category (e.g. "Producer" or

"Actor").
credits - [Credit!]! An array of credit items for the limit - Int
given credit category.
totalCredits - Int! Total number of (principal and
non-principal) credits in this
category including uncredited
credits.
restriction - Details of any restrictions within
CreditRestriction the result set.

ProductionAnnouncement - (Type)

Official announcements related to a title.

Fields

Field Name Description

comment - ProductionAnnouncementComment Additional information relating to a title’s announcement

(e.g. a press release link).
date - Date! The date of the announcement.

117
IMDb RealTime API - Schema Documentation

ProductionAnnouncementComment - (Type)

Additional information relating to a title’s announcement (e.g. a press release link).

Fields

Field Name Description

id - ID! ID of the announcement comment.

text - String! The announcement comment text.

ProductionBudget - (Type)

The current production stage as modelled by the IMDb website. Titles in early stages (announced, pitch, etc.) will be
in the In Production stage if they also have a status of Announced, otherwise they will be In Development.

Fields

Field Name Description

budget - Money! Details regarding the money spent, such as amount and
currency.

ProductionStage - (Type)

The current production stage as modelled by the IMDb website. Titles in early stages (announced, pitch, etc.) will be
in the In Production stage if they also have a status of Announced, otherwise they will be In Development.

Fields

Field Name Description

id - ID! The production stage id (e.g. in_production).

text - String! The production stage text (e.g. In development, In
production, Completed, Abandoned, Released,
etc.).

118
IMDb RealTime API - Schema Documentation

ProductionStatus - (Type)

Details regarding the title’s production status.

Fields

Field Name Description

id - ID! The production status id (e.g. released).

text - String! The production status text, e.g. "Pitch", "Pre-production",
"Released".
The available statuses for in-production listings are listed
on IMDb’s help site.

ProductionStatusDetails - (Type)

Details about the title’s current and historical production statuses.

Fields

Field Name Description

currentProductionStage - The current production stage as modelled by the IMDb

ProductionStage! website.
productionStatusHistory - A list of production statuses for this title in ascending
[ProductionStatusHistory] order by date, with the last status being the current
production status.
announcements - Official announcements related to a title.
[ProductionAnnouncement!]
restriction - Details of any restrictions within the result set.
ProductionStatusHistoryRestriction

ProductionStatusHistory - (Type)

Details regarding the production status history.

Fields

119
IMDb RealTime API - Schema Documentation

Field Name Description

status - ProductionStatus! Details about the production status. Available

production statuses are listed on the IMDb help site.
stage - ProductionStage! Production stage corresponding to the status.
date - Date! Date of when the production status was updated.

ProductionStatusHistoryRestriction - (Type)

Some production status information may be restricted due to the production status of the title. More information can be
found in the restrictions section.

Fields

Field Name Description

unrestrictedTotal - Int The total number of items if there was no restriction.

explanations - List of explanations for the restriction.
[RestrictionExplanation!]!

Profession - (Type)

Fields

Field Name Description

id - ID!
text - String!

RankedLifetimeBoxOfficeGross - (Type)

The lifetime gross for the title within the relevant area.

Fields

Field Name Description

boxOfficeAreaType - BoxOfficeAreaType! The BoxOfficeAreaType the gross is related to.

120
IMDb RealTime API - Schema Documentation

Field Name Description

rank - Int The all-time rank for the title.

total - Money! The total amount the title made at the box office.

RankedLifetimeBoxOfficeGrossConnection - (Type)

Pagination for ranked lifetime box office grosses, which always has a known total number of edges.

Fields

Field Name Description

edges - Pages of ranked lifetime box offices grosses.

[RankedLifetimeBoxOfficeGrossEdge!]!
pageInfo - PageInfo! Details of the page.
total - Int! Total number of objects in the entire set.

RankedLifetimeBoxOfficeGrossEdge - (Type)

Page of ranked lifetime box office grosses.

Fields

Field Name Description

cursor - ID! Cursor ID.

node - RankedLifetimeBoxOfficeGross! A ranked lifetime box office gross node.
position - Int! Position of the node in this context, eg: ranked lifetime
box office gross 4 out of 31.

RatingsBody - (Type)

Details about the certificate rating body.

Fields

121
IMDb RealTime API - Schema Documentation

Field Name Description

id - ID! The rating body ID.

text - String! The rating body text (e.g. "MPAA").

RatingsSummary - (Type)

Details about a title’s IMDb rating.

Fields

Field Name Description

aggregateRating - Float The IMDb rating for the title. The rating is between 1 and
10 and given to one decimal place. See IMDb’s help site
for more information on how the rating is calculated. A
TV series rating is not the weighted average of the ratings
of individual episodes. Instead, customers vote
separately for the rating of the series as a whole via each
title’s series page.
voteCount - Int! The number of users who voted on this title. A single
IMDb user can cast a maximum of one vote.

ReleaseDate - (Type)

Release dates for a given title

Fields

Field Name Description

country - DisplayableCountry Country for the returned release date.

day - Int Release date day (1 - 31).
displayableProperty - The displayable property of a release date.
DisplayableTitleReleaseDateProperty!
month - Int Release date month (1 for January, 2 for February, etc.).
year - Int Release date year (yyyy).
restriction - ReleaseDateRestriction Details of any restrictions within the result set.

122
IMDb RealTime API - Schema Documentation

Field Name Description

attributes - [DisplayableAttribute!] Miscellaneous attributes (e.g. Wide release).

ReleaseDateConnection - (Type)

Pagination for release date type on a Title.

Fields

Field Name Description

edges - [ReleaseDateEdge!]! Pages of release dates.

pageInfo - PageInfo! Details of the page.
total - Int! Total number of objects in the entire set.

ReleaseDateEdge - (Type)

A page containing a release date.

Fields

Field Name Description

cursor - ID! Cursor ID.

node - ReleaseDate! A release date node.
position - Int! Position of the node in this context (e.g. release date 4
out of 31).

ReleaseDateRestriction - (Type)

Some release date information may be restricted due to the production status of the title. More information can be found
in the restrictions section.

Fields

123
IMDb RealTime API - Schema Documentation

Field Name Description

explanations - List of explanations for the restriction.

[RestrictionExplanation!]!

RestrictionExplanation - (Type)

An explanation for the restriction.

Fields

Field Name Description

id - ID! The id for the explanation.

text - String! The explanation text. e.g. "Cast is limited to 5 for
in-development titles.".

Runtime - (Type)

Runtime details for a title.

Fields

Field Name Description

country - DisplayableCountry The country this runtime belongs to.

displayableProperty - The displayable property of a runtime.
DisplayableTitleRuntimeProperty!
id - ID! The ID of the runtime.
seconds - Int! Runtime in seconds.

Series - (Type)

For titles which are part of a series (e.g. episodes), provides information about its position within the series.

Fields

124
IMDb RealTime API - Schema Documentation

Field Name Description

episodeNumber - EpisodeNumber Episode number within the series. For series with
seasons, this will be the episode number within the
season (e.g. for Season 4, Episode 1, this will be 1).
nextEpisode - Title Title information associated with the episode after the
current episode.
previousEpisode - Title Title information associated with the episode before the
current episode.
series - Title! The Title associated with this series.

SpokenLanguage - (Type)

Details about a spoken language.

Fields

Field Name Description

displayableProperty -
DisplayableTitleSpokenLanguageProperty!
id - ID! The language code - either an ISO 639 code or an
internally defined code if no ISO code exists for the
language.
text - String! Display text for the language (e.g. English).

SpokenLanguages - (Type)

Details about the languages spoken in a title.

Fields

Field Name Description Arguments

spokenLanguages - A list of the languages spoken in limit - Int

[SpokenLanguage!]! this title, in order of frequency
which they are spoken.

125
IMDb RealTime API - Schema Documentation

Tagline - (Type)

Details about a tagline.

Fields

Field Name Description

displayableProperty - The displayable property of a tagline.

DisplayableTitleTaglineProperty!
text - String! The tagline text.

TaglineConnection - (Type)

Pagination for taglines which always has a known total number of edges.

Fields

Field Name Description

edges - [TaglineEdge!]! Pages of taglines.

pageInfo - PageInfo! Details of the page.
total - Int! Total number of objects in the entire set.

TaglineEdge - (Type)

Page of taglines.

Fields

Field Name Description

cursor - ID! Cursor ID.

node - Tagline! A Tagline node.
position - Int! Position of the node in this context (e.g. Tagline 4 out of
46).

126
IMDb RealTime API - Schema Documentation

TechnicalSpecifications - (Type)

Technical details about a title.

Fields

Field Name Description

colorations - Colorations! Details about the title’s colorations (e.g. whether it was
filmed in black and white or color).

TechnicalSpecificationsRestriction - (Type)

Some technical specification information may be restricted due to the production status of the title. More information can
be found in the restrictions section.

Fields

Field Name Description

unrestrictedTotal - Int The total number of items if there was no restriction.

explanations - List of explanations for the restriction.
[RestrictionExplanation!]!

Title - (Type)

Details about a title.

Fields

Field Name Description Arguments

id - ID! The unique IMDb ID for the title in

question (e.g. "tt0111161" for The
Shawshank Redemption).

127
IMDb RealTime API - Schema Documentation

Field Name Description Arguments

akas - AkaConnection Alternative title texts by which this first - Int

title is known. after - ID
last - Int
before - ID
sort - AkaSort
filter - AkaFilter
countriesOfOrigin - A list of the countries of origin for
CountriesOfOrigin the title.
taglines - TaglineConnection A list of taglines (short first - Int
descriptions/comments on a after - ID
movie that are displayed on movie last - Int
posters, video covers, etc. to before - ID
capture the essence of the movie).
Further information on taglines
can be found on IMDb’s help site.
plots - PlotConnection Up to three plot descriptions of first - Int
this title, one per each plot type. after - ID
last - Int
before - ID
jumpTo - ID
filter - FilterPlots
titleType - TitleType The type of the title (e.g. "movie",
"episode").

128
IMDb RealTime API - Schema Documentation

Field Name Description Arguments

companyCredits - A list of the names of distribution, first - Int

CompanyCreditConnection production, special-effects, and after - ID
other miscellaneous companies last - Int
associated with the making or before - ID
subsequent distribution of this filter -
title. This list includes all CompanyCreditsFilter
companies that have ever been
involved with the title, even if their
involvement has now ended.
These are ordered by on-screen
credit order, or in the case of
distribution companies by
distribution release date.
Additional information about
companies associated with titles
can be found on IMDb’s help site.
certificate - Certificate The certificate for the title.
connections - A list of other titles which have a first - Int
TitleConnectionConnection connection to this title. For after - ID
instance, titles which reference or last - Int
spoof this title. More information before - ID
about connection categories can jumpTo - ID
be found on IMDb’s help site. filter -
ConnectionsFilter
certificates - A list of content rating certifications first - Int
CertificatesConnection that have been given to a title, and after - ID
the region where the rating applies last - Int
or applied. For example a title may before - ID
be given a "PG-13" rating in the jumpTo - ID
"US" region (by the MPAA). There filter -
may be additional attributes about CertificatesFilter
the certificate or reasons for the
rating provided by the rating
organization (e.g. "Rated PG-13 for
sequences of violence and action
throughout"). Certificates can be
optionally filtered by ratings body,
e.g. "MPAA".

129
IMDb RealTime API - Schema Documentation

Field Name Description Arguments

spokenLanguages - A list of the languages spoken in

SpokenLanguages the title.
releaseDates - A list of release dates for a given after - ID
ReleaseDateConnection title. before - ID
first - Int
last - Int
credits - CreditConnection The entire list of cast & crew first - Int
members. after - ID
last - Int
before - ID
filter -
TitleCreditsFilter
principalCredits - Array of most important credit filter -
[PrincipalCreditsForCategory!]categories and credits in that PrincipalCreditsFilter
category.
runtime - Runtime The runtime for the title, in
seconds.
filmingLocations - A list of locations where scenes first - Int
FilmingLocationConnection from this title were filmed. after - ID
last - Int
before - ID
jumpTo - ID
keywords - A list of keywords associated with first - Int
TitleKeywordConnection the title. More information about after - ID
keywords and guidance for how last - Int
they might be associated with at before - ID
title can be found on IMDb’s help jumpTo - ID
site. sort - TitleKeywordsSort
externalLinks - External links for a title. first - Int
ExternalLinkConnection after - ID
last - Int
before - ID
filter -
ExternalLinksFilter

130
IMDb RealTime API - Schema Documentation

Field Name Description Arguments

awardNominations - The awards that the title has won first - Int
AwardNominationConnection or been nominated for. after - ID
last - Int
before - ID
jumpTo - ID
filter -
AwardNominationsFilter
titleGenres - TitleGenres A list of genres to which this title
belongs. The full list of allowed
genres and guidelines for how
titles should be categorized can be
found on IMDb’s help site. IMDb
defines a limited list of genres but
may add more in the future.
genres - Genres A list of genres to which this title
belongs. The full list of allowed
genres and guidelines for how
titles should be categorized can be
found on IMDb’s help site. IMDb
defines a limited list of genres but
may add more in the future. Please
use titleGenres instead.
releaseYear - YearRange The year of the title. The existing
IMDb concept of a year that is
independent of the release date.
isAdult - Boolean A boolean flag that indicates
whether IMDb considers this title
to be primarily pornographic or
adult genre.
releaseDate - ReleaseDate The earliest release date of the
title.
titleText - TitleText The text for the title.
productionStatus - Current production stage of the
ProductionStatusDetails title, and the status history.
originalTitleText - TitleText The original title text of the title,
normally what the title is known as
in its original country of release.

131
IMDb RealTime API - Schema Documentation

Field Name Description Arguments

technicalSpecifications - Technical specifications for a title. filter -

TechnicalSpecifications TechnicalSpecificationsFilter
episodes - Episodes For titles which are a series,
provides information about the
episodes of that series.
series - Series For titles which are part of a series,
provides information about its
position within the series.
primaryImage - Image The primary image (e.g. movie
poster, still frame) for the title.
Contains the image URL and
dimensions (height/width in
pixels).
meta - TitleMeta | Metadata for this title.
canonicalUrl - String The full URL to see the title on
www.imdb.com.
ratingsSummary - A summary of the rating
RatingsSummary information associated with the
title. Includes aggregate rating and
number of user votes amongst
other things.
openingWeekendGross - Opening weekend gross for this boxOfficeArea -
OpeningWeekendGross title. BoxOfficeArea!
productionBudget - Estimated amount of money spent
ProductionBudget on the entire project.
lifetimeGross - The liftime gross for this title boxOfficeArea -
BoxOfficeGross BoxOfficeArea!
rankedLifetimeGross - The lifetime box office grosses for boxOfficeArea -
RankedLifetimeBoxOfficeGross this title within the specified areas. BoxOfficeArea!
Rank is compared to the lifetime
grosses of other titles within the
specified area.

132
IMDb RealTime API - Schema Documentation

Field Name Description Arguments

rankedLifetimeGrosses - The lifetime box office grosses for after - ID

RankedLifetimeBoxOfficeGrossConnection
this title within the specified areas. before - ID
Rank is compared to the lifetime filter -
grosses of other titles within the RankedLifetimeBoxOfficeGrossFi
specified area. first - Int
last - Int

TitleConnection - (Type)

A connection between two titles with the connection reasoning.

Fields

Field Name Description

associatedTitle - Title! The other title in this connection.

category - TitleConnectionCategory! The category of this connection.
text - String The connection text.

TitleConnectionCategory - (Type)

The type of connection, for example titles which reference or spoof this title.

A complete list of current connection types can be found on IMDb’s help site.

Fields

Field Name Description

id - ID! An ID of the connection type.

text - String! The type of connection (e.g. "featured in", "spin off",
"spoofed in").

TitleConnectionConnection - (Type)

Pagination for title connection which always has a known total number of edges.

133
IMDb RealTime API - Schema Documentation

Fields

Field Name Description

edges - [TitleConnectionEdge!]! Pages of title connections.

pageInfo - PageInfo! Details of the page.
total - Int! Total number of objects in the entire set.

TitleConnectionEdge - (Type)

Page of title connection.

Fields

Field Name Description

cursor - ID! Cursor ID.

node - TitleConnection! A TitleConnection node.
position - Int! Position of the node in this context (e.g. TitleConnection
3 out of 340).

TitleGenre - (Type)

Contains genre, relevanceRanking and subGenres for a title.

Fields

Field Name Description

genre - GenreItem! The genre for the title.

relevanceRanking - Int! The relevance ranking of the title in the respective genre.
subGenres - [TitleKeyword]! An Array of the titles sub genres.

TitleGenres - (Type)

Provides information for a title regarding the genre of the title and the relevance of the title for a given genre.

134
IMDb RealTime API - Schema Documentation

Fields

Field Name Description Arguments

genres - [TitleGenre!]! An array of titleGenres limit - Int

(alphabetically ordered). The limit sort - GenreSort
parameter controls the number of
items returned.

TitleKeyword - (Type)

TitleKeyword details.

Fields

Field Name Description

interestScore - InterestScore! Votes from users about whether this keyword item is
interesting.
keyword - Keyword! The keyword.

TitleKeywordConnection - (Type)

Pagination for keywords which always has a known total number of edges.

Fields

Field Name Description

edges - [TitleKeywordEdge!]! Pages of keywords.

pageInfo - PageInfo! Details of the page.
total - Int! Total number of objects in the entire set.

TitleKeywordEdge - (Type)

Pages of keywords.

Fields

135
IMDb RealTime API - Schema Documentation

Field Name Description

cursor - ID! Cursor ID.

node - TitleKeyword! A TitleKeyword node.
position - Int! Position of the node in this context (e.g. TitleKeyword 3
out of 340).

TitleMeta - (Type)

Metadata for a given Title.

Fields

Field Name Description

canonicalId - ID! It is possible that two IMDb IDs can be created for a single
entity within our system before IMDb identify that they
actually represent the same title. When this happens, we
maintain the data associated with both identifiers,
duplicating the data. If there are duplicate title entities
for a title, canonicalId provides the IMDb ID of the
primary title entity for this title.
publicationStatus - PublicationStatus! The publication status for a given title.
restrictions - TitleMetaRestrictions Details of any restrictions within the result set.

TitleMetaRestrictions - (Type)

Some title meta information may be restricted due to the production status of the title. More information can be found in
the restrictions section.

Fields

Field Name Description

explanations - List of explanations for the restriction.

[RestrictionExplanation!]!

136
IMDb RealTime API - Schema Documentation

TitleMetadata - (Type)

Metadata about Title

Fields

Field Name Description Arguments

titleConnectionCategories - All of the title connection

[TitleConnectionCategory!]! categories.
titleGenres - [GenreItem!]! All of the title genres.
titleTypeCategories - All of the title type categories.
[TitleTypeCategoryWithTitleTypes!]!
titleTypes - [TitleType!]! All of the title types. category -
TitleTypeCategoryValue

TitleText - (Type)

The title text for a given title.

Fields

Field Name Description

isOriginalTitle - Boolean! If the title is known by the text field in its original
country of release, this field will be set to true (or
false otherwise).
text - String! The text for the title (e.g The Matrix).

TitleType - (Type)

The type of a given title.

Fields

Field Name Description

canHaveEpisodes - Boolean! A boolean value denoting if a title can have episodes.

categories - [TitleTypeCategory!]! The TitleType categories for a given title.

137
IMDb RealTime API - Schema Documentation

Field Name Description

displayableProperty - The displayable property for a given TitleType.

DisplayableTitleTypeProperty!
id - ID! Title type ID.
isEpisode - Boolean! A boolean value denoting if a title is an episode.
isSeries - Boolean! A boolean value denoting if a title is a series.
text - String! The title type (e.g. "TV Series").

TitleTypeCategory - (Type)

The category of a given title type.

Fields

Field Name Description

id - ID! The id for a title type category.

text - String! The text for a title type category.
value - TitleTypeCategoryValue! The value for a title type category.

TitleTypeCategoryWithTitleTypes - (Type)

A TitleType category with the associated TitleTypes.

Fields

Field Name Description

category - TitleTypeCategory! A title type category.

titleTypes - [TitleType!]! The title types for a given title type category (e.g. "TV
Series")..

YearRange - (Type)

An IMDb type used to represent a year range (e.g. 2004 - 2012). Both fields are optional, as exact data about a year range
may not be known.

138
IMDb RealTime API - Schema Documentation

Fields

Field Name Description

endYear - Int End year (e.g. 2012).

year - Int Start year (e.g. 2004)

Unions

MainSearchEntity - (Union)

A union type of Title, Name and Keyword.

If you are querying a field that returns a MainSearchEntity union type, you will need to use inline fragments to access
the fields of the underlying concrete type (... on <Type>). For instance, in the query below, the Title type specific
fields can be accessed using an inline fragment on the MainSearchEntity union type.

{
mainSearch(
first: 5
options: {
searchTerm: "Goodfellas"
isExactMatch: false
type: TITLE
titleSearchOptions: { type: MOVIE }
}
) {
edges {
node {
entity {
... on Title {
id
titleText {
text
}
}
}
}
}
}
}

139
IMDb RealTime API - Schema Documentation

Types

Union Types

Keyword
Name
Title

140