> **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/threads/search/get](https://www.socialfetch.dev/docs/api/v1/threads/search/get) - **Markdown (.mdx) URL:** [https://www.socialfetch.dev/docs/api/v1/threads/search/get.mdx](https://www.socialfetch.dev/docs/api/v1/threads/search/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`). --- # Search Threads posts (https://www.socialfetch.dev/docs/api/v1/threads/search/get) ## Summary Returns public Threads posts matching a search query. Optional date filters limit the search window. **Tags:** `Threads` ## HTTP - **Method:** GET - **Path:** `/v1/threads/search` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.threads.search({ query, startDate?, endDate?, trim? })` - **Pagination:** none - **Trimmed response mode:** supported via `trim=true` ## Credits - **Base:** 1 credit per successful lookup. - **Maximum on success (200):** 1 credit. - **Normalization failure (502):** 1 credit charged. - **Authoritative field:** `meta.creditsCharged`. ## Authentication - **`x-api-key`**: API key (`sfk_...`) ## Parameters ### `query` (query) - **Required:** yes - **Constraints:** type `string`; minLength: 1; maxLength: 512 - **Description:** Search query text for public Threads posts. ### `startDate` (query) - **Required:** no - **Constraints:** type `string`; pattern: `^\d{4}-\d{2}-\d{2}$` - **Description:** Optional start date filter in YYYY-MM-DD format. ### `endDate` (query) - **Required:** no - **Constraints:** type `string`; pattern: `^\d{4}-\d{2}-\d{2}$` - **Description:** Optional end date filter in YYYY-MM-DD format. ### `trim` (query) - **Required:** no - **Constraints:** type `boolean` - **Description:** Whether to request a smaller response shape when available. ## Behavior notes - **`trim`**: Whether to request a smaller response shape when available. ## Responses (status codes) - **200**: Search results for the requested query. - **400**: Invalid query parameters - **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) Search results for the requested query. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **query** (required) — type `string`. Search query string evaluated for this response. - **posts** (required) — type `array`. Threads posts matching the query. - _items:_ - **id** (required) — type `string`; minLength: 1. Stable post identifier string. - **platform** (required) — type `string`; enum: threads. Social platform for this search result. - **url** (required) — type `string`; minLength: 1; nullable. Canonical public post URL when available. - **code** (required) — type `string`; minLength: 1; nullable. Short post code used in public URLs when available. - **text** (required) — type `string`. Post body text when available (may be empty). - **createdAt** (required) — type `integer`; minimum: 0; nullable. Creation time as a Unix timestamp in seconds when available. - **author** (required) — type `object`; nullable. Author details when available. - **id** (required) — type `string`; nullable. Author profile identifier when available. - **handle** (required) — type `string`; nullable. Author username without a leading @ when available. - **displayName** (required) — type `string`; nullable. Author display name when available. - **avatarUrl** (required) — type `string`; nullable. Profile image URL for the author when available. - **verified** (required) — type `boolean`. Whether the author is marked as verified. - **privateAccount** (required) — type `boolean`; nullable. Whether the author account is private when known. - **profileUrl** (required) — type `string`; nullable. Canonical public profile URL when available. - **metrics** (required) — type `object`. Engagement metrics for this post. - **likes** (required) — type `integer`; minimum: 0; nullable. Like count when available. - **reposts** (required) — type `integer`; minimum: 0; nullable. Repost count when available. - **quotes** (required) — type `integer`; minimum: 0; nullable. Quote-post count when available. - **replies** (required) — type `integer`; minimum: 0; nullable. Direct reply count when available. - **media** (required) — type `array`. Image and video items extracted from the post. - _items:_ - **type** (required) — type `string`; enum: image, video, unknown. Normalized media type for this item. - **url** (required) — type `string`; minLength: 1. Direct URL for this media item when available. - **width** (required) — type `integer`; minimum: 0; nullable. Width in pixels when available. - **height** (required) — type `integer`; minimum: 0; nullable. Height in pixels when available. - **totalResults** (required) — type `integer`; minimum: 0. Count of posts returned in this response. - **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 (results) ```json { "data": { "query": "basketball", "totalResults": 2, "posts": [ { "id": "3876725847588352169_63251387228", "platform": "threads", "url": "https://www.threads.net/@courtinsights/post/DXM5Z5dFDCp", "code": "DXM5Z5dFDCp", "text": "More basketball highlights from tonight's game.", "createdAt": 1776361755, "author": { "id": "63251387228", "handle": "courtinsights", "displayName": "Court Insights", "avatarUrl": "https://example.com/avatar.jpg", "verified": true, "privateAccount": false, "profileUrl": "https://www.threads.net/@courtinsights" }, "metrics": { "likes": 9041, "reposts": 322, "quotes": 32, "replies": 176 }, "media": [ { "type": "image", "url": "https://example.com/image-1440.jpg", "width": 1440, "height": 1919 } ] }, { "id": "3817101020598584113_66348895092", "platform": "threads", "url": "https://www.threads.net/@cityhoops/post/DT5ESeEj0Mx", "code": "DT5ESeEj0Mx", "text": "Open-gym basketball is the best reset.", "createdAt": 1769253924, "author": { "id": "66348895092", "handle": "cityhoops", "displayName": "City Hoops", "avatarUrl": null, "verified": false, "privateAccount": false, "profileUrl": "https://www.threads.net/@cityhoops" }, "metrics": { "likes": 1803, "reposts": null, "quotes": null, "replies": null }, "media": [] } ] }, "meta": { "requestId": "req_01example", "creditsCharged": 1, "version": "v1" } } ``` ### Example JSON (empty) ```json { "data": { "query": "socialfetch_fixture_no_results_000000", "totalResults": 0, "posts": [] }, "meta": { "requestId": "req_01example", "creditsCharged": 1, "version": "v1" } } ``` ### Example JSON (trimmed) ```json { "data": { "query": "basketball", "totalResults": 1, "posts": [ { "id": "3876725847588352169_63251387228", "platform": "threads", "url": "https://www.threads.net/@courtinsights/post/DXM5Z5dFDCp", "code": "DXM5Z5dFDCp", "text": "More basketball highlights from tonight's game.", "createdAt": 1776361755, "author": { "id": "63251387228", "handle": "courtinsights", "displayName": "Court Insights", "avatarUrl": "https://example.com/avatar.jpg", "verified": true, "privateAccount": false, "profileUrl": "https://www.threads.net/@courtinsights" }, "metrics": { "likes": 9041, "reposts": null, "quotes": null, "replies": null }, "media": [] } ] }, "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 query parameters **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.threads.search({ query: "basketball", }); 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/threads/search?query=basketball", { headers: { "x-api-key": "YOUR_API_KEY", } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v1/threads/search?query=basketball" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/threads/search?query=basketball", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ``` ### Example: optional query parameters First request illustrating common optional query flags (adjust values to your integration): ```javascript const url = "https://api.socialfetch.dev/v1/threads/search?trim=true"; const response = await fetch(url, { headers: { "x-api-key": "YOUR_API_KEY" }, }); const data = await response.json(); ```