> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scraperize.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Search users
> Searches Threads accounts by username or name, like the "Profiles" results on Threads search: best match first, up to about 100 accounts in one response. Each account has its id, username, display name, bio, profile link and picture, follower count, and verified and private flags. No match returns an empty list. Only publicly available data is returned.
**Cost: 1 credit** per successful request. Errors and cache hits (`cache_max_age`) are free.
Paste this into ChatGPT, Claude or your coding assistant to generate working code for this endpoint (use the copy button).
```text Prompt
I want to make an API call to /v1/threads/search/users. Here are the details:
Endpoint: GET https://api.scraperize.com/v1/threads/search/users
Description: Searches Threads accounts by username or name, like the "Profiles" results on Threads search: best match first, up to about 100 accounts in one response. Each account has its id, username, display name, bio, profile link and picture, follower count, and verified and private flags. No match returns an empty list. Only publicly available data is returned.
Required Headers:
- x-api-key: Your API key
Parameters:
- query (string) [required]: The username or name to search for, e.g. `zuck` (a leading `@` is ignored).
- cache_max_age (select): Optional. Return a cached result if one this age or newer exists — served for **0 credits** with `meta.cached=true` and `meta.cachedAt`. Otherwise a fresh scrape runs (**1 credit**) and refreshes the cache. Omit to always scrape fresh.
Example Response:
{
"data": {
"query": "zuck",
"users": [
{
"id": "63055343223",
"handle": "zuck",
"fullName": "Mark Zuckerberg",
"biography": "Mostly superintelligence and MMA takes",
"url": "https://www.threads.com/@zuck",
"profilePicUrl": "https://scontent-los4-1.cdninstagram.com/v/t51.82787-19/825322135_17989325280103224_1252773933700107438_n.jpg?stp=dst-jpg_s206x206_tt6&_nc_cat=107&ccb=7-5&_nc_s…",
"isVerified": true,
"isPrivate": false,
"followerCount": 5754865
}
],
"count": 75,
"fetchedAt": "2026-10-19T16:35:13.590Z"
},
"meta": {
"requestId": "req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f",
"creditsCharged": 1,
"creditsRemaining": 4999,
"cached": false
}
}
Please help me write code in my preferred programming language to make this API call and handle the response appropriately. Include error handling and best practices.
```
## OpenAPI
````yaml /api-reference/openapi.json get /v1/threads/search/users
openapi: 3.0.3
info:
title: Scraperize API
version: 1.0.0
description: >-
Extract public data from social media platforms as clean JSON. Endpoints are
split by platform and by what they return, e.g. `GET /v1/twitter/tweet`.
## Authentication
Send your API key in the `x-api-key` header (or `Authorization: Bearer
`). Create keys in your dashboard.
## Credits
Each successful live scrape costs **1 credit**. Credits are prepaid and
never expire.
## Caching
Every endpoint accepts an optional `cache_max_age`
(`1d`|`3d`|`7d`|`14d`|`30d`). A cache hit within that window is returned for
**0 credits**.
## Responses
Success returns `{ "data": …, "meta": { "requestId", … } }`. Errors return
`{ "error": { "code", "message", "requestId" } }` with a matching HTTP
status. `meta` on a scrape carries `creditsCharged`, `creditsRemaining`,
`cached`, and (on a hit) `cachedAt`.
## Rate limits
Requests are limited per team per minute; over the limit returns `429` with
a `Retry-After` header.
servers:
- url: https://api.scraperize.com
description: Production
security:
- ApiKeyAuth: []
tags:
- name: Twitter
description: Twitter / X scraping endpoints
- name: Facebook
description: Facebook scraping endpoints
- name: Linkme
description: Linkme (link.me) scraping endpoints
- name: Amazon
description: Amazon (creator shop / storefront) scraping endpoints
- name: Linkbio
description: Linkbio (lnk.bio) scraping endpoints
- name: Pillar
description: Pillar (pillar.io) scraping endpoints
- name: Komi
description: Komi (komi.io) scraping endpoints
- name: Linktree
description: Linktree (linktr.ee) scraping endpoints
- name: Kick
description: Kick (kick.com) scraping endpoints
- name: Snapchat
description: Snapchat (snapchat.com) scraping endpoints
- name: Telegram
description: Telegram (t.me) scraping endpoints
- name: LinkedIn
description: LinkedIn scraping endpoints
- name: Twitch
description: Twitch scraping endpoints
- name: TikTok
description: TikTok (tiktok.com) scraping endpoints
- name: Instagram
description: Instagram scraping endpoints
- name: Lagos Life
description: Lagos Life scraping endpoints
- name: Bluesky
description: Bluesky (bsky.app) scraping endpoints
- name: Threads
description: Threads (threads.com) scraping endpoints
paths:
/v1/threads/search/users:
get:
tags:
- Threads
summary: Search users
description: >-
Searches Threads accounts by username or name, like the "Profiles"
results on Threads search: best match first, up to about 100 accounts in
one response. Each account has its id, username, display name, bio,
profile link and picture, follower count, and verified and private
flags. No match returns an empty list. Only publicly available data is
returned.
parameters:
- name: query
in: query
required: true
description: >-
The username or name to search for, e.g. `zuck` (a leading `@` is
ignored).
schema:
type: string
minLength: 1
maxLength: 100
example: zuck
- name: cache_max_age
in: query
required: false
description: >-
Optional. Return a cached result if one this age or newer exists —
served for **0 credits** with `meta.cached=true` and
`meta.cachedAt`. Otherwise a fresh scrape runs (**1 credit**) and
refreshes the cache. Omit to always scrape fresh.
schema:
type: string
enum:
- 1d
- 3d
- 7d
- 14d
- 30d
example: 7d
responses:
'200':
description: The matching accounts.
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
query:
type: string
users:
type: array
items:
type: object
count:
type: integer
fetchedAt:
type: string
format: date-time
meta:
type: object
description: >-
requestId + credit/caching metadata (creditsCharged,
creditsRemaining, cached, cachedAt).
required:
- data
- meta
example:
data:
query: zuck
users:
- id: '63055343223'
handle: zuck
fullName: Mark Zuckerberg
biography: Mostly superintelligence and MMA takes
url: https://www.threads.com/@zuck
profilePicUrl: >-
https://scontent-los4-1.cdninstagram.com/v/t51.82787-19/825322135_17989325280103224_1252773933700107438_n.jpg?stp=dst-jpg_s206x206_tt6&_nc_cat=107&ccb=7-5&_nc_sid=30ff31&efg=eyJ2ZW5jb2RlX3RhZyI6InByb2ZpbGVfcGljLnd3dy4xMDgwLkMzIn0%3D&_nc_ohc=dyzJhQmgZIYQ7kNvwEnRJAQ&_nc_oc=Adpc8QV_TlGlFe1pZR1I5kUlWXhAP7dy7wWfaX_7fimaM64UhTxP6p8k6AmS9DIolNk&_nc_zt=24&_nc_ht=scontent-los4-1.cdninstagram.com&_nc_gid=1axBvqC_ajEeVMMQxAkqBw&_nc_ss=7c289&oh=00_AQNqvBzxE8WBbHv2GA0va1-ZnITFlhH_vyytjGxdRdxpHQ&oe=6ADBFF6B
isVerified: true
isPrivate: false
followerCount: 5754865
- id: '64054509910'
handle: ben_zucker_musik
fullName: Ben Zucker
biography: |-
Sehen wir uns auf den Sommer Open Airs? 💪🏼♥️☀️
⬇️Tickets, Album, Merch & Impressum
url: https://www.threads.com/@ben_zucker_musik
profilePicUrl: >-
https://scontent-los4-1.cdninstagram.com/v/t51.2885-19/463655732_532857019530184_2804600388665544218_n.jpg?stp=dst-jpg_s206x206_tt6&_nc_cat=111&ccb=7-5&_nc_sid=30ff31&efg=eyJ2ZW5jb2RlX3RhZyI6InByb2ZpbGVfcGljLnd3dy4xMDgwLkMzIn0%3D&_nc_ohc=rXfJPfBQgGcQ7kNvwHCdL4B&_nc_oc=AdqttZe68mTXpK-LrrKUyewMKxrItGdiesle7WrNLddK6b5FigybR7hiycW0ak9M9JU&_nc_zt=24&_nc_ht=scontent-los4-1.cdninstagram.com&_nc_ss=7c289&oh=00_AQOpUj6MVw4TIhiRApMJ2EHOoGx1wAojbjqFNnYDnjyGFw&oe=6ADC1C3B
isVerified: true
isPrivate: false
followerCount: 20539
- id: '63100372837'
handle: zuckermandave
fullName: Dave Zuckerman
biography: >-
Gen X. Professor. Opinionated. Uncivil responses get you
blocked. See Lake_Meadow_News for the gossip stories.
url: https://www.threads.com/@zuckermandave
profilePicUrl: >-
https://scontent-los4-1.cdninstagram.com/v/t51.82787-19/824507987_17987273556100838_600041553485758573_n.jpg?stp=dst-jpg_s206x206_tt6&_nc_cat=100&ccb=7-5&_nc_sid=30ff31&efg=eyJ2ZW5jb2RlX3RhZyI6InByb2ZpbGVfcGljLnd3dy43MjAuQzMifQ%3D%3D&_nc_ohc=h9I56CgIkhQQ7kNvwEoR1eL&_nc_oc=AdrLuyDk12HFK9MB1ZNDeVyWPQRZNbg-YqWMxBtW9OKxBbk3O1bd4Q70GaAV_UUNJjQ&_nc_zt=24&_nc_ht=scontent-los4-1.cdninstagram.com&_nc_gid=1axBvqC_ajEeVMMQxAkqBw&_nc_ss=7c289&oh=00_AQMGRcicSnImnlEdoZSGM46mBf06RnCcaUtM1VgoFheutw&oe=6ADC0AB2
isVerified: false
isPrivate: false
followerCount: 526
count: 75
fetchedAt: '2026-10-19T16:35:13.590Z'
meta:
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
creditsCharged: 1
creditsRemaining: 4999
cached: false
'401':
description: Missing, invalid, or revoked API key.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: UNAUTHORIZED
message: API key required — pass it in the `x-api-key` header.
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
'402':
description: Not enough credits for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: INSUFFICIENT_CREDITS
message: >-
This request costs 1 credit, but your balance is 0. Top up
to continue.
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
'422':
description: Invalid query parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: VALIDATION_ERROR
message: Request validation failed
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
details:
- path: url
message: url is required
'429':
description: Over the per-minute rate limit — honour `Retry-After`.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: RATE_LIMITED
message: >-
Rate limit exceeded — max 100 requests per 60s. Retry in
~30s.
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
'503':
description: >-
Temporarily unavailable — retry after `Retry-After`. `error.code`
tells you why: `UPSTREAM_BLOCKED` (the source blocked this request),
`EXTRACTION_FAILED` (the source returned unexpected data),
`PLATFORM_UNAVAILABLE` (the source is down), or
`SERVICE_UNAVAILABLE` (we are at capacity).
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: UPSTREAM_BLOCKED
message: >-
The source is temporarily unavailable. Please try again
shortly.
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
components:
schemas:
Error:
type: object
properties:
error:
type: object
properties:
code:
type: string
example: NOT_FOUND
message:
type: string
example: The requested content was not found.
requestId:
type: string
example: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
details:
type: array
items:
type: object
description: Present on validation errors.
required:
- code
- message
- requestId
required:
- error
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
Your API key. Send it in the `x-api-key` header (or `Authorization:
Bearer `). Create and manage keys from your dashboard.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.