{ "openapi": "3.0.1", "info": { "title": "Pinterest Scraper With Engagement Analytics", "description": "Scrape Pinterest search results for pins and videos at scale. This actor gathers pin metadata, descriptions, media URLs, and engagement stats from keyword searches. Built for marketers, analysts, and developers needing structured Pinterest search data.", "version": "0.1", "x-build-id": "bnIO7KXhXR1GwV50y" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapio~pinterest-pins-videos-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapio-pinterest-pins-videos-search-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/scrapio~pinterest-pins-videos-search-scraper/runs": { "post": { "operationId": "runs-sync-scrapio-pinterest-pins-videos-search-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/scrapio~pinterest-pins-videos-search-scraper/run-sync": { "post": { "operationId": "run-sync-scrapio-pinterest-pins-videos-search-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": [ "searchTerms" ], "properties": { "searchTerms": { "title": "🔍 Search Terms, Pin / Board / Profile URLs", "type": "array", "description": "Keywords (e.g. \"cat\"), or real Pinterest URLs — a pin (https://www.pinterest.com/pin/12345/), a board (https://www.pinterest.com/user/board-name/), or a profile (https://www.pinterest.com/user/). URLs are routed to the correct endpoint, not turned into a keyword search. Example: [\"cat\", \"https://www.pinterest.com/pin/60376016447291956/\"].", "items": { "type": "string" } }, "maxItems": { "title": "🔢 Maximum Items per Target", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum pins to scrape per input target (keyword/board/profile). A single pin URL always returns 1. Deterministic bookmark paging is used to reach this number without dropping results. Default 50.", "default": 50 }, "filtre": { "title": "📌🎥 Media Filter", "enum": [ "All", "Videos" ], "type": "string", "description": "All = pins + videos. Videos = only video pins.", "default": "All" }, "imageSize": { "title": "🖼️ Primary Image Size", "enum": [ "orig", "736x", "564x", "474x", "236x" ], "type": "string", "description": "Which image variant fills the primary imageUrl field. All variants are always returned in the images object; this only selects the primary. orig = original full resolution.", "default": "orig" }, "videoFormat": { "title": "🎬 Video Variant", "enum": [ "auto", "mp4", "hls" ], "type": "string", "description": "Which video variant fills the primary videoUrl field for video pins. All variants are always returned in videoVariants. auto = prefer direct MP4, then HLS.", "default": "auto" }, "includeCounts": { "title": "💾 Include Save & Comment Counts", "type": "boolean", "description": "Fetch each pin's save (repin) count and comment count. These are NOT in Pinterest's search/board/profile grid data, so enabling this makes ONE extra request per pin (slower + more compute on large runs). A single pin URL always includes counts for free. Default off.", "default": false }, "proxyConfiguration": { "title": "🌐 Proxy Configuration", "type": "object", "description": "Proxy settings. By default no proxy is used; if Pinterest blocks the request the actor falls back to datacenter, then residential proxies automatically." } } }, "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 } } } } } } } } } }