{ "openapi": "3.0.1", "info": { "title": "Pinterest Search Scraper — Pins, Boards & People", "description": "Search Pinterest by keyword and export pins, video pins, boards or people as clean structured data: images, captions, links, destinations, creators and exact ranking. Every search also returns Pinterest's own scored related search terms, free. Add real save, repin and comment counts on demand.", "version": "0.0", "x-build-id": "iFcU417pMIMhZcQCU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apt_marble~pinterest-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apt_marble-pinterest-search-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/apt_marble~pinterest-search-scraper/runs": { "post": { "operationId": "runs-sync-apt_marble-pinterest-search-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/apt_marble~pinterest-search-scraper/run-sync": { "post": { "operationId": "run-sync-apt_marble-pinterest-search-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": [ "queries" ], "properties": { "queries": { "title": "Search terms", "type": "array", "description": "One or more things to search Pinterest for. Type plain keywords such as \"coffee recipes\", or paste a Pinterest search page address and the term is taken from it. Up to 100 terms per run.", "default": [ "coffee recipes" ], "items": { "type": "string" } }, "scope": { "title": "What to search for", "enum": [ "pins", "videos", "boards", "users" ], "type": "string", "description": "Pinterest keeps four separate public result lists for the same words. Pick the one you want: pins, video pins only, boards, or people.", "default": "pins" }, "maxItemsPerQuery": { "title": "Maximum results per search term", "minimum": 1, "maximum": 2000, "type": "integer", "description": "How many results to collect for each search term before moving on. Pinterest publishes a limited number of public results for any one search, so a very high number simply returns everything Pinterest makes available.", "default": 50 }, "includePromoted": { "title": "Include promoted pins", "type": "boolean", "description": "Pinterest mixes paid placements into search results — on some topics they are close to half the grid. Leave this off to get organic results only. When on, they are kept and flagged with isPromoted, with the advertiser behind each one in promotedBy.", "default": false }, "enrichEngagement": { "title": "Add full engagement metrics", "type": "boolean", "description": "Pinterest's search results do not publish save, repin, share or comment counts. Turn this on to look each pin up individually and add its real figures. This is billed as a separate paid event and makes the run take longer. Applies to pin and video searches only.", "default": false }, "includeRelatedKeywords": { "title": "Include related search terms", "type": "boolean", "description": "Pinterest returns its own scored list of related search terms with every pin and video search. They are attached, at no extra cost, to the top-ranked row for each search term in the relatedKeywords field.", "default": true }, "country": { "title": "Browse from", "enum": [ "us", "gb", "ca", "au", "de", "fr", "es", "it", "nl", "se", "no", "dk", "fi", "pl", "pt", "ie", "ch", "at", "be", "cz", "ro", "gr", "tr", "in", "sg", "jp", "kr", "hk", "br", "mx", "ar", "cl", "co", "za", "ae", "sa", "nz", "il", "ua", "id", "ph", "th", "vn", "my" ], "type": "string", "description": "Pinterest personalises results by location, so the same words can return a different set from a different country. Pick the market you care about and it is kept the same for the whole run.", "default": "us" } } }, "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 } } } } } } } } } }