threads

Search Threads users

Searches Threads for user accounts matching a query. Returns up to about 10 matching accounts with the handle, display name, avatar and verification status. A plain call is that identity window for 1 credit, and author.followers, author.bio, author.private and author.ext.bio_link stay null: the search index does not carry them. Send include=profile to fill them by row hydration: each account is looked up on /v1/threads/profile by its handle in the same call, and only those four leaves are copied onto the row, so nothing already on it changes. It costs 1 credit per account filled, adds 3 to 6 seconds (never more than 12), and a data.hydration block reports the rows looked up, filled and served from cache and the credits held and kept; an account the lookup could not fill is refunded and named by data._warnings: ["profile_partial"]. limit (1 to 12) takes the top N accounts and caps the extra credits with them. include_details=true, the older spelling, is the same call at the same price. Post count and join date stay null either way: Threads does not publish them. author.url is the account's Threads permalink, built from the handle.

get/threads/search/users

Request

  • Base URL: https://www.socialcrawl.dev/v1
  • URL: https://www.socialcrawl.dev/v1/threads/search/users
  • Auth: API key in header x-api-key

Query parameters

querystring required

Search keyword or phrase to find Threads users

include'profile'

Send profile to fill author.followers, author.bio, author.private and author.ext.bio_link on each account by looking it up on /v1/threads/profile in the same call. 1 credit per account filled from a fresh lookup (12 at most, or limit); accounts served from that lookup's cache (15 minutes) and accounts it could not fill are free. Adds 3 to 6 seconds, never more than 12. One token only: profile.

limitinteger

Take the top N accounts of the page, 1 to 12. With include=profile it also caps the extra credits: limit=5&include=profile holds 6 credits, not 13. A plain call with limit still costs 1.

include_detailsboolean

The older spelling of include=profile, kept working: include_details=true runs the same join at the same price (1 credit per account filled, 13 at most), and false is the plain call. Prefer include=profile in new code.

Headers

Cache-Controlstring

Send no-cache to bypass the response cache and force a live fetch. Billed at the normal endpoint cost; the fresh result is written back to cache for the next caller. Only the no-cache directive triggers this. See the Response Schema guide for details.

Idempotency-Keystring

Optional UUID that makes the request safely retriable. The key is reserved atomically per account before billing. A concurrent retry receives 409 IDEMPOTENCY_IN_PROGRESS with a Retry-After of 1 second while the original is young, growing to a quarter of the time it has been running (at most 30); a crashed reservation expires after 5 minutes. A replay keeps the cached payload immutable except for billing metadata: credits_used becomes 0, idempotent_replay becomes true, and credits_remaining is refreshed to the current balance. A known current balance appears in both the body and X-Credits-Remaining header; no balance row resolves to 0. On a transient lookup failure, body credits_remaining is null and X-Credits-Remaining is omitted. Completed outcomes expire after 24 hours. If the claim store is unavailable, the request fails closed before billing. GET endpoints do not combine idempotent replay with Server-Sent Events: use Accept: application/json when sending this header. The unsupported key-plus-SSE combination is rejected before billing.

Response

Successful response

successboolean required

Whether the request succeeded

platformstring required

Platform name

endpointstring required

API endpoint path

credits_usedinteger required

Number of credits consumed

credits_remaininginteger nullable required

Current account balance, or null when this response could not establish one. Free cache hits always return null because they do not establish an authoritative post-request balance. An idempotency replay also returns null when its current-balance lookup fails. It is never a fabricated zero, so a zero here means the account really is empty. The authoritative reading is the one on a billed response, which comes straight from the deduction.

request_idstring required

Unique request identifier for support

cachedboolean required

Whether the response was served from cache

idempotent_replayboolean

True only when this response is an idempotency replay

Example response

{
  "success": true,
  "platform": "threads",
  "endpoint": "/v1/threads/search/users",
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "req-abc123",
  "idempotent_replay": true,
  "meta": {
    "hint": {
      "code": "search_multi",
      "message": "You searched \"matcha\" on 3 platforms one call at a time; /v1/search/multi returns each platform's own search rows in one call at the same price per platform, and a platform with no rows is not charged.",
      "method": "GET",
      "path": "/v1/search/multi?query=matcha&platforms=instagram,tiktok,youtube"
    }
  },
  "pagination": {
    "next_cursor": "sc.eyJ2IjoyLCJjIjoiMiIsInAiOiJwYWdlIn0",
    "has_more": true,
    "page_size": 30,
    "stopped_at": "known_id"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.