> 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 Boards / Pins

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

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

## Overview

Call `GET /api/v2/pinterest-boards/` with `urls`. The results are in `data.pins`; send `data.next_cursor` back as `cursor` to get the next page. 1 optional parameter refines the call (see Parameters).

## Request

```bash
curl -G "https://api.scrapier.io/api/v2/pinterest-boards/" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "urls=https://www.pinterest.com/officialflawliz/cherry-cola-lips/" \
  --max-time 210
```

```python
import requests

resp = requests.get(
    "https://api.scrapier.io/api/v2/pinterest-boards/",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"urls": "https://www.pinterest.com/officialflawliz/cherry-cola-lips/"},
    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. |
| `urls` | string | yes | e.g. `https://www.pinterest.com/officialflawliz/cherry-cola-lips/` | Pinterest pin or board URL. |
| `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. |
| `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": {
    "urls": "https://www.pinterest.com/officialflawliz/cherry-cola-lips/",
    "page": 1,
    "page_size": 50,
    "pins": [
      {
        "imageUrl": "https://i.pinimg.com/originals/aa/bb/cc/aabbcc.jpg",
        "description": "Cherry cola lips makeup look",
        "title": "Cherry Cola Lips",
        "pinUrl": "https://www.pinterest.com/pin/1125968710103999/",
        "externalLink": "https://example.com/cherry-cola-lip-combo",
        "repins": 1520,
        "date": "2026-09-28",
        "boardName": "cherry cola lips",
        "user": "officialflawliz",
        "index": 1,
        "boardDescription": "Cherry cola lip combos and inspo",
        "boardUrl": "https://www.pinterest.com/officialflawliz/cherry-cola-lips/",
        "totalPins": 128,
        "input_url": "https://www.pinterest.com/officialflawliz/cherry-cola-lips/",
        "scrapedAt": "2026-10-06"
      }
    ],
    "next_cursor": "eyJoIjoiYWJjMTIzZGVmIiwiaSI6Imh0dHBzOi8vd3d3LnBpbnRlcmVzdC5jb20vLi4uIiwicCI6MiwibGsiOnt9fQ"
  }
}
```

## Response fields

| Field | Type | Example | Description |
|---|---|---|---|
| `urls` | string | `https://www.pinterest.com/officialflawliz/che…` |  |
| `page` | integer | `1` |  |
| `page_size` | integer | `50` |  |
| `pins` | array | `[1 item]` | The results. |
| `next_cursor` | string | `eyJoIjoiYWJjMTIzZGVmIiwiaSI6Imh0dHBzOi8vd3d3L…` | Pass back as `cursor` for the next page. `null` on the last page. |
| `pins[].imageUrl` | string | `https://i.pinimg.com/originals/aa/bb/cc/aabbc…` |  |
| `pins[].description` | string | `Cherry cola lips makeup look` |  |
| `pins[].title` | string | `Cherry Cola Lips` |  |
| `pins[].pinUrl` | string | `https://www.pinterest.com/pin/1125968710103999/` |  |
| `pins[].externalLink` | string | `https://example.com/cherry-cola-lip-combo` |  |
| `pins[].repins` | integer | `1520` |  |
| `pins[].date` | string | `2026-09-28` |  |
| `pins[].boardName` | string | `cherry cola lips` |  |
| `pins[].user` | string | `officialflawliz` |  |
| `pins[].index` | integer | `1` |  |
| `pins[].boardDescription` | string | `Cherry cola lip combos and inspo` |  |
| `pins[].boardUrl` | string | `https://www.pinterest.com/officialflawliz/che…` |  |
| `pins[].totalPins` | integer | `128` |  |
| `pins[].input_url` | string | `https://www.pinterest.com/officialflawliz/che…` |  |
| `pins[].scrapedAt` | string | `2026-10-06` |  |

## 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-boards/"
HEADERS = {"X-API-Key": "YOUR_API_KEY"}
params = {"urls": "https://www.pinterest.com/officialflawliz/cherry-cola-lips/"}
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

- Nothing special: send the inputs, read the result.

## Related

- [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.
- [Pinterest Search](https://docs.scrapier.io/api-reference/pinterest/pinterest-search.md): Structured Pinterest data: send `queries`. Cursor-paginated, 1 credit per successful call.
