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

# YouTube Video Sponsors

Structured YouTube data: send `video_ids`. Cursor-paginated, 1 credit per successful call.

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

## Overview

Call `GET /api/v2/youtube-video-sponsors/` with `video_ids`. The results are in `data.result`; send `data.next_cursor` back as `cursor` to get the next page. 4 optional parameters refine the call (see Parameters).

## Request

```bash
curl -G "https://api.scrapier.io/api/v2/youtube-video-sponsors/" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "video_ids=https://www.youtube.com/watch?v=K8AMhj-ImMI" \
  --max-time 210
```

```python
import requests

resp = requests.get(
    "https://api.scrapier.io/api/v2/youtube-video-sponsors/",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"video_ids": "https://www.youtube.com/watch?v=K8AMhj-ImMI"},
    timeout=210,
)
body = resp.json()
if not resp.ok:
    raise RuntimeError(body.get("error") or body.get("detail"))

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

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. |
| `video_ids` | string | yes | e.g. `https://www.youtube.com/watch?v=K8AMhj-ImMI` | YouTube watch / youtu.be / shorts / embed URL or bare 11-char id. One video per call. Required first call. |
| `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. |
| `language` | string | no | `en` | 2-letter transcript language code. Locked in cursor. |
| `include_transcript` | boolean | no | `false` | Also return the full transcript segments. Locked in cursor. |
| `resolve_short_links` | boolean | no | `true` | Follow bit.ly / amzn.to style links. 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.result`. Sample from the live catalog, arrays trimmed to 3 items.

```json
{
  "success": true,
  "data": {
    "video_ids": "https://www.youtube.com/watch?v=K8AMhj-ImMI",
    "result": {
      "success": true,
      "input_value": "https://www.youtube.com/watch?v=K8AMhj-ImMI",
      "scraped_at": "2026-09-17T06:21:48.204Z",
      "video_id": "K8AMhj-ImMI",
      "video": {
        "id": "K8AMhj-ImMI",
        "title": "If you're ambitious but inconsistent, please watch this",
        "channel": {
          "handle": "aliabdaal",
          "title": "Ali Abdaal",
          "subscriber_count": 6690000
        },
        "is_paid_promotion": true,
        "view_count": 458547
      },
      "suspected_sponsors": [
        {
          "name": "Wispr Flow",
          "website": "ref.wisprflow.ai",
          "confidence": "high",
          "score": 5,
          "is_affiliate_like": true
        }
      ],
      "sponsor_detection": {
        "status": "found",
        "sponsor_count": 4,
        "highest_confidence": "high",
        "paid_promotion_badge": true
      },
      "attempts": 1
    },
    "next_cursor": null
  }
}
```

## Response fields

| Field | Type | Example | Description |
|---|---|---|---|
| `video_ids` | string | `https://www.youtube.com/watch?v=K8AMhj-ImMI` |  |
| `result` | object | `{…}` | The results. |
| `next_cursor` | null | `null` | Pass back as `cursor` for the next page. `null` on the last page. |
| `result.success` | boolean | `true` |  |
| `result.input_value` | string | `https://www.youtube.com/watch?v=K8AMhj-ImMI` |  |
| `result.scraped_at` | string | `2026-09-17T06:21:48.204Z` |  |
| `result.video_id` | string | `K8AMhj-ImMI` |  |
| `result.video` | object | `{…}` |  |
| `result.suspected_sponsors` | array | `[1 item]` |  |
| `result.sponsor_detection` | object | `{…}` |  |
| `result.attempts` | 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/youtube-video-sponsors/"
HEADERS = {"X-API-Key": "YOUR_API_KEY"}
params = {"video_ids": "https://www.youtube.com/watch?v=K8AMhj-ImMI"}
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.append(data.get("result"))
    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: `language`, `include_transcript`, `resolve_short_links`. Set them on the first call; later pages reuse them.
- The response data carries its own `success` field from the scraper. The outer `success` is what counts: an HTTP 200 with outer `success: true` is billed, even if the inner field says otherwise.

## Related

- [YouTube Channel Info](https://docs.scrapier.io/api-reference/youtube/youtube-channel-info.md): Structured YouTube data: send `urls`. Single lookup, 1 credit per successful call.
- [YouTube Channel Live/Streams](https://docs.scrapier.io/api-reference/youtube/youtube-channel-live.md): Structured YouTube data: send `channels`. Cursor-paginated, 1 credit per successful call.
- [YouTube Channel Video Scraper](https://docs.scrapier.io/api-reference/youtube/youtube-channel-video-scraper.md): Structured YouTube data: send `youtube_channels`. Cursor-paginated, 1 credit per successful call.
- [YouTube Comment Replies](https://docs.scrapier.io/api-reference/youtube/youtube-comment-replies.md): Structured YouTube data: send `continuation_tokens`. Cursor-paginated, 1 credit per successful call.
