### GET /titles/{titleId}/parentsGuide Source: https://imdbapi.dev/imdbapi Retrieve the parents guide information associated with a specific title. ```APIDOC ## GET /titles/{titleId}/parentsGuide ### Description Retrieve the parents guide information associated with a specific title. ### Method GET ### Endpoint /titles/{titleId}/parentsGuide ### Parameters #### Path Parameters - **titleId** (string) - Required - IMDb title ID in the format "tt1234567". ### Response #### Success Response (200) - **imdbapiListTitleParentsGuideResponse** - A successful response containing parents guide data. #### Response Example ```json { "violence": "Some scenes contain intense violence.", "profanity": "Frequent use of strong language.", "frighteningScenes": "Contains several jump scares and disturbing imagery." } ``` ``` -------------------------------- ### List Title Parents Guide API Source: https://imdbapi.dev/imdbapi Retrieves the parents guide information for a specific title. This includes content warnings and age ratings. ```APIDOC ## GET /titles/{title_id}/parents_guide ### Description Retrieves the parents guide information for a specific title. This includes details about violence, profanity, nudity, and other content warnings relevant to viewers. ### Method GET ### Endpoint /titles/{title_id}/parents_guide ### Parameters #### Path Parameters - **title_id** (string) - Required - The unique identifier for the title. ### Request Example ```json { "example": "GET /titles/tt0111161/parents_guide" } ``` ### Response #### Success Response (200) - **parentsGuide** (array) - List of parents guide entries associated with the title. #### Response Example ```json { "parentsGuide": [ { "category": "Violence & Gore", "description": "Scenes of graphic violence, including depictions of torture and death." }, { "category": "Profanity", "description": "Frequent use of strong language and profanity." } ] } ``` ``` -------------------------------- ### GET /search/titles Source: https://imdbapi.dev/imdbapi Search for titles using a query string. ```APIDOC ## GET /search/titles ### Description Search for titles using a query string. ### Method GET ### Endpoint /search/titles ### Parameters #### Query Parameters - **query** (string) - Required - The search query for titles. - **limit** (integer) - Optional - Limit the number of results returned. Maximum is 50. ### Request Example ```json { "example": "Not applicable for GET request" } ``` ### Response #### Success Response (200) - **imdbapiSearchTitlesResponse** - A successful response. #### Response Example ```json { "example": "imdbapiSearchTitlesResponse object" } ``` ``` -------------------------------- ### GET /titles Source: https://imdbapi.dev/imdbapi Retrieve a list of titles (movies, TV shows, etc.) with various filtering options. ```APIDOC ## GET /titles ### Description Retrieve a list of titles with optional filters. This endpoint allows you to search for titles based on type, genre, country, language, associated names, interests, and release year range. ### Method GET ### Endpoint /titles ### Parameters #### Query Parameters - **types** (array of string) - Optional - Filter titles by their type (e.g., MOVIE, TV_SERIES). Allowed values: MOVIE, TV_SERIES, TV_MINI_SERIES, TV_SPECIAL, TV_MOVIE, SHORT, VIDEO, VIDEO_GAME. - **genres** (array of string) - Optional - Filter titles by genre. - **countryCodes** (array of string) - Optional - Filter titles by ISO 3166-1 alpha-2 country codes (e.g., "US", "GB"). - **languageCodes** (array of string) - Optional - Filter titles by ISO 639-1 or ISO 639-2 language codes. - **nameIds** (array of string) - Optional - Filter titles by the IDs of associated names (actors, directors, etc.). - **interestIds** (array of string) - Optional - Filter titles by the IDs of associated interests. - **startYear** (integer) - Optional - Filter titles released on or after this year. - **endYear** (integer) - Optional - Filter titles released on or before this year. - **minVoteCount** (integer) - Optional - Filter titles with a minimum number of votes (0 to 1,000,000,000). Defaults to 0. - **maxVoteCount** (integer) - Optional - Filter titles with a maximum number of votes (0 to 1,000,000,000). - **minAggregateRating** (number) - Optional - Filter titles with a minimum aggregate rating. ### Request Example ``` GET /titles?types=MOVIE&genres=Action&startYear=2020 ``` ### Response #### Success Response (200) - **titles** (array) - A list of title objects matching the filter criteria. - Each title object may contain fields like `id`, `titleText`, `originalTitleText`, `releaseYear`, `ratings`, etc. #### Response Example ```json { "titles": [ { "id": "tt0111161", "titleText": {"text": "The Shawshank Redemption"}, "originalTitleText": {"text": "The Shawshank Redemption"}, "releaseYear": 1994, "ratings": {"ratingCount": 2800000, "rating": 9.3} } // ... more titles ] } ``` ``` -------------------------------- ### Get Title Details API Source: https://imdbapi.dev/imdbapi Retrieves detailed information for a specific title using its unique identifier. ```APIDOC ## GET /titles/{id} ### Description Retrieves detailed information for a specific title using its unique identifier. ### Method GET ### Endpoint /titles/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the title. ### Response #### Success Response (200) - **id** (string) - The unique identifier for the title. - **titleType** (string) - The type of the title. - **titleText** (object) - Contains title text variations. - **originalTitleText** (object) - Contains original title text variations. - **principalCast** (array) - List of principal cast members. - **ratings** (object) - Contains aggregate rating and vote count. - **releaseDate** (object) - Contains release date information. - **countriesOfOrigin** (array) - List of countries of origin. - **genres** (array) - List of genres associated with the title. - **parentalGuide** (object) - Contains parental guide information. #### Response Example ```json { "example": { "id": "tt1375666", "titleType": "movie", "titleText": { "text": "Inception", "original": "Inception" }, "originalTitleText": { "text": "Inception", "original": "Inception" }, "principalCast": [ { "name": { "nameText": { "text": "Leonardo DiCaprio", "original": "Leonardo DiCaprio" } }, "characters": ["Cobb"] } ], "ratings": { "aggregateRating": 8.8, "voteCount": 2500000 }, "releaseDate": { "day": 16, "month": 7, "year": 2010 }, "countriesOfOrigin": ["USA", "UK"] } } ``` ``` -------------------------------- ### Batch Get Titles by IDs Source: https://imdbapi.dev/imdbapi Retrieve details of multiple titles using their IMDb IDs. ```APIDOC ## GET /titles:batchGet ### Description Retrieve details of multiple titles using their IMDb IDs. ### Method GET ### Endpoint /titles:batchGet ### Parameters #### Query Parameters - **titleIds** (array of strings) - Required - List of IMDb title IDs. Maximum 5 IDs. ### Response #### Success Response (200) - **titles** (array) - List of titles matching the provided IDs. #### Response Example ```json { "titles": [ { "titleId": "tt0111161", "title": "The Shawshank Redemption", "titleType": "MOVIE", "year": 1994 }, { "titleId": "tt0068646", "title": "The Godfather", "titleType": "MOVIE", "year": 1972 } ] } ``` ``` -------------------------------- ### GET /titles/{titleId}/boxOffice Source: https://imdbapi.dev/imdbapi Get box office information for a title. ```APIDOC ## GET /titles/{titleId}/boxOffice ### Description Retrieve the box office information associated with a specific title. ### Method GET ### Endpoint /titles/{titleId}/boxOffice ### Parameters #### Path Parameters - **titleId** (string) - Required - IMDb title ID in the format "tt1234567". ### Request Example ```json { "example": "Not applicable for GET request" } ``` ### Response #### Success Response (200) - **imdbapiBoxOffice** - A successful response. #### Response Example ```json { "example": "imdbapiBoxOffice object" } ``` ``` -------------------------------- ### GET /titles/{titleId}/certificates Source: https://imdbapi.dev/imdbapi Retrieve the certificates (e.g., MPAA ratings) associated with a specific title. ```APIDOC ## GET /titles/{titleId}/certificates ### Description Retrieve the certificates (e.g., MPAA ratings) associated with a specific title. ### Method GET ### Endpoint /titles/{titleId}/certificates ### Parameters #### Path Parameters - **titleId** (string) - Required - IMDb title ID in the format "tt1234567". ### Response #### Success Response (200) - **imdbapiListTitleCertificatesResponse** - A successful response containing certificate data. #### Response Example ```json { "certificates": [ { "rating": "PG-13", "country": "USA" } ] } ``` ``` -------------------------------- ### Get Title by ID Source: https://imdbapi.dev/imdbapi Retrieve a title's details using its IMDb ID. ```APIDOC ## GET /titles/{titleId} ### Description Retrieve a title's details using its IMDb ID. ### Method GET ### Endpoint /titles/{titleId} ### Parameters #### Path Parameters - **titleId** (string) - Required - The IMDb title ID in the format 'tt1234567'. ### Response #### Success Response (200) - **title** (object) - Detailed information about the title. #### Response Example ```json { "titleId": "tt0111161", "title": "The Shawshank Redemption", "titleType": "MOVIE", "year": 1994, "rating": 9.3, "ratingCount": 2500000 } ``` ``` -------------------------------- ### GET /names/{nameId} Source: https://imdbapi.dev/imdbapi Retrieve a name's details using its IMDb ID. ```APIDOC ## GET /names/{nameId} ### Description Retrieve a name's details using its IMDb ID. ### Method GET ### Endpoint /names/{nameId} ### Parameters #### Path Parameters - **nameId** (string) - Required - IMDB name ID in the format "nm1234567". ### Request Example ```json { "example": "Not applicable for GET request" } ``` ### Response #### Success Response (200) - **imdbapiName** - A successful response. #### Response Example ```json { "example": "imdbapiName object" } ``` ``` -------------------------------- ### GET /names/{nameId}/images Source: https://imdbapi.dev/imdbapi Retrieve the images associated with a specific name. ```APIDOC ## GET /names/{nameId}/images ### Description Retrieve the images associated with a specific name. ### Method GET ### Endpoint /names/{nameId}/images ### Parameters #### Path Parameters - **nameId** (string) - Required - IMDB name ID in the format "nm1234567". #### Query Parameters - **types** (array of strings) - Optional - The types of images to filter by. If not specified, all types are returned. - **pageSize** (integer) - Optional - The maximum number of images to return per page. Must be between 1 and 50. Default is 20. - **pageToken** (string) - Optional - Token for pagination, if applicable. ### Request Example ```json { "example": "Not applicable for GET request" } ``` ### Response #### Success Response (200) - **imdbapiListNameImagesResponse** - A successful response. #### Response Example ```json { "example": "imdbapiListNameImagesResponse object" } ``` ``` -------------------------------- ### GET /names:batchGet Source: https://imdbapi.dev/imdbapi Batch retrieve details for multiple names using their IMDb IDs. This endpoint supports fetching up to 5 names at once. ```APIDOC ## GET /names:batchGet ### Description Batch get names by IDs. Retrieve details of multiple names using their IMDb IDs. ### Method GET ### Endpoint /names:batchGet ### Parameters #### Query Parameters - **nameIds** (array of strings) - Required - Required. List of IMDb name IDs in the format "nm1234567". The maximum number of IDs is 5. ### Response #### Success Response (200) - **imdbapiBatchGetNamesResponse** - Schema reference for the successful response. #### Error Response - **rpcStatus** - Schema reference for an unexpected error response. ``` -------------------------------- ### GET /titles/{titleId}/companyCredits Source: https://imdbapi.dev/imdbapi Retrieve company credits for a specific IMDb title. ```APIDOC ## GET /titles/{titleId}/companyCredits ### Description Retrieves company credits for a specific IMDb title. ### Method GET ### Endpoint /titles/{titleId}/companyCredits ### Parameters #### Path Parameters - **titleId** (string) - Required - IMDb title ID in the format "tt1234567". #### Query Parameters - **categories** (array of strings) - Optional - The categories of company credits to filter by. - **pageSize** (integer) - Optional - The maximum number of company credits to return per page. Must be between 1 and 50. Default is 20. - **pageToken** (string) - Optional - Token for pagination, if applicable. ### Request Example ```json { "example": "Not applicable for GET request" } ``` ### Response #### Success Response (200) - **imdbapiListTitleCompanyCreditsResponse** - A successful response. #### Response Example ```json { "example": "imdbapiListTitleCompanyCreditsResponse object" } ``` ``` -------------------------------- ### GET /chart/starmeter Source: https://imdbapi.dev/imdbapi Retrieve the star meter rankings for names. This endpoint allows for paginated retrieval of popular actor rankings. ```APIDOC ## GET /chart/starmeter ### Description List star meter rankings. Retrieve the star meter rankings for names. ### Method GET ### Endpoint /chart/starmeter ### Parameters #### Query Parameters - **pageToken** (string) - Optional - Token for pagination, if applicable. ### Response #### Success Response (200) - **imdbapiListStarMetersResponse** - Schema reference for the successful response. #### Error Response - **rpcStatus** - Schema reference for an unexpected error response. ``` -------------------------------- ### GET /titles/{titleId}/companyCredits Source: https://imdbapi.dev/imdbapi Retrieve the company credits (e.g., production companies, distributors) associated with a specific title. ```APIDOC ## GET /titles/{titleId}/companyCredits ### Description Retrieve the company credits (e.g., production companies, distributors) associated with a specific title. ### Method GET ### Endpoint /titles/{titleId}/companyCredits ### Parameters #### Path Parameters - **titleId** (string) - Required - IMDb title ID in the format "tt1234567". ### Response #### Success Response (200) - **imdbapiListTitleCompanyCreditsResponse** - A successful response containing company credit data. #### Response Example ```json { "companyCredits": [ { "company": { "id": "co1234567", "name": "Example Productions" }, "role": "Producer" } ] } ``` ``` -------------------------------- ### GET /interests/{interestId} Source: https://imdbapi.dev/imdbapi Retrieve detailed information about a specific interest category using its unique ID. This endpoint allows you to fetch all data associated with a particular interest. ```APIDOC ## GET /interests/{interestId} ### Description Get interest by ID. Retrieve details of a specific interest using its ID. ### Method GET ### Endpoint /interests/{interestId} ### Parameters #### Path Parameters - **interestId** (string) - Required - The ID of the interest to retrieve. #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **(object)** - A successful response containing the details of the specified interest. #### Response Example ```json { "id": "tt0111161", "titleType": "movie", "titleText": { "text": "The Shawshank Redemption" }, "releaseYear": 1994 } ``` ``` -------------------------------- ### GET /names/{nameId}/relationships Source: https://imdbapi.dev/imdbapi Retrieve the relationships associated with a specific name ID. This endpoint provides information about connections to other individuals. ```APIDOC ## GET /names/{nameId}/relationships ### Description Retrieve the relationships associated with a specific name. ### Method GET ### Endpoint /names/{nameId}/relationships ### Parameters #### Path Parameters - **nameId** (string) - Required - Required. IMDB name ID in the format "nm1234567". ### Response #### Success Response (200) - **imdbapiListNameRelationshipsResponse** - Schema reference for the successful response. #### Error Response - **rpcStatus** - Schema reference for an unexpected error response. ``` -------------------------------- ### GET /titles/{titleId}/videos Source: https://imdbapi.dev/imdbapi Retrieve the videos associated with a specific title. This endpoint allows filtering by video type and paginating results. ```APIDOC ## GET /titles/{titleId}/videos ### Description Retrieve the videos associated with a specific title. This endpoint allows filtering by video type and paginating results. ### Method GET ### Endpoint /titles/{titleId}/videos ### Parameters #### Path Parameters - **titleId** (string) - Required - IMDb title ID in the format "tt1234567". #### Query Parameters - **types** (array[string]) - Optional - The types of videos to filter by. If not specified, all types are returned. - **pageSize** (integer) - Optional - The maximum number of videos to return per page. The value must be between 1 and 50. Default is 20. - **pageToken** (string) - Optional - Token for pagination, if applicable. ### Response #### Success Response (200) - **imdbapiListTitleVideosResponse** - A successful response containing video data. #### Response Example ```json { "videos": [ { "id": "vi123456789", "title": "Trailer", "type": "TRAILER", "thumbnailUrl": "https://example.com/thumbnail.jpg", "url": "https://example.com/video.mp4" } ], "nextPageToken": "someToken" } ``` ``` -------------------------------- ### GET /interests Source: https://imdbapi.dev/imdbapi Retrieve a list of all available interest categories from the IMDb API. This endpoint is useful for understanding the different types of interests categorized within the API. ```APIDOC ## GET /interests ### Description List interest categories available in the IMDb API. ### Method GET ### Endpoint /interests ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **(object)** - A successful response containing a list of interest categories. #### Response Example ```json { "interests": [ { "id": "tt0111161", "titleType": "movie", "titleText": { "text": "The Shawshank Redemption" }, "releaseYear": 1994 } ] } ``` ``` -------------------------------- ### GET /titles/{titleId}/awardNominations Source: https://imdbapi.dev/imdbapi Retrieve the award nominations associated with a specific title. Supports pagination for a large number of nominations. ```APIDOC ## GET /titles/{titleId}/awardNominations ### Description Retrieve the award nominations associated with a specific title. Supports pagination for a large number of nominations. ### Method GET ### Endpoint /titles/{titleId}/awardNominations ### Parameters #### Path Parameters - **titleId** (string) - Required - IMDb title ID in the format "tt1234567". #### Query Parameters - **pageSize** (integer) - Optional - The maximum number of award nominations to return per page. The value must be between 1 and 50. Default is 20. - **pageToken** (string) - Optional - Token for pagination, if applicable. ### Response #### Success Response (200) - **imdbapiListTitleAwardNominationsResponse** - A successful response containing award nomination data. #### Response Example ```json { "awardNominations": [ { "awardCategory": "Best Picture", "awardName": "Academy Awards", "outcome": "Nominee", "year": 2023 } ], "nextPageToken": "anotherToken" } ``` ``` -------------------------------- ### Batch Get Names - IMDb API Source: https://imdbapi.dev/imdbapi Retrieves details for multiple names simultaneously by providing a list of IMDb IDs. This endpoint requires a 'nameIds' parameter, which is a required array of strings. The maximum number of IDs allowed in a single request is 5. ```OpenAPI paths: /names:batchGet: get: summary: Batch get names by IDs description: Retrieve details of multiple names using their IMDb IDs. operationId: IMDbAPIService_BatchGetNames responses: "200": description: A successful response. schema: $ref: '#/definitions/imdbapiBatchGetNamesResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: nameIds description: |- Required. List of IMDb name IDs in the format "nm1234567". The maximum number of IDs is 5. in: query required: true type: array items: type: string collectionFormat: multi tags: - Name ``` -------------------------------- ### GET /names/{nameId}/trivia Source: https://imdbapi.dev/imdbapi Retrieve trivia related to a specific name ID. This endpoint allows pagination for trivia entries. ```APIDOC ## GET /names/{nameId}/trivia ### Description Retrieve the trivia associated with a specific name. ### Method GET ### Endpoint /names/{nameId}/trivia ### Parameters #### Path Parameters - **nameId** (string) - Required - Required. IMDB name ID in the format "nm1234567". #### Query Parameters - **pageSize** (integer) - Optional - The maximum number of trivia entries to return per page. The value must be between 1 and 50. Default is 20. - **pageToken** (string) - Optional - Token for pagination, if applicable. ### Response #### Success Response (200) - **imdbapiListNameTriviaResponse** - Schema reference for the successful response. #### Error Response - **rpcStatus** - Schema reference for an unexpected error response. ``` -------------------------------- ### GET /names/{nameId}/filmography Source: https://imdbapi.dev/imdbapi Retrieve the filmography associated with a specific name ID. This endpoint allows filtering by credit categories and pagination. ```APIDOC ## GET /names/{nameId}/filmography ### Description Retrieve the filmography associated with a specific name. ### Method GET ### Endpoint /names/{nameId}/filmography ### Parameters #### Path Parameters - **nameId** (string) - Required - Required. IMDB name ID in the format "nm1234567". #### Query Parameters - **categories** (array of strings) - Optional - The categories of credits to filter by. If not specified, all categories are returned. - **pageSize** (integer) - Optional - The maximum number of credits to return per page. The value must be between 1 and 50. Default is 20. - **pageToken** (string) - Optional - Token for pagination, if applicable. ### Response #### Success Response (200) - **imdbapiListNameFilmographyResponse** - Schema reference for the successful response. #### Error Response - **rpcStatus** - Schema reference for an unexpected error response. ``` -------------------------------- ### Get Name Relationships - IMDb API Source: https://imdbapi.dev/imdbapi Retrieves the relationships associated with a specific name using their IMDb ID. This endpoint only requires the 'nameId' as a path parameter. No other query parameters are supported for filtering or pagination. ```OpenAPI paths: /names/{nameId}/relationships: get: summary: List relationships for a name description: Retrieve the relationships associated with a specific name. operationId: IMDbAPIService_ListNameRelationships responses: "200": description: A successful response. schema: $ref: '#/definitions/imdbapiListNameRelationshipsResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: nameId description: Required. IMDB name ID in the format "nm1234567". in: path required: true type: string tags: - Name ``` -------------------------------- ### Get Name Filmography - IMDb API Source: https://imdbapi.dev/imdbapi Retrieves the filmography for a specific name using their IMDb ID. Supports filtering by categories and pagination using page size and token. It requires the 'nameId' as a path parameter and optionally accepts 'categories', 'pageSize', and 'pageToken' as query parameters. ```OpenAPI paths: /names/{nameId}/filmography: get: summary: List filmography for a name description: Retrieve the filmography associated with a specific name. operationId: IMDbAPIService_ListNameFilmography responses: "200": description: A successful response. schema: $ref: '#/definitions/imdbapiListNameFilmographyResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: nameId description: Required. IMDB name ID in the format "nm1234567". in: path required: true type: string - name: categories description: |- Optional. The categories of credits to filter by. If not specified, all categories are returned. in: query required: false type: array items: type: string collectionFormat: multi - name: pageSize description: |- Optional. The maximum number of credits to return per page. If not specified, a default value will be used. The value must be between 1 and 50. Default is 20. in: query required: false type: integer format: int32 - name: pageToken description: Optional. Token for pagination, if applicable. in: query required: false type: string tags: - Name ``` -------------------------------- ### Get Name Trivia - IMDb API Source: https://imdbapi.dev/imdbapi Retrieves trivia information for a specific name using their IMDb ID. Supports pagination using page size and token. It requires the 'nameId' as a path parameter and optionally accepts 'pageSize' and 'pageToken' as query parameters. ```OpenAPI paths: /names/{nameId}/trivia: get: summary: List trivia for a name description: Retrieve the trivia associated with a specific name. operationId: IMDbAPIService_ListNameTrivia responses: "200": description: A successful response. schema: $ref: '#/definitions/imdbapiListNameTriviaResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: nameId description: Required. IMDB name ID in the format "nm1234567". in: path required: true type: string - name: pageSize description: |- Optional. The maximum number of trivia entries to return per page. If not specified, a default value will be used. The value must be between 1 and 50. Default is 20. in: query required: false type: integer format: int32 - name: pageToken description: Optional. Token for pagination, if applicable. in: query required: false type: string tags: - Name ``` -------------------------------- ### List Credits for a Title Source: https://imdbapi.dev/imdbapi Retrieve the credits associated with a specific title. ```APIDOC ## GET /titles/{titleId}/credits ### Description Retrieve the credits associated with a specific title. ### Method GET ### Endpoint /titles/{titleId}/credits ### Parameters #### Path Parameters - **titleId** (string) - Required - IMDb title ID in the format "tt1234567". #### Query Parameters - **categories** (array of strings) - Optional - The categories of credits to filter by. - **pageSize** (integer) - Optional - The maximum number of credits to return per page. ### Response #### Success Response (200) - **credits** (array) - List of credits for the specified title. #### Response Example ```json { "credits": [ { "personId": "nm0000318", "name": "Tom Hanks", "category": "ACTOR", "characters": ["Forrest Gump"] }, { "personId": "nm0000432", "name": "Robin Wright", "category": "ACTOR", "characters": ["Jenny Curran"] } ] } ``` ``` -------------------------------- ### Interest Data Structure Source: https://imdbapi.dev/imdbapi Defines the structure for an interest or genre, including its ID, name, primary image, description, and related interests. ```APIDOC ## imdbapiInterest ### Description Represents a specific interest or genre within the IMDb API. ### Properties - **id** (string) - The unique identifier for the interest. - **name** (string) - The name of the interest (e.g., 'Action', 'Drama'). - **primaryImage** (imdbapiImage) - The primary image associated with the interest. - **description** (string) - A brief description of the interest. - **isSubgenre** (boolean) - Indicates if this interest is a subgenre. - **similarInterests** (array of imdbapiInterest) - A list of similar interests. ``` -------------------------------- ### List Episodes for a Title Source: https://imdbapi.dev/imdbapi Retrieve the episodes associated with a specific title, with options to filter by season and paginate. ```APIDOC ## GET /titles/{titleId}/episodes ### Description Retrieve the episodes associated with a specific title. ### Method GET ### Endpoint /titles/{titleId}/episodes ### Parameters #### Path Parameters - **titleId** (string) - Required - IMDb title ID in the format "tt1234567". #### Query Parameters - **season** (string) - Optional - The season number to filter episodes by. - **pageSize** (integer) - Optional - The maximum number of episodes to return per page. Must be between 1 and 50. Default is 20. - **pageToken** (string) - Optional - Token for pagination, if applicable. ### Response #### Success Response (200) - **response** (imdbapiListTitleEpisodesResponse) - A successful response. #### Error Response - **error** (rpcStatus) - An unexpected error response. ``` -------------------------------- ### List Titles API Source: https://imdbapi.dev/imdbapi Searches for titles based on various criteria and returns a list of matching titles. Includes pagination support. ```APIDOC ## GET /titles ### Description Searches for titles based on specified criteria such as title name, genre, year, etc. This endpoint returns a list of matching titles and supports pagination. ### Method GET ### Endpoint /titles ### Parameters #### Query Parameters - **title** (string) - Optional - The name or part of the name of the title to search for. - **genre** (string) - Optional - Filters titles by genre. - **year** (integer) - Optional - Filters titles by release year. - **pageToken** (string) - Optional - Token for the next page of results. - **pageSize** (integer) - Optional - The number of results to return per page. ### Request Example ```json { "example": "GET /titles?title=The+Shawshank+Redemption&year=1994&pageToken=CAUQAA&pageSize=10" } ``` ### Response #### Success Response (200) - **titles** (array) - List of titles matching the request criteria. - **totalCount** (integer) - Total number of titles matching the request criteria. - **nextPageToken** (string) - Token for the next page of results, if applicable. #### Response Example ```json { "titles": [ { "id": "tt0111161", "title": "The Shawshank Redemption", "year": 1994 } ], "totalCount": 1, "nextPageToken": "CAUQAA" } ``` ``` -------------------------------- ### List Title Release Dates API Source: https://imdbapi.dev/imdbapi Retrieves the release dates for a specific title across different regions. Includes platform and region information. ```APIDOC ## GET /titles/{title_id}/release_dates ### Description Retrieves the release dates for a specific title. This endpoint provides information about when and where the title was released, including theatrical, streaming, and home media dates. ### Method GET ### Endpoint /titles/{title_id}/release_dates ### Parameters #### Path Parameters - **title_id** (string) - Required - The unique identifier for the title. ### Request Example ```json { "example": "GET /titles/tt0111161/release_dates" } ``` ### Response #### Success Response (200) - **releaseDates** (array) - List of release dates associated with the title. #### Response Example ```json { "releaseDates": [ { "country": "USA", "date": "1994-09-23", "type": "THEATRICAL_RELEASE" }, { "country": "Germany", "date": "1995-01-12", "type": "THEATRICAL_RELEASE" } ] } ``` ``` -------------------------------- ### Search Titles Source: https://imdbapi.dev/imdbapi Search for titles based on various criteria such as query, minimum/maximum rating, sorting order, and pagination. ```APIDOC ## GET /titles ### Description Search for titles based on various criteria. ### Method GET ### Endpoint /titles ### Parameters #### Query Parameters - **query** (string) - Required - The search query string. - **minRating** (number) - Optional - The minimum rating a title can have to be included. The value must be between 0.0 and 10.0. - **maxRating** (number) - Optional - The maximum rating a title can have to be included. The value must be between 0.0 and 10.0. - **minAggregateRating** (number) - Optional - The minimum aggregate rating a title can have to be included. The value must be between 0.0 and 10.0. - **maxAggregateRating** (number) - Optional - The maximum aggregate rating a title can have to be included. The value must be between 0.0 and 10.0. - **sortBy** (string) - Optional - The sorting order for the titles. Possible values: SORT_BY_POPULARITY, SORT_BY_RELEASE_DATE, SORT_BY_USER_RATING, SORT_BY_USER_RATING_COUNT, SORT_BY_YEAR. - **sortOrder** (string) - Optional - The sorting order for the titles. Possible values: ASC, DESC. - **pageToken** (string) - Optional - Token for pagination, if applicable. ### Response #### Success Response (200) - **titles** (array) - List of titles matching the search criteria. #### Response Example ```json { "titles": [ { "titleId": "tt0111161", "title": "The Shawshank Redemption", "titleType": "MOVIE", "year": 1994 } ] } ``` ``` -------------------------------- ### Search Titles API Source: https://imdbapi.dev/imdbapi Allows searching for titles based on various criteria and returns a list of matching titles. ```APIDOC ## GET /titles ### Description Searches for titles based on provided query parameters and returns a list of matching titles. ### Method GET ### Endpoint /titles ### Parameters #### Query Parameters - **query** (string) - Required - The search query string. - **titleType** (string) - Optional - Filters results by title type (e.g., "movie", "tvSeries"). - **year** (integer) - Optional - Filters results by release year. - **sort** (string) - Optional - Specifies the sorting order for the results (e.g., "ASC", "DESC"). ### Request Example ```json { "example": "/titles?query=Inception&titleType=movie&year=2010" } ``` ### Response #### Success Response (200) - **titles** (array) - List of titles matching the search query. - **id** (string) - The unique identifier for the title. - **type** (string) - The type of the title. - **isAdult** (boolean) - Indicates if the title is intended for adult audiences. - **primaryTitle** (string) - The primary title of the title. - **originalTitle** (string) - The original title of the title. - **primaryImage** (object) - The primary image associated with the title. - **startYear** (integer) - The start year for the title. - **endYear** (integer) - The end year for the title. - **runtimeSeconds** (integer) - The runtime of the title in seconds. #### Response Example ```json { "example": { "titles": [ { "id": "tt1375666", "type": "movie", "isAdult": false, "primaryTitle": "Inception", "originalTitle": "Inception", "primaryImage": { "url": "https://imdb-api.com/images/title/tt1375666.jpg", "width": 1000, "height": 1500 }, "startYear": 2010, "endYear": 0, "runtimeSeconds": 148 } ] } } ``` ``` -------------------------------- ### Episode Data Structure Source: https://imdbapi.dev/imdbapi Defines the structure for an episode, including its ID, title, primary image, season, episode number, runtime, plot, rating, and release date. ```APIDOC ## imdbapiEpisode ### Description Represents an episode within a series, containing details about its title, release, and content. ### Properties - **id** (string) - The unique identifier for the episode. - **title** (string) - The title of the episode. - **primaryImage** (imdbapiImage) - The primary image associated with the episode. - **season** (string) - The season number of the episode. - **episodeNumber** (integer) - The episode number within its season. - **runtimeSeconds** (integer) - The runtime of the episode in seconds. - **plot** (string) - A brief description or plot summary of the episode. - **rating** (imdbapiRating) - The rating information for the episode. - **releaseDate** (imdbapiPrecisionDate) - The release date of the episode. ``` -------------------------------- ### List Title Videos API Source: https://imdbapi.dev/imdbapi Retrieves a list of videos (trailers, clips, etc.) associated with a specific title. Includes pagination support. ```APIDOC ## GET /titles/{title_id}/videos ### Description Retrieves a list of videos, such as trailers, teasers, and clips, associated with a specific title. This endpoint supports pagination for video results. ### Method GET ### Endpoint /titles/{title_id}/videos ### Parameters #### Path Parameters - **title_id** (string) - Required - The unique identifier for the title. #### Query Parameters - **pageToken** (string) - Optional - Token for the next page of results. - **pageSize** (integer) - Optional - The number of results to return per page. ### Request Example ```json { "example": "GET /titles/tt0111161/videos?pageToken=CAUQAA&pageSize=5" } ``` ### Response #### Success Response (200) - **videos** (array) - List of videos associated with the title. - **totalCount** (integer) - Total count of videos associated with the title. - **nextPageToken** (string) - Token for the next page of results, if applicable. #### Response Example ```json { "videos": [ { "id": "vi123456789", "title": "The Shawshank Redemption Official Trailer", "type": "TRAILER" } ], "totalCount": 15, "nextPageToken": "CAUQAA" } ``` ``` -------------------------------- ### List Images for a Title Source: https://imdbapi.dev/imdbapi Retrieve images associated with a specific title, with options to filter by type and paginate. ```APIDOC ## GET /titles/{titleId}/images ### Description Retrieve the images associated with a specific title. ### Method GET ### Endpoint /titles/{titleId}/images ### Parameters #### Path Parameters - **titleId** (string) - Required - IMDb title ID in the format "tt1234567". #### Query Parameters - **types** (array of strings) - Optional - The types of images to filter by. If not specified, all types are returned. - **pageSize** (integer) - Optional - The maximum number of images to return per page. If not specified, a default value will be used. The value must be between 1 and 50. Default is 20. - **pageToken** (string) - Optional - Token for pagination, if applicable. ### Response #### Success Response (200) - **response** (imdbapiListTitleImagesResponse) - A successful response. #### Error Response - **error** (rpcStatus) - An unexpected error response. ``` -------------------------------- ### List Title Episodes API Source: https://imdbapi.dev/imdbapi Retrieves a list of episodes for a given TV show title. Includes pagination support. ```APIDOC ## GET /titles/{title_id}/episodes ### Description Retrieves a list of episodes for a specific TV show title. This endpoint allows you to fetch episode details and supports pagination. ### Method GET ### Endpoint /titles/{title_id}/episodes ### Parameters #### Path Parameters - **title_id** (string) - Required - The unique identifier for the TV show title. #### Query Parameters - **pageToken** (string) - Optional - Token for the next page of results. - **pageSize** (integer) - Optional - The number of results to return per page. ### Request Example ```json { "example": "GET /titles/tt0944947/episodes?pageToken=CAUQAA&pageSize=50" } ``` ### Response #### Success Response (200) - **episodes** (array) - List of episodes associated with the title. - **totalCount** (integer) - The total number of episodes that have aired for this title. - **nextPageToken** (string) - Token for the next page of results, if applicable. #### Response Example ```json { "episodes": [ { "id": "ep0000001", "title": "Winter Is Coming", "seasonNumber": 1, "episodeNumber": 1 } ], "totalCount": 73, "nextPageToken": "CAUQAA" } ``` ```