> **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):** - **Markdown (.mdx) URL:** ## API base URL and authentication - **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev` - **Authentication:** send `x-api-key: sfk_...` on `/v1/**` and `/v2/**` 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:** ## 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, 910 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`). --- # Search Stack Overflow questions (https://www.socialfetch.dev/docs/api/v1/stack-overflow/questions/search/get) ## Summary Search Stack Overflow questions and answers by words, title, body, tag, author or answer count, with snippets. **Tags:** `Stack Overflow` ## HTTP - **Method:** GET - **Path:** `/v1/stack-overflow/questions/search` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.stackOverflow.searchQuestions({ q: "segfault", sort: "votes" })` - **Pagination:** cursor via `cursor`, next cursor: `data.page.nextCursor`, has more: `data.page.hasMore` ## Credits - **Base:** 1 credit per successful lookup. - **Maximum on success (200):** 1 credit. - **Failed requests (`lookup_failed`, `503`):** not charged. - **Authoritative field:** `meta.creditsCharged`. ## Authentication - **`x-api-key`**: API key (`sfk_...`) ## Parameters ### `site` (query) - **Required:** no - **Constraints:** type `string` - **Description:** Stack Exchange site, by its API name (`askubuntu`, `serverfault`, `math`, `ru.stackoverflow`). Default: `stackoverflow`. The sites endpoint lists them all. ### `q` (query) - **Required:** no - **Constraints:** type `string`; minLength: 1; maxLength: 200 - **Description:** Free text to find in titles, bodies and tags. ### `title` (query) - **Required:** no - **Constraints:** type `string`; minLength: 1; maxLength: 200 - **Description:** Text that must be in the title. ### `body` (query) - **Required:** no - **Constraints:** type `string`; minLength: 1; maxLength: 200 - **Description:** Text that must be in the question body. ### `tagged` (query) - **Required:** no - **Constraints:** type `array` - **Description:** Only questions that carry all of these tags, comma-separated, up to 5. ### `notTagged` (query) - **Required:** no - **Constraints:** type `array` - **Description:** Leave out questions that carry any of these tags, comma-separated, up to 5. ### `user` (query) - **Required:** no - **Constraints:** type `integer`; minimum: -1; maximum: 2147483647 - **Description:** Only questions asked by this user id. ### `accepted` (query) - **Required:** no - **Constraints:** type `boolean` - **Description:** `true` for questions with an accepted answer, `false` for those without. ### `closed` (query) - **Required:** no - **Constraints:** type `boolean` - **Description:** `true` for closed questions, `false` for open ones. ### `answersMin` (query) - **Required:** no - **Constraints:** type `integer`; minimum: 0; maximum: 1000000000 - **Description:** Only questions with at least this many answers. ### `viewsMin` (query) - **Required:** no - **Constraints:** type `integer`; minimum: 0; maximum: 1000000000 - **Description:** Only questions with at least this many views. ### `createdAfter` (query) - **Required:** no - **Constraints:** type `string` - **Description:** Only questions asked at or after this time, as an ISO 8601 date or time (such as `2026-01-31`) or epoch seconds. A time with no zone is UTC. ### `createdBefore` (query) - **Required:** no - **Constraints:** type `string` - **Description:** Only questions asked before this time, as an ISO 8601 date or time (such as `2026-01-31`) or epoch seconds. A time with no zone is UTC. ### `sort` (query) - **Required:** no - **Constraints:** type `string`; enum: relevance, creation, activity, votes - **Description:** Order: `relevance` (default), `creation` (the only one that pages without a ceiling), `activity` or `votes`. Ties can repeat or skip rows. ### `order` (query) - **Required:** no - **Constraints:** type `string`; enum: desc, asc - **Description:** Direction of the sort: `desc` (default) or `asc`. ### `mode` (query) - **Required:** no - **Constraints:** type `string`; enum: full, excerpt - **Description:** `full` (default) returns questions. `excerpt` returns the questions and answers that match, each with a highlighted snippet. ### `include` (query) - **Required:** no - **Constraints:** type `array` - **Description:** `body` adds the question text (HTML and Markdown) to each row in `full` mode. Default: none. ### `limit` (query) - **Required:** no - **Constraints:** type `integer`; minimum: 1; maximum: 100 - **Description:** Up to this many rows per page, 1 to 100. Default: 30. A page can hold fewer than `limit` rows where rows share a creation second or a block of 100 rows ends. Follow `page.nextCursor` until `hasMore` is false. ### `cursor` (query) - **Required:** no - **Constraints:** type `string`; minLength: 1; maxLength: 1024 - **Description:** Cursor from `page.nextCursor` of the previous response. It only works with the same filters. ## Pagination This endpoint uses **cursor-based pagination** via the `cursor` query parameter. - Read **hasMore** from `data.page.hasMore`. - When that value is `true`, read **nextCursor** from `data.page.nextCursor` and pass it as the `cursor` query parameter on the **next** request (URL-encode when building a query string). - Omit `cursor` on the **first** request. - Stop when **hasMore** is `false` or **nextCursor** is null (end of list). ## Responses (status codes) - **200**: Search results. - **400**: Invalid request - **401**: Missing or invalid API key - **402**: Insufficient credits - **500**: Unexpected or billing error - **502**: Lookup could not be completed. - **503**: Service temporarily unavailable; safe to retry with backoff. ## Response body (200) Search results. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **site** (required) — type `string`. The site that was searched. - **mode** (required) — type `string`; enum: full, excerpt. Which list below is filled. - **questions** (required) — type `array`; nullable. The matching questions in `full` mode; null in `excerpt` mode. - _items:_ - **id** (required) — type `integer`. Question id. - **url** (required) — type `string`; nullable. Link to the question. - **title** (required) — type `string`; nullable. Title, with HTML entities decoded. - **tags** (required) — type `array`. Tags. - _items:_ - type `string` - **score** (required) — type `integer`; nullable. Votes up minus votes down. - **votes** (required) — type `object`. Vote counts. - **viewCount** (required) — type `integer`; nullable. Views. - **answerCount** (required) — type `integer`; nullable. Answers. - **commentCount** (required) — type `integer`; nullable. Comments on the question. - **favoriteCount** (required) — type `integer`; nullable. Times favourited. - **isAnswered** (required) — type `boolean`; nullable. Whether it has an accepted or upvoted answer. - **acceptedAnswerId** (required) — type `integer`; nullable. The accepted answer; null when none. - **createdAt** (required) — type `string`; nullable. When it was asked, ISO 8601 UTC. - **lastActivityAt** (required) — type `string`; nullable. Last activity, ISO 8601 UTC. - **lastEditedAt** (required) — type `string`; nullable. Last edit, ISO 8601 UTC; null when never edited. - **communityWikiAt** (required) — type `string`; nullable. When it became a community wiki; null when it is not. - **protectedAt** (required) — type `string`; nullable. When it was protected; null when it is not. - **lockedAt** (required) — type `string`; nullable. When it was locked; null when it is not. - **closed** (required) — type `object`; nullable. Why it was closed; null when it is open. - **bounty** (required) — type `object`; nullable. The open bounty; null when none. - **notice** (required) — type `object`; nullable. The lock, protection or bounty banner; null when none. - **author** (required) — type `object`. Who asked it. - **lastEditor** (required) — type `object`; nullable. Who edited it last; null when never edited. - **license** (required) — type `string`; nullable. Content licence, e.g. `CC BY-SA 4.0`; null when the site does not say. - **migratedFrom** (required) — type `string`; nullable. The site it was moved from; null when it was not moved. - **migratedTo** (required) — type `string`; nullable. The site it was moved to; null when it was not moved. - **bodyHtml** (required) — type `string`; nullable. Question text as HTML; null on lists that were not asked for bodies. - **bodyMarkdown** (required) — type `string`; nullable. Question text as Markdown; null on lists that were not asked for bodies. - **answers** (required) — type `array`; nullable. The answers when asked for with `include=answers`; null otherwise. - _items:_ - **answersComplete** (required) — type `boolean`; nullable. False when the list in `answers` has fewer answers than `answerCount` says the question has; null when answers were not asked for. - **comments** (required) — type `array`; nullable. Comments on the question when asked for with `include=comments`; null otherwise. - _items:_ - **excerpts** (required) — type `array`; nullable. The matching questions and answers in `excerpt` mode; null in `full` mode. - _items:_ - **itemType** (required) — type `string`; enum: question, answer. Whether the match is a question or an answer. - **questionId** (required) — type `integer`. The question, or the question the answer belongs to. - **answerId** (required) — type `integer`; nullable. The answer id for an answer match; null for a question. - **title** (required) — type `string`; nullable. Question title, with HTML entities decoded. - **url** (required) — type `string`. Link to the question or answer. - **excerptHtml** (required) — type `string`; nullable. A snippet with the matched words in ``. - **bodyHtml** (required) — type `string`; nullable. The full text of the match as plain text, with HTML entities decoded. - **tags** (required) — type `array`. Tags of the question. - _items:_ - type `string` - **score** (required) — type `integer`; nullable. Score of the match. - **questionScore** (required) — type `integer`; nullable. Score of the question. - **isAnswered** (required) — type `boolean`; nullable. Whether the question is answered. - **hasAcceptedAnswer** (required) — type `boolean`; nullable. Whether the question has an accepted answer. - **isAccepted** (required) — type `boolean`; nullable. For an answer match, whether it is the accepted one. - **answerCount** (required) — type `integer`; nullable. Answers on the question. - **createdAt** (required) — type `string`; nullable. When the match was posted, ISO 8601 UTC. - **lastActivityAt** (required) — type `string`; nullable. Last activity, ISO 8601 UTC. - **equivalentTagSearch** (required) — type `boolean`; nullable. Whether the search term was also matched as a tag. - **page** (required) — type `object`. Pagination state for the current page. - **hasMore** (required) — type `boolean`. Whether another page is available. - **nextCursor** (required) — type `string`; nullable. Cursor for the next page; null on the last page. - **limitReached** (required) — type `boolean`. True when the list stopped at the site's 25-page ceiling (2,500 rows, or 625 when the page carries text), or when a user's answer or comment list is too large for page-offset paging and has served its first 100 rows (25 when it carries text). Sort by `creation` to page deeper. False for every list that ends because it ran out. - **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 (found) ```json { "data": { "site": "stackoverflow", "mode": "full", "questions": [ { "id": 2549214, "url": "https://stackoverflow.com/questions/2549214/interpreting-segfault-messages", "title": "Interpreting segfault messages", "tags": [ "linux" ], "score": 92, "votes": { "up": 92, "down": 0 }, "viewCount": 211200, "answerCount": 4, "commentCount": 1, "favoriteCount": 0, "isAnswered": true, "acceptedAnswerId": 2549363, "createdAt": "2010-03-30T22:40:38.000Z", "lastActivityAt": "2022-03-11T12:47:30.000Z", "lastEditedAt": "2021-10-31T19:02:22.000Z", "communityWikiAt": null, "protectedAt": null, "lockedAt": null, "closed": null, "bounty": null, "notice": null, "author": { "id": 58394, "accountId": 23344, "name": "knorv", "url": "https://stackoverflow.com/users/58394/knorv", "imageUrl": "https://www.gravatar.com/avatar/4efba28ff0df4f5c3e8819a1ccbf9f1f?s=256&d=identicon&r=PG", "reputation": 50505, "type": "registered", "acceptRate": 99 }, "lastEditor": { "id": 3889449, "accountId": 4817894, "name": "Marco Bonelli", "url": "https://stackoverflow.com/users/3889449/marco-bonelli", "imageUrl": "https://www.gravatar.com/avatar/eb07e0f09deb982a1a0deedca7a5c002?s=256&d=identicon&r=PG", "reputation": 71452, "type": "registered", "acceptRate": 86 }, "license": null, "migratedFrom": null, "migratedTo": null, "bodyHtml": null, "bodyMarkdown": null, "answers": null, "answersComplete": null, "comments": null } ], "excerpts": null, "page": { "hasMore": true, "nextCursor": "eyJrIjowLCJwIjoxLCJ6IjoxMDAsIm8iOjIsInciOjEwMCwiZiI6IjQ1Y2IwZjFkZjBiOWQ2MTMifQ" }, "limitReached": false }, "meta": { "requestId": "req_0b3cce25-70fd-4124-90ad-68c84559f967", "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. **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.stackOverflow.searchQuestions({ q: "segfault", }); 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/stack-overflow/questions/search?q=segfault", { headers: { "x-api-key": "YOUR_API_KEY" } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v1/stack-overflow/questions/search?q=segfault" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/stack-overflow/questions/search?q=segfault", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ``` ### Example: next page (pagination) After a successful response, if pagination is not finished, request the next page using `cursor` (URL-encode when composing the query string): ```javascript const previous = await response.json(); const nextCursor = previous?.data?.page?.nextCursor; const hasMore = previous?.data?.page?.hasMore; if (!hasMore || nextCursor == null) { // no more pages } else { const nextUrl = new URL("https://api.socialfetch.dev/v1/stack-overflow/questions/search"); nextUrl.searchParams.set("cursor", nextCursor); // optionally preserve sort: nextUrl.searchParams.set("sortBy", "latest"); const nextResponse = await fetch(nextUrl.toString(), { headers: { "x-api-key": "YOUR_API_KEY" }, }); const nextData = await nextResponse.json(); } ```