---
title: "Where an address stands among the largest holders"
method: GET
path: "/address_rank/{network}/{address}"
tags: ["Addresses"]
---

# Where an address stands among the largest holders

`GET /address_rank/{network}/{address}`

## Request

- Base URL: `https://sochain.com/api/v3`
- URL: `https://sochain.com/api/v3/address_rank/{network}/{address}`
- Auth: one of:
  - none
  - API key in header `API-KEY`
  - API key in query parameter `api_key`

Its exact rank within the top 10,000 and its share of all coins.

## Path parameters

- `network` 'BTC' | 'LTC' | 'DOGE' | 'ZEC' | 'BTCTEST' | 'LTCTEST' | 'DOGETEST' | 'ZECTEST', required
- `address` string, required

## Response `200`

Success.

- object
  - `status` 'success', required
  - `data` AddressRank, required
    - `address` string, required
    - `balance` string, required: An exact decimal amount of coins with 8 decimals. Signed amounts may start with '-'. Parse as an integer of the smallest unit, not a float.
    - `rank` integer, nullable, required: Exact within the top 10,000; null below that or below the rich list's minimum.
    - `rank_limit` integer, required
    - `share_of_supply` number, nullable, required

## Other responses

- `400`: A bad parameter or body; the message says which.
- `401`: An invalid key, no key where one is needed (buckets, webhooks, /account_info), a locked account or expired plan, or both the month's requests and the keyless rate used up. Kept as 401, with this message, for v3 compatibility.
- `404`: Unknown network, or not an address on it.
- `429`: Without a key, past the day's 2,500 lookups from this IP while SoChain is busy (Retry-After: 60), or past the day's most (Retry-After: seconds to 00:00 UTC). With or without one, too many requests in flight at once (Retry-After: 1, not counted).
- `503`: Briefly unavailable; retry with backoff. May carry Retry-After.

---

[API](https://skmtc.dev/sochain/apis/sochain-api.md) · [All operations](https://skmtc.dev/sochain/apis/sochain-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sochain/apis/sochain-api/revisions/80682797b38f?raw)