---
title: "Get an X profile"
method: GET
path: "/v1/x/profiles"
---

# Get an X profile

`GET /v1/x/profiles`

## Request

- Base URL: `https://api.veezee.io`
- URL: `https://api.veezee.io/v1/x/profiles`
- Auth: HTTP bearer

Fetch one X account's profile: name, bio, location, website, follower/following counts, tweet and media counts, verification state, and join date. identifier accepts a screen name without the @ (e.g. 'nasa'), a full x.com or twitter.com profile URL, or the numeric account id; numeric strings are treated as ids, and the rare all-digit handle can be forced with by='screen_name'. Costs 4 credits. The returned platform_fields.id is stable across handle changes; store it for repeat lookups. To find accounts by topic use x_search type=people, and to read what an account posts use x_get_tweets; this tool returns no tweets.

## Query parameters

- `identifier` string, required: Screen name without the @ (e.g. 'nasa'), profile URL, or numeric account id.
- `by` 'screen_name' | 'id': Force how identifier is interpreted; auto-detected when omitted.
- `freshness` 'recent' | 'realtime': recent (default) serves cached data from the last few hours when available; realtime forces a live fetch for +2 credits (refunded if we fall back to cached data). Trial keys are cached-only and reject realtime with TRIAL_CAP_EXCEEDED; paying upgrades this same key to unlock it.
- `max_credits` integer: Spend ceiling for this one call. The call is rejected (nothing charged) if its quote exceeds this. Only the quote is ever reserved, never this ceiling.

## Headers

- `Idempotency-Key` string

## Response `200`

x_profile envelope (schema_version 2)

- XProfileEnvelope
  - `entity` 'x_profile', required
  - `platform` 'linkedin' | 'reddit' | 'x', nullable, required
  - `canonical_url` string, nullable, required
  - `data_as_of` string, nullable, required
  - `schema_version` '2', required
  - `common` object, required
    - `screen_name` string, required
    - `name` string, nullable, required
    - `description` string, nullable, required
    - `location` string, nullable, required
    - `website_url` string, nullable, required: The link in the profile bio, not the x.com URL.
    - `created_at` string, nullable, required
    - `followers` integer, nullable, required
    - `following` integer, nullable, required
    - `tweets_count` integer, nullable, required
    - `media_count` integer, nullable, required
    - `is_verified` boolean, nullable, required: Blue-check state.
    - `verified_type` string, nullable, required: e.g. 'Business' or 'Government' when applicable.
    - `is_protected` boolean, nullable, required: True when tweets are visible to approved followers only.
    - `image_url` string, nullable, required
    - `banner_url` string, nullable, required
    - `url` string, required: Canonical x.com profile URL.
  - `platform_fields` object, required
    - `id` string, required: Numeric account id as a string; stable across handle changes. Use for repeat lookups.
    - `pinned_tweet_ids` string[], nullable, required
    - `is_business_account` boolean, nullable, required
  - `freshness` object, nullable, required
    - `source_retrieved_at` string, nullable, required: When the data was fetched from the source. ISO 8601.
    - `served_at` string, required
    - `cache_age_seconds` integer, nullable, required
    - `served_from_cache` boolean, required: True when these bytes were served from cache rather than fetched for this call. source_retrieved_at says how old they are.
    - `freshness_requested` 'recent' | 'realtime', required
    - `freshness_served` 'recent' | 'realtime' | 'stale', required
  - `usage` object, required
    - `receipt_id` string, nullable, required
    - `credits_quoted` integer, required
    - `credits_charged` integer, required
    - `balance_remaining` integer, nullable, required
    - `free_tier_hint` string: Present on free-tier trial-key calls: what budget the call drew from and that paying upgrades this same key. Near the daily cap on unclaimed keys it also carries a claim link to relay to your human (claiming adds one-time credits).

## Other responses

- `400`: INVALID_INPUT | IDEMPOTENCY_KEY_REQUIRED
- `401`: UNAUTHORIZED | AUTH_REQUIRED | KEY_REQUIRED
- `402`: INSUFFICIENT_CREDITS | QUOTE_EXCEEDS_MAX_CREDITS
- `403`: NOT_ENTITLED | TRIAL_CAP_EXCEEDED
- `404`: NOT_FOUND
- `409`: IDEMPOTENCY_KEY_REUSED
- `413`: PAYLOAD_TOO_LARGE
- `429`: CONCURRENCY_LIMIT | RATE_LIMITED
- `500`: INTERNAL
- `502`: UPSTREAM_UNAVAILABLE
- `503`: BUDGET_EXHAUSTED

---

[API](https://skmtc.dev/veezee/apis/veezee-api.md) · [All operations](https://skmtc.dev/veezee/apis/veezee-api/llms.txt) · [OpenAPI document](https://skmtc.dev/veezee/apis/veezee-api/revisions/6f1831474e70?raw)