{ "openapi": "3.0.1", "info": { "title": "Pinterest Scraper: Ideas, Pins & Monitoring", "description": "Scrape Pinterest pins, Ideas feeds, topics, profiles, boards, sections, comments and product data. Find creators, filter results, and monitor new pins or engagement changes—no login required.", "version": "0.0", "x-build-id": "o9hTMqc6H6FAH2ikd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapingmonkey~pinterest-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapingmonkey-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/scrapingmonkey~pinterest-scraper/runs": { "post": { "operationId": "runs-sync-scrapingmonkey-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/scrapingmonkey~pinterest-scraper/run-sync": { "post": { "operationId": "run-sync-scrapingmonkey-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "auto", "ideas", "pinDetails", "profile", "board", "comments", "relatedPins" ], "type": "string", "description": "Choose one source type or Auto for a mixed URL list.", "default": "search" }, "searchTerms": { "title": "Search terms", "minItems": 1, "maxItems": 100, "type": "array", "description": "Keywords or phrases for Search mode. Every term is paginated independently.", "items": { "type": "string" }, "default": [ "modern kitchen" ] }, "searchType": { "title": "Search result type", "enum": [ "pins", "videos", "boards", "profiles" ], "type": "string", "description": "Return pins, video pins, boards, or public profiles.", "default": "pins" }, "startUrls": { "title": "Mixed Pinterest URLs", "minItems": 1, "maxItems": 100, "type": "array", "description": "For Auto mode: mix Pin, profile, board, search, /ideas/, and /ideas/topic/id/ URLs in one run.", "items": { "type": "string" }, "default": [ "https://www.pinterest.com/ideas/", "https://www.pinterest.com/pinterest/" ] }, "ideasUrls": { "title": "Ideas URLs", "minItems": 1, "maxItems": 100, "type": "array", "description": "The main https://www.pinterest.com/ideas/ feed or topic URLs such as /ideas/beauty/935541271955/.", "items": { "type": "string" }, "default": [ "https://www.pinterest.com/ideas/" ] }, "pinIds": { "title": "Pin IDs or URLs", "minItems": 1, "maxItems": 100, "type": "array", "description": "Numeric Pin IDs or pinterest.com/pin/ID/ URLs for Pin details, Comments, and Related pins modes.", "items": { "type": "string" }, "default": [ "1020909809261285009" ] }, "profiles": { "title": "Profiles", "minItems": 1, "maxItems": 100, "type": "array", "description": "Pinterest usernames, @usernames, or public profile URLs.", "items": { "type": "string" }, "default": [ "pinterest" ] }, "boardUrls": { "title": "Board URLs", "minItems": 1, "maxItems": 100, "type": "array", "description": "Public Pinterest board URLs in /username/board-slug/ format.", "items": { "type": "string" }, "default": [ "https://www.pinterest.com/pinterest/official-news/" ] }, "maxResults": { "title": "Results per source", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum feed rows per search term, profile, board, section, source pin, Ideas feed, or Ideas topic.", "default": 50 }, "maxItems": { "title": "Global primary result limit", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Stop after this many filtered primary records across all inputs. Use 0 for unlimited. Optional creator-lead and analytics rows are additional.", "default": 0 }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Number of independent inputs and pin-detail enrichments processed in parallel. Lower this if a target is unusually sensitive.", "default": 5 }, "country": { "title": "Proxy country", "minLength": 2, "maxLength": 2, "type": "string", "description": "Two-letter country for the mandatory Apify Residential Proxy, such as US, DE, or PH.", "default": "US" }, "language": { "title": "Language", "type": "string", "description": "Pinterest request language or locale, such as en, de, pt-BR, or zh-CN.", "default": "en" }, "includePinDetails": { "title": "Enrich pin details", "type": "boolean", "description": "Fetch every feed pin's detail resource for richer commerce, media, creator, and metadata fields.", "default": false }, "includeComments": { "title": "Include comments with pin details", "type": "boolean", "description": "In Pin details and Auto Pin processing, also return public comments and Tried It responses.", "default": false }, "maxComments": { "title": "Maximum comments", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum Comment and Tried It rows per pin.", "default": 100 }, "includePins": { "title": "Include pins", "type": "boolean", "description": "Include created pins in Profile mode and sectionless board pins in Board mode.", "default": true }, "includeBoards": { "title": "Include profile boards", "type": "boolean", "description": "Include boards owned by requested profiles.", "default": true }, "includeSections": { "title": "Include board sections", "type": "boolean", "description": "Return detailed section records for requested boards.", "default": true }, "includeSectionPins": { "title": "Include section pins", "type": "boolean", "description": "Also paginate pins inside every section of each requested board.", "default": false }, "includeTopicMetadata": { "title": "Include Ideas topic metadata", "type": "boolean", "description": "For topic URLs, add one complete ideaTopic record before the topic pins.", "default": true }, "includeCreatorLeads": { "title": "Generate creator leads", "type": "boolean", "description": "Add deduplicated creatorLead rows with public profile, website, verification, follower, Instagram, and lead-score fields.", "default": false }, "includeAnalytics": { "title": "Add analytics summary", "type": "boolean", "description": "Add one analytics row with counts, saves, prices, currencies, domains, hashtags, creators, and source breakdowns.", "default": false }, "deduplicate": { "title": "Deduplicate results", "type": "boolean", "description": "Keep one record per Pinterest entity even when the same entity appears in multiple inputs.", "default": true }, "minSaves": { "title": "Minimum saves", "minimum": 0, "type": "number", "description": "Keep pins with at least this many saves. Leave empty to disable." }, "minFollowers": { "title": "Minimum creator followers", "minimum": 0, "type": "number", "description": "Keep pins, profiles, boards, and creator leads meeting this follower threshold." }, "domainFilter": { "title": "Destination domains", "type": "string", "description": "Comma-separated destination domains, for example etsy.com,example.com. Subdomains are included." }, "createdAfter": { "title": "Created after", "type": "string", "description": "Keep pins created on or after this ISO date or timestamp." }, "createdBefore": { "title": "Created before", "type": "string", "description": "Keep pins created on or before this ISO date or timestamp." }, "pinType": { "title": "Pin type filter", "enum": [ "all", "image", "video", "product", "story" ], "type": "string", "description": "Keep all pins or only image, video, product, or story pins.", "default": "all" }, "minPrice": { "title": "Minimum product price", "minimum": 0, "type": "number", "description": "Keep pins with a parsed price at or above this value." }, "maxPrice": { "title": "Maximum product price", "minimum": 0, "type": "number", "description": "Keep pins with a parsed price at or below this value." }, "currency": { "title": "Product currency", "type": "string", "description": "Keep prices in one currency code, such as USD or EUR." }, "verifiedMerchantsOnly": { "title": "Verified merchants only", "type": "boolean", "description": "Keep pins and creator records connected to verified merchants.", "default": false }, "monitorMode": { "title": "Monitoring", "enum": [ "off", "newPins", "engagementChanges" ], "type": "string", "description": "Emit every matching row, only newly discovered pins, or new pins plus engagement/commerce changes.", "default": "off" }, "monitorKey": { "title": "Monitor key", "type": "string", "description": "Stable name that identifies this monitor across scheduled Actor runs.", "default": "pinterest-monitor" } } }, "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 } } } } } } } } } }