{ "openapi": "3.0.1", "info": { "title": "Pinterest Scraper & Monitor - Pins, Boards, Trends", "description": "Scrape and monitor public Pinterest pins from search, user feeds, boards, and pin URLs. Get images, products, videos, and engagement via fast HTTP.", "version": "1.0", "x-build-id": "IBDYg4QSTj4KFPg9N" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thirdwatch~pinterest-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thirdwatch-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/thirdwatch~pinterest-scraper/runs": { "post": { "operationId": "runs-sync-thirdwatch-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/thirdwatch~pinterest-scraper/run-sync": { "post": { "operationId": "run-sync-thirdwatch-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", "properties": { "searchQueries": { "title": "Search Queries", "type": "array", "description": "List of search terms to find pins for. Examples: 'minimalist bedroom', 'web design inspiration', 'healthy recipes'.", "default": [], "items": { "type": "string" } }, "usernames": { "title": "Pinterest Usernames", "type": "array", "description": "List of Pinterest usernames to scrape pins from. Example: 'pinterest', 'interiordesign'.", "default": [], "items": { "type": "string" } }, "boardUrls": { "title": "Board URLs", "type": "array", "description": "List of Pinterest board URLs to scrape pins from. Example: 'https://www.pinterest.com/username/board-name/'.", "default": [], "items": { "type": "string" } }, "pinUrls": { "title": "Pin URLs", "type": "array", "description": "List of specific Pinterest pin URLs to scrape. Example: 'https://www.pinterest.com/pin/123456789/'.", "default": [], "items": { "type": "string" } }, "includeDetails": { "title": "Include detailed pin data", "type": "boolean", "description": "Fetch each pin's public detail payload for engagement counts, video, Story Pin, product, hashtag, and SEO fields. Uses HTTP only, adds one request per pin, and supports up to 500 results.", "default": false }, "monitorMode": { "title": "Monitoring mode", "enum": [ "off", "new-pins", "engagement-changes" ], "type": "string", "description": "Off returns the current snapshot. New pins emits only pins first seen by this watch. Engagement changes emits new pins plus changes in public save, reaction, repin, comment, or share counts.", "default": "off" }, "monitorStoreName": { "title": "Monitor name (optional)", "maxLength": 100, "type": "string", "description": "Stable name for this watch. Reuse the same name on scheduled runs. If omitted, the Actor derives one from the watched inputs." }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum total number of pins to scrape across all inputs.", "default": 10 } } }, "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 } } } } } } } } } }