{ "openapi": "3.0.1", "info": { "title": "Pinterest Pins, Profiles, Boards & Idea Topics Scraper", "description": "Collect Pinterest Pins, creator profiles, boards, idea topics, and search results in one actor, with built-in filters for minimum saves, creator followers, verified accounts, shoppable pins, and image-only results.", "version": "1.0", "x-build-id": "12qyg2ZPNYh1aCBuR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nimbryxo-studio~pinterest-pins-profiles-boards-and-idea-topics/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nimbryxo-studio-pinterest-pins-profiles-boards-and-idea-topics", "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/nimbryxo-studio~pinterest-pins-profiles-boards-and-idea-topics/runs": { "post": { "operationId": "runs-sync-nimbryxo-studio-pinterest-pins-profiles-boards-and-idea-topics", "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/nimbryxo-studio~pinterest-pins-profiles-boards-and-idea-topics/run-sync": { "post": { "operationId": "run-sync-nimbryxo-studio-pinterest-pins-profiles-boards-and-idea-topics", "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": "What to collect", "enum": [ "auto", "pinDetail", "comments", "searchPins", "searchVideos", "searchUsers", "searchBoards", "userProfile", "userPins", "userBoards", "boardDetail", "boardPins", "boardSections", "ideas", "search", "relatedPins" ], "type": "string", "description": "Choose the Pinterest use case. Every mode uses public Pinterest data and needs no login.", "default": "searchPins" }, "startUrls": { "title": "Pinterest URLs (auto-detect)", "type": "array", "description": "Mixed public Pinterest links for mode=`auto`. Unambiguous Pin, profile, board, board-section, idea, and search links are routed to the matching collector; unsupported links are skipped.", "items": { "type": "string" }, "default": [] }, "keywords": { "title": "Search words", "type": "array", "description": "Words or phrases for search modes, for example `minimalist kitchen`.", "items": { "type": "string" }, "default": [] }, "pinUrls": { "title": "Pin URLs or IDs", "type": "array", "description": "Public Pinterest Pin links or numeric IDs. Used by mode=`pinDetail` and `comments`. Opaque e1_ IDs from feeds are list-only and cannot be opened directly.", "items": { "type": "string" }, "default": [] }, "usernames": { "title": "Pinterest usernames", "type": "array", "description": "Pinterest usernames, @usernames, or public profile links.", "items": { "type": "string" }, "default": [] }, "boardUrls": { "title": "Board or section URLs", "type": "array", "description": "Public board links, `username/board-name` paths, or a section link such as `https://www.pinterest.com/krity_s/home-decor/mens/`.", "items": { "type": "string" }, "default": [] }, "ideaUrls": { "title": "Idea topic URLs", "type": "array", "description": "Public Pinterest idea-topic links, for example `https://www.pinterest.com/ideas/beauty/935541271955/`.", "items": { "type": "string" }, "default": [] }, "ideaSlugs": { "title": "Idea topic paths", "type": "array", "description": "Idea topic path pairs such as `beauty/935541271955`. Used when `mode=ideas`.", "items": { "type": "string" }, "default": [] }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Maximum rows returned across all supplied inputs.", "default": 50 }, "maxPages": { "title": "Max pages", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Maximum result pages to walk per feed (one page is about 25-50 Pins).", "default": 10 }, "language": { "title": "Language", "enum": [ "en", "es", "fr", "de", "it", "pt", "ja", "ko", "ar", "hi", "id", "th", "vi", "nl", "pl", "tr", "ru", "cs", "da", "el", "fi", "hu", "no", "ro", "sv", "uk", "zh", "bn", "ms", "fil", "bg", "ca", "et", "he", "hr", "lt", "lv", "sk", "sl", "sr" ], "type": "string", "description": "Pinterest UI language. It affects ranked search results and localized labels.", "default": "en" }, "minSaves": { "title": "Minimum saves", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Keep Pins whose published save count is at least N. Pins without a published count pass through as unknown." }, "minCreatorFollowers": { "title": "Minimum creator followers", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Keep Pins whose public creator follower count reaches N. Unknown counts pass through." }, "verifiedOnly": { "title": "Verified accounts only", "type": "boolean", "description": "Keep only rows where Pinterest explicitly reports a verified creator or profile.", "default": false }, "requireOutboundLink": { "title": "Require destination link", "type": "boolean", "description": "For Pin results, keep only Pins with a public destination URL supplied by Pinterest.", "default": false }, "imageOnly": { "title": "Image Pins only", "type": "boolean", "description": "Drop video Pins and keep image Pins only.", "default": false }, "excludeAds": { "title": "Exclude promoted Pins", "type": "boolean", "description": "Drop Pins that Pinterest explicitly marks as promoted or sponsored.", "default": false }, "commerceOnly": { "title": "Shoppable Pins only", "type": "boolean", "description": "Keep only Pins that carry Pinterest product or shopping metadata.", "default": false }, "enrichPinDetails": { "title": "Enrich collection Pins", "type": "boolean", "description": "For `userPins` and `boardPins`, visit each numeric Pin page for detail-only fields. Slower but more complete.", "default": false }, "includeComments": { "title": "Include Pin comments", "type": "boolean", "description": "Add real public comment and activity rows for collected numeric Pins.", "default": false }, "includeIdeaPins": { "title": "Include idea-topic Pins", "type": "boolean", "description": "When mode=`ideas`, also emit the Pins shown on the idea-topic page.", "default": false }, "maxComments": { "title": "Maximum comments per Pin", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Maximum public comment and activity rows per Pin when comments are enabled or mode=`comments`.", "default": 10 }, "proxyConfiguration": { "title": "Optional proxy", "type": "object", "description": "Optional Apify proxy override. The actor automatically falls back to Apify datacenter proxy and direct traffic, so no proxy setup is required." } } }, "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 } } } } } } } } } }