> **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/lists/get](https://www.socialfetch.dev/docs/api/v1/twitter/lists/get) - **Markdown (.mdx) URL:** [https://www.socialfetch.dev/docs/api/v1/twitter/lists/get.mdx](https://www.socialfetch.dev/docs/api/v1/twitter/lists/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 Twitter list (https://www.socialfetch.dev/docs/api/v1/twitter/lists/get) ## Summary Get an X list by URL or id. **Tags:** `Twitter` ## HTTP - **Method:** GET - **Path:** `/v1/twitter/lists` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.twitter.getList({ url })` - **Accepted identifiers:** `url` (query) - **Pagination:** none - **Business outcome field:** `data.lookupStatus` with values `found`, `not_found`, `private` ## Agent notes - **Disambiguation:** Unknown lists usually return `lookupStatus: not_found`. Some valid-looking list ids return an uncharged 502 `lookup_failed` — that is not a client input error; confirm the list on X or try another id. ## 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 ### `url` (query) - **Required:** yes - **Constraints:** type `string`; minLength: 1; maxLength: 4096 - **Description:** List permalink or numeric id. ## Responses (status codes) - **200**: List details. - **400**: Invalid 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) List details. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, not_found, private. Whether the list was found. - **list** (required) — type `object`; nullable. List details when available. - **id** (required) — type `string`; minLength: 1. Numeric list identifier as a string. - **name** (required) — type `string`. List display name. - **description** (required) — type `string`; nullable. List description text when available. - **isPrivate** (required) — type `boolean`. Whether the list is private. - **url** (required) — type `string`; minLength: 1. Canonical public list URL on x.com (`https://x.com/i/lists/{id}`). - **bannerUrl** (required) — type `string`; nullable. List banner image URL when available. - **memberCount** (required) — type `integer`; minimum: 0; nullable. Approximate member count when available. - **subscriberCount** (required) — type `integer`; minimum: 0; nullable. Approximate subscriber (follower) count when available. - **createdAt** (required) — type `string`; nullable. List creation time (ISO-8601) when available. - **owner** (required) — type `object`; nullable. List owner compact user card when available. - **id** (required) — type `string`. Numeric X user id as a string. - **handle** (required) — type `string`. X screen name (handle) without the leading @. - **displayName** (required) — type `string`; nullable. Display name shown on the profile. - **description** (required) — type `string`; nullable. Profile biography text. - **avatarUrl** (required) — type `string`; nullable. Best available square avatar image URL. - **bannerUrl** (required) — type `string`; nullable. Profile banner image URL when available. - **location** (required) — type `string`; nullable. Location string from the profile when provided. - **website** (required) — type `string`; nullable. Primary outbound link (expanded URL) from the profile. - **verified** (required) — type `boolean`. Whether X marks the profile with legacy verification (not necessarily paid blue). - **isBlueVerified** (required) — type `boolean`. Whether the account has X blue (paid) verification. - **isProtected** (required) — type `boolean`. Whether the account is protected (private). - **followerCount** (required) — type `integer`; minimum: 0; nullable. Follower count from X when available. - **followingCount** (required) — type `integer`; minimum: 0; nullable. Following (friends) count from X when available. - **tweetCount** (required) — type `integer`; minimum: 0; nullable. Total post (status) count from X when available. - **listedCount** (required) — type `integer`; minimum: 0; nullable. Listed count when X provides it. - **createdAt** (required) — type `string`; nullable. Account creation time (ISO-8601) when derivable. - **profileUrl** (required) — type `string`. Canonical public profile URL on x.com (`https://x.com/`). - **profileImageShape** (optional) — type `string`; nullable. Avatar crop shape reported by X, such as Circle or Square. - **verifiedType** (optional) — type `string`; nullable. X verification type label when provided (for example a government or organization note). - **pinnedTweetIds** (optional) — type `array`; nullable. Pinned tweet ids from X, in display order. - _items:_ - type `string` - **professional** (optional) — 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** (optional) — type `array`; nullable. Country codes where the profile is withheld. - _items:_ - type `string` - **favoritesCount** (optional) — type `integer`; minimum: 0; nullable. Total likes (favorites) on the profile when available. - **mediaCount** (optional) — type `integer`; minimum: 0; nullable. Media item count when X provides it. - **slug** (optional) — type `string`; nullable. List slug when X provides one. - **uri** (optional) — type `string`; nullable. List URI when X provides one. - **facepileUrls** (optional) — type `array`; nullable. Member avatar URLs shown in the list preview. - _items:_ - type `string`; minLength: 1 - **defaultBannerMedia** (optional) — nullable. Default banner media payload when X provides one. - **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 (found) ```json { "data": { "lookupStatus": "found", "list": { "id": "9001939934624392988", "name": "Sample User 71233", "description": "Sample profile bio for Sample User 52066.", "isPrivate": false, "url": "https://x.com/i/lists/9001939934624392988", "bannerUrl": null, "memberCount": 42, "subscriberCount": 2362, "createdAt": "2022-07-01T02:37:35.000Z", "owner": { "id": "1004175810672249878", "handle": "sample_user_78026", "displayName": "Sample User 78026", "description": "Sample profile bio for Sample User 78026.", "avatarUrl": "https://example.com/images/sample-avatar-78026.jpg", "bannerUrl": "https://example.com/images/sample-banner-78026.jpg", "location": null, "website": null, "verified": false, "isBlueVerified": false, "isProtected": false, "followerCount": 66, "followingCount": 334, "tweetCount": 1477, "listedCount": 0, "createdAt": "2020-03-14T01:03:23.000Z", "profileUrl": "https://x.com/sample_user_78026", "profileImageShape": "Circle", "verifiedType": null, "pinnedTweetIds": [ "2003389317958797165" ], "professional": null, "withheldInCountries": [], "favoritesCount": 59316, "mediaCount": 19 }, "slug": null, "uri": null, "facepileUrls": [ "https://example.com/link-94089/profile-29900/media/sample-media-71233.jpg" ], "defaultBannerMedia": null } }, "meta": { "requestId": "req_example_twitter_list", "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 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.getList({ url: "https://x.com/i/lists/1227596802024771586", }); 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/lists?url=https://x.com/i/lists/1227596802024771586", { headers: { "x-api-key": "YOUR_API_KEY" } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v1/twitter/lists?url=https://x.com/i/lists/1227596802024771586" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/twitter/lists?url=https://x.com/i/lists/1227596802024771586", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ```