Pinterest Pins & Videos Search
Structured Pinterest data: send queries. Cursor-paginated, 1 credit per successful call.
Overview
Section titled “Overview”Call GET /api/v2/pinterest-pins-videos/ with queries. The results are in data.pins; send data.next_cursor back as cursor to get the next page. 3 optional parameters refine the call (see Parameters).
Request
Section titled “Request”curl -G "https://api.scrapier.io/api/v2/pinterest-pins-videos/" \ -H "X-API-Key: YOUR_API_KEY" \ --data-urlencode "queries=minimalist interior" \ --max-time 210const params = new URLSearchParams({ queries: "minimalist interior" });
const res = await fetch(`https://api.scrapier.io/api/v2/pinterest-pins-videos/?${params}`, { headers: { "X-API-Key": "YOUR_API_KEY" }, signal: AbortSignal.timeout(210_000),});const body = await res.json();if (!res.ok) throw new Error(body.error ?? body.detail ?? `HTTP ${res.status}`);
console.log(body.data.pins);import requests
resp = requests.get( "https://api.scrapier.io/api/v2/pinterest-pins-videos/", headers={"X-API-Key": "YOUR_API_KEY"}, params={"queries": "minimalist interior"}, timeout=210,)body = resp.json()if not resp.ok: raise RuntimeError(body.get("error") or body.get("detail"))
print(body["data"]["pins"])curl -X POST "https://api.scrapier.io/api/v2/pinterest-pins-videos/" \ -H "X-API-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"queries":"minimalist interior"}' \ --max-time 210Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X-API-Key header | string | yes | — | Your API key from the dashboard. |
queries | string | yes | e.g. minimalist interior | Search keyword. Ignored when cursor is supplied (the cursor carries it). |
cursor | string | no | — | Pagination cursor returned in the previous response's next_cursor. Pass it back unchanged to fetch the next page. When next_cursor is null, you have reached the last page. |
filter_type | string | no | All | All (pins) | Videos (Pinterest video search; only rows with a playable link_to_video). AllVideos locked in cursor |
page_size | integer | no | 25 | Minimum NEW pins per page (1-100). Pinterest serves ~25 per request, so a page may return up to ~2x this. locked in cursor |
Advanced
| Name | Type | Default | Description |
|---|---|---|---|
use_proxy | boolean | true | Route the request through Scrapier's residential proxy pool. Default: true. Leave as is unless support tells you otherwise. |
raw_data | boolean | false | When true, the response carries the full raw upstream payload(s) the scraper received (GraphQL / JSON API bodies, HTML, embedded JSON-LD -- exactly as the platform returned them) under raw_responses, in place of the formatted items. When false (default) you get the formatted output. Pagination (cursor / next_cursor) works the same in both modes. |
Response
Section titled “Response”{ "success": true, "data": { "queries": "cooking", "filter_type": "Videos", "page": 1, "page_size": 25, "pins": [ { "node_id": "368661919510059013", "created_at": "Wed, 15 Feb 2023 11:39:08 +0000", "url": "https://i.pinimg.com/236x/d0/9d/c4/d09dc402598f40db1b462150974063d4.jpg", "pinner": { "full_name": "Richa at My Food Story", "username": "my_foodstory", "follower_count": 190705, "image_url": "https://i.pinimg.com/140x140_RS/..." }, "domain": "myfoodstory.com", "reaction_counts": { "1": 7240 }, "width": 236, "height": 419, "image_size": "236x", "dominant_color": "#a86c3f", "link": "https://myfoodstory.com/...", "title": "Easy Butter Chicken", "description": "Restaurant-style butter chicken at home", "link_to_video": "https://v1.pinimg.com/videos/mc/hls/13/20/76/....m3u8", "is_video": true, "keyword": "cooking", "position": 1 } ], "has_more": true, "next_cursor": "pz1.eNrtV..." }}Bad input. The exact message varies by endpoint.
{ "success": false, "error": "…"}Balance below the endpoint’s price.
{ "error": "Insufficient credits. Buy more to scrape more.", "balance": 1, "required": 2}Invalid or unknown API key.
{ "detail": "Authentication service unavailable or invalid API key."}Throttled — wait for Retry-After.
{ "detail": "Request was throttled. Expected available in N seconds."}Sample from the live catalog; arrays trimmed to 3 items. Results are in data.pins.
Response fields
Section titled “Response fields”| Field | Type | Example | Description |
|---|---|---|---|
queries | string | cooking | — |
filter_type | string | Videos | — |
page | integer | 1 | — |
page_size | integer | 25 | — |
pins | array | [1 item] | The results. |
has_more | boolean | true | — |
next_cursor | string | pz1.eNrtV... | Pass back as cursor for the next page. null on the last page. |
pins[].node_id | string | 368661919510059013 | — |
pins[].created_at | string | Wed, 15 Feb 2023 11:39:08 +0000 | — |
pins[].url | string | https://i.pinimg.com/236x/d0/9d/c4/d09dc40259… | — |
pins[].pinner | object | {…} | — |
pins[].domain | string | myfoodstory.com | — |
pins[].reaction_counts | object | {…} | — |
pins[].width | integer | 236 | — |
pins[].height | integer | 419 | — |
pins[].image_size | string | 236x | — |
pins[].dominant_color | string | #a86c3f | — |
pins[].link | string | https://myfoodstory.com/... | — |
pins[].title | string | Easy Butter Chicken | — |
pins[].description | string | Restaurant-style butter chicken at home | — |
pins[].link_to_video | string | https://v1.pinimg.com/videos/mc/hls/13/20/76/… | — |
pins[].is_video | boolean | true | — |
pins[].keyword | string | cooking | — |
pins[].position | integer | 1 | — |
Pagination
Section titled “Pagination”Pass data.next_cursor back as cursor until it is null. Required inputs are ignored once a cursor is sent. Each page is one billed call. More in Pagination.
const url = "https://api.scrapier.io/api/v2/pinterest-pins-videos/";let params = { queries: "minimalist interior" };const items = [];
for (let page = 0; page < 10; page++) { // each page is one billed call const res = await fetch(`${url}?${new URLSearchParams(params)}`, { headers: { "X-API-Key": "YOUR_API_KEY" }, signal: AbortSignal.timeout(210_000), }); const body = await res.json(); if (!res.ok) throw new Error(body.error ?? body.detail ?? `HTTP ${res.status}`); const data = body.data; items.push(...(data.pins ?? [])); if (!data.next_cursor) break; // null = last page params = { cursor: data.next_cursor };}import requests
URL = "https://api.scrapier.io/api/v2/pinterest-pins-videos/"HEADERS = {"X-API-Key": "YOUR_API_KEY"}params = {"queries": "minimalist interior"}items = []
for _ in range(10): # each page is one billed call resp = requests.get(URL, headers=HEADERS, params=params, timeout=210) resp.raise_for_status() data = resp.json()["data"] items.extend(data.get("pins") or []) if not data.get("next_cursor"): # None = last page break params = {"cursor": data["next_cursor"]}Errors
Section titled “Errors”Failed calls are free. Branch on the HTTP status and read the message from error (or detail). Full details in Errors.
| Status | Meaning | Retry? | Charged? |
|---|---|---|---|
400 | Bad or missing input. | No — fix the params | No |
401 / 403 | Missing, invalid or revoked API key. | No — fix the key | No |
402 | Out of credits (body has balance). | No — top up | No |
404 | Unknown endpoint slug. | No — check the slug | No |
429 / 503 | Busy or throttled. | Yes — after Retry-After | No |
5xx | Target site or upstream failure, or timeout. | Yes — with backoff | No |
- Locked into the cursor:
filter_type,page_size. Set them on the first call; later pages reuse them.
Related
Section titled “Related”- Pinterest Boards / Pins — Structured Pinterest data: send
urls. Cursor-paginated, 1 credit per successful call. - Pinterest Search — Structured Pinterest data: send
queries. Cursor-paginated, 1 credit per successful call.