{ "openapi": "3.0.1", "info": { "title": "Pinterest Pins, Profiles and Boards Collector with Filters", "description": "Collect public Pinterest Pins, profiles, boards, search results and comments by keyword or URL, with filters for saves, creator followers, verification, ads and shoppable Pins.", "version": "1.1", "x-build-id": "6EBR67S9mHDk9t96v" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vexaloom-labs~pinterest-pins-profiles-and-boards-collector/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vexaloom-labs-pinterest-pins-profiles-and-boards-collector", "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/vexaloom-labs~pinterest-pins-profiles-and-boards-collector/runs": { "post": { "operationId": "runs-sync-vexaloom-labs-pinterest-pins-profiles-and-boards-collector", "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/vexaloom-labs~pinterest-pins-profiles-and-boards-collector/run-sync": { "post": { "operationId": "run-sync-vexaloom-labs-pinterest-pins-profiles-and-boards-collector", "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": { "mode": { "title": "What to collect", "enum": [ "auto", "pinDetail", "comments", "searchPins", "searchVideos", "searchUsers", "searchBoards", "userProfile", "userPins", "userBoards", "boardDetail", "boardPins", "boardSections", "ideas" ], "type": "string", "description": "Choose a collection type. Auto-detect accepts mixed public Pinterest Pin, profile, board, board-section, search and idea links.", "default": "auto" }, "keywords": { "title": "Search words", "type": "array", "description": "One or more words or phrases for the search modes.", "items": { "type": "string" }, "default": [] }, "pinUrls": { "title": "Pin URLs or IDs", "type": "array", "description": "Public Pin links, numeric Pin IDs, or opaque feed IDs. Opaque IDs are kept as list rows without a detail page.", "items": { "type": "string" }, "default": [] }, "usernames": { "title": "Pinterest usernames", "type": "array", "description": "Usernames, @usernames, or public profile links.", "items": { "type": "string" }, "default": [] }, "boardUrls": { "title": "Board or section URLs", "type": "array", "description": "Public board links or username/board paths. A three-part board-section link is routed to that section's Pins.", "items": { "type": "string" }, "default": [] }, "ideaUrls": { "title": "Idea topic URLs", "type": "array", "description": "Public idea-topic links such as /ideas/beauty/935541271955/. Pinterest exposes a list-only feed capped at about 17 Pins.", "items": { "type": "string" }, "default": [] }, "startUrls": { "title": "Mixed Pinterest URLs", "type": "array", "description": "Pin, profile, board, board-section, search and idea links for Auto-detect.", "items": { "type": "string" }, "default": [] }, "maxItems": { "title": "Maximum records", "minimum": 0, "maximum": 20000, "type": "integer", "description": "Maximum number of emitted records, including comment and section rows. Set to 0 for no user cap.", "default": 50 }, "maxPages": { "title": "Maximum pages", "minimum": 0, "maximum": 2000, "type": "integer", "description": "Maximum feed pages per search, profile, or board. 0 follows Pinterest's cursors until the source ends.", "default": 0 }, "minSaves": { "title": "Minimum saves", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "0 means no minimum. For a positive value, keep only Pins where Pinterest supplies a numeric save count at or above it.", "default": 0 }, "minCreatorFollowers": { "title": "Minimum creator followers", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "0 means no minimum. Keep Pins only when Pinterest supplies a creator follower count at or above this value.", "default": 0 }, "verifiedOnly": { "title": "Verified accounts only", "type": "boolean", "description": "Keep only rows that Pinterest explicitly marks as verified.", "default": false }, "requireOutboundLink": { "title": "Require destination link", "type": "boolean", "description": "Keep only Pins with a public destination link supplied by Pinterest.", "default": false }, "imageOnly": { "title": "Images only", "type": "boolean", "description": "Exclude Pins that Pinterest identifies as video.", "default": false }, "excludeAds": { "title": "Exclude promoted Pins", "type": "boolean", "description": "Exclude Pins that Pinterest marks as promoted or sponsored.", "default": false }, "commerceOnly": { "title": "Shoppable Pins only", "type": "boolean", "description": "Keep only Pins with source-backed product, price, or shopping metadata.", "default": false }, "includeComments": { "title": "Include Pin comments", "type": "boolean", "description": "Add one real public comment row per collected numeric Pin. Comment rows count toward Maximum records.", "default": false }, "maxComments": { "title": "Maximum comments per Pin", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Maximum public comment rows to add per Pin when comments are enabled.", "default": 10 }, "enrichDetails": { "title": "Enrich Pin details", "type": "boolean", "description": "Check each collection Pin's public detail page for more accurate creator, engagement, link, and media fields. Slower and uses more requests.", "default": false }, "resolveNumericIds": { "title": "Recover numeric creator Pin IDs", "type": "boolean", "description": "When a creator feed contains only opaque IDs, read the creator's public RSS feed to recover openable numeric Pin IDs.", "default": true }, "proxyConfiguration": { "title": "Optional proxy configuration", "type": "object", "description": "Leave empty for direct-first collection with the actor's automatic fallback. A supplied proxy is used only after a direct empty or blocked response." } } }, "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 } } } } } } } } } }