Threads Search Users
Structured Threads data: send queries. Cursor-paginated, 1 credit per successful call.
Overview
Section titled “Overview”Call GET /api/v2/threads-search-users/ with queries. The results are in data.engines; send data.next_cursor back as cursor to get the next page. 6 optional parameters refine the call (see Parameters).
Request
Section titled “Request”curl -G "https://api.scrapier.io/api/v2/threads-search-users/" \ -H "X-API-Key: YOUR_API_KEY" \ --data-urlencode "queries=shams" \ --max-time 210const params = new URLSearchParams({ queries: "shams" });
const res = await fetch(`https://api.scrapier.io/api/v2/threads-search-users/?${params}`, { headers: { "X-API-Key": "YOUR_API_KEY" }, signal: AbortSignal.timeout(210_000),});const body = await res.json();if (!res.ok) throw new Error(body.error ?? body.detail ?? `HTTP ${res.status}`);
console.log(body.data.engines);import requests
resp = requests.get( "https://api.scrapier.io/api/v2/threads-search-users/", headers={"X-API-Key": "YOUR_API_KEY"}, params={"queries": "shams"}, timeout=210,)body = resp.json()if not resp.ok: raise RuntimeError(body.get("error") or body.get("detail"))
print(body["data"]["engines"])curl -X POST "https://api.scrapier.io/api/v2/threads-search-users/" \ -H "X-API-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"queries":"shams"}' \ --max-time 210Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X-API-Key header | string | yes | — | Your API key from the dashboard. |
queries | string | yes | e.g. shams | Search text (a handle, a name or a topic) -> the matching Threads accounts as a guest, 12 verified accounts per call in rank order. Required first call, ignored when cursor is supplied. |
cursor | string | no | — | Pagination cursor returned in the previous response's next_cursor. Pass it back unchanged to fetch the next page. When next_cursor is null, you have reached the last page. |
include | string | no | — | 'profile' fills bio / followers / private / ext.bio_link on every row of the page from its profile page. profile locked in cursor |
include_details | boolean | no | false | Older spelling of include=profile (true = the same join). locked in cursor |
engines | string | no | brave,ddg | Handle-discovery engines, any of brave / ddg; "" = Threads-only. locked in cursor |
engine_pages | integer | no | 5 | Brave result pages walked at most per call. locked in cursor |
candidate_pool | integer | no | — | Candidates ranked before selection (default max(40, 36 x page)). locked in cursor |
Advanced
| Name | Type | Default | Description |
|---|---|---|---|
use_proxy | boolean | true | Route the request through Scrapier's residential proxy pool. Default: true. Leave as is unless support tells you otherwise. |
raw_data | boolean | false | When true, the response carries the full raw upstream payload(s) the scraper received (GraphQL / JSON API bodies, HTML, embedded JSON-LD -- exactly as the platform returned them) under raw_responses, in place of the formatted items. When false (default) you get the formatted output. Pagination (cursor / next_cursor) works the same in both modes. |
Response
Section titled “Response”{ "success": true, "data": { "queries": "shams", "page": 1, "page_size": 12, "include": null, "engines": [ "brave", "ddg" ], "pool": 28, "ranked": 28, "excluded": 0, "beyond_limit": 14, "verified_dead": 0, "more_discovery_possible": true, "sources": { "probe": { "handle": "shams", "status": "ok", "found": true }, "posts": { "status": "ok", "threads": 18, "authors": 13 }, "brave": { "status": "ok", "handles": 16, "pages": 1 }, "ddg": { "status": "challenged", "handles": 0, "pages": 1 } }, "warnings": [], "hydration": null, "requests": 17, "duration_ms": 12180, "users": [ { "keyword": "shams", "position": 1, "user_id": "63263616227", "verified": true, "username": "shams", "pk": "63263616227", "is_active_on_text_post_app": true, "full_name": "Shams Charania", "profile_pic_url": "https://instagram.fdac8-1.fna.fbcdn.net/v/t51.2885-19/...jpg?stp=dst-jpg_s150x150_tt6&...", "is_verified": true, "has_onboarded_to_text_post_app": true, "id": "63263616227", "bio": null, "followers": null, "following": null, "posts_count": null, "likes_count": null, "url": "https://www.threads.com/@shams", "location": null, "joined_at": null, "private": null, "ext": { "bio_link": null }, "match_tier": 0, "source": "probe", "sources": [ "probe", "posts" ], "search": { "query": "shams", "probe_handle": "shams", "pool": 28, "ranked": 28, "sources": { "...": "..." }, "warnings": [] }, "hydration": { "include": null, "status": "verified", "rows": 12, "looked_up": 12, "filled": 12, "cached": 0, "unfilled": 0, "ms": 12047 }, "scraped_at": "2026-09-22T08:46:10.412Z" }, { "keyword": "shams", "position": 2, "user_id": "65310101636", "verified": false, "username": "shams_a20", "pk": "65310101636", "is_active_on_text_post_app": true, "full_name": "Sunny💛", "is_verified": false, "has_onboarded_to_text_post_app": true, "id": "65310101636", "bio": null, "followers": null, "url": "https://www.threads.com/@shams_a20", "private": null, "ext": { "bio_link": null }, "match_tier": 1, "source": "brave", "sources": [ "brave" ], "...": "... (same keys as the first row)" } ], "next_cursor": "eyJxIjogInNoYW1zIiwgImxrIjoge30sICJwIjogMSwgInBvcyI6IDEyLCAicyI6IFsic2hhbXMiLCAic2hhbXNfYTIwIiwgIi4uLiJdfQ" }}Bad input. The exact message varies by endpoint.
{ "success": false, "error": "…"}Balance below the endpoint’s price.
{ "error": "Insufficient credits. Buy more to scrape more.", "balance": 1, "required": 2}Invalid or unknown API key.
{ "detail": "Authentication service unavailable or invalid API key."}Throttled — wait for Retry-After.
{ "detail": "Request was throttled. Expected available in N seconds."}Sample from the live catalog; arrays trimmed to 3 items. Results are in data.engines.
Response fields
Section titled “Response fields”| Field | Type | Example | Description |
|---|---|---|---|
queries | string | shams | — |
page | integer | 1 | — |
page_size | integer | 12 | — |
include | null | null | — |
engines | array | [2 items] | The results. |
pool | integer | 28 | — |
ranked | integer | 28 | — |
excluded | integer | 0 | — |
beyond_limit | integer | 14 | — |
verified_dead | integer | 0 | — |
more_discovery_possible | boolean | true | — |
sources | object | {…} | — |
warnings | array | [] | — |
hydration | null | null | — |
requests | integer | 17 | — |
duration_ms | integer | 12180 | — |
users | array | [2 items] | — |
next_cursor | string | eyJxIjogInNoYW1zIiwgImxrIjoge30sICJwIjogMSwgI… | Pass back as cursor for the next page. null on the last page. |
Pagination
Section titled “Pagination”Pass data.next_cursor back as cursor until it is null. Required inputs are ignored once a cursor is sent. Each page is one billed call. More in Pagination.
const url = "https://api.scrapier.io/api/v2/threads-search-users/";let params = { queries: "shams" };const items = [];
for (let page = 0; page < 10; page++) { // each page is one billed call const res = await fetch(`${url}?${new URLSearchParams(params)}`, { headers: { "X-API-Key": "YOUR_API_KEY" }, signal: AbortSignal.timeout(210_000), }); const body = await res.json(); if (!res.ok) throw new Error(body.error ?? body.detail ?? `HTTP ${res.status}`); const data = body.data; items.push(...(data.engines ?? [])); if (!data.next_cursor) break; // null = last page params = { cursor: data.next_cursor };}import requests
URL = "https://api.scrapier.io/api/v2/threads-search-users/"HEADERS = {"X-API-Key": "YOUR_API_KEY"}params = {"queries": "shams"}items = []
for _ in range(10): # each page is one billed call resp = requests.get(URL, headers=HEADERS, params=params, timeout=210) resp.raise_for_status() data = resp.json()["data"] items.extend(data.get("engines") or []) if not data.get("next_cursor"): # None = last page break params = {"cursor": data["next_cursor"]}Errors
Section titled “Errors”Failed calls are free. Branch on the HTTP status and read the message from error (or detail). Full details in Errors.
| Status | Meaning | Retry? | Charged? |
|---|---|---|---|
400 | Bad or missing input. | No — fix the params | No |
401 / 403 | Missing, invalid or revoked API key. | No — fix the key | No |
402 | Out of credits (body has balance). | No — top up | No |
404 | Unknown endpoint slug. | No — check the slug | No |
429 / 503 | Busy or throttled. | Yes — after Retry-After | No |
5xx | Target site or upstream failure, or timeout. | Yes — with backoff | No |
- Locked into the cursor:
include,include_details,engines,engine_pages,candidate_pool. Set them on the first call; later pages reuse them.
Related
Section titled “Related”- Threads Profile Info — Structured Threads data: send
usernames. Single lookup, 1 credit per successful call. - Threads Search — Structured Threads data: send
queries. Cursor-paginated, 1 credit per successful call. - Threads Single Post — Structured Threads data: send
urls. Single lookup, 1 credit per successful call. - Threads User Posts — Structured Threads data: send
usernames. Cursor-paginated, 1 credit per successful call.