{ "openapi": "3.0.1", "info": { "title": "Pinterest Scraper — Pins, Boards & Profiles", "description": "Scrape Pinterest pins from keyword search, boards, sections, profiles and pin URLs: images in all sizes, video, outbound link, saves, comments, product price, board and pinner data.", "version": "0.1", "x-build-id": "vThjZs3EXATblxBfd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tortuga~pinterest-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tortuga-pinterest-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/tortuga~pinterest-scraper/runs": { "post": { "operationId": "runs-sync-tortuga-pinterest-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/tortuga~pinterest-scraper/run-sync": { "post": { "operationId": "run-sync-tortuga-pinterest-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", "properties": { "searchTerms": { "title": "Search terms", "type": "array", "description": "Keywords to search on Pinterest, one per line (for example `cottage garden ideas`). Each term returns pins in Pinterest's search order, page after page, up to the limits below.", "items": { "type": "string" } }, "startUrls": { "title": "Pinterest URLs", "type": "array", "description": "Board URLs (`pinterest.com/user/board/`), board section URLs (`/user/board/section/`), profile URLs (`pinterest.com/user/` for the user's pins, `/user/_saved/` for the list of the user's boards), pin URLs (`/pin/123.../` or `pin.it/...` short links) and search URLs (`/search/pins/?q=...`, `/search/videos/?q=...`). Country domains such as pinterest.co.uk or de.pinterest.com work too.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max results", "minimum": 1, "type": "integer", "description": "Stop after this many items (pins, plus board / profile items) are saved in total. Every saved item is one charged result, so this caps the cost.", "default": 100 }, "maxPinsPerSource": { "title": "Max pins per search / board / profile", "minimum": 1, "type": "integer", "description": "Optional cap for each search term or URL, so several sources share the total fairly. Leave empty to take pins until Max results is reached. With monitoring on, this is the window each run looks at (the first N pins of every source; Max results is used when empty)." }, "includeDetails": { "title": "Fetch full pin details", "type": "boolean", "description": "Make one extra request per pin for the full pin page data: comment count, share count, saves for search results, MP4 video URL, hashtags, full description and rich-pin product data. Off: search pins come without save/comment counts (board and profile pins still have saves and repins). Same price per result; the run takes longer.", "default": false }, "includeBoardAndProfileInfo": { "title": "Include board and profile items", "type": "boolean", "description": "For every board or profile URL, also save one item with its metadata (type `board` or `profile`: name, description, followers, pin and board counts, owner, website). Each such item is one charged result.", "default": true }, "includePromotedPins": { "title": "Include promoted pins (ads)", "type": "boolean", "description": "Search results can contain ads. Off (default): promoted pins are skipped and not charged.", "default": false }, "onlyNewOrChanged": { "title": "Only new or changed items", "type": "boolean", "description": "Remember which pins earlier runs of this input returned and output only pins not seen before (new pins on a board, profile or search). Use with a Schedule; pins already returned are skipped before any detail request and are not charged.", "default": false }, "monitoringKey": { "title": "Monitoring key", "type": "string", "description": "Name for this watch, so several schedules on the same search stay separate; defaults to a key derived from the search input" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify datacenter proxy (the default) works: Pinterest's public pages answer it normally. Responses are 15-300 KB (about 8 KB per pin), so proxy traffic stays small. RESIDENTIAL is not needed.", "default": { "useApifyProxy": true } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }