{ "openapi": "3.0.1", "info": { "title": "Pinterest Scraper API", "description": "Collect public Pinterest pins with image/video links, source websites and available save counts. Restricted boards use a public preview of up to 50 pins. Keyword and profile feeds depend on public availability. $1.25/1,000 saved pins, no start fee. Maintained by CleanScrape.", "version": "0.1", "x-build-id": "cI6nJ7XbXpULrpkDN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cleanscrape~pinterest-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cleanscrape-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/cleanscrape~pinterest-scraper/runs": { "post": { "operationId": "runs-sync-cleanscrape-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/cleanscrape~pinterest-scraper/run-sync": { "post": { "operationId": "run-sync-cleanscrape-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": "Optional topics, one per line. Search pins come with their image, text, destination website, pinner and board, but no pin link: Pinterest hides pin links in logged-out search. A Pinterest link typed here is collected as a link.", "items": { "type": "string" } }, "pinterestUrls": { "title": "Pinterest links or accounts", "type": "array", "description": "Replace the example with your public board or pin link. Profile links and @account names also work when their feed is available. Some boards expose only a preview of up to 50 pins.", "items": { "type": "string" } }, "maxPins": { "title": "Maximum pins", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Total across all searches and links. Fewer may be available.", "default": 100 }, "searchMatching": { "title": "Search matching", "enum": [ "pinterest", "allWords", "exactPhrase" ], "type": "string", "description": "Pinterest's own results can include loosely related pins. A stricter choice keeps only pins whose text contains your words.", "default": "pinterest" }, "includeAny": { "title": "Must contain any of", "type": "array", "description": "Keep pins whose title, description or image text contains at least one of these words or phrases.", "items": { "type": "string" } }, "excludeAny": { "title": "Leave out pins containing", "type": "array", "description": "Leave out pins whose title, description or image text contains any of these.", "items": { "type": "string" } }, "mediaType": { "title": "Media type", "enum": [ "all", "image", "video" ], "type": "string", "description": "Images, videos or both. Video links are included when Pinterest provides them.", "default": "all" }, "dateRange": { "title": "Pin created", "enum": [ "any", "7days", "30days", "90days" ], "type": "string", "description": "When the pin was first created, not when it was saved to a board. Pins without a date are left out when this is set.", "default": "any" }, "includeDetails": { "title": "More pin details", "type": "boolean", "description": "Looks up each pin's creation date and its save and comment counts. Slower, with no extra charge.", "default": false }, "maxPinsToScan": { "title": "Scan limit (optional)", "minimum": 1, "maximum": 20000, "type": "integer", "description": "How many pins to look through at most, including ones your filters leave out. Default: five times Maximum pins, at least 500." }, "connection": { "title": "Connection", "enum": [ "automatic", "direct", "residential" ], "type": "string", "description": "Leave this as it is. The connection cost is included in the pin price.", "default": "automatic" } } }, "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 } } } } } } } } } }