/debank/users/search

POST /api/debank/users/search

Price: 1 credit

Search DeBank users by web3 id, name or wallet address

How to use it

Search for crypto wallets / DeBank users by web3 id, display name or wallet address. Returns matching users with their address, web3 id, display name, bio, total net worth in USD, follower and following counts, DeBank rank, linked twitter handle, VIP and pro flags, and avatar. Use this to resolve a human-readable web3 id or name into a wallet address, then call the users, tokens, protocols or history endpoints for full details.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• q string required — Search query: a web3 id, display name or wallet address (minLength: 1)
• count integer required — Max number of users to return (min: 1)

Response

• @type string (default: "DebankUserSearchResult")
• id string required
• web3_id string nullable
• name string nullable
• bio string nullable
• usd_value number nullable
• follower_count integer nullable
• following_count integer nullable
• rank integer nullable
• twitter_id string nullable
• is_vip boolean (default: false)
• is_pro boolean (default: false)
• image string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.