{ "openapi": "3.0.1", "info": { "title": "Pinterest Boards Scraper (Pin Comments & Replies)", "description": "Collect actionable insights from Pinterest boards automatically. This scraper fetches board details, pins, images, videos, and engagement stats. Useful for competitive research, content strategy, and large-scale Pinterest data analysis.", "version": "0.1", "x-build-id": "rnewN4YfEjAki5H1d" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/simpleapi~pinterest-boards-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-simpleapi-pinterest-boards-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/simpleapi~pinterest-boards-scraper/runs": { "post": { "operationId": "runs-sync-simpleapi-pinterest-boards-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/simpleapi~pinterest-boards-scraper/run-sync": { "post": { "operationId": "run-sync-simpleapi-pinterest-boards-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": [ "urls" ], "properties": { "urls": { "title": "🔗 Boards, profiles or pins to read", "type": "array", "description": "Board URLs (https://www.pinterest.com///), profile URLs or bare usernames, and pin URLs or bare pin IDs. One per line. Comment density varies enormously by board — a recipe or product board carries discussion, a mood board usually does not.", "items": { "type": "string" } }, "maxItems": { "title": "📊 Max rows per URL", "minimum": 1, "maximum": 5000, "type": "integer", "description": "How many pin ROWS to return per target (1–5000). With '🗣️ Only pins with comments' on, this counts the pins you KEEP, not the pins opened — so a cap of 20 returns 20 commented pins, however many silent ones had to be opened to find them.", "default": 10 }, "includeComments": { "title": "💬 Fetch the comment thread", "type": "boolean", "description": "Attach the comment thread to each pin row as a nested `comments` array — verbatim text, commenter identity, date, reactions, attached photos, and each comment's own reply count. Turn it off and the actor returns plain pin rows with an empty `comments` array.", "default": true }, "maxCommentsPerPin": { "title": "🔢 Max comments per pin", "minimum": 1, "maximum": 200, "type": "integer", "description": "Comments are read 50 per request. Threads longer than this are cut and the row is flagged `commentsTruncated: true`; `commentCountReported` still shows Pinterest's own total for the thread, so a cut is always visible.", "default": 20 }, "commentedPinsOnly": { "title": "🗣️ Only pins with comments", "type": "boolean", "description": "Drop pins whose thread came back empty, so the export is a reading list rather than a grid. Density is a board property and it is low: measured live, /HGTV/hgtv-dream-home/ kept 10 of 26 pins opened, /officialflawliz/cherry-cola-lips/ kept 0 of 25, and a deep walk of /marthastewart/easy-dinner-recipes/ kept 5 of 400. Ignored when the comment fetch above is off.", "default": true }, "maxPinsScannedPerUrl": { "title": "🔍 Max pins opened per URL", "minimum": 0, "maximum": 20000, "type": "integer", "description": "Ceiling on how many pins are opened while hunting for commented ones. It stops a silent 8,000-pin board from being read end to end. 0 = no ceiling. The log warns when the ceiling, rather than the board, ended the run.", "default": 400 }, "fetchPinDetails": { "title": "🔎 Also fill the pin's creation date and share count", "type": "boolean", "description": "Fills `date` (ISO 8601), `commentCount`, `shareCount` and `pinner.followerCount` on the pin row. These four are null without it. It reuses the SAME closeup request the comment engine already made, so with comments on it is effectively free.", "default": false }, "maxPinDetailFetches": { "title": "🔢 Max pins enriched per run", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Ceiling on the enrichment above, across the whole run. Pins past the ceiling are still returned, with those four fields null. 0 = no ceiling.", "default": 50 }, "includeBoardSections": { "title": "📁 Tag each pin with its board section", "type": "boolean", "description": "Walks the board's sections and stamps `sectionId` / `sectionTitle` / `sectionSlug` onto each pin. Pins that sit outside every section keep a null section — on a 1,200-pin board about 52 genuinely do.", "default": false }, "fetchLinkDetails": { "title": "🌐 Keep the outbound link and domain", "type": "boolean", "description": "Fills `link` / `externalLink` / `domain` with the destination each pin points at. Turn it off to return all three as null.", "default": true }, "proxyConfiguration": { "title": "🛡️ Proxy", "type": "object", "description": "Your own proxy selection is honored exactly as configured — groups, country and custom proxy URLs all reach the fetch layer.", "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 } } } } } } } } } }