{ "openapi": "3.0.1", "info": { "title": "Pinterest Scraper API – Pins, Search, Boards & Profiles", "description": "Scrape public Pinterest Pins, search results, Boards, and Profiles into structured JSON. Extract images, videos, creators, engagement, outbound links, and available product data from keywords, URLs, Pin IDs, pin.it links, or usernames.", "version": "0.1", "x-build-id": "rtKG0BLHsvOrH2Dtu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lance_api~pinterest-scraper-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lance_api-pinterest-scraper-api", "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/lance_api~pinterest-scraper-api/runs": { "post": { "operationId": "runs-sync-lance_api-pinterest-scraper-api", "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/lance_api~pinterest-scraper-api/run-sync": { "post": { "operationId": "run-sync-lance_api-pinterest-scraper-api", "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": { "searchQueries": { "title": "Search queries", "type": "array", "description": "Search Pinterest by one or more keywords. This field starts keyword searches only. Examples: home decor, summer outfits, healthy recipes.", "items": { "type": "string", "minLength": 1 }, "default": [] }, "startUrls": { "title": "Pinterest URLs", "type": "array", "description": "Add Pinterest URLs to scrape. Supported URLs include individual Pins, Boards, Profiles, Pinterest Search result pages, and pin.it short links. For plain usernames, use the Pinterest profiles field below.", "items": { "type": "string", "minLength": 1 }, "default": [] }, "profiles": { "title": "Pinterest profiles", "type": "array", "description": "Enter Pinterest usernames or profile URLs to scrape profile information and profile content. Examples: jfcain, https://www.pinterest.com/jfcain/.", "items": { "type": "string", "minLength": 1 }, "default": [] }, "maxResults": { "title": "Max results per input", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of content results to return for each search, board, or profile input. Profile and board metadata rows do not count toward this limit. For Profiles with Pins and boards selected, the limit applies independently to Pins and Boards.", "default": 20 }, "searchType": { "title": "Search type", "enum": [ "pins", "videos", "boards" ], "type": "string", "description": "Choose what type of Pinterest results to return for keyword searches. Only applies to Search queries. Pinterest Search URLs keep the type from the URL, such as /search/pins/ or /search/videos/.", "default": "pins" }, "profileContent": { "title": "Profile content", "enum": [ "pins", "boards", "pins_and_boards", "profile_only" ], "type": "string", "description": "Choose what content to collect when scraping Pinterest profiles. Only applies to profile inputs, including profile URLs in Pinterest URLs and usernames or profile URLs in Pinterest profiles.", "default": "pins" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional proxy settings for Pinterest requests. Leave disabled unless you need a specific proxy configuration.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }