Datasets

Search the Box Office Mojo dataset

Searches theatrical box-office records from Box Office Mojo charts and title pages. Filter by title id, year, franchise/brand/genre, gross band, lifetime top-1000 membership, hydration status, and worldwide/domestic gross ranges. Sort enum: relevance, worldwide_desc, domestic_desc, peak_worldwide_desc, lifetime_rank_asc, year_desc, year_asc. gross_band enum: under_50m, 50_100m, 100_250m, 250_500m, 500m_1b, over_1b. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).

get/datasets/boxofficemojo/search

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/datasets/boxofficemojo/search
  • Auth: API key in header x-api-key

Query parameters

qstring

Full-text query over title and taxonomy names, max 256 characters

title_idstring

Exact title id (IMDb tt… id used by Box Office Mojo), max 32 characters

yearinteger

Year that must appear in years_active

lifetime_yearinteger

Primary lifetime chart year

gross_band'under_50m' | '50_100m' | '100_250m' | '250_500m' | '500m_1b' | 'over_1b'

Gross band enum: under_50m, 50_100m, 100_250m, 250_500m, 500m_1b, over_1b

franchisestring

Franchise name filter, max 128 characters

brandstring

Brand name filter, max 128 characters

genrestring

Genre name filter, max 128 characters

in_lifetime_top_1000boolean

Only titles in the lifetime worldwide top 1000 chart

hydratedboolean

Only titles with hydrated release groups and market grosses

is_billion_dollarboolean

Only titles with worldwide gross of at least $1B

min_worldwideinteger

Minimum lifetime worldwide gross in whole USD dollars

max_worldwideinteger

Maximum lifetime worldwide gross in whole USD dollars

min_domesticinteger

Minimum lifetime domestic gross in whole USD dollars

min_foreign_sharenumber

Minimum foreign share of worldwide gross, 0 through 1

max_domestic_sharenumber

Maximum domestic share of worldwide gross, 0 through 1

sort'relevance' | 'worldwide_desc' | 'domestic_desc' | 'peak_worldwide_desc' | 'lifetime_rank_asc' | 'year_desc' | 'year_asc'

Sort enum: relevance, worldwide_desc, domestic_desc, peak_worldwide_desc, lifetime_rank_asc, year_desc, year_asc

pageinteger

Page number, defaults to 1

page_sizeinteger

Page size, defaults to 20 and maxes at 100; page * page_size must be <= 10000

Headers

x-api-keystring required

API key required

Response

OK

codeinteger
msgstring

Example response

{
  "code": 200,
  "msg": "OK"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.