{ "openapi": "3.0.1", "info": { "title": "Letterboxd Film & Review Scraper", "description": "Letterboxd unofficial API: scrape film ratings, reviews, cast & user watchlists. Export Letterboxd data to CSV/JSON. No login, no public API needed.", "version": "1.0", "x-build-id": "VFqq4q6Qa6kcXu4LG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/logiover~letterboxd-film-review-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-logiover-letterboxd-film-review-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/logiover~letterboxd-film-review-scraper/runs": { "post": { "operationId": "runs-sync-logiover-letterboxd-film-review-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/logiover~letterboxd-film-review-scraper/run-sync": { "post": { "operationId": "run-sync-logiover-letterboxd-film-review-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "mode" ], "properties": { "mode": { "title": "Scrape Mode", "enum": [ "film", "user", "list", "search" ], "type": "string", "description": "What to scrape. 'film' fetches full metadata, ratings and embedded reviews for each film page. 'user' scrapes all films a user has watched along with their personal star ratings. 'list' scrapes all films from a curated Letterboxd list. 'search' finds films matching a keyword and then scrapes their detail pages.", "default": "film" }, "startUrls": { "title": "Letterboxd URLs", "type": "array", "description": "Letterboxd URLs to scrape. Supported formats: film pages (letterboxd.com/film/the-godfather/), user profiles (letterboxd.com/username/), and list pages (letterboxd.com/username/list/listname/). The scraper detects the URL type automatically and routes it to the correct handler.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchQueries": { "title": "Search Keywords", "type": "array", "description": "Film titles or keywords to search for on Letterboxd. Each query fetches the search results page and then visits each matching film's detail page. Used when mode is 'search'. Examples: 'the godfather', 'sci-fi 2020', 'kubrick'.", "items": { "type": "string" } }, "scrapeReviews": { "title": "Scrape Reviews", "type": "boolean", "description": "When enabled, each film's user reviews are saved as their own dataset rows (one review per row) with reviewer name, username, star rating, full review text, like count, spoiler flag, review date and URL. Reviews are collected from the film's dedicated reviews page and paginated up to 'Max Reviews Per Film'.", "default": true }, "fetchFullText": { "title": "Fetch Full Review Text", "type": "boolean", "description": "Letterboxd truncates long reviews with a '…more' link. When enabled, the scraper fetches the complete text for each truncated review. This adds one extra request per long review (slightly higher cost). Disable to keep only the visible preview text.", "default": true }, "maxReviews": { "title": "Max Reviews Per Film", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of reviews to extract per film. The scraper paginates through the film's reviews page (sorted by activity) until it reaches this number or runs out of reviews.", "default": 20 }, "maxFilms": { "title": "Max Films", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum total number of film records to save. Applies to user, list and search modes where many films are discovered through pagination. Does not apply when scraping individual film URLs directly.", "default": 50 }, "proxyConfiguration": { "title": "Proxy Settings", "type": "object", "description": "Proxy settings for all requests to letterboxd.com. Residential proxies are strongly recommended — Letterboxd actively blocks datacenter IPs. Use the RESIDENTIAL proxy group for reliable access.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }