{ "openapi": "3.0.1", "info": { "title": "Pinterest Tracker", "description": "A powerful Pinterest Scraper that extracts full pin metadata, product details, pricing, images, engagement stats, pinner info, and board data. Supports deep GraphQL extraction, and user-selectable output fields. Perfect for ecommerce research, trend tracking, and building automation workflows.", "version": "1.0", "x-build-id": "3r2TtkAqQso8sqVSJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vivid.travelogue~pinterest-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vivid.travelogue-pinterest-tracker", "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/vivid.travelogue~pinterest-tracker/runs": { "post": { "operationId": "runs-sync-vivid.travelogue-pinterest-tracker", "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/vivid.travelogue~pinterest-tracker/run-sync": { "post": { "operationId": "run-sync-vivid.travelogue-pinterest-tracker", "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": { "search": { "title": "Search Keyword", "type": "string", "description": "Pinterest search query (e.g., 'interior design', 'minimalist decor'). Leave empty to use only startUrls for direct pin/profile URLs.", "default": "interior design minimalist" }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Direct Pinterest URLs to scrape: specific pins (https://pinterest.com/pin/ID), user profiles (https://pinterest.com/@username), or boards. Leave empty if using search keyword.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max Items to Scrape", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of pin items to extract. The crawler will stop after reaching this limit. Set to 0 for unlimited (not recommended).", "default": 5 }, "maxScrollsPerPage": { "title": "Max Scrolls Per Page", "minimum": 1, "maximum": 30, "type": "integer", "description": "Number of page scrolls per search/board/profile page to load additional pins. Higher values may find more pins but take longer and consume more resources.", "default": 6 }, "cookiesString": { "title": "Cookies String (Optional)", "type": "string", "description": "Pre-exported Pinterest session cookies (semicolon-separated, e.g., 'csrftoken=...; _pinterest_sess=...'). If provided, password login is skipped. Falls back to PINTEREST_COOKIES env variable.", "default": "" }, "cookies": { "title": "Cookies Array (Optional)", "type": "array", "description": "Structured cookie objects with name, value, domain, path, secure flags. Useful for programmatic cookie injection. Overrides cookiesString if both provided.", "default": [] }, "cookieDomain": { "title": "Cookie Domain", "type": "string", "description": "Domain for injected cookies (typically '.pinterest.com' or regional variants like '.au.pinterest.com'). Used when parsing cookiesString.", "default": ".pinterest.com" }, "downloadImages": { "title": "Download Pin Images", "type": "boolean", "description": "Download primary image for each scraped pin and store in local/cloud storage. Enables offline access but increases storage/bandwidth usage.", "default": false }, "imagesDirectory": { "title": "Images Directory Path", "type": "string", "description": "Relative path to save downloaded images (used if downloadImages=true). Will be created if not exists.", "default": "images" }, "n8n": { "title": "n8n Export Format", "type": "boolean", "description": "Output results in n8n workflow-compatible format (wraps items in 'items' array). Enables direct n8n webhook integration.", "default": false }, "useApifyProxy": { "title": "Use Apify Residential Proxy", "type": "boolean", "description": "Route requests through Apify's rotating residential proxy pool to avoid IP blocks and improve success rate. Requires Apify account with proxy credits.", "default": true }, "apifyProxyCountry": { "title": "Proxy Country", "enum": [ "US", "UK", "IN", "AU", "CA", "DE", "FR", "IT", "ES", "JP", "BR", "MX", "SG", "NL", "AE", "SA", "SE", "PL", "TR", "EG" ], "type": "string", "description": "Preferred country for residential proxy IPs (impacts Pinterest content and geo-restrictions). Common options: US, UK, AU, DE, BR.", "default": "US" }, "headless": { "title": "Headless Browser Mode", "type": "boolean", "description": "Run Playwright browser in headless mode (no GUI). Recommended for production/cloud environments. Disable for debugging.", "default": true }, "outputFields": { "title": "Raw Filter", "type": "array", "description": "Specify which raw fields to extract from Instagram's internal JSON. Example: [\"like_count\", \"pinner\", \"owner\", \"owner.username\"].", "default": [ "*" ] } } }, "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 } } } } } } } } } }