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

# X/Twitter Video Transcript

Structured X (Twitter) data: send `urls`. Single lookup, 2 credits per successful call.

`GET|POST https://api.scrapier.io/api/v2/twitter-transcript/` · 2 credits per successful call · Single lookup · Long-running

## Overview

Call `GET /api/v2/twitter-transcript/` with `urls`. The results are in `data.transcript`. 7 optional parameters refine the call (see Parameters).

## Request

```bash
curl -G "https://api.scrapier.io/api/v2/twitter-transcript/" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "urls=https://x.com/MrBeast/status/2096285173788840001" \
  --max-time 210
```

```python
import requests

resp = requests.get(
    "https://api.scrapier.io/api/v2/twitter-transcript/",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"urls": "https://x.com/MrBeast/status/2096285173788840001"},
    timeout=210,
)
body = resp.json()
if not resp.ok:
    raise RuntimeError(body.get("error") or body.get("detail"))

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

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://x.com/MrBeast/status/2096285173788840001` | Tweet/X post URL. Lookup endpoint -- next_cursor null. |
| `translate_to_english` | boolean | no | `false` | Translate transcript to English. |
| `model_size` | string | no | `small` | faster-whisper model size. One of: `tiny`, `base`, `small`, `medium`, `large-v3`. |
| `beam_size` | integer | no | `5` | Beam search width (1-10). |
| `language` | string | no | — | ISO language code to force (default: auto-detect). |
| `vad_filter` | boolean | no | `true` | Drop non-speech audio. |
| `max_duration_seconds` | integer | no | `900` | Longer videos fail as a record. |
| `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.transcript`. Sample from the live catalog, arrays trimmed to 3 items.

```json
{
  "success": true,
  "data": {
    "urls": "https://x.com/MrBeast/status/2096285173788840001",
    "transcript": {
      "input_url": "https://x.com/MrBeast/status/2096285173788840001",
      "transcript": "We're in the middle of the world's deadliest show...",
      "language": "en",
      "status_id": "2096285173788840001",
      "video_url": "https://video.twimg.com/....mp4",
      "duration": 31.2,
      "status": "success"
    },
    "next_cursor": null
  }
}
```

## Response fields

| Field | Type | Example | Description |
|---|---|---|---|
| `urls` | string | `https://x.com/MrBeast/status/2096285173788840001` |  |
| `transcript` | object | `{…}` | The results. |
| `next_cursor` | null | `null` | Pass back as `cursor` for the next page. `null` on the last page. |
| `transcript.input_url` | string | `https://x.com/MrBeast/status/2096285173788840001` |  |
| `transcript.transcript` | string | `We're in the middle of the world's deadliest …` |  |
| `transcript.language` | string | `en` |  |
| `transcript.status_id` | string | `2096285173788840001` |  |
| `transcript.video_url` | string | `https://video.twimg.com/....mp4` |  |
| `transcript.duration` | number | `31.2` |  |
| `transcript.status` | string | `success` |  |

## Pagination

Single lookup: everything comes back in one call and `next_cursor` is always `null`.

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

- This endpoint can take several minutes. Set your client timeout to at least 210 seconds.

## Related

- [Twitter/X Posts](https://docs.scrapier.io/api-reference/twitter/twitter-post.md): Structured X (Twitter) data: send `usernames`. Cursor-paginated, 1 credit per successful call.
- [Twitter/X Profile Tweets](https://docs.scrapier.io/api-reference/twitter/twitter-tweets.md): Structured X (Twitter) data: send `usernames`. Cursor-paginated, 1 credit per successful call.
