> ## Documentation Index
> Fetch the complete documentation index at: https://docs.brightdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# X (Twitter) scraper quickstart

> Set up the Bright Data X (Twitter) Scraper API and collect your first profile or post as structured JSON in under 5 minutes with cURL, Python or Node.js.

This tutorial shows you how to scrape an X (formerly Twitter) profile and get structured JSON data using the Bright Data X Scraper API.

## Prerequisites

* A [Bright Data account](https://brightdata.com/products/web-scraper/twitter?hs_signup=1\&utm_source=docs)
* cURL, Python 3.9+, or Node.js 18+ installed

<Steps>
  <Step title="Get your API key">
    Go to the [user settings page](https://brightdata.com/cp/setting/users) in your Bright Data account and create an API key, or use one you already have.

    If you don't have an account yet, [sign up at brightdata.com](https://brightdata.com/products/web-scraper/twitter?hs_signup=1\&utm_source=docs). New accounts get 5,000 free credits every month, no credit card required. See the [free tier](/general/account/billing-and-pricing/free-tier).

    <Warning>
      Your API key is shown only once when created. Copy and store it securely.
    </Warning>
  </Step>

  <Step title="Send a request">
    We'll use the **Profiles endpoint**. The quickest route is the Bright Data Python SDK (`pip install brightdata-sdk`), which waits for the result for you. The other tabs call the API directly with a synchronous request. Replace `YOUR_API_KEY` with your API key:

    <CodeGroup>
      ```python Python SDK theme={null}
      # pip install brightdata-sdk
      from brightdata import SyncBrightDataClient

      # The Scraper API uses no zones, so skip the SDK's zone setup
      with SyncBrightDataClient(token="YOUR_API_KEY", auto_create_zones=False) as client:
          result = client.scrape.x.profiles(url="https://x.com/elonmusk")
          print(result.data)
      ```

      ```bash cURL theme={null}
      curl -X POST \
        "https://api.brightdata.com/datasets/v3/scrape?dataset_id=gd_lwxmeb2u1cniijd7t4&format=json" \
        -H "Authorization: Bearer YOUR_API_KEY" \
        -H "Content-Type: application/json" \
        -d '[{"url": "https://x.com/elonmusk"}]'
      ```

      ```python Python theme={null}
      import requests

      response = requests.post(
          "https://api.brightdata.com/datasets/v3/scrape",
          params={"dataset_id": "gd_lwxmeb2u1cniijd7t4", "format": "json"},
          headers={
              "Authorization": "Bearer YOUR_API_KEY",
              "Content-Type": "application/json",
          },
          json=[{"url": "https://x.com/elonmusk"}],
      )

      data = response.json()
      if response.status_code == 202:
          print(f"Job running. Snapshot ID: {data['snapshot_id']}")
      else:
          print(data)
      ```

      ```javascript Node.js theme={null}
      const response = await fetch(
        "https://api.brightdata.com/datasets/v3/scrape?dataset_id=gd_lwxmeb2u1cniijd7t4&format=json",
        {
          method: "POST",
          headers: {
            "Authorization": "Bearer YOUR_API_KEY",
            "Content-Type": "application/json",
          },
          body: JSON.stringify([
            { url: "https://x.com/elonmusk" }
          ]),
        }
      );

      const data = await response.json();
      if (response.status === 202) {
        console.log(`Job running. Snapshot ID: ${data.snapshot_id}`);
      } else {
        console.log(data);
      }
      ```
    </CodeGroup>

    The SDK prints the returned records from `result.data`. It waits up to 240 seconds for the result, so you don't handle a `202` yourself. With cURL, Python or Node.js you should see a `200` status code and a JSON array. A `202` means the scrape needs longer than 1 minute; see the note below. Processing time varies with target-site conditions and scraper workload.

    <Note>
      A synchronous request waits up to 1 minute. If the Bright Data X (Twitter) Scraper API needs longer, the response is HTTP `202` with a `snapshot_id` instead of profile data, and collection continues asynchronously. Fetch the result with the [async workflow](/products/scrapers/scrapers-library/async-requests) or have it pushed to you with [webhook delivery](/products/scrapers/scrapers-library/data-delivery).
    </Note>
  </Step>

  <Step title="Review the response">
    The Bright Data X Scraper API returns a JSON array with structured profile data:

    ```json theme={null}
    [
      {
        "followers": 241583960,
        "following": 1403,
        "is_verified": true,
        "url": "https://x.com/elonmusk",
        "x_id": "44196397",
        "id": "elonmusk",
        "profile_name": "Elon Musk",
        "biography": "https://t.co/ZdBx5WABYx",
        "profile_image_link": "https://pbs.twimg.com/profile_images/2053244804520427520/m8mdWZCG_400x400.jpg",
        "date_joined": "2009-06-02T20:12:29.000Z"
      }
    ]
    ```

    Each profile object includes fields covering follower counts, bio, verification status, and more. See the [full response schema](/api-reference/scrapers/social-media-apis/twitter-profiles-collect-by-url).
  </Step>
</Steps>

You've successfully scraped your first X profile using the Bright Data X Scraper API.

## Common questions

### Can I scrape multiple profiles in one request?

Yes. Add more objects to the input array. Bright Data recommends 20 URLs or fewer per synchronous request, a best practice rather than a hard limit. For larger batches, use the [async `/trigger` endpoint](/products/scrapers/scrapers-library/async-requests).

```json theme={null}
[
  {"url": "https://x.com/elonmusk"},
  {"url": "https://x.com/BillGates"},
  {"url": "https://x.com/NASA"}
]
```

### Getting a 401 or 403 error?

Verify your API key is correct and hasn't expired. Create a new API key in [Account settings](https://brightdata.com/cp/setting/users). See the [authentication guide](/api-reference/authentication) for details.

### Request is timing out?

Synchronous requests have a 1-minute timeout. If the request exceeds this limit, the API returns HTTP `202` with a `snapshot_id` and finishes the job asynchronously. Use the [async workflow](/products/scrapers/scrapers-library/async-requests) for large batches.

### Empty or partial response data?

Verify the X profile URL is publicly accessible and correctly formatted. The URL should follow the pattern `https://x.com/username`.

## Do I have to call the API directly?

No. The Bright Data SDKs, the CLI and coding-agent tools call the same Scraper API, so you can start from whichever fits your stack.

| Client | Install | First call |
| :- | :- | :- |
| **Python and Node.js SDK** | `pip install brightdata-sdk` or `npm install @brightdata/sdk` | Call `client.scrape.<platform>.<endpoint>(url="...")`; the method list is in the [Python SDK](/api-reference/SDK) and [JavaScript SDK](/api-reference/SDK-JS) |
| **CLI** | `npm install -g @brightdata/cli`, then `bdata login` | `bdata pipelines list` prints every pipeline name, then run `bdata pipelines <pipeline> "<url>" --pretty`; see the [CLI commands](/products/cli/commands) |
| **Coding agents** | `npx skills add brightdata/skills` installs the skills; the [Bright Data MCP](/products/mcp-server/overview) server exposes the scrapers as tools | See the [coding agent quickstart](/quickstart-coding-agent) |

## Next steps

<CardGroup cols={3}>
  <Card title="Endpoints" icon="bolt" href="/products/scrapers/twitter/send-first-request">
    One request per endpoint, each with a captured response.
  </Card>

  <Card title="Async batch requests" icon="layer-group" href="/products/scrapers/scrapers-library/async-requests">
    Scrape hundreds of URLs in a single batch job.
  </Card>

  <Card title="Set up webhooks" icon="webhook" href="/products/scrapers/scrapers-library/data-delivery">
    Receive results automatically when scraping completes.
  </Card>
</CardGroup>