# X / Twitter Profile (`twitter.profile`)

Public X (Twitter) profile for one handle: bio, follower and post counts, verification, links and pinned posts.

Docs: https://primaryapi.com/docs/api-reference/twitter/profile

- Endpoint: `POST https://api.primaryapi.com/v1/run/twitter.profile`
- Category: Social · Platform: `twitter` · Kind: lookup · Status: live
- Price: 1 credit per call; up to 2 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost.
- Billing unit: per successful call
- Reliability: routed to a healthy upstream and retried automatically when an attempt fails; live 30-day status: `GET https://api.primaryapi.com/v1/status/apis?sku=twitter.profile`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `handle` | string | yes |  | max 100 chars | X (Twitter) username, with or without the leading @. |

Unknown fields are rejected with `400 invalid_input`. The routing controls `preferLatencyUnderMs` and `maxCredits` may be sent in the same JSON body.

## Output

When `output.found` is `true`, `output.data` has this shape:

| Field | Type | Description |
|---|---|---|
| `id` | string \| null | Numeric user id (string) |
| `handle` | string | Screen name without @ |
| `displayName` | string \| null |  |
| `bio` | string \| null |  |
| `followers` | integer \| null |  |
| `following` | integer \| null |  |
| `tweets` | integer \| null | Posts count (statuses) |
| `mediaCount` | integer \| null |  |
| `location` | string \| null |  |
| `website` | string \| null | Link in the profile (expanded), not the x.com URL |
| `avatarUrl` | string \| null |  |
| `coverUrl` | string \| null |  |
| `createdUtc` | integer \| null | Account creation, UTC epoch seconds |
| `verified` | boolean \| null | Blue check (X Premium) or legacy verification |
| `private` | boolean \| null | Protected account |
| `pinnedPostIds` | string[] |  |

When the thing you asked about does not exist (or a search matches nothing) the call still succeeds: `output.found` is `false`, `output.data` is `null` and `output.reason` says why (`not_found`, `private`, `no_results`, …). Misses are free unless the notes below say misses are billed.

## Example request

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/twitter.profile" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"handle":"nasa"}'
```

## Example response

_Values are placeholders that follow the output schema; `credits` is what this call would cost at the usual price._

```json
{
  "output": {
    "found": true,
    "data": {
      "id": "string",
      "handle": "nasa",
      "displayName": "string",
      "bio": "string",
      "followers": 0,
      "following": 0,
      "tweets": 0,
      "mediaCount": 0,
      "location": "string",
      "website": "string",
      "avatarUrl": "https://example.com",
      "coverUrl": "https://example.com",
      "createdUtc": 0,
      "verified": true,
      "private": true,
      "pinnedPostIds": [
        "string"
      ]
    }
  },
  "provider": "PrimaryAPI",
  "credits": 1,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z"
}
```

## Pricing and reliability

- Usual price: 1 credit per call
- Price ceiling: up to 2 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost; the `maxCredits` routing control caps it per call
- Live 30-day status, success rate, uptime and latency: `GET https://api.primaryapi.com/v1/status/apis?sku=twitter.profile`

## Errors to handle

`invalid_input`, `unauthorized`, `insufficient_balance`, `key_limit_reached`, `trial_cap_reached`, `forbidden`, `not_found`, `idempotency_conflict`, `rate_limited`, `all_sources_failed`, `service_unavailable`, `timeout`. See https://primaryapi.com/docs/errors.

## Notes

Suspended or missing accounts return found=false (reason suspended|not_found|unavailable); protected accounts are found with private=true.

