{ "openapi": "3.0.1", "info": { "title": "Pinterest Pin, Board & Profile Scraper", "description": "Scrape Pinterest pins, boards, and user profiles via the internal Pinterest API. Supports search (pins/boards), board feed, and user profile modes. Extracts full pin details including image URLs, save counts, rich pin data, hashtags, pinner info, and more. Includes analytics: top domains, trendin...", "version": "1.0", "x-build-id": "jBzU8ncKaaTEvuXgv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/brilliant_gum~pinterest-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-brilliant_gum-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/brilliant_gum~pinterest-scraper/runs": { "post": { "operationId": "runs-sync-brilliant_gum-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/brilliant_gum~pinterest-scraper/run-sync": { "post": { "operationId": "run-sync-brilliant_gum-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": "Scraping Mode", "enum": [ "search_pins", "search_boards", "user_profile" ], "type": "string", "description": "Choose what to scrape.\n• search_pins — keyword search for pins\n• search_boards — keyword search for boards\n• user_profile — boards and pins from specific Pinterest usernames", "default": "search_pins" }, "queries": { "title": "Search Queries", "type": "array", "description": "Search keywords for 'search_pins' and 'search_boards' modes. Each query runs independently.", "items": { "type": "string" }, "default": [] }, "usernames": { "title": "Pinterest Usernames", "type": "array", "description": "Pinterest usernames for 'user_profile' mode. Do not include '@'. Example: [\"nasa\", \"nike\"]", "items": { "type": "string" }, "default": [] }, "maxItems": { "title": "Max Items Per Query / Username", "minimum": 0, "maximum": 50000, "type": "integer", "description": "Maximum number of pins (or boards) to collect per query or username. 0 means no limit.", "default": 100 }, "minSaves": { "title": "Minimum Saves (Repins)", "minimum": 0, "type": "integer", "description": "Only include pins with at least this many saves. Leave at 0 for no filter.", "default": 0 }, "filterByDomain": { "title": "Filter by Source Domain", "type": "string", "description": "Only include pins whose original link comes from this domain. Useful for brand monitoring. Example: \"apple.com\" or \"nytimes.com\"" }, "includeVideo": { "title": "Include Video Pins", "type": "boolean", "description": "When false, video pins are skipped. When true (default), video pins are included with their video URL extracted.", "default": true }, "dateFrom": { "title": "Created After (ISO Date)", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only include pins created on or after this date. Format: YYYY-MM-DD. Example: \"2024-01-01\"" }, "sortBy": { "title": "Sort Results By", "enum": [ "relevance", "recent", "popular" ], "type": "string", "description": "Sort order for search results. 'relevance' is Pinterest's default ranking. Only applies to search modes.", "default": "relevance" }, "includeAnalytics": { "title": "Include Analytics Summary", "type": "boolean", "description": "After scraping, compute and push an analytics record: top domains, saves distribution, category distribution, trending hashtags, and dominant color analysis across pin images.", "default": true }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Apify proxy settings. Residential proxies are strongly recommended for reliable Pinterest access.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }