> **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/twitter/search/get](https://www.socialfetch.dev/docs/api/v1/twitter/search/get)
- **Markdown (.mdx) URL:** [https://www.socialfetch.dev/docs/api/v1/twitter/search/get.mdx](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/**` 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 Twitter posts (https://www.socialfetch.dev/docs/api/v1/twitter/search/get)

## Summary

Searches public posts on X by keyword and optional engagement/date filters. Pagination uses an opaque `cursor` returned by a previous response.

**Tags:** `Twitter`

## HTTP

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

## Capability summary

- **SDK mapping:** `client.twitter.search({ query, section?, minRetweets?, minLikes?, minReplies?, limit?, startDate?, endDate?, language?, cursor? })`
- **Pagination:** cursor via `cursor`, next cursor: `data.page.nextCursor`, has more: `data.page.hasMore`

## Credits

- **Base:** 2 credits per successful lookup.
- **Maximum on success (200):** 2 credits.
- **Normalization failure (502):** 2 credits 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 to run against public posts on X.

### `section` (query)

- **Required:** no
- **Constraints:** type `string`; enum: top, latest, people, photos, videos
- **Description:** Optional search section filter. Omit to use the default `top` section.

### `minRetweets` (query)

- **Required:** no
- **Constraints:** type `integer`; minimum: 0; nullable
- **Description:** Optional minimum retweet count filter.

### `minLikes` (query)

- **Required:** no
- **Constraints:** type `integer`; minimum: 0; nullable
- **Description:** Optional minimum like count filter.

### `minReplies` (query)

- **Required:** no
- **Constraints:** type `integer`; minimum: 0; nullable
- **Description:** Optional minimum reply count filter.

### `limit` (query)

- **Required:** no
- **Constraints:** type `integer`; minimum: 1; maximum: 20
- **Description:** Optional page size. Maximum supported value is 20.

### `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.

### `language` (query)

- **Required:** no
- **Constraints:** type `string`; enum: en, es, fr, de, it, pt, ru, zh, ja, ko, ar, bg, hr, cs, da, nl, et, fi, el, hu, id, ga, lv, lt, no, pl, ro, sk, sl, sv, tr, uk, vi, cy, zu
- **Description:** Optional language filter.

### `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 `integer`; minimum: 0. Creation time as Unix epoch seconds.
      - **createdAtLabel** (required) — type `string`; nullable. Human-readable creation timestamp string when available.
      - **language** (required) — type `string`; nullable. Language code for the tweet when available.
      - **author** (required) — type `object`; nullable. Author metadata for the tweet when available.
        - **handle** (required) — type `string`; minLength: 1. Author handle without the leading @.
        - **displayName** (required) — type `string`; nullable. Display name shown for the author.
        - **avatarUrl** (required) — type `string`; nullable. Profile image URL for the author when available.
        - **profileUrl** (required) — type `string`; nullable. Canonical public profile URL for the author when available.
        - **verified** (required) — type `boolean`. Whether the author has legacy verification on X.
        - **blueVerified** (required) — type `boolean`. Whether the author has paid blue verification on X.
        - **platformUserId** (optional) — type `string`. Numeric X user id for the author as a string.
      - **metrics** (required) — type `object`. Engagement metrics for a Twitter search result.
        - **likes** (required) — type `integer`; minimum: 0. Like count.
        - **retweets** (required) — type `integer`; minimum: 0. Retweet count.
        - **replies** (required) — type `integer`; minimum: 0. Reply count.
        - **quotes** (required) — type `integer`; minimum: 0. Quote count.
        - **views** (required) — type `integer`; minimum: 0; nullable. View count when available.
      - **media** (required) — type `array`. Media attachments returned for the tweet.
        - _items:_
          - **url** (required) — type `string`; minLength: 1. Direct media URL when available.
          - **type** (required) — type `string`; enum: photo. Media type when Social Fetch can classify it confidently.
      - **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.
      - **source** (required) — type `string`; nullable. Source label such as `Twitter Web App` when available.
  - **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 of search results 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.

### Example JSON (results)

```json
{
  "data": {
    "tweets": [
      {
        "id": "1726127805249802561",
        "url": "https://x.com/hack_git/status/1726127805249802561",
        "text": "SqliSniper...",
        "createdAt": 1700375913,
        "createdAtLabel": "Sun Nov 19 06:38:33 +0000 2023",
        "language": "en",
        "author": {
          "handle": "hack_git",
          "displayName": "HackGit",
          "avatarUrl": "https://pbs.twimg.com/profile_images/1430451138277556224/yDiqSjga_normal.jpg",
          "profileUrl": "https://x.com/hack_git",
          "verified": false,
          "blueVerified": true,
          "platformUserId": "1430450807451828228"
        },
        "metrics": {
          "likes": 148,
          "retweets": 33,
          "replies": 1,
          "quotes": 0,
          "views": 13392
        },
        "media": [
          {
            "url": "https://pbs.twimg.com/media/F_RwCCTXsAADBL8.png",
            "type": "photo"
          }
        ],
        "expandedUrl": "https://twitter.com/hack_git/status/1726127805249802561/photo/1",
        "isRetweet": false,
        "source": "Twitter Web App"
      }
    ],
    "page": {
      "nextCursor": "opaque_cursor_token",
      "hasMore": true
    }
  },
  "meta": {
    "requestId": "req_01twittersearch",
    "creditsCharged": 2,
    "version": "v1"
  }
}
```

### Example JSON (empty)

```json
{
  "data": {
    "tweets": [],
    "page": {
      "nextCursor": null,
      "hasMore": false
    }
  },
  "meta": {
    "requestId": "req_01twittersearch_empty",
    "creditsCharged": 2,
    "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 to watch this weekend",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY",
    }
  }
);

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

### cURL

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

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/twitter/search?query=what to watch this weekend",
    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/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": "YOUR_API_KEY" },
  });
  const nextData = await nextResponse.json();
}
```