API Reference

v1.0.0 · updated from bundled OpenAPI

GET/twitter

X Search API

The X Search API enables users to retrieve relevant links and tweets based on specified search queries without utilizing AI-driven models. It analyzes links from X posts that align with the provided search criteria. Billing metadata: successful billable responses include the `X-Desearch-Cost-Usd`, `X-Desearch-Usage-Count`, `X-Desearch-Service`, and `X-Desearch-Currency` headers. JSON object responses also include optional `cost_usd`, `usage_count`, `service`, and `currency` fields. For example, `usage_count=10` at `$0.015 / 1,000` resolves to `cost_usd=0.00015`. JSON arrays, text, and streaming responses keep their body shape and expose billing metadata only through headers.

Base URL

https://api.desearch.ai

Implementation guidance

Use X Search API when your application needs real-time X datawithout maintaining its own crawler, social-data pipeline, or retrieval infrastructure. The endpoint returns structured data that can be consumed by agents, research tools, dashboards, and retrieval-augmented generation workflows. Keep the request focused on the minimum fields your workflow needs so responses remain fast and easy to validate.

Send requests to GET /twitter with your Desearch API key in the authorization header. Treat the key as a server-side secret, validate all required parameters before sending the request, and handle non-2xx responses explicitly. Production integrations should use sensible timeouts, retry only transient failures with backoff, and record the response status and request identifier for troubleshooting.

Test the example request below before integrating it into a larger workflow. Confirm that the returned fields, links, and timestamps meet your freshness requirements, then add schema validation at the application boundary. For agentic systems, preserve source URLs with the generated answer so users can inspect evidence and your application can avoid presenting unsupported claims.

Query Parameters

querystringrequired

Advanced search query

sortstring

Sort by Top or Latest

Default: Top

userstring

User to search for

start_datestring

Start date in UTC (YYYY-MM-DD format)

end_datestring

End date in UTC (YYYY-MM-DD format)

langstring

Language code (e.g., en, es, fr)

verifiedstring

Filter for verified users

blue_verifiedstring

Filter for blue checkmark verified users

is_quotestring

Include only tweets with quotes

is_videostring

Include only tweets with videos

is_imagestring

Include only tweets with images

min_retweetsstring

Minimum number of retweets

min_repliesstring

Minimum number of replies

min_likesstring

Minimum number of likes

countstring

Number of tweets to retrieve

Default: 20

Responses

200A JSON object mapping X Search to its search results.

301Moved Permanently

304Not Modified

401Unauthorized

422Validation Error

429Too Many Requests

500Internal Server Error

Authorization

Your API key is sent in the Authorization header.

Request

curl -X GET "https://api.desearch.ai/twitter?query=Whats+going+on+with+Bittensor" \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json"

ResponseSchema

[
  {
    "user": {
      "id": "123456789",
      "url": "https://twitter.com/example_user",
      "name": "John Doe",
      "username": "johndoe",
      "created_at": "2023-01-01T00:00:00Z",
      "description": "This is an example user description.",
      "favourites_count": 100,
      "followers_count": 1500,
      "followings_count": 100,
      "listed_count": 10,
      "media_count": 50,
      "profile_image_url": "https://example.com/profile.jpg",
      "profile_banner_url": "https://example.com/banner.jpg",
      "statuses_count": 500,
      "verified": true,
      "is_blue_verified": true,
      "entities": {},
      "can_dm": true,
      "can_media_tag": true,
      "location": "Jamaica",
      "pinned_tweet_ids": [
        "123456789",
        "987654321"
      ],
      "professional": {
        "professional_type": "Business",
        "category": []
      }
    },
    "id": "987654321",
    "text": "This is an example tweet.",
    "reply_count": 10,
    "view_count": 1000,
    "retweet_count": 5,
    "like_count": 100,
    "quote_count": 2,
    "bookmark_count": 3,
    "url": "https://twitter.com/example_tweet",
    "created_at": "2023-01-01T00:00:00Z",
    "media": [],
    "is_quote_tweet": false,
    "is_retweet": false,
    "lang": "en",
    "conversation_id": "987654321",
    "in_reply_to_screen_name": "someuser",
    "in_reply_to_status_id": "987654320",
    "in_reply_to_user_id": "123456789",
    "quoted_status_id": "987654319",
    "quote": {
      "user": {
        "id": "123456789",
        "url": "https://twitter.com/example_user",
        "name": "John Doe",
        "username": "johndoe",
        "created_at": "2023-01-01T00:00:00Z",
        "description": "This is an example user description.",
        "favourites_count": 100,
        "followers_count": 1500,
        "followings_count": 100,
        "listed_count": 10,
        "media_count": 50,
        "profile_image_url": "https://example.com/profile.jpg",
        "profile_banner_url": "https://example.com/banner.jpg",
        "statuses_count": 500,
        "verified": true,
        "is_blue_verified": true,
        "can_dm": true,
        "can_media_tag": true,
        "location": "Jamaica",
        "pinned_tweet_ids": [
          "123456789",
          "987654321"
        ]
      },
      "id": "987654321",
      "text": "This is an example tweet.",
      "reply_count": 10,
      "view_count": 1000,
      "retweet_count": 5,
      "like_count": 100,
      "quote_count": 2,
      "bookmark_count": 3,
      "url": "https://twitter.com/example_tweet",
      "created_at": "2023-01-01T00:00:00Z",
      "media": [],
      "is_quote_tweet": false,
      "is_retweet": false,
      "lang": "en",
      "conversation_id": "987654321",
      "in_reply_to_screen_name": "someuser",
      "in_reply_to_status_id": "987654320",
      "in_reply_to_user_id": "123456789",
      "quoted_status_id": "987654319",
      "quote": {
        "id": "987654321",
        "text": "This is an example tweet.",
        "reply_count": 10,
        "view_count": 1000,
        "retweet_count": 5,
        "like_count": 100,
        "quote_count": 2,
        "bookmark_count": 3,
        "url": "https://twitter.com/example_tweet",
        "created_at": "2023-01-01T00:00:00Z",
        "media": [],
        "is_quote_tweet": false,
        "is_retweet": false,
        "lang": "en",
        "conversation_id": "987654321",
        "in_reply_to_screen_name": "someuser",
        "in_reply_to_status_id": "987654320",
        "in_reply_to_user_id": "123456789",
        "quoted_status_id": "987654319",
        "display_text_range": [
          0,
          280
        ]
      },
      "replies": [
        {}
      ],
      "display_text_range": [
        0,
        280
      ],
      "entities": {},
      "extended_entities": {},
      "retweet": {
        "id": "987654321",
        "text": "This is an example tweet.",
        "reply_count": 10,
        "view_count": 1000,
        "retweet_count": 5,
        "like_count": 100,
        "quote_count": 2,
        "bookmark_count": 3,
        "url": "https://twitter.com/example_tweet",
        "created_at": "2023-01-01T00:00:00Z",
        "media": [],
        "is_quote_tweet": false,
        "is_retweet": false,
        "lang": "en",
        "conversation_id": "987654321",
        "in_reply_to_screen_name": "someuser",
        "in_reply_to_status_id": "987654320",
        "in_reply_to_user_id": "123456789",
        "quoted_status_id": "987654319",
        "display_text_range": [
          0,
          280
        ]
      }
    },
    "replies": [
      {
        "user": {},
        "id": "987654321",
        "text": "This is an example tweet.",
        "reply_count": 10,
        "view_count": 1000,
        "retweet_count": 5,
        "like_count": 100,
        "quote_count": 2,
        "bookmark_count": 3,
        "url": "https://twitter.com/example_tweet",
        "created_at": "2023-01-01T00:00:00Z",
        "media": [],
        "is_quote_tweet": false,
        "is_retweet": false,
        "lang": "en",
        "conversation_id": "987654321",
        "in_reply_to_screen_name": "someuser",
        "in_reply_to_status_id": "987654320",
        "in_reply_to_user_id": "123456789",
        "quoted_status_id": "987654319",
        "quote": {},
        "replies": [],
        "display_text_range": [
          0,
          280
        ],
        "entities": {},
        "extended_entities": {},
        "retweet": {}
      }
    ],
    "display_text_range": [
      0,
      280
    ],
    "entities": {
      "hashtags": [
        {}
      ],
      "media": [
        {}
      ],
      "symbols": [
        {}
      ],
      "timestamps": [],
      "urls": [
        {}
      ],
      "user_mentions": [
        {}
      ]
    },
    "extended_entities": {
      "media": [
        {}
      ]
    },
    "retweet": {
      "user": {
        "id": "123456789",
        "url": "https://twitter.com/example_user",
        "name": "John Doe",
        "username": "johndoe",
        "created_at": "2023-01-01T00:00:00Z",
        "description": "This is an example user description.",
        "favourites_count": 100,
        "followers_count": 1500,
        "followings_count": 100,
        "listed_count": 10,
        "media_count": 50,
        "profile_image_url": "https://example.com/profile.jpg",
        "profile_banner_url": "https://example.com/banner.jpg",
        "statuses_count": 500,
        "verified": true,
        "is_blue_verified": true,
        "can_dm": true,
        "can_media_tag": true,
        "location": "Jamaica",
        "pinned_tweet_ids": [
          "123456789",
          "987654321"
        ]
      },
      "id": "987654321",
      "text": "This is an example tweet.",
      "reply_count": 10,
      "view_count": 1000,
      "retweet_count": 5,
      "like_count": 100,
      "quote_count": 2,
      "bookmark_count": 3,
      "url": "https://twitter.com/example_tweet",
      "created_at": "2023-01-01T00:00:00Z",
      "media": [],
      "is_quote_tweet": false,
      "is_retweet": false,
      "lang": "en",
      "conversation_id": "987654321",
      "in_reply_to_screen_name": "someuser",
      "in_reply_to_status_id": "987654320",
      "in_reply_to_user_id": "123456789",
      "quoted_status_id": "987654319",
      "quote": {
        "id": "987654321",
        "text": "This is an example tweet.",
        "reply_count": 10,
        "view_count": 1000,
        "retweet_count": 5,
        "like_count": 100,
        "quote_count": 2,
        "bookmark_count": 3,
        "url": "https://twitter.com/example_tweet",
        "created_at": "2023-01-01T00:00:00Z",
        "media": [],
        "is_quote_tweet": false,
        "is_retweet": false,
        "lang": "en",
        "conversation_id": "987654321",
        "in_reply_to_screen_name": "someuser",
        "in_reply_to_status_id": "987654320",
        "in_reply_to_user_id": "123456789",
        "quoted_status_id": "987654319",
        "display_text_range": [
          0,
          280
        ]
      },
      "replies": [
        {}
      ],
      "display_text_range": [
        0,
        280
      ],
      "entities": {},
      "extended_entities": {},
      "retweet": {
        "id": "987654321",
        "text": "This is an example tweet.",
        "reply_count": 10,
        "view_count": 1000,
        "retweet_count": 5,
        "like_count": 100,
        "quote_count": 2,
        "bookmark_count": 3,
        "url": "https://twitter.com/example_tweet",
        "created_at": "2023-01-01T00:00:00Z",
        "media": [],
        "is_quote_tweet": false,
        "is_retweet": false,
        "lang": "en",
        "conversation_id": "987654321",
        "in_reply_to_screen_name": "someuser",
        "in_reply_to_status_id": "987654320",
        "in_reply_to_user_id": "123456789",
        "quoted_status_id": "987654319",
        "display_text_range": [
          0,
          280
        ]
      }
    }
  }
]

Possible status codes:

200401422429500