> Documentation index: https://docs.scrapier.io/llms.txt
> Auth: header `X-API-Key: <key>` · Base: https://api.scrapier.io/api/v2 · Synchronous; paginate with `cursor` ← `data.next_cursor`.

# Pinterest Search

Structured Pinterest data: send `queries`. Cursor-paginated, 1 credit per successful call.

`GET|POST https://api.scrapier.io/api/v2/pinterest-search/` · 1 credit per successful call · Cursor-paginated

## Overview

Call `GET /api/v2/pinterest-search/` 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

```bash
curl -G "https://api.scrapier.io/api/v2/pinterest-search/" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "queries=wallpaper" \
  --max-time 210
```

```python
import requests

resp = requests.get(
    "https://api.scrapier.io/api/v2/pinterest-search/",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"queries": "wallpaper"},
    timeout=210,
)
body = resp.json()
if not resp.ok:
    raise RuntimeError(body.get("error") or body.get("detail"))

print(body["data"]["pins"])
```

POST with a JSON body works too (same parameters; the body is merged over the query string).

## Parameters

| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| `X-API-Key` (header) | string | yes | — | Your API key. |
| `queries` | string | yes | e.g. `wallpaper` | 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. |
| `content_filter` | string | no | `all` | 'all' (pins) or 'videos' (Pinterest's video search). Alias: filter. One of: `all`, `videos`. 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. |
| `use_proxy` | boolean | no | `true` | Route the request through Scrapier's residential proxy pool. Default: `true`. Leave as is unless support tells you otherwise. |
| `raw_data` | boolean | no | `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

HTTP 200. Results are in `data.pins`. Sample from the live catalog, arrays trimmed to 3 items.

```json
{
  "success": true,
  "data": {
    "queries": "minimalist tattoo",
    "content_filter": "all",
    "page": 1,
    "page_size": 25,
    "pins": [
      {
        "keyword": "minimalist tattoo",
        "node_id": "22518066882805770",
        "type": "pin",
        "title": "20 Minimalist Tiny Tattoo Ideas",
        "description": "Small fine-line tattoo inspiration",
        "domain": "Uploaded by user",
        "link": "",
        "dominant_color": "#966f58",
        "created_at": "Wed, 09 Sep 2026 02:26:40 +0000",
        "board": {
          "id": "...",
          "url": "/user/board/"
        },
        "reaction_counts": {
          "1": 12
        },
        "native_creator": {},
        "pinner": {
          "id": "...",
          "username": "user",
          "full_name": "User"
        },
        "image_url": "https://i.pinimg.com/originals/00/a8/34/00a83467113a7be09453054a90e5f183.jpg",
        "image_width": 736,
        "image_height": 1104,
        "position": 1
      }
    ],
    "has_more": true,
    "next_cursor": "pz1.eNrtV..."
  }
}
```

## Response fields

| Field | Type | Example | Description |
|---|---|---|---|
| `queries` | string | `minimalist tattoo` |  |
| `content_filter` | string | `all` |  |
| `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[].keyword` | string | `minimalist tattoo` |  |
| `pins[].node_id` | string | `22518066882805770` |  |
| `pins[].type` | string | `pin` |  |
| `pins[].title` | string | `20 Minimalist Tiny Tattoo Ideas` |  |
| `pins[].description` | string | `Small fine-line tattoo inspiration` |  |
| `pins[].domain` | string | `Uploaded by user` |  |
| `pins[].link` | string |  |  |
| `pins[].dominant_color` | string | `#966f58` |  |
| `pins[].created_at` | string | `Wed, 09 Sep 2026 02:26:40 +0000` |  |
| `pins[].board` | object | `{…}` |  |
| `pins[].reaction_counts` | object | `{…}` |  |
| `pins[].native_creator` | object | `{…}` |  |
| `pins[].pinner` | object | `{…}` |  |
| `pins[].image_url` | string | `https://i.pinimg.com/originals/00/a8/34/00a83…` |  |
| `pins[].image_width` | integer | `736` |  |
| `pins[].image_height` | integer | `1104` |  |
| `pins[].position` | integer | `1` |  |

## 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.

```python
import requests

URL = "https://api.scrapier.io/api/v2/pinterest-search/"
HEADERS = {"X-API-Key": "YOUR_API_KEY"}
params = {"queries": "wallpaper"}
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

Failed calls are free. Branch on HTTP status; the message is in `error` (or `detail`). See https://docs.scrapier.io/errors.md

- **400** Bad input. The exact message varies by endpoint. `{"success":false,"error":"…"}`
- **402** Balance below the endpoint's price. `{"error":"Insufficient credits. Buy more to scrape more.","balance":1,"required":2}`
- **403** Invalid or unknown API key. `{"detail":"Authentication service unavailable or invalid API key."}`
- **429** Throttled — wait for Retry-After. `{"detail":"Request was throttled. Expected available in N seconds."}`
- **404** unknown slug · **503** busy (retry after `Retry-After`) · **5xx** upstream failure or timeout (retry with backoff).

## Notes

- Locked into the cursor: `content_filter`, `page_size`. Set them on the first call; later pages reuse them.

## Related

- [Pinterest Boards / Pins](https://docs.scrapier.io/api-reference/pinterest/pinterest-boards.md): Structured Pinterest data: send `urls`. Cursor-paginated, 1 credit per successful call.
- [Pinterest Pins & Videos Search](https://docs.scrapier.io/api-reference/pinterest/pinterest-pins-videos.md): Structured Pinterest data: send `queries`. Cursor-paginated, 1 credit per successful call.
