Images
Query the images associated with a specific collection.
This method returns the backdrop and poster images associated with a specific collection. It can be used to retrieve all the images for a collection.
async images(params: CollectionImagesParams): Promise<CollectionImages>TMDB Reference: Collection Images
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
collection_id | number | ✅ | TMDB collection identifier. |
language | Language | ❌ | Language for localized results. Defaults to en-US. |
include_image_language | (Language | "null")[] | ❌ | Languages to include images for. Pass an array (e.g., ["en", "null"]). Use "null" to include untagged images. |
If you have a language specified, it will act as a filter on the returned items. You can use the include_image_language param to query additional languages.
Returns
A CollectionImages object containing
the images of the specified collection.
Example
import { TMDB } from "@lorenzopant/tmdb";
const tmdb = new TMDB("your-api-key");
const collection = await tmdb.collections.images({
collection_id: 10,
language: "en-US",
include_image_language: ["en", "null"],
}); // Star Wars Collection Images