# Pinterest Search Scraper (`dami_studio/pinterest-search-scraper`) Actor Search Pinterest by keyword and get structured pins — image (and video) URLs, title, description, destination link, pinner, board, repins and comment counts. Paginated, residential-proxy friendly, no login. - **URL**: https://apify.com/dami\_studio/pinterest-search-scraper.md - **Developed by:** [Dami's Studio](https://apify.com/dami_studio) (community) - **Categories:** Social media, Integrations, E-commerce - **Stats:** 4 total users, 2 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: 5.00 out of 5 stars ## Pricing $2.50 / 1,000 pin returneds This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Pinterest Search Scraper Search Pinterest by keyword and get clean, structured pins — image and video URLs, title, description, the **destination link** (where the pin actually goes), pinner, board, and repin/comment counts. No login. Pinterest's web API rejects anything that doesn't look like a real browser session with the current app build, which is why naive scrapers just get `Invalid Resource Request`. This actor bootstraps a real session and the live build hash on every run, then paginates cleanly through the results. ### Input | Field | Notes | |---|---| | `query` | Keywords, e.g. `home office setup`, `minimalist tattoo`. | | `maxItems` | Pins to collect; the scraper paginates to reach it. | | `includeVideosOnly` | Only video pins (with the direct video URL). | | `includePromoted` | Include sponsored pins (off by default). | ### Output One row per pin: `title`, `description`, `pinUrl`, `imageUrl`, `isVideo`, `videoUrl`, `link` (destination), `repinCount`, `commentCount`, `createdAt`, `pinnerUsername`, `pinnerName`, `boardName`, `boardUrl`, `dominantColor`. Queries with no matches return a single `note` row and **are not charged**. #### Nullable fields Pinterest does not return every field for every pin, so some fields can be `null` even on otherwise complete rows: - `videoUrl` can be `null` **even when `isVideo` is `true`** — Pinterest's API does not always include the playable video field for a given pin. Such pins are still real video pins; only the direct URL is missing. - `link` (destination), `description`, `repinCount`, `commentCount`, `createdAt`, `boardName`, `boardUrl`, and `dominantColor` may also be `null` when Pinterest omits them for a pin. ### Diagnostics & charging Only genuine pins are charged (pay-per-result). Runs that are blocked, rate-limited, return no results, or are given bad input are **never charged** — instead a single diagnostic row (`ok: false`) is written to the dataset with a clear `errorCode`: - `BAD_INPUT` — no `query` was provided. - `BLOCKED` / `RATE_LIMITED` — Pinterest blocked or throttled the IP; retry with a residential proxy. - `NO_RESULTS` — the query succeeded but matched no pins. - `NETWORK` / `SERVER_ERROR` — a transient connectivity or Pinterest server error; retry later. If you request more pins than you receive, it usually means Pinterest's relevance ranking simply ran out of fresh results for that query (the scraper stops after two consecutive empty pages), or the IP was rate-limited — check for a diagnostic row to tell the two apart. ### Notes A residential proxy is recommended — Pinterest geolocates and rate-limits datacenter IPs. Results follow Pinterest's own relevance ranking for the query. # Actor input Schema ## `query` (type: `string`): Keywords to search Pinterest pins for (e.g. "home office setup", "minimalist tattoo"). ## `maxItems` (type: `integer`): How many pins to collect. The scraper paginates through Pinterest's search results to reach this number. ## `includeVideosOnly` (type: `boolean`): Return only pins that are videos. The direct video URL is included when Pinterest exposes it, but videoUrl may still be null for some video pins where Pinterest's API omits the video field. ## `includePromoted` (type: `boolean`): Include sponsored/promoted pins in the results. Off by default. ## `notionConnector` (type: `string`): Optional. Write each pin as a page into your Notion when the run finishes. Authorize a Notion connector once in Settings → API & Integrations → MCP connectors, then pick it here. Leave empty to skip (default) — results are always saved to the dataset regardless. ## `notionParentId` (type: `string`): Optional. The Notion data source ID of the database to write into (only used if a Notion connector is set). Leave empty to create the pages privately in your workspace instead. ## `proxyConfiguration` (type: `object`): Pinterest geolocates and rate-limits — RESIDENTIAL proxy recommended. ## Actor input object example ```json { "query": "home office setup", "maxItems": 50, "includeVideosOnly": false, "includePromoted": false, "proxyConfiguration": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } ```` # Actor output Schema ## `results` (type: `string`): Scraped rows are stored in the default dataset (one row per result). Blocked/empty/error runs return a single uncharged diagnostic row instead. # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "query": "home office setup" }; // Run the Actor and wait for it to finish const run = await client.actor("dami_studio/pinterest-search-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "query": "home office setup" } # Run the Actor and wait for it to finish run = client.actor("dami_studio/pinterest-search-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "query": "home office setup" }' | apify call dami_studio/pinterest-search-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=dami_studio/pinterest-search-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Pinterest Search Scraper", "description": "Search Pinterest by keyword and get structured pins — image (and video) URLs, title, description, destination link, pinner, board, repins and comment counts. Paginated, residential-proxy friendly, no login.", "version": "0.1", "x-build-id": "nZb0GRqhtJraTj5aV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dami_studio~pinterest-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dami_studio-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/dami_studio~pinterest-search-scraper/runs": { "post": { "operationId": "runs-sync-dami_studio-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/dami_studio~pinterest-search-scraper/run-sync": { "post": { "operationId": "run-sync-dami_studio-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": [ "query" ], "properties": { "query": { "title": "Search query", "type": "string", "description": "Keywords to search Pinterest pins for (e.g. \"home office setup\", \"minimalist tattoo\")." }, "maxItems": { "title": "Max pins", "minimum": 1, "maximum": 2000, "type": "integer", "description": "How many pins to collect. The scraper paginates through Pinterest's search results to reach this number.", "default": 50 }, "includeVideosOnly": { "title": "Video pins only", "type": "boolean", "description": "Return only pins that are videos. The direct video URL is included when Pinterest exposes it, but videoUrl may still be null for some video pins where Pinterest's API omits the video field.", "default": false }, "includePromoted": { "title": "Include promoted (ad) pins", "type": "boolean", "description": "Include sponsored/promoted pins in the results. Off by default.", "default": false }, "notionConnector": { "title": "Notion connector (optional)", "type": "string", "description": "Optional. Write each pin as a page into your Notion when the run finishes. Authorize a Notion connector once in Settings → API & Integrations → MCP connectors, then pick it here. Leave empty to skip (default) — results are always saved to the dataset regardless." }, "notionParentId": { "title": "Notion target data source ID", "type": "string", "description": "Optional. The Notion data source ID of the database to write into (only used if a Notion connector is set). Leave empty to create the pages privately in your workspace instead." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Pinterest geolocates and rate-limits — RESIDENTIAL proxy recommended.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } } ```