> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). The sections below mirror the orientation block in [`/llms.txt`](https://www.socialfetch.dev/llms.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need a structured operation inventory. The catalog covers documented operations with on-site reference pages.

## This page

- **On-site (HTML):** [https://www.socialfetch.dev/docs/api/v1/twitter/profiles/handle/get](https://www.socialfetch.dev/docs/api/v1/twitter/profiles/handle/get)
- **Markdown (.mdx) URL:** [https://www.socialfetch.dev/docs/api/v1/twitter/profiles/handle/get.mdx](https://www.socialfetch.dev/docs/api/v1/twitter/profiles/handle/get.mdx)

## API base URL and authentication

- **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev`
- **Authentication:** send `x-api-key: sfk_...` on `/v1/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route).
- **OpenAPI JSON:** [https://www.socialfetch.dev/openapi.json](https://www.socialfetch.dev/openapi.json)

## Recommended docs entrypoints (this site)

- [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown).
- [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope.
- [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`.
- [SDK reference](https://www.socialfetch.dev/docs/sdk-reference.mdx) — exhaustive SDK method inventory and route mapping for agents, tooling, and power users.
- [Choose the right endpoint](https://www.socialfetch.dev/docs/choose-endpoint.mdx) — task-oriented route selection for smoke tests, profiles, list endpoints, and single-item lookups.
- [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — fast comparison of identifiers, pagination, outcomes, media download, and SDK coverage.
- [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping.
- [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages.
- [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance.
- [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs.
- Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract.

## Markdown docs convention

- Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`).
- Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`).

---
# Get Twitter profile (https://www.socialfetch.dev/docs/api/v1/twitter/profiles/handle/get)

## Summary

Looks up an X profile by handle.

**Tags:** `Twitter`

## HTTP

- **Method:** GET
- **Path:** `/v1/twitter/profiles/{handle}`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.twitter.getProfile({ handle })`
- **Accepted identifiers:** `handle` (path)
- **Pagination:** none
- **Business outcome field:** `data.lookupStatus` with values `found`, `private`, `not_found`

## Authentication

- **`x-api-key`**: API key (`sfk_...`)

## Parameters

### `handle` (path)

- **Required:** yes
- **Constraints:** type `string`
- **Description:** X handle to look up, with or without a leading @.

## Responses (status codes)

- **200**: Lookup result. Check `data.lookupStatus` for `found`, `private`, or `not_found`.
- **400**: Invalid handle or bad request
- **401**: Missing or invalid API key
- **402**: Insufficient credits
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed from the response (unexpected or invalid data).
- **503**: Service temporarily unavailable; safe to retry with backoff.

## Response body (200)

Lookup result. Check `data.lookupStatus` for `found`, `private`, or `not_found`.

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **lookupStatus** (required) — type `string`; enum: found, private, not_found. Whether the profile was found, private, or not found.
  - **profile** (required) — type `object`; nullable. Profile details when available.
    - **platform** (required) — type `string`; enum: twitter. Social platform for this profile.
    - **handle** (required) — type `string`. X screen name (handle) without the leading @.
    - **displayName** (required) — type `string`; nullable. Display name shown on the profile.
    - **bio** (required) — type `string`; nullable. Profile biography text.
    - **avatarUrl** (required) — type `string`; nullable. Best available square avatar image URL.
    - **bannerUrl** (optional) — type `string`; nullable. Profile banner image URL when available.
    - **verified** (required) — type `boolean`. Whether X marks the profile with legacy verification (not necessarily paid blue).
    - **blueVerified** (required) — type `boolean`. Whether the account has X blue (paid) verification.
    - **profileUrl** (required) — type `string`; minLength: 1. Canonical public profile URL on x.com.
    - **privateAccount** (required) — type `boolean`. Whether the account is protected (private).
    - **platformUserId** (optional) — type `string`. Numeric X user id (`rest_id`) as a string.
    - **accountCreatedAt** (optional) — type `integer`; minimum: 0. Account creation time as Unix epoch seconds when derivable.
    - **location** (optional) — type `string`; nullable. Location string from the profile when provided.
    - **website** (optional) — type `string`; nullable. Primary outbound link (expanded URL) from the profile.
    - **pinnedTweetId** (optional) — type `string`. Pinned tweet id when X exposes one.
    - **verificationInfo** (optional) — type `object`. Structured verification metadata from X.
      - **isIdentityVerified** (required) — type `boolean`. Whether X marks the account as identity-verified.
      - **verifiedSinceMsec** (optional) — type `string`. When verification became effective, as milliseconds since epoch (string from X).
      - **reason** (optional) — type `object`. Verification reason payload when X provides it.
        - **text** (optional) — type `string`. Human-readable verification reason text from X.
        - **entities** (optional) — type `array`. Inline entity metadata for the reason text (vendor-defined).
          - _items:_
            - nullable
    - **tipJar** (optional) — type `object`. Tip jar configuration when present.
      - **isEnabled** (required) — type `boolean`. Whether the X tip jar is enabled.
      - **handles** (optional) — type `object`. Per-service handles when any are present.
        - **bandcamp** (optional) — type `string`. Bandcamp handle from tip jar.
        - **bitcoin** (optional) — type `string`. Bitcoin address or handle.
        - **cashApp** (optional) — type `string`. Cash App handle.
        - **ethereum** (optional) — type `string`. Ethereum address or handle.
        - **goFundMe** (optional) — type `string`. GoFundMe handle.
        - **patreon** (optional) — type `string`. Patreon handle.
        - **payPal** (optional) — type `string`. PayPal handle.
        - **venmo** (optional) — type `string`. Venmo handle.
    - **highlights** (optional) — type `object`. Tweet highlights metadata when present.
      - **canHighlightTweets** (required) — type `boolean`. Whether the account may highlight tweets on the profile.
      - **highlightedTweetCount** (required) — type `integer`; minimum: 0. Count of highlighted tweets when reported by X.
    - **businessAccount** (optional) — type `object`. Opaque business-account payload from X when non-empty (vendor-defined).
    - **creatorSubscriptionsCount** (optional) — type `integer`; minimum: 0. Creator subscriptions count when X reports it.
    - **affiliateLabel** (optional) — type `object`. Affiliate or business label when X provides one.
      - **description** (required) — type `string`. Affiliate or business label text shown on the profile.
      - **badgeUrl** (optional) — type `string`. Badge image URL when X provides one.
      - **url** (optional) — type `string`. Destination URL for the label link.
  - **metrics** (required) — type `object`; nullable. Profile metrics when available.
    - **followers** (required) — type `integer`; minimum: 0. Follower count from X.
    - **following** (required) — type `integer`; minimum: 0. Following (friends) count from X.
    - **tweets** (required) — type `integer`; minimum: 0. Total post (status) count from X.
    - **favourites** (required) — type `integer`; minimum: 0. Total favourites (likes) count from X.
    - **listedCount** (optional) — type `integer`; minimum: 0. Listed count when X provides it.
    - **mediaCount** (optional) — type `integer`; minimum: 0. Media item count when X provides it.
    - **fastFollowersCount** (optional) — type `integer`; minimum: 0. Fast-followers count when X provides it.
- **meta** (required) — type `object`. Metadata describing the request and billing outcome.
  - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call.
  - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request.
  - **version** (required) — type `string`; enum: v1. Public API version that served the response.

### Example JSON (found)

```json
{
  "data": {
    "lookupStatus": "found",
    "profile": {
      "platform": "twitter",
      "handle": "alexbishop2002",
      "displayName": "alexbishop",
      "bio": "Love football i follow back up the posh",
      "avatarUrl": "https://pbs.twimg.com/profile_images/506120681910964224/Qycpq4pO_400x400.jpeg",
      "bannerUrl": "https://pbs.twimg.com/profile_banners/2262329555/1409503563",
      "verified": false,
      "blueVerified": false,
      "profileUrl": "https://x.com/alexbishop2002",
      "privateAccount": false,
      "platformUserId": "2262329555",
      "accountCreatedAt": 1388859821,
      "location": null,
      "website": null,
      "verificationInfo": {
        "isIdentityVerified": false
      },
      "tipJar": {
        "isEnabled": false
      },
      "highlights": {
        "canHighlightTweets": false,
        "highlightedTweetCount": 0
      },
      "creatorSubscriptionsCount": 0
    },
    "metrics": {
      "followers": 44,
      "following": 0,
      "tweets": 98,
      "favourites": 47,
      "listedCount": 0,
      "mediaCount": 13,
      "fastFollowersCount": 0
    }
  },
  "meta": {
    "requestId": "req_01example",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Example JSON (private)

```json
{
  "data": {
    "lookupStatus": "private",
    "profile": {
      "platform": "twitter",
      "handle": "lukem1221",
      "displayName": "Luke",
      "bio": null,
      "avatarUrl": "https://pbs.twimg.com/profile_images/1999456116619771904/rmqNgqiu_400x400.jpg",
      "bannerUrl": null,
      "verified": false,
      "blueVerified": false,
      "profileUrl": "https://x.com/lukem1221",
      "privateAccount": true,
      "platformUserId": "761228485981528065",
      "accountCreatedAt": 1470325989,
      "location": null,
      "website": "https://www.voicegecko.io/",
      "verificationInfo": {
        "isIdentityVerified": false
      },
      "tipJar": {
        "isEnabled": false
      },
      "highlights": {
        "canHighlightTweets": false,
        "highlightedTweetCount": 0
      },
      "creatorSubscriptionsCount": 0
    },
    "metrics": {
      "followers": 115,
      "following": 97,
      "tweets": 47,
      "favourites": 48,
      "listedCount": 3,
      "mediaCount": 5,
      "fastFollowersCount": 0
    }
  },
  "meta": {
    "requestId": "req_01example",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Example JSON (not_found)

```json
{
  "data": {
    "lookupStatus": "not_found",
    "profile": null,
    "metrics": null
  },
  "meta": {
    "requestId": "req_01example",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Machine-readable error codes

When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime):

- `bad_request`

## Error handling & retries

Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status.

- **400**: Invalid handle or bad request **Retry:** Fix the request; retrying the same invalid payload will not help.
- **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help.
- **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help).
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed from the response (unexpected or invalid data). **Retry:** May be transient; a few retries with backoff are reasonable.
- **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter.

### Suggested client defaults

- Send the API key using the `x-api-key` header on every request.
- On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user.
- On `402`, surface an actionable billing message rather than blind retries.

## Examples

### TypeScript SDK

```typescript
import { SocialFetchClient } from "@socialfetch/sdk";

const client = new SocialFetchClient({
  apiKey: process.env.SOCIALFETCH_API_KEY!,
});

const result = await client.twitter.getProfile({
  handle: "charlidamelio",
});

if (!result.ok) {
  console.error(result.error);
} else {
  console.log(result.value.data);
}
```

### Node.js

```javascript
const response = await fetch(
  "https://api.socialfetch.dev/v1/twitter/profiles/charlidamelio",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY",
    }
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash
curl "https://api.socialfetch.dev/v1/twitter/profiles/charlidamelio" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/twitter/profiles/charlidamelio",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```