> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration. ## This page - **On-site (HTML):** [https://www.socialfetch.dev/docs/api/v1/twitter/profiles/get](https://www.socialfetch.dev/docs/api/v1/twitter/profiles/get) - **Markdown (.mdx) URL:** [https://www.socialfetch.dev/docs/api/v1/twitter/profiles/get.mdx](https://www.socialfetch.dev/docs/api/v1/twitter/profiles/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()`. - [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — every operation with identifiers, pagination, outcomes, media download, credits, and its SDK method. Generated from OpenAPI, so use it for route selection instead of scanning individual pages. - [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples. - [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, Make custom app, SDK, and REST API connection paths. - [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install. - [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 204 endpoint tools, plus docs_search/docs_read for implementation help. - [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples. - [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start. - [Make integration](https://www.socialfetch.dev/docs/integrations/make.mdx) — custom app modules for Make scenarios, API key credentials, and module catalog. - [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI). - [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls). - [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist. - [`/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`). - Published blog posts use the same convention: `/blog/{slug}` → `/blog/{slug}.mdx`, or `Accept: text/markdown` on the HTML URL (`Vary: Accept`). --- # Get multiple Twitter profiles (https://www.socialfetch.dev/docs/api/v1/twitter/profiles/get) ## Summary Get up to 50 X profiles in one request by handles and/or numeric user ids. **Tags:** `Twitter` ## HTTP - **Method:** GET - **Path:** `/v1/twitter/profiles` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.twitter.getProfilesBatch({ handles?, ids? })` - **Accepted identifiers:** `handle` (query), `id` (query) - **Pagination:** none ## Credits - **Base:** 1 credit per successful lookup. - **Maximum on success (200):** 1 credit. - **Normalization failure (502):** 0 credits charged. - **Authoritative field:** `meta.creditsCharged`. ## Authentication - **`x-api-key`**: API key (`sfk_...`) ## Parameters ### `handle` (query) - **Required:** no - **Constraints:** type `array`; nullable - **Description:** X (Twitter) profile handle without the leading @. Repeat this parameter for multiple handles. ### `id` (query) - **Required:** no - **Constraints:** type `array` - **Description:** Numeric X (Twitter) user id. Repeat this parameter for multiple ids. ## Responses (status codes) - **200**: Twitter profile batch lookup results. - **400**: Invalid handle or id, or batch size out of range - **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) Twitter profile batch lookup results. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **results** (required) — type `array`. Per-request profile lookup results, in the same order as the request (handles then ids). Duplicates are not removed. - _items:_ - **input** (required) — type `string`; minLength: 1. Requested handle or numeric user id echoed for this row. - **kind** (required) — type `string`; enum: handle, id. Whether this row was requested as a handle or a numeric user id. - **lookupStatus** (required) — type `string`; enum: found, private, not_found. Whether this profile was resolved. - **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 as a string. - **accountCreatedAt** (optional) — type `string`. Account creation time (ISO-8601) 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. - **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. - **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. - **isBlueVerified** (required) — type `boolean`; nullable. Whether X marks the account as blue-verified. Same signal as `blueVerified`. - **verifiedType** (required) — type `string`; nullable. X verification type label when provided (for example a government or organization note). - **pinnedTweetIds** (required) — type `array`; nullable. Pinned tweet ids from X, in display order. - _items:_ - type `string` - **favoritesCount** (required) — type `integer`; minimum: 0; nullable. Total likes (favorites) on the profile. Prefer `metrics.favourites`. - **createdAt** (required) — type `string`; nullable. Account creation time as returned by X (raw upstream string). Prefer `accountCreatedAt` for ISO-8601. - **professional** (required) — type `object`; nullable. X professional-account metadata when the account is marked professional. - **type** (required) — type `string`; nullable. Professional account type from X, when present. - **category** (required) — type `array`; nullable. Professional category entries from X. - _items:_ - nullable - **restId** (required) — type `string`; nullable. Professional account rest id from X, when present. - **withheldInCountries** (required) — type `array`; nullable. Country codes where the profile is withheld. - _items:_ - type `string` - **profileImageShape** (optional) — type `string`; nullable. Avatar crop shape reported by X, such as Circle or Square. - **verifiedSince** (optional) — type `string`; nullable. When X verification became effective (ISO-8601). Invalid dates are null. Prefer this over `verificationInfo.verifiedSinceMsec`. - **possiblySensitive** (optional) — type `boolean`; nullable. Whether X marks the profile as possibly sensitive. - **profileInterstitialType** (optional) — type `string`; nullable. Interstitial type shown on the profile when X reports one. - **hasHiddenSubscriptions** (optional) — type `boolean`; nullable. Whether creator subscriptions are hidden on the profile. - **hasGraduatedAccess** (optional) — type `boolean`; nullable. Whether X reports graduated access for this account. - **isProfileTranslatable** (optional) — type `boolean`; nullable. Whether X considers the profile text translatable. - **hasCustomTimelines** (optional) — type `boolean`; nullable. Whether the account has custom timelines. - **isTranslator** (optional) — type `boolean`; nullable. Whether X marks the account as a translator. - **defaultProfile** (optional) — type `boolean`; nullable. Whether the account still uses the default profile theme. - **defaultProfileImage** (optional) — type `boolean`; nullable. Whether the account still uses the default avatar. - **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. - **summary** (required) — type `object`. Summary counts for the profile batch. - **requested** (required) — type `integer`; minimum: 0. Number of handles and ids requested in this batch. - **found** (required) — type `integer`; minimum: 0. Number of public profiles successfully found. - **notFound** (required) — type `integer`; minimum: 0. Number of profiles that were not found. - **private** (required) — type `integer`; minimum: 0. Number of profiles that are protected (private). - **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. - **cached** (optional) — type `boolean`. True when served from shared response cache. Credits still apply (full endpoint price); Age header may be present. ### Example JSON (OpenAPI example) ```json { "data": { "results": [ { "input": "nasa", "kind": "handle", "lookupStatus": "found", "profile": { "platform": "twitter", "handle": "NASA", "displayName": "NASA", "bio": "Making the seemingly impossible, possible. ✨", "avatarUrl": "https://pbs.twimg.com/profile_images/1321163587679784960/0ZxKlEKB_400x400.jpg", "bannerUrl": "https://pbs.twimg.com/profile_banners/11348282/1788992290/1500x500", "verified": false, "blueVerified": true, "profileUrl": "https://x.com/NASA", "privateAccount": false, "platformUserId": "11348282", "accountCreatedAt": "2007-12-19T20:20:32.000Z", "location": "Pale Blue Dot", "website": "http://www.nasa.gov/", "verificationInfo": { "isIdentityVerified": false, "verifiedSinceMsec": "1249674830941" }, "highlights": { "canHighlightTweets": true, "highlightedTweetCount": 277 }, "businessAccount": { "affiliatesCount": 87 }, "creatorSubscriptionsCount": 0, "isBlueVerified": true, "verifiedType": "This account is verified because it is a government or multilateral organization account. Learn more", "pinnedTweetIds": [], "favoritesCount": 16987, "createdAt": "2007-12-19T20:20:32.000Z", "professional": null, "withheldInCountries": [], "profileImageShape": "Square", "verifiedSince": "2009-08-07T19:53:50.941Z", "possiblySensitive": false, "profileInterstitialType": null, "hasHiddenSubscriptions": false, "hasGraduatedAccess": true, "isProfileTranslatable": false, "hasCustomTimelines": true, "isTranslator": false, "defaultProfile": false, "defaultProfileImage": false }, "metrics": { "followers": 92390307, "following": 117, "tweets": 74285, "favourites": 16987, "listedCount": 96932, "mediaCount": 28140 } } ], "summary": { "requested": 3, "found": 2, "notFound": 1, "private": 0 } }, "meta": { "requestId": "req_example_twitter_profiles-batch", "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 id, or batch size out of range **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.getProfilesBatch(); 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", { 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" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/twitter/profiles", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ```