> **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/search/get>
- **Markdown (.mdx) URL:** <https://www.socialfetch.dev/docs/api/v1/twitter/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/**` 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:** <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, 1112 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.
- [Authentication](https://www.socialfetch.dev/docs/authentication.mdx) — `x-api-key` header, the `SOCIALFETCH_API_KEY` environment variable, and a curl check.
- [Rate limits](https://www.socialfetch.dev/docs/rate-limits.mdx) — no per-minute cap on paid lookups with a key, 200 in flight per workspace, per-minute limits on free and keyless routes, `429`/`503` and `Retry-After`.
- [CLI and agents](https://www.socialfetch.dev/docs/cli-and-agents.mdx) — curl and jq, the `socialfetch` CLI, MCP and the agent skill from a terminal.
- [`/pricing.json`](https://www.socialfetch.dev/pricing.json) — machine-readable pricing: credit packs, plans, free credits and each endpoint's credit cost.
- 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 Twitter posts (https://www.socialfetch.dev/docs/api/v1/twitter/search/get)

## Summary

Search X posts or people by query.

**Tags:** `Twitter`

## HTTP

- **Method:** GET
- **Path:** `/v1/twitter/search`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.twitter.search({ query, section?, limit?, cursor? })`
- **Accepted identifiers:** `query` (query)
- **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

### `query` (query)

- **Required:** yes
- **Constraints:** type `string`; minLength: 1; maxLength: 512
- **Description:** Search query for public posts on X. Supported post-type operators include `include:nativeretweets`, `filter:nativeretweets`, and `filter:retweets`; `is:retweet` is not supported.
- **Query builder:** /tools/twitter-advanced-search

### `section` (query)

- **Required:** no
- **Constraints:** type `string`; enum: top, latest, people, photos, videos; default: `top`
- **Description:** Search section: `top` (default), `latest`, `people`, `photos`, or `videos`.

### `limit` (query)

- **Required:** no
- **Constraints:** type `integer`; minimum: 1; maximum: 20
- **Description:** Optional page size (1–20). Requests cannot ask for more than 20 posts; the actual page size may be smaller. Use the response cursor for subsequent pages.

### `cursor` (query)

- **Required:** no
- **Constraints:** type `string`; minLength: 1
- **Description:** Opaque pagination cursor returned by a previous response.

## 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 for the requested query.
- **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)

Search results for the requested query.

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **tweets** (required) — type `array`. Tweets returned for the requested search query.
    - _items:_
      - **id** (required) — type `string`; minLength: 1. Tweet id.
      - **url** (required) — type `string`; nullable. Canonical public URL for the tweet when available.
      - **text** (required) — type `string`. Full tweet text when available.
      - **createdAt** (required) — type `string`; nullable. Creation time (ISO-8601). Null when the source gives no usable timestamp (seen on some quoted tweets).
      - **createdAtLabel** (required) — type `string`; nullable. Human-readable creation timestamp string when available.
      - **language** (required) — type `string`; nullable. Language code for the tweet when available.
      - **conversationId** (required) — type `string`; minLength: 1; nullable. Conversation identifier when supplied.
      - **inReplyToStatusId** (required) — type `string`; minLength: 1; nullable. Parent post identifier when this post is a reply.
      - **inReplyToUserId** (optional) — type `string`; minLength: 1; nullable. Parent post author user id when this post is a reply.
      - **inReplyToScreenName** (optional) — type `string`; minLength: 1; nullable. Parent post author handle when this post is a reply.
      - **quotedStatusId** (required) — type `string`; minLength: 1; nullable. Quoted post identifier when this post quotes another.
      - **retweetTweetId** (required) — type `string`; minLength: 1; nullable. Original post identifier when this post is an engagement repost.
      - **author** (required) — type `object`; nullable. Author metadata for the tweet when available.
      - **metrics** (required) — type `object`. Engagement metrics for a tweet.
      - **media** (required) — type `array`. Media attachments returned for the tweet.
        - _items:_
      - **expandedUrl** (required) — type `string`; nullable. Expanded URL attached to the tweet when available.
      - **isRetweet** (required) — type `boolean`. Whether the tweet is marked as a retweet.
      - **isReply** (optional) — type `boolean`; default: `false`. Whether the tweet is a reply to another post.
      - **isQuote** (optional) — type `boolean`; default: `false`. Whether the tweet quotes another post.
      - **source** (required) — type `string`; nullable. Source label such as `Twitter Web App` when available.
      - **communityId** (optional) — type `string`; nullable. Community id when the tweet was posted to a community.
      - **hasAIGeneratedMedia** (optional) — type `boolean`; nullable. Whether X marks the tweet as containing AI-generated media.
      - **isPaidPromotion** (optional) — type `boolean`; nullable. Whether the author labeled the tweet as a paid partnership (X's disclosure label). Not X ads or Promote status, which X does not expose on tweets.
      - **isTranslatable** (optional) — type `boolean`; nullable. Whether X considers the tweet text translatable.
      - **hasBirdwatchNotes** (optional) — type `boolean`; nullable. X's Community Notes flag for this tweet. It can be false while a note is shown; use `communityNote` for the note X displays.
      - **possiblySensitive** (optional) — type `boolean`; nullable. Whether X marks the content sensitive.
      - **entities** (optional) — type `object`. Hashtags, mentions, links, and cashtags in the tweet text.
      - **editInfo** (optional) — type `object`. Edit metadata when the tweet is editable or edited.
      - **card** (optional) — type `object`; nullable. Link preview card when the tweet has one.
      - **poll** (optional) — type `object`; nullable. Poll when the tweet contains one.
      - **article** (optional) — type `object`; nullable. X article when the tweet is a long-form article.
      - **place** (optional) — type `object`; nullable. Tagged location when the author added one.
      - **communityNote** (optional) — type `object`; nullable. Community Note text and link when one is shown on the tweet.
      - **isEdited** (optional) — type `boolean`; nullable. Whether the tweet has been edited.
      - **quotedTweet** (optional) — type `object`; nullable. Quoted tweet expanded one level (no further nesting).
      - **retweetedTweet** (optional) — type `object`; nullable. Reposted tweet expanded one level, plus its quoted tweet when it is a quote.
  - **people** (required) — type `array`. Profiles returned for the requested search query.
    - _items:_
      - **platformUserId** (required) — type `string`; minLength: 1. Numeric X user id as a string.
      - **handle** (required) — type `string`; nullable. 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.
      - **privateAccount** (required) — type `boolean`. Whether the account is protected (private).
      - **profileUrl** (required) — type `string`; minLength: 1. Canonical public profile URL on x.com.
      - **website** (optional) — type `string`; nullable. Primary outbound link from the profile when provided.
      - **location** (optional) — type `string`; nullable. Location string from the profile when provided.
      - **accountCreatedAt** (optional) — type `string`. Account creation time (ISO-8601) when derivable.
      - **metrics** (required) — type `object`. Aggregate profile metrics from X.
      - **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.
      - **affiliateLabel** (optional) — type `object`; nullable. Affiliation or automated-account label shown next to the name, when X provides one.
      - **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.
  - **page** (required) — type `object`. Pagination information for the current response.
    - **nextCursor** (required) — type `string`; nullable. Cursor to pass as `cursor` in the next request when another page exists.
    - **hasMore** (required) — type `boolean`. Whether another page can be requested.
- **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.
  - **stale** (optional) — type `boolean`; enum: true. Present, and `true`, only when the source couldn't be reached and this is the last good answer for the same request instead, up to 24 hours old. Absent on every live answer.
  - **fetchedAt** (optional) — type `string`. When a stale answer (`stale: true`) was originally fetched (ISO 8601, UTC). Absent on every live answer.

### Example JSON (empty)

```json
{
  "data": {
    "tweets": [],
    "people": [],
    "page": {
      "hasMore": false,
      "nextCursor": null
    }
  },
  "meta": {
    "requestId": "req_example_twitter_search",
    "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.search({
  query: "what to watch this weekend",
});

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/search?query=what%20to%20watch%20this%20weekend",
  {
    headers: {
      "x-api-key": process.env.SOCIALFETCH_API_KEY
    }
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash
curl "https://api.socialfetch.dev/v1/twitter/search?query=what%20to%20watch%20this%20weekend" \
  -H "x-api-key: $SOCIALFETCH_API_KEY"
```

### Python

```python
import os

import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/twitter/search?query=what%20to%20watch%20this%20weekend",
    headers={"x-api-key": os.environ["SOCIALFETCH_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/twitter/search");
  nextUrl.searchParams.set("cursor", nextCursor);
  // optionally preserve sort: nextUrl.searchParams.set("sortBy", "latest");
  const nextResponse = await fetch(nextUrl.toString(), {
    headers: { "x-api-key": process.env.SOCIALFETCH_API_KEY },
  });
  const nextData = await nextResponse.json();
}
```