{ "openapi": "3.0.1", "info": { "title": "Pinterest Scraper Pro: Pins, Boards, Profiles & Comments", "description": "Scrape Pinterest pins, boards, profiles, comments, related pins and keyword suggestions. Engagement and date filters, affiliate-link detection, monitoring mode for new pins, clean CSV-ready output.", "version": "1.0", "x-build-id": "UnoJg8rIR7X4h6JEj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nadeemnk~pinterest-scraper-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nadeemnk-pinterest-scraper-pro", "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/nadeemnk~pinterest-scraper-pro/runs": { "post": { "operationId": "runs-sync-nadeemnk-pinterest-scraper-pro", "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/nadeemnk~pinterest-scraper-pro/run-sync": { "post": { "operationId": "run-sync-nadeemnk-pinterest-scraper-pro", "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": "Pin, board, profile (incl. /_created/ and /_saved/), search, idea-hub (/ideas/topic/123/) or pin.it short links. Mix any of them in one run.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchQueries": { "title": "Search keywords", "type": "array", "description": "One Pinterest search per keyword.", "items": { "type": "string" } }, "searchType": { "title": "Search returns", "enum": [ "pins", "videos", "boards", "profiles" ], "type": "string", "description": "Which Pinterest search tab to scrape for the keywords above.", "default": "pins" }, "usernames": { "title": "Usernames", "type": "array", "description": "Pinterest usernames (with or without @). Same as adding their profile URLs.", "items": { "type": "string" } }, "maxItemsPerSource": { "title": "Max items per URL / keyword / username", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stops each source after this many saved items. Profile and board records do not count toward a source's pin limit.", "default": 100 }, "maxItems": { "title": "Max items in total", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Hard cap for the whole run, across all sources. Protects you from surprise costs.", "default": 1000 }, "profilePins": { "title": "Pins to take from profiles", "enum": [ "created", "saved", "none" ], "type": "string", "description": "For profile URLs and usernames. A /_created/ or /_saved/ URL overrides this.", "default": "created" }, "includeProfileBoards": { "title": "Also list each profile's boards", "type": "boolean", "description": "Saves one board record (name, pin count, followers, created date) per public board of each profile.", "default": false }, "includePinDetails": { "title": "Fetch full pin details (paid add-on)", "type": "boolean", "description": "One extra lookup per pin for exact saves, repins, comment and share counts plus SEO title. Pinterest only allows this for pins with numeric ids (profiles, boards, pin URLs); search results use opaque ids and are skipped. Turned on automatically per pin when a saves/repins/comments filter needs it.", "default": false }, "includeComments": { "title": "Include comments (paid add-on)", "type": "boolean", "description": "Adds a comments array to each pin that has comments.", "default": false }, "maxCommentsPerPin": { "title": "Max comments per pin", "minimum": 1, "maximum": 500, "type": "integer", "description": "Upper limit of top-level comments saved per pin.", "default": 20 }, "includeCommentReplies": { "title": "Include comment replies", "type": "boolean", "description": "Nests replies under each comment (up to 50 per comment). Requires comments.", "default": false }, "includeKeywordSuggestions": { "title": "Keyword suggestions for each search", "type": "boolean", "description": "Saves Pinterest's autocomplete suggestions for every keyword as separate records. Handy for Pinterest SEO.", "default": false }, "minSaves": { "title": "Min saves", "minimum": 0, "type": "integer", "description": "Known for profile and board pins (and pin details). Not available in search results." }, "minRepins": { "title": "Min repins", "minimum": 0, "type": "integer", "description": "Known for profile and board pins (and pin details). Not available in search results." }, "minReactions": { "title": "Min reactions", "minimum": 0, "type": "integer", "description": "Works everywhere, including search results." }, "minComments": { "title": "Min comments", "minimum": 0, "type": "integer", "description": "Known for profile and board pins (and pin details). Not available in search results." }, "minFollowers": { "title": "Min followers", "minimum": 0, "type": "integer", "description": "For pins: the pinner's followers. For profile and board records: their own followers." }, "createdAfter": { "title": "Created after", "type": "string", "description": "A date (2026-01-31) or a relative period (30 days, 6 months)." }, "createdBefore": { "title": "Created before", "type": "string", "description": "A date (2026-06-30) or a relative period (7 days)." }, "mediaType": { "title": "Media type", "enum": [ "any", "image", "video" ], "type": "string", "description": "Keep only image pins or only video pins.", "default": "any" }, "onlyWithLink": { "title": "Only pins with an outbound link", "type": "boolean", "description": "Keep only pins that link to an external website.", "default": false }, "onlyProductPins": { "title": "Only product / shopping pins", "type": "boolean", "description": "Keep only pins with product data (price, tagged products or a product rich pin).", "default": false }, "onlyAffiliatePins": { "title": "Only pins with affiliate links", "type": "boolean", "description": "Keep only pins whose link or tagged products use an affiliate network (Amazon Associates, LTK, Rakuten, CJ, Awin, ShareASale, Impact, Skimlinks and more).", "default": false }, "includeDomains": { "title": "Only these link domains", "type": "array", "description": "e.g. amazon.com, etsy.com. Subdomains match too.", "items": { "type": "string" } }, "excludeDomains": { "title": "Exclude link domains", "type": "array", "description": "Drop pins linking to these domains. Subdomains match too.", "items": { "type": "string" } }, "mustContainKeywords": { "title": "Must contain any of these words", "type": "array", "description": "Matched against title, description, alt text, hashtags and topics.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Exclude pins containing", "type": "array", "description": "Drop pins whose title, description, alt text, hashtags or topics contain any of these words.", "items": { "type": "string" } }, "addContentCategory": { "title": "Add content category", "type": "boolean", "description": "Rule-based category (Home Decor, Food & Drink, Fashion, …) with confidence and matched terms. Free.", "default": true }, "addSentiment": { "title": "Add sentiment", "type": "boolean", "description": "Lexicon-based sentiment of the pin text and of each comment. Free.", "default": false }, "deduplicate": { "title": "Remove duplicate pins", "type": "boolean", "description": "When the same pin is found by several sources, save it once.", "default": true }, "includeRawData": { "title": "Include Pinterest's raw object", "type": "boolean", "description": "Adds the untouched Pinterest JSON under `raw`. Large; for debugging and power users.", "default": false }, "monitorMode": { "title": "Monitoring", "enum": [ "off", "new-only", "new-and-changed" ], "type": "string", "description": "For scheduled runs. The first run saves everything and remembers it; later runs save only new pins, or new pins plus pins whose saves/repins/reactions/comments changed.", "default": "off" }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Give each watch its own name and reuse it on every scheduled run.", "default": "default" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy is used by default. Switch to Residential only for very large runs that get blocked.", "default": { "useApifyProxy": true } }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many requests run in parallel. Keep it low to stay polite and avoid blocks.", "default": 5 }, "maxRequestRetries": { "title": "Max retries per request", "minimum": 0, "maximum": 10, "type": "integer", "description": "How often a failed request is retried with a fresh session before it is given up.", "default": 4 } } }, "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 } } } } } } } } } }