Threads user search API
  1. Docs
  2. Threads
  3. Threads user search API

Threads user search API

Accounts matching a query.

GET /v1/threads/search/users

GET /v1/threads/search/users

Accounts matching a query. There is no direct account search, so these are the authors of the search results whose handle or name matches, best match first, plus the account whose handle is the query itself.

  • Cost: 1 credit
  • Cache: Results are kept up to 30 days; send max_age_days to reuse them for free.
  • Timeout: A request still running after about 25 seconds answers 202 with a job to poll (Batch and jobs).

Parameters#

NameTypeRequiredDescription
querystringyesSearch terms. Also accepted as keyword, q.

Every request also accepts:

  • cursor: the cursor from the previous page (Pagination).
  • trim: true for a smaller response without null fields and extra.
  • raw: true to also get the platform's original object as raw.
  • max_age_days: accept a cached result up to this many days old, for 0 credits (Caching).

Example request#

Set your key in the environment first (see Authentication).

1curl -G "https://api.socialscrape.dev/v1/threads/search/users" \2  -H "x-api-key: $SOCIALSCRAPE_API_KEY" \3  --data-urlencode "query=nasa"

Example response#

This is a sample from a recorded response, lists and long text are shortened. Status 200.

200 OKSample response
1{2  "ok": true,3  "credits_charged": 1,4  "credits_remaining": 4999,5  "cached": false,6  "cached_at": null,7  "request_id": "req_01830dcb7287cd426bd2b7c1",8  "data": {9    "object": "list",10    "items": [11      {12        "object": "profile",13        "platform": "threads",14        "id": "28829152388",15        "handle": "nasa",16        "name": "NASA",17        "headline": null,18        "url": "https://www.threads.com/@nasa",19        "kind": "person",20        "bio": null,21        "avatar_url": "https://scontent-atl3-1.cdninstagram.com/v/t51.82787-19/669747085_18089786557960389_922072622069351626_n.jpg?stp=dst-jpg_s150x150_tt6&efg=eyJ2ZW5jb2RlX3RhZyI6InByb2ZpbGVfcGljLmRqYW5nby4xMDgwLmMyIn0&_nc_ht=scontent-atl3-1.cdninstagram.com&_n...",22        "banner_url": null,23        "verified": true,24        "is_private": false,25        "external_url": null,26        "links": null,27        "location": null,28        "category": null,29        "created_at": null,30        "stats": {31          "followers": null,32          "following": null,33          "posts": null,34          "likes": null,35          "views": null36        },37        "extra": null38      }39    ],40    "cursor": null,41    "has_more": false,42    "parent": null43  },44  "cursor": null,45  "has_more": false46}

Response#

A list of Profile objects in data.items, with data.cursor and data.has_more.

See Data models for every field. The envelope around data is described in Responses.

Errors#

Failures are free: credits_charged is 0. Branch on error.code, never on the message.

CodeHTTPRetryMeaning
invalid_params400noA parameter is missing, unknown or has the wrong type.
not_found404noThe platform says this profile, post or item does not exist.

Every request can also fail with the account and platform errors listed on the Errors page.