Endpoints
    POST/desearch/people/search/x

    X Profile Search

    Find X accounts by what they post and how they describe themselves. Describe the people you want in plain language; the search scans recent X posts for people talking about it, groups the matches by author, reads each profile (bio, followers, website, location) and scores how well each account fits. You get **profiles, not posts**: each with a fit score, the reasons it matched and the posts that prove it. **How it runs.** The search runs in the background. This call returns a `task_id` at once. Poll `GET /desearch/people/tasks/{task_id}` every few seconds, read profiles with `GET /desearch/people/tasks/{task_id}/results` (they arrive while the search is still running), or download everything with `GET /desearch/people/tasks/{task_id}/export?format=csv`. You can pause, resume or cancel a search at any time. Results stay available for 30 days. When it ends, `completion_reason` says why, `coverage_limited` whether a budget stopped it before it found `count` profiles, and `warnings` what made part of it less reliable (e.g. LinkedIn profiles that could not be read). **Billing.** `count` profiles are reserved at the route price when the task is created (`cost_usd` on this response). When the search ends you pay only for the qualified profiles it delivered (prices, including any minimum, are at https://www.desearch.ai/pricing); the rest of the reservation is returned automatically. A search that delivers no profiles costs nothing. Prices: https://www.desearch.ai/pricing. 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. Current prices are at https://www.desearch.ai/pricing. 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 Profile Search when your application needs scored public profiles of people and creatorswithout 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 POST /desearch/people/search/x 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.

    Header Parameters

    Idempotency-Keystringoptional

    Optional. Any unique string, for example a UUID. Surrounding whitespace is removed and the value is cut to 200 characters; a longer key is not rejected. The same key again for this company returns the original search with HTTP 200 and refunds this call's reservation, so it is not charged. A new key starts a search and returns HTTP 202.

    maxLength: 200

    Body Parameters

    querystringrequired

    Who you are looking for, in plain language.

    countinteger

    How many qualified profiles to find. The search reserves this many at the route price and bills only the profiles it delivers (a minimum applies when it finds any; a search that finds none is free).

    Default: 25

    min_scorestring

    Only return profiles with at least this fit score (0-100).

    excludearray of strings

    Handles to leave out, for example people you already contacted. Up to 1,000 handles.

    One item per line, or a JSON array. Sent as an array.

    metadataobject (JSON)

    Your own labels for this search, e.g. the workspace or campaign it belongs to. At most 10 keys; keys are 1-40 characters of a-z, 0-9, '_', '.' or '-'; values are strings of at most 200 characters. Returned as `metadata` on the task and usable as a filter on `GET /desearch/people/tasks` (`metadata.<key>=<value>`). Never used by the search itself.

    A JSON object, sent as JSON. Leave it empty to omit the field.

    filtersobject (JSON)

    A JSON object, sent as JSON. Leave it empty to omit the field. Keys: min_followers, max_followers, verified_only, countries, keywords, exclude_keywords.

    Responses

    200Same Idempotency-Key as an earlier search: that task, not charged again.
    202The created search task.
    400Bad request: an unknown platform, sort, status, cursor or `has` channel, a filter the platform does not support, or an invalid `metadata.<key>` filter
    401Unauthorized
    402Not enough credits for the reservation.
    422Validation Error
    429Too many searches are already queued, running or paused.
    500Internal Server Error
    Authorization

    Your API key is sent in the Authorization header.

    Request
    curl -X POST "https://api.desearch.ai/desearch/people/search/x" \
      -H "Authorization: YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
      "count": 25,
      "filters": {
        "min_followers": 200
      },
      "min_score": 60,
      "query": "Indie hackers building in public who share their MRR"
    }'
    ResponseSchema
    {
      "task_id": "Task Id",
      "search_type": "x_profile_search",
      "platform": "x",
      "status": "queued",
      "stage": "planning",
      "query": "Query",
      "count": 0,
      "result_count": 0,
      "metadata": {},
      "interpreted": {},
      "progress": {},
      "errors": [],
      "completion_reason": "count_reached",
      "coverage_limited": false,
      "warnings": [
        {
          "code": "Code",
          "platform": "x",
          "attempted": 0,
          "enriched": 0,
          "failed": 0,
          "by_reason": {},
          "message": "string"
        }
      ],
      "reserved_cost_usd": 0,
      "final_cost_usd": 0,
      "refunded_usd": 0,
      "created_by": {
        "user_id": "string",
        "api_key_id": "string",
        "via": "string"
      },
      "created_at": "2024-01-15T10:30:00Z",
      "started_at": "2024-01-15T10:30:00Z",
      "paused_at": "2024-01-15T10:30:00Z",
      "finished_at": "2024-01-15T10:30:00Z",
      "results_expire_at": "2024-01-15T10:30:00Z",
      "links": {
        "self": "Self",
        "results": "Results",
        "export": "Export"
      }
    }

    Possible status codes:

    200401422429500