{ "openapi": "3.0.1", "info": { "title": "Pinterest Board Scraper — Board Pins & User Boards", "description": "Scrape Pinterest boards from any board URL or username. Board mode returns board metadata plus every pin (deep pagination). User mode lists all boards a profile owns. Cookieless, no login, HTTP-only. PAY_PER_EVENT. MCP/API-ready.", "version": "0.1", "x-build-id": "XmoFY1exfCusim5Ew" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/khadinakbar~pinterest-boards-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-khadinakbar-pinterest-boards-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/khadinakbar~pinterest-boards-scraper/runs": { "post": { "operationId": "runs-sync-khadinakbar-pinterest-boards-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/khadinakbar~pinterest-boards-scraper/run-sync": { "post": { "operationId": "run-sync-khadinakbar-pinterest-boards-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", "properties": { "startUrls": { "title": "Board or profile URLs", "type": "array", "description": "Pinterest URLs to scrape, one per line. A board URL (e.g. 'https://www.pinterest.com/nike/back-to-school/') returns the board plus its pins. A profile URL (e.g. 'https://www.pinterest.com/etsy/') returns every board that user owns. The mode is auto-detected per URL. NOT for individual pin URLs (/pin//) — this scraper works at the board level.", "items": { "type": "string" } }, "usernames": { "title": "Usernames (all their boards)", "type": "array", "description": "Pinterest handles (without the @ or URL), one per line — each resolves to every board that user owns. Use this as a shortcut instead of full profile URLs (e.g. 'etsy' is equivalent to the profile URL 'https://www.pinterest.com/etsy/'). Leave empty if you only use startUrls. NOT a board slug — a slug alone is ambiguous, provide the full board URL in startUrls instead.", "items": { "type": "string" } }, "mode": { "title": "Mode", "enum": [ "auto", "board-pins", "user-boards" ], "type": "string", "description": "Controls how each input is treated. 'auto' (default) detects per URL: board URL -> board pins, profile URL/username -> user boards. 'board-pins' forces every input to be read as a board. 'user-boards' forces every input to be read as a username/profile and lists its boards. Leave on 'auto' unless you are mixing ambiguous inputs.", "default": "auto" }, "maxPinsPerBoard": { "title": "Max pins per board", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Maximum number of pins to return per board in board mode. Up to 50 is served fast and free by Pinterest's widget API; higher values page deeper via the provider fallback. Set to 0 to return only board metadata with no pins. Defaults to 50; hard cap 5000.", "default": 50 }, "maxBoardsPerUser": { "title": "Max boards per user", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of boards to return per user in user-boards mode. Boards are returned newest/most-prominent first as Pinterest orders them on the profile. Defaults to 50; hard cap 500. Does not affect board-pins mode.", "default": 50 }, "includeBoardPins": { "title": "Also scrape pins for each user board", "type": "boolean", "description": "In user-boards mode, when true, also scrape pins for every board found (each board then costs pin charges up to Max pins per board). When false (default), user-boards mode returns only the board directory (metadata), which is faster and cheaper. Has no effect in board-pins mode, where pins are always scraped.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings for profile-page requests. Residential proxies (default) are strongly recommended — Pinterest challenges datacenter IPs on profile pages. The widget and provider endpoints are called directly and are unaffected by this setting.", "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 } } } } } } } } } }