# Field reference - Veezee docs

Every field Veezee serves, generated from https://veezee.io/openapi.json. Only served fields appear here; nothing upstream-only.

## url_resolution

| Field | Type | Description |
| --- | --- | --- |
| `entity` | `"url_resolution"` |  |
| `platform` | `linkedin | reddit | x | null` |  |
| `canonical_url` | `string | null` |  |
| `data_as_of` | `string | null` |  |
| `schema_version` | `"2"` |  |
| `common.input_url` | `string` |  |
| `common.type` | `person | company | post | subreddit | user | comment | profile | tweet` | What the URL points at, in the platform's own vocabulary. |
| `common.id` | `string | null` |  |
| `common.handle` | `string | null` |  |
| `common.canonical_url` | `string | null` |  |
| `freshness.source_retrieved_at` | `string | null` |  |
| `freshness.served_at` | `string` |  |
| `freshness.cache_age_seconds` | `integer | null` |  |
| `freshness.served_from_cache` | `boolean` | True when these bytes were served from cache rather than fetched for this call. source_retrieved_at says how old they are. |
| `freshness.freshness_requested` | `recent | realtime` |  |
| `freshness.freshness_served` | `recent | realtime | stale` |  |
| `usage.receipt_id` | `string | null` |  |
| `usage.credits_quoted` | `integer` |  |
| `usage.credits_charged` | `integer` |  |
| `usage.balance_remaining` | `integer | null` |  |
| `usage.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). |

## person

| Field | Type | Description |
| --- | --- | --- |
| `entity` | `"person"` |  |
| `platform` | `linkedin | reddit | x | null` |  |
| `canonical_url` | `string | null` |  |
| `data_as_of` | `string | null` |  |
| `schema_version` | `"2"` |  |
| `common.full_name` | `string` |  |
| `common.first_name` | `string | null` |  |
| `common.last_name` | `string | null` |  |
| `common.headline` | `string | null` |  |
| `common.location.name` | `string | null` |  |
| `common.location.country_code` | `string | null` |  |
| `common.about` | `string | null` |  |
| `common.current_position.company_name` | `string | null` |  |
| `common.current_position.company_handle` | `string | null` |  |
| `common.current_position.company_url` | `string | null` |  |
| `common.current_position.company_urn` | `string | null` |  |
| `common.current_position.start_year` | `integer | null` |  |
| `common.experience[].company.name` | `string | null` |  |
| `common.experience[].company.handle` | `string | null` |  |
| `common.experience[].company.url` | `string | null` |  |
| `common.experience[].positions[].role` | `string | null` |  |
| `common.experience[].positions[].location` | `string | null` |  |
| `common.experience[].positions[].is_current` | `boolean | null` |  |
| `common.experience[].positions[].start_date.month` | `integer | null` |  |
| `common.experience[].positions[].start_date.year` | `integer | null` |  |
| `common.experience[].positions[].end_date.month` | `integer | null` |  |
| `common.experience[].positions[].end_date.year` | `integer | null` |  |
| `common.education[].institution` | `string | null` |  |
| `common.education[].institution_url` | `string | null` |  |
| `common.education[].degree` | `string | null` |  |
| `common.education[].start_year` | `integer | null` |  |
| `common.education[].end_year` | `integer | null` |  |
| `common.skills[].name` | `string` |  |
| `common.skills[].endorsement_count` | `integer | null` |  |
| `common.followers` | `integer | null` |  |
| `common.connections` | `integer | null` |  |
| `common.is_verified` | `boolean | null` |  |
| `common.image_url` | `string | null` |  |
| `common.url` | `string` | Canonical LinkedIn profile URL. |
| `platform_fields.urn` | `string` | Stable LinkedIn URN (urn:li:fsd_profile:...). Use this for repeat lookups. |
| `platform_fields.public_identifier` | `string | null` |  |
| `platform_fields.is_influencer` | `boolean | null` |  |
| `platform_fields.is_creator` | `boolean | null` |  |
| `platform_fields.is_hiring` | `boolean | null` |  |
| `platform_fields.has_premium` | `boolean | null` |  |
| `platform_fields.open_to_messages` | `boolean | null` |  |
| `platform_fields.pronoun` | `string | null` |  |
| `freshness.source_retrieved_at` | `string | null` |  |
| `freshness.served_at` | `string` |  |
| `freshness.cache_age_seconds` | `integer | null` |  |
| `freshness.served_from_cache` | `boolean` | True when these bytes were served from cache rather than fetched for this call. source_retrieved_at says how old they are. |
| `freshness.freshness_requested` | `recent | realtime` |  |
| `freshness.freshness_served` | `recent | realtime | stale` |  |
| `usage.receipt_id` | `string | null` |  |
| `usage.credits_quoted` | `integer` |  |
| `usage.credits_charged` | `integer` |  |
| `usage.balance_remaining` | `integer | null` |  |
| `usage.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). |

## people_search

| Field | Type | Description |
| --- | --- | --- |
| `entity` | `"people_search"` |  |
| `platform` | `linkedin | reddit | x | null` |  |
| `canonical_url` | `string | null` |  |
| `data_as_of` | `string | null` |  |
| `schema_version` | `"2"` |  |
| `common.results[].name` | `string` |  |
| `common.results[].position` | `string | null` |  |
| `common.results[].location` | `string | null` |  |
| `common.results[].followers` | `integer | null` |  |
| `common.results[].is_verified` | `boolean | null` |  |
| `common.results[].image_url` | `string | null` |  |
| `common.results[].url` | `string | null` |  |
| `common.results[].urn` | `string` |  |
| `common.results[].public_identifier` | `string | null` |  |
| `common.results[].is_anonymous` | `boolean` | True when the profile is private: it exists but linkedin_get_profile cannot dereference it. Do not retry. |
| `common.cursor` | `string | null` |  |
| `common.next_url` | `string | null` |  |
| `common.total_matches` | `integer | null` |  |
| `common.returned_count` | `integer` |  |
| `common.truncation_hint` | `string | null` |  |
| `freshness.source_retrieved_at` | `string | null` |  |
| `freshness.served_at` | `string` |  |
| `freshness.cache_age_seconds` | `integer | null` |  |
| `freshness.served_from_cache` | `boolean` | True when these bytes were served from cache rather than fetched for this call. source_retrieved_at says how old they are. |
| `freshness.freshness_requested` | `recent | realtime` |  |
| `freshness.freshness_served` | `recent | realtime | stale` |  |
| `usage.receipt_id` | `string | null` |  |
| `usage.credits_quoted` | `integer` |  |
| `usage.credits_charged` | `integer` |  |
| `usage.balance_remaining` | `integer | null` |  |
| `usage.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). |

## company

| Field | Type | Description |
| --- | --- | --- |
| `entity` | `"company"` |  |
| `platform` | `linkedin | reddit | x | null` |  |
| `canonical_url` | `string | null` |  |
| `data_as_of` | `string | null` |  |
| `schema_version` | `"2"` |  |
| `common.name` | `string` |  |
| `common.description` | `string | null` |  |
| `common.website_url` | `string | null` |  |
| `common.industry` | `array<string>` |  |
| `common.employee_count` | `integer | null` |  |
| `common.employee_count_range` | `string | null` |  |
| `common.followers` | `integer | null` |  |
| `common.founded_year` | `integer | null` |  |
| `common.specialities` | `array<string>` |  |
| `common.headquarters.name` | `string | null` |  |
| `common.headquarters.country_code` | `string | null` |  |
| `common.logo_url` | `string | null` |  |
| `common.url` | `string` | Canonical LinkedIn company URL. |
| `platform_fields.urn` | `string` | Stable LinkedIn URN (urn:li:fsd_company:...). |
| `platform_fields.linkedin_id` | `integer | null` |  |
| `platform_fields.public_identifier` | `string | null` |  |
| `platform_fields.organization_type` | `string | null` |  |
| `platform_fields.stock_symbol` | `string | null` |  |
| `platform_fields.is_verified` | `boolean | null` |  |
| `freshness.source_retrieved_at` | `string | null` |  |
| `freshness.served_at` | `string` |  |
| `freshness.cache_age_seconds` | `integer | null` |  |
| `freshness.served_from_cache` | `boolean` | True when these bytes were served from cache rather than fetched for this call. source_retrieved_at says how old they are. |
| `freshness.freshness_requested` | `recent | realtime` |  |
| `freshness.freshness_served` | `recent | realtime | stale` |  |
| `usage.receipt_id` | `string | null` |  |
| `usage.credits_quoted` | `integer` |  |
| `usage.credits_charged` | `integer` |  |
| `usage.balance_remaining` | `integer | null` |  |
| `usage.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). |

## posts

| Field | Type | Description |
| --- | --- | --- |
| `entity` | `"posts"` |  |
| `platform` | `linkedin | reddit | x | null` |  |
| `canonical_url` | `string | null` |  |
| `data_as_of` | `string | null` |  |
| `schema_version` | `"2"` |  |
| `common.results[].urn` | `string` |  |
| `common.results[].url` | `string | null` |  |
| `common.results[].text` | `string | null` |  |
| `common.results[].created_at` | `string | null` |  |
| `common.results[].author.name` | `string | null` |  |
| `common.results[].author.url` | `string | null` |  |
| `common.results[].author.urn` | `string | null` |  |
| `common.results[].likes` | `integer | null` |  |
| `common.results[].comments_count` | `integer | null` |  |
| `common.results[].shares` | `integer | null` |  |
| `common.results[].is_repost` | `boolean | null` |  |
| `common.cursor` | `string | null` |  |
| `common.next_url` | `string | null` |  |
| `common.returned_count` | `integer` |  |
| `common.author_type` | `person | company` | What kind of entity the posts belong to. |
| `freshness.source_retrieved_at` | `string | null` |  |
| `freshness.served_at` | `string` |  |
| `freshness.cache_age_seconds` | `integer | null` |  |
| `freshness.served_from_cache` | `boolean` | True when these bytes were served from cache rather than fetched for this call. source_retrieved_at says how old they are. |
| `freshness.freshness_requested` | `recent | realtime` |  |
| `freshness.freshness_served` | `recent | realtime | stale` |  |
| `usage.receipt_id` | `string | null` |  |
| `usage.credits_quoted` | `integer` |  |
| `usage.credits_charged` | `integer` |  |
| `usage.balance_remaining` | `integer | null` |  |
| `usage.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). |

## reddit_search

| Field | Type | Description |
| --- | --- | --- |
| `entity` | `"reddit_search"` |  |
| `platform` | `linkedin | reddit | x | null` |  |
| `canonical_url` | `string | null` |  |
| `data_as_of` | `string | null` |  |
| `schema_version` | `"2"` |  |
| `common.type` | `posts | comments | subreddits | users` | Which result array is populated. |
| `common.posts[].id` | `string` | Post id with the t3_ prefix. Pass to reddit_get_post. |
| `common.posts[].title` | `string | null` |  |
| `common.posts[].author` | `string | null` |  |
| `common.posts[].subreddit.name` | `string` | Subreddit name without the r/ prefix, e.g. 'selfhosted'. |
| `common.posts[].subreddit.subscribers` | `integer | null` |  |
| `common.posts[].created_at` | `string | null` |  |
| `common.posts[].upvotes` | `integer | null` |  |
| `common.posts[].upvote_ratio` | `number | null` |  |
| `common.posts[].comment_count` | `integer | null` |  |
| `common.posts[].permalink` | `string | null` |  |
| `common.posts[].external_url` | `string | null` |  |
| `common.posts[].preview_text` | `string | null` |  |
| `common.posts[].flair` | `string | null` |  |
| `common.posts[].media_type` | `string | null` |  |
| `common.posts[].is_promoted` | `boolean` | True for promoted ads, which subreddit feeds include only when include_promoted=true. Organic posts are false. |
| `common.comments[].id` | `string` | Comment id with the t1_ prefix. |
| `common.comments[].author` | `string | null` |  |
| `common.comments[].content` | `string | null` |  |
| `common.comments[].created_at` | `string | null` |  |
| `common.comments[].upvotes` | `integer | null` |  |
| `common.comments[].permalink` | `string | null` |  |
| `common.comments[].parent_id` | `string | null` |  |
| `common.comments[].depth` | `integer | null` |  |
| `common.comments[].post.id` | `string | null` |  |
| `common.comments[].post.title` | `string | null` |  |
| `common.comments[].post.subreddit.name` | `string` | Subreddit name without the r/ prefix, e.g. 'selfhosted'. |
| `common.comments[].post.subreddit.subscribers` | `integer | null` |  |
| `common.subreddits[].name` | `string` |  |
| `common.subreddits[].description` | `string | null` |  |
| `common.subreddits[].subscribers` | `integer | null` |  |
| `common.users[].username` | `string` |  |
| `common.users[].created_at` | `string | null` |  |
| `common.users[].karma` | `integer | null` |  |
| `common.users[].profile_url` | `string | null` |  |
| `common.cursor` | `string | null` |  |
| `common.next_url` | `string | null` |  |
| `common.returned_count` | `integer` |  |
| `common.truncation_hint` | `string | null` |  |
| `freshness.source_retrieved_at` | `string | null` |  |
| `freshness.served_at` | `string` |  |
| `freshness.cache_age_seconds` | `integer | null` |  |
| `freshness.served_from_cache` | `boolean` | True when these bytes were served from cache rather than fetched for this call. source_retrieved_at says how old they are. |
| `freshness.freshness_requested` | `recent | realtime` |  |
| `freshness.freshness_served` | `recent | realtime | stale` |  |
| `usage.receipt_id` | `string | null` |  |
| `usage.credits_quoted` | `integer` |  |
| `usage.credits_charged` | `integer` |  |
| `usage.balance_remaining` | `integer | null` |  |
| `usage.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). |

## subreddit

| Field | Type | Description |
| --- | --- | --- |
| `entity` | `"subreddit"` |  |
| `platform` | `linkedin | reddit | x | null` |  |
| `canonical_url` | `string | null` |  |
| `data_as_of` | `string | null` |  |
| `schema_version` | `"2"` |  |
| `common.name` | `string` |  |
| `common.title` | `string | null` |  |
| `common.description` | `string | null` |  |
| `common.subscribers` | `integer | null` |  |
| `common.active_users` | `integer | null` |  |
| `common.created_at` | `string | null` |  |
| `common.is_nsfw` | `boolean | null` |  |
| `common.topics` | `array<string>` |  |
| `common.url` | `string` | Canonical reddit.com URL for the subreddit. |
| `common.rules[].name` | `string | null` |  |
| `common.rules[].description` | `string | null` |  |
| `common.moderators` | `array<string> | null` |  |
| `freshness.source_retrieved_at` | `string | null` |  |
| `freshness.served_at` | `string` |  |
| `freshness.cache_age_seconds` | `integer | null` |  |
| `freshness.served_from_cache` | `boolean` | True when these bytes were served from cache rather than fetched for this call. source_retrieved_at says how old they are. |
| `freshness.freshness_requested` | `recent | realtime` |  |
| `freshness.freshness_served` | `recent | realtime | stale` |  |
| `usage.receipt_id` | `string | null` |  |
| `usage.credits_quoted` | `integer` |  |
| `usage.credits_charged` | `integer` |  |
| `usage.balance_remaining` | `integer | null` |  |
| `usage.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). |

## reddit_posts

| Field | Type | Description |
| --- | --- | --- |
| `entity` | `"reddit_posts"` |  |
| `platform` | `linkedin | reddit | x | null` |  |
| `canonical_url` | `string | null` |  |
| `data_as_of` | `string | null` |  |
| `schema_version` | `"2"` |  |
| `common.results[].id` | `string` | Post id with the t3_ prefix. Pass to reddit_get_post. |
| `common.results[].title` | `string | null` |  |
| `common.results[].author` | `string | null` |  |
| `common.results[].subreddit.name` | `string` | Subreddit name without the r/ prefix, e.g. 'selfhosted'. |
| `common.results[].subreddit.subscribers` | `integer | null` |  |
| `common.results[].created_at` | `string | null` |  |
| `common.results[].upvotes` | `integer | null` |  |
| `common.results[].upvote_ratio` | `number | null` |  |
| `common.results[].comment_count` | `integer | null` |  |
| `common.results[].permalink` | `string | null` |  |
| `common.results[].external_url` | `string | null` |  |
| `common.results[].preview_text` | `string | null` |  |
| `common.results[].flair` | `string | null` |  |
| `common.results[].media_type` | `string | null` |  |
| `common.results[].is_promoted` | `boolean` | True for promoted ads, which subreddit feeds include only when include_promoted=true. Organic posts are false. |
| `common.cursor` | `string | null` |  |
| `common.next_url` | `string | null` |  |
| `common.returned_count` | `integer` |  |
| `freshness.source_retrieved_at` | `string | null` |  |
| `freshness.served_at` | `string` |  |
| `freshness.cache_age_seconds` | `integer | null` |  |
| `freshness.served_from_cache` | `boolean` | True when these bytes were served from cache rather than fetched for this call. source_retrieved_at says how old they are. |
| `freshness.freshness_requested` | `recent | realtime` |  |
| `freshness.freshness_served` | `recent | realtime | stale` |  |
| `usage.receipt_id` | `string | null` |  |
| `usage.credits_quoted` | `integer` |  |
| `usage.credits_charged` | `integer` |  |
| `usage.balance_remaining` | `integer | null` |  |
| `usage.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). |

## reddit_user

| Field | Type | Description |
| --- | --- | --- |
| `entity` | `"reddit_user"` |  |
| `platform` | `linkedin | reddit | x | null` |  |
| `canonical_url` | `string | null` |  |
| `data_as_of` | `string | null` |  |
| `schema_version` | `"2"` |  |
| `common.username` | `string` |  |
| `common.created_at` | `string | null` |  |
| `common.karma` | `integer | null` |  |
| `common.followers` | `integer | null` |  |
| `common.is_verified` | `boolean | null` |  |
| `common.description` | `string | null` |  |
| `common.account_type` | `string | null` |  |
| `common.url` | `string` | Canonical reddit.com URL for the user. |
| `common.comments[].id` | `string` | Comment id with the t1_ prefix. |
| `common.comments[].author` | `string | null` |  |
| `common.comments[].content` | `string | null` |  |
| `common.comments[].created_at` | `string | null` |  |
| `common.comments[].upvotes` | `integer | null` |  |
| `common.comments[].permalink` | `string | null` |  |
| `common.comments[].parent_id` | `string | null` |  |
| `common.comments[].depth` | `integer | null` |  |
| `common.comments[].post.id` | `string | null` |  |
| `common.comments[].post.title` | `string | null` |  |
| `common.comments[].post.subreddit.name` | `string` | Subreddit name without the r/ prefix, e.g. 'selfhosted'. |
| `common.comments[].post.subreddit.subscribers` | `integer | null` |  |
| `common.posts[].id` | `string` | Post id with the t3_ prefix. Pass to reddit_get_post. |
| `common.posts[].title` | `string | null` |  |
| `common.posts[].author` | `string | null` |  |
| `common.posts[].subreddit.name` | `string` | Subreddit name without the r/ prefix, e.g. 'selfhosted'. |
| `common.posts[].subreddit.subscribers` | `integer | null` |  |
| `common.posts[].created_at` | `string | null` |  |
| `common.posts[].upvotes` | `integer | null` |  |
| `common.posts[].upvote_ratio` | `number | null` |  |
| `common.posts[].comment_count` | `integer | null` |  |
| `common.posts[].permalink` | `string | null` |  |
| `common.posts[].external_url` | `string | null` |  |
| `common.posts[].preview_text` | `string | null` |  |
| `common.posts[].flair` | `string | null` |  |
| `common.posts[].media_type` | `string | null` |  |
| `common.posts[].is_promoted` | `boolean` | True for promoted ads, which subreddit feeds include only when include_promoted=true. Organic posts are false. |
| `common.subreddits[].name` | `string` | Subreddit name without the r/ prefix, e.g. 'selfhosted'. |
| `common.subreddits[].subscribers` | `integer | null` |  |
| `freshness.source_retrieved_at` | `string | null` |  |
| `freshness.served_at` | `string` |  |
| `freshness.cache_age_seconds` | `integer | null` |  |
| `freshness.served_from_cache` | `boolean` | True when these bytes were served from cache rather than fetched for this call. source_retrieved_at says how old they are. |
| `freshness.freshness_requested` | `recent | realtime` |  |
| `freshness.freshness_served` | `recent | realtime | stale` |  |
| `usage.receipt_id` | `string | null` |  |
| `usage.credits_quoted` | `integer` |  |
| `usage.credits_charged` | `integer` |  |
| `usage.balance_remaining` | `integer | null` |  |
| `usage.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). |

## reddit_thread

| Field | Type | Description |
| --- | --- | --- |
| `entity` | `"reddit_thread"` |  |
| `platform` | `linkedin | reddit | x | null` |  |
| `canonical_url` | `string | null` |  |
| `data_as_of` | `string | null` |  |
| `schema_version` | `"2"` |  |
| `common.posts[].id` | `string` | Post id with the t3_ prefix. Pass to reddit_get_post. |
| `common.posts[].title` | `string | null` |  |
| `common.posts[].author` | `string | null` |  |
| `common.posts[].subreddit.name` | `string` | Subreddit name without the r/ prefix, e.g. 'selfhosted'. |
| `common.posts[].subreddit.subscribers` | `integer | null` |  |
| `common.posts[].created_at` | `string | null` |  |
| `common.posts[].upvotes` | `integer | null` |  |
| `common.posts[].upvote_ratio` | `number | null` |  |
| `common.posts[].comment_count` | `integer | null` |  |
| `common.posts[].permalink` | `string | null` |  |
| `common.posts[].external_url` | `string | null` |  |
| `common.posts[].preview_text` | `string | null` |  |
| `common.posts[].flair` | `string | null` |  |
| `common.posts[].media_type` | `string | null` |  |
| `common.posts[].is_promoted` | `boolean` | True for promoted ads, which subreddit feeds include only when include_promoted=true. Organic posts are false. |
| `common.posts[].content` | `string | null` |  |
| `common.comments[].id` | `string` | Comment id with the t1_ prefix. |
| `common.comments[].author` | `string | null` |  |
| `common.comments[].content` | `string | null` |  |
| `common.comments[].created_at` | `string | null` |  |
| `common.comments[].upvotes` | `integer | null` |  |
| `common.comments[].permalink` | `string | null` |  |
| `common.comments[].parent_id` | `string | null` |  |
| `common.comments[].depth` | `integer | null` |  |
| `common.comments[].post.id` | `string | null` |  |
| `common.comments[].post.title` | `string | null` |  |
| `common.comments[].post.subreddit.name` | `string` | Subreddit name without the r/ prefix, e.g. 'selfhosted'. |
| `common.comments[].post.subreddit.subscribers` | `integer | null` |  |
| `common.comments_cursor` | `string | null` |  |
| `common.returned_count` | `integer` |  |
| `freshness.source_retrieved_at` | `string | null` |  |
| `freshness.served_at` | `string` |  |
| `freshness.cache_age_seconds` | `integer | null` |  |
| `freshness.served_from_cache` | `boolean` | True when these bytes were served from cache rather than fetched for this call. source_retrieved_at says how old they are. |
| `freshness.freshness_requested` | `recent | realtime` |  |
| `freshness.freshness_served` | `recent | realtime | stale` |  |
| `usage.receipt_id` | `string | null` |  |
| `usage.credits_quoted` | `integer` |  |
| `usage.credits_charged` | `integer` |  |
| `usage.balance_remaining` | `integer | null` |  |
| `usage.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). |

## x_search

| Field | Type | Description |
| --- | --- | --- |
| `entity` | `"x_search"` |  |
| `platform` | `linkedin | reddit | x | null` |  |
| `canonical_url` | `string | null` |  |
| `data_as_of` | `string | null` |  |
| `schema_version` | `"2"` |  |
| `common.type` | `recent | popular | people` | Which result array is populated. |
| `common.tweets[].id` | `string` | Numeric tweet id as a string. Pass to x_get_tweet. |
| `common.tweets[].text` | `string | null` |  |
| `common.tweets[].author.screen_name` | `string | null` |  |
| `common.tweets[].author.name` | `string | null` |  |
| `common.tweets[].author.id` | `string | null` |  |
| `common.tweets[].author.followers` | `integer | null` |  |
| `common.tweets[].author.is_verified` | `boolean | null` |  |
| `common.tweets[].created_at` | `string | null` |  |
| `common.tweets[].url` | `string | null` |  |
| `common.tweets[].views` | `integer | null` |  |
| `common.tweets[].likes` | `integer | null` |  |
| `common.tweets[].retweets` | `integer | null` |  |
| `common.tweets[].replies` | `integer | null` |  |
| `common.tweets[].quotes` | `integer | null` |  |
| `common.tweets[].bookmarks` | `integer | null` |  |
| `common.tweets[].lang` | `string | null` |  |
| `common.tweets[].is_reply` | `boolean | null` |  |
| `common.tweets[].is_retweet` | `boolean | null` |  |
| `common.tweets[].is_quote` | `boolean | null` |  |
| `common.tweets[].in_reply_to_screen_name` | `string | null` |  |
| `common.tweets[].conversation_id` | `string | null` |  |
| `common.tweets[].possibly_sensitive` | `boolean | null` |  |
| `common.people[].screen_name` | `string | null` |  |
| `common.people[].name` | `string | null` |  |
| `common.people[].id` | `string | null` |  |
| `common.people[].followers` | `integer | null` |  |
| `common.people[].is_verified` | `boolean | null` |  |
| `common.people[].description` | `string | null` |  |
| `common.people[].location` | `string | null` |  |
| `common.cursor` | `string | null` |  |
| `common.next_url` | `string | null` |  |
| `common.returned_count` | `integer` |  |
| `common.truncation_hint` | `string | null` |  |
| `freshness.source_retrieved_at` | `string | null` |  |
| `freshness.served_at` | `string` |  |
| `freshness.cache_age_seconds` | `integer | null` |  |
| `freshness.served_from_cache` | `boolean` | True when these bytes were served from cache rather than fetched for this call. source_retrieved_at says how old they are. |
| `freshness.freshness_requested` | `recent | realtime` |  |
| `freshness.freshness_served` | `recent | realtime | stale` |  |
| `usage.receipt_id` | `string | null` |  |
| `usage.credits_quoted` | `integer` |  |
| `usage.credits_charged` | `integer` |  |
| `usage.balance_remaining` | `integer | null` |  |
| `usage.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). |

## x_profile

| Field | Type | Description |
| --- | --- | --- |
| `entity` | `"x_profile"` |  |
| `platform` | `linkedin | reddit | x | null` |  |
| `canonical_url` | `string | null` |  |
| `data_as_of` | `string | null` |  |
| `schema_version` | `"2"` |  |
| `common.screen_name` | `string` |  |
| `common.name` | `string | null` |  |
| `common.description` | `string | null` |  |
| `common.location` | `string | null` |  |
| `common.website_url` | `string | null` |  |
| `common.created_at` | `string | null` |  |
| `common.followers` | `integer | null` |  |
| `common.following` | `integer | null` |  |
| `common.tweets_count` | `integer | null` |  |
| `common.media_count` | `integer | null` |  |
| `common.is_verified` | `boolean | null` |  |
| `common.verified_type` | `string | null` |  |
| `common.is_protected` | `boolean | null` |  |
| `common.image_url` | `string | null` |  |
| `common.banner_url` | `string | null` |  |
| `common.url` | `string` | Canonical x.com profile URL. |
| `platform_fields.id` | `string` | Numeric account id as a string; stable across handle changes. Use for repeat lookups. |
| `platform_fields.pinned_tweet_ids` | `array<string> | null` |  |
| `platform_fields.is_business_account` | `boolean | null` |  |
| `freshness.source_retrieved_at` | `string | null` |  |
| `freshness.served_at` | `string` |  |
| `freshness.cache_age_seconds` | `integer | null` |  |
| `freshness.served_from_cache` | `boolean` | True when these bytes were served from cache rather than fetched for this call. source_retrieved_at says how old they are. |
| `freshness.freshness_requested` | `recent | realtime` |  |
| `freshness.freshness_served` | `recent | realtime | stale` |  |
| `usage.receipt_id` | `string | null` |  |
| `usage.credits_quoted` | `integer` |  |
| `usage.credits_charged` | `integer` |  |
| `usage.balance_remaining` | `integer | null` |  |
| `usage.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). |

## x_tweets

| Field | Type | Description |
| --- | --- | --- |
| `entity` | `"x_tweets"` |  |
| `platform` | `linkedin | reddit | x | null` |  |
| `canonical_url` | `string | null` |  |
| `data_as_of` | `string | null` |  |
| `schema_version` | `"2"` |  |
| `common.results[].id` | `string` | Numeric tweet id as a string. Pass to x_get_tweet. |
| `common.results[].text` | `string | null` |  |
| `common.results[].author.screen_name` | `string | null` |  |
| `common.results[].author.name` | `string | null` |  |
| `common.results[].author.id` | `string | null` |  |
| `common.results[].author.followers` | `integer | null` |  |
| `common.results[].author.is_verified` | `boolean | null` |  |
| `common.results[].created_at` | `string | null` |  |
| `common.results[].url` | `string | null` |  |
| `common.results[].views` | `integer | null` |  |
| `common.results[].likes` | `integer | null` |  |
| `common.results[].retweets` | `integer | null` |  |
| `common.results[].replies` | `integer | null` |  |
| `common.results[].quotes` | `integer | null` |  |
| `common.results[].bookmarks` | `integer | null` |  |
| `common.results[].lang` | `string | null` |  |
| `common.results[].is_reply` | `boolean | null` |  |
| `common.results[].is_retweet` | `boolean | null` |  |
| `common.results[].is_quote` | `boolean | null` |  |
| `common.results[].in_reply_to_screen_name` | `string | null` |  |
| `common.results[].conversation_id` | `string | null` |  |
| `common.results[].possibly_sensitive` | `boolean | null` |  |
| `common.cursor` | `string | null` |  |
| `common.next_url` | `string | null` |  |
| `common.returned_count` | `integer` |  |
| `freshness.source_retrieved_at` | `string | null` |  |
| `freshness.served_at` | `string` |  |
| `freshness.cache_age_seconds` | `integer | null` |  |
| `freshness.served_from_cache` | `boolean` | True when these bytes were served from cache rather than fetched for this call. source_retrieved_at says how old they are. |
| `freshness.freshness_requested` | `recent | realtime` |  |
| `freshness.freshness_served` | `recent | realtime | stale` |  |
| `usage.receipt_id` | `string | null` |  |
| `usage.credits_quoted` | `integer` |  |
| `usage.credits_charged` | `integer` |  |
| `usage.balance_remaining` | `integer | null` |  |
| `usage.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). |

## x_tweet

| Field | Type | Description |
| --- | --- | --- |
| `entity` | `"x_tweet"` |  |
| `platform` | `linkedin | reddit | x | null` |  |
| `canonical_url` | `string | null` |  |
| `data_as_of` | `string | null` |  |
| `schema_version` | `"2"` |  |
| `common.id` | `string` | Numeric tweet id as a string. Pass to x_get_tweet. |
| `common.text` | `string | null` |  |
| `common.author.screen_name` | `string | null` |  |
| `common.author.name` | `string | null` |  |
| `common.author.id` | `string | null` |  |
| `common.author.followers` | `integer | null` |  |
| `common.author.is_verified` | `boolean | null` |  |
| `common.created_at` | `string | null` |  |
| `common.url` | `string | null` |  |
| `common.views` | `integer | null` |  |
| `common.likes` | `integer | null` |  |
| `common.retweets` | `integer | null` |  |
| `common.replies` | `integer | null` |  |
| `common.quotes` | `integer | null` |  |
| `common.bookmarks` | `integer | null` |  |
| `common.lang` | `string | null` |  |
| `common.is_reply` | `boolean | null` |  |
| `common.is_retweet` | `boolean | null` |  |
| `common.is_quote` | `boolean | null` |  |
| `common.in_reply_to_screen_name` | `string | null` |  |
| `common.conversation_id` | `string | null` |  |
| `common.possibly_sensitive` | `boolean | null` |  |
| `common.quoted_tweet.id` | `string` | Numeric tweet id as a string. Pass to x_get_tweet. |
| `common.quoted_tweet.text` | `string | null` |  |
| `common.quoted_tweet.author.screen_name` | `string | null` |  |
| `common.quoted_tweet.author.name` | `string | null` |  |
| `common.quoted_tweet.author.id` | `string | null` |  |
| `common.quoted_tweet.author.followers` | `integer | null` |  |
| `common.quoted_tweet.author.is_verified` | `boolean | null` |  |
| `common.quoted_tweet.created_at` | `string | null` |  |
| `common.quoted_tweet.url` | `string | null` |  |
| `common.quoted_tweet.views` | `integer | null` |  |
| `common.quoted_tweet.likes` | `integer | null` |  |
| `common.quoted_tweet.retweets` | `integer | null` |  |
| `common.quoted_tweet.replies` | `integer | null` |  |
| `common.quoted_tweet.quotes` | `integer | null` |  |
| `common.quoted_tweet.bookmarks` | `integer | null` |  |
| `common.quoted_tweet.lang` | `string | null` |  |
| `common.quoted_tweet.is_reply` | `boolean | null` |  |
| `common.quoted_tweet.is_retweet` | `boolean | null` |  |
| `common.quoted_tweet.is_quote` | `boolean | null` |  |
| `common.quoted_tweet.in_reply_to_screen_name` | `string | null` |  |
| `common.quoted_tweet.conversation_id` | `string | null` |  |
| `common.quoted_tweet.possibly_sensitive` | `boolean | null` |  |
| `freshness.source_retrieved_at` | `string | null` |  |
| `freshness.served_at` | `string` |  |
| `freshness.cache_age_seconds` | `integer | null` |  |
| `freshness.served_from_cache` | `boolean` | True when these bytes were served from cache rather than fetched for this call. source_retrieved_at says how old they are. |
| `freshness.freshness_requested` | `recent | realtime` |  |
| `freshness.freshness_served` | `recent | realtime | stale` |  |
| `usage.receipt_id` | `string | null` |  |
| `usage.credits_quoted` | `integer` |  |
| `usage.credits_charged` | `integer` |  |
| `usage.balance_remaining` | `integer | null` |  |
| `usage.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). |

## usage

| Field | Type | Description |
| --- | --- | --- |
| `entity` | `"usage"` |  |
| `platform` | `linkedin | reddit | x | null` |  |
| `canonical_url` | `string | null` |  |
| `data_as_of` | `string | null` |  |
| `schema_version` | `"2"` |  |
| `common.plan` | `trial | payg | flex | production` |  |
| `common.platforms` | `array<string>` | Platforms this account's key may call. Grants are explicit; write to hello@veezee.io to enable more. |
| `common.balance_remaining` | `integer` |  |
| `common.free_tier.credits_per_ip_day` | `integer` |  |
| `common.free_tier.used_today` | `integer` |  |
| `common.free_tier.remaining_today` | `integer` |  |
| `common.free_tier.resets` | `string` | UTC midnight when the day budget resets. ISO 8601. |
| `common.realtime_ops_used` | `integer` |  |
| `common.realtime_ops_limit` | `integer | null` |  |
| `common.concurrent_limit` | `integer` |  |
| `common.recent_receipts[].receipt_id` | `string` |  |
| `common.recent_receipts[].tool` | `string` |  |
| `common.recent_receipts[].credits_charged` | `integer` |  |
| `common.recent_receipts[].created_at` | `string` |  |
| `common.claim_url` | `string | null` |  |
| `common.upgrade_url` | `string` | Give this link to your human to add credits or upgrade; purchases credit THIS account with no login. |
| `common.manage_url` | `string` | Give this link to your human to change or cancel a paid plan in the Stripe billing portal. Valid at least 24 hours; call get_usage again for a fresh one. |
| `freshness.source_retrieved_at` | `string | null` |  |
| `freshness.served_at` | `string` |  |
| `freshness.cache_age_seconds` | `integer | null` |  |
| `freshness.served_from_cache` | `boolean` | True when these bytes were served from cache rather than fetched for this call. source_retrieved_at says how old they are. |
| `freshness.freshness_requested` | `recent | realtime` |  |
| `freshness.freshness_served` | `recent | realtime | stale` |  |
| `usage.receipt_id` | `string | null` |  |
| `usage.credits_quoted` | `integer` |  |
| `usage.credits_charged` | `integer` |  |
| `usage.balance_remaining` | `integer | null` |  |
| `usage.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). |