{ "openapi": "3.0.1", "info": { "title": "Pinterest Pins, Boards & Profiles Scraper", "description": "Scrape Pinterest (pinterest.com) pins, videos, boards and profiles from searches, profile, board and pin URLs. Titles, images, outbound links, saves, reactions, creators and boards. Filters and a cache for new pins only. Export JSON, CSV or Excel.", "version": "1.0", "x-build-id": "IVBygWXnq3cJxHjhK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/confidential_gnat~pinterest-pins-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-confidential_gnat-pinterest-pins-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/confidential_gnat~pinterest-pins-scraper/runs": { "post": { "operationId": "runs-sync-confidential_gnat-pinterest-pins-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/confidential_gnat~pinterest-pins-scraper/run-sync": { "post": { "operationId": "run-sync-confidential_gnat-pinterest-pins-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": { "startUrls": { "title": "Pinterest URLs", "type": "array", "description": "Search pages (https://www.pinterest.com/search/pins/?q=living+room, also /search/videos/, /search/boards/ and /search/users/), profiles (https://www.pinterest.com/username/), boards (https://www.pinterest.com/username/board-name/) and single pins (https://www.pinterest.com/pin/1234567890/).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "queries": { "title": "Search keywords", "type": "array", "description": "Search Pinterest for these keywords instead of (or as well as) using URLs. One search per keyword.", "items": { "type": "string" } }, "searchType": { "title": "Search for", "enum": [ "pins", "videos", "boards", "users" ], "type": "string", "description": "What the keyword searches return: pins, video pins, boards or profiles.", "default": "pins" }, "maxItems": { "title": "Max items per URL or keyword", "minimum": 1, "type": "integer", "description": "Maximum records saved for each start URL or keyword. A Pinterest search ends after about 1,000 pins: when you ask for more, the scraper continues with Pinterest's own related searches and removes duplicates.", "default": 5 }, "cacheProjectName": { "title": "Cache project name", "type": "string", "description": "Use the same name on each scheduled run to get only new pins (and pins whose title, description or link changed). Unchanged pins are skipped, not charged and not counted towards Max items. Each record gets changeType: new or updated. Leave empty to turn the cache off." }, "scrapeDetails": { "title": "Scrape pin details", "type": "boolean", "description": "Open each pin of a profile, board or pin URL to also fill comment, share and category fields, hashtags and price. Pins found by search carry no detail page, so their detail fields stay empty.", "default": true }, "minReactions": { "title": "Minimum reactions", "minimum": 0, "type": "integer", "description": "Only keep pins with at least this many reactions. Leave 0 for no limit.", "default": 0 }, "onlyPinsWithLink": { "title": "Only pins with an outbound link", "type": "boolean", "description": "Skip pins that do not link to another website.", "default": false }, "excludePromotedPins": { "title": "Exclude promoted pins", "type": "boolean", "description": "Skip ads (promoted pins).", "default": false }, "linkDomainContains": { "title": "Link domain contains", "type": "string", "description": "Only keep pins whose outbound link contains one of these words, comma separated, for example etsy,amazon." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify datacenter proxy is enough for Pinterest. Switch to residential only if runs are blocked.", "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 } } } } } } } } } }