{ "openapi": "3.0.1", "info": { "title": "Pinterest Scraper", "description": "Fast and cost-effective Pinterest scraper to extract pins, boards, user profiles, search results, comments, images, videos, and comprehensive engagement metrics. Perfect for social media analytics, competitor research, and content strategy.", "version": "0.0", "x-build-id": "icGwP4jHsBrLhud3x" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/happitap~pinterest-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-happitap-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/happitap~pinterest-scraper/runs": { "post": { "operationId": "runs-sync-happitap-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/happitap~pinterest-scraper/run-sync": { "post": { "operationId": "run-sync-happitap-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": [ "proxyConfiguration" ], "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "List of Pinterest URLs to scrape. Supports: pin details, user profiles, boards, ideas, collections, and search results. Format: Array of URL objects. Example: [{'url': 'https://www.pinterest.com/pin/123456789/'}]. Why needed: Defines what content to extract from Pinterest.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "search": { "title": "Search Query", "type": "string", "description": "Keyword to search on Pinterest. Searches across pins, boards, and users. Format: String (e.g., 'home decor', 'fashion ideas'). Why needed: Enables searching Pinterest for specific topics or keywords. Leave empty if using startUrls only." }, "maxItems": { "title": "Max Items", "minimum": 0, "type": "integer", "description": "Maximum number of items to scrape. Limits total pins, boards, or profiles extracted. Format: Number (e.g., 100, 500). Why needed: Controls scraping volume and costs. Set to 0 for unlimited scraping.", "default": 100 }, "endPage": { "title": "End Page", "minimum": 0, "type": "integer", "description": "Maximum number of pages to scrape per URL or search query. Each page typically contains 20-50 items. Format: Number (e.g., 1, 5, 10). Why needed: Controls pagination depth. Set to 0 for infinite scrolling until maxItems is reached.", "default": 5 }, "includeComments": { "title": "Include Comments", "type": "boolean", "description": "Extract all comments from pins. Increases scraping time and resource usage proportionally to comment count. Format: Boolean (true/false). Why needed: Provides engagement data and user feedback on pins. Disable for faster scraping.", "default": false }, "includeUserInfoOnly": { "title": "User Info Only", "type": "boolean", "description": "Extract only user profile information without pins or boards. Faster and uses fewer resources. Format: Boolean (true/false). Why needed: Useful for building user databases or follower lists without content details.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings to avoid IP blocking. Pinterest requires proxies for reliable scraping. Residential proxies recommended for best results. Format: Proxy configuration object. Why needed: Pinterest blocks direct scraping; proxies ensure successful data extraction.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "extendOutputFunction": { "title": "Extend Output Function", "type": "string", "description": "Custom JavaScript function to extend or modify scraped data. Function receives the data object and should return modified object. Format: JavaScript function as string. Example: '(data) => { data.custom = 'value'; return data; }'. Why needed: Allows custom data transformations and calculations." }, "customMapFunction": { "title": "Custom Map Function", "type": "string", "description": "Custom JavaScript function to transform each item before saving. Function receives item object and should return transformed object. Format: JavaScript function as string. Why needed: Enables custom filtering, formatting, or enrichment of scraped data." } } }, "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 } } } } } } } } } }