> For the complete documentation index, see [llms.txt](https://gitbook-docs.coinmetrics.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook-docs.coinmetrics.io/cm-api-spec/atlas/list-of-blockchain-entities-v2/list-of-sub-accounts.md).

# List of sub-accounts

Returns a list of blockchain sub-accounts with their current balance.\
For rebasing assets, the balances returned are adjusted according to the current rebasing conditions.\
Results are ordered by tuple `(creation_chain_sequence_number, account)`.\
To fetch the next page of results use `next_page_url` JSON response field.

```json
{"openapi":"3.0.2","info":{"title":"Coin Metrics API v4","version":"4.0.0"},"tags":[{"name":"List of blockchain entities v2","description":"Endpoints for fetching lists of blockchain entities.\n\n**Sections in this group:**\n- **Full blockchain entities v2** (3 endpoints)\n\n**Endpoints on this page:**\n- `GET /blockchain-v2/{asset}/accounts` — List of accounts\n- `GET /blockchain-v2/{asset}/accounts/{account}/balance-updates` — List of balance updates for account\n- `GET /blockchain-v2/{asset}/balance-updates` — List of balance updates\n- `GET /blockchain-v2/{asset}/blocks` — List of blocks\n- `GET /blockchain-v2/{asset}/rebasing-changes` — List of rebasing changes\n- `GET /blockchain-v2/{asset}/sub-accounts` — List of sub-accounts\n- `GET /blockchain-v2/{asset}/transactions` — List of transactions"}],"servers":[{"url":"https://api.coinmetrics.io/v4"},{"url":"wss://api.coinmetrics.io/v4"},{"url":"https://community-api.coinmetrics.io/v4"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"description":"Coin Metrics API key can be specified as `?api_key=` query parameter.","in":"query","name":"api_key","type":"apiKey"}},"parameters":{"BlockchainAsset":{"description":"Asset name.","in":"path","name":"asset","required":true,"schema":{"type":"string"}},"BlockchainAccountsV2":{"description":"Optional comma separated list of accounts to filter a response.<br/> The list must contain a single element for Community users.","in":"query","name":"accounts","schema":{"type":"array","items":{"type":"string"}},"explode":false},"StartTimeMutuallyExclusiveWithHeightAtlasV2":{"description":"Start of the time interval.<br/> This field refers to the `time` field in the response.<br/> Multiple formats of ISO 8601 are supported: `2006-01-20T00:00:00Z`, `2006-01-20T00:00:00.000Z`, `2006-01-20T00:00:00.123456Z`, `2006-01-20T00:00:00.123456789Z`, `2006-01-20`, `20060120`.<br/> Inclusive by default. Mutually exclusive with `start_height`.<br/> UTC timezone by default. `Z` suffix is optional and `timezone` parameter has a priority over it.<br/> If `start_time` is omitted, response will include time series from the **earliest** time available.<br/> This parameter is disabled for Community users.","in":"query","name":"start_time","schema":{"type":"string"}},"EndTimeMutuallyExclusiveWithHeightAtlasV2":{"description":"End of the time interval.<br/> This field refers to the `time` field in the response.<br/> Multiple formats of ISO 8601 are supported: `2006-01-20T00:00:00Z`, `2006-01-20T00:00:00.000Z`, `2006-01-20T00:00:00.123456Z`, `2006-01-20T00:00:00.123456789Z`, `2006-01-20`, `20060120`.<br/> Inclusive by default. Mutually exclusive with `end_height`.<br/> UTC timezone by default. `Z` suffix is optional and `timezone` parameter has a priority over it.<br/> If `end_time` is omitted, response will include time series up to the **latest** time available.<br/> This parameter is disabled for Community users.","in":"query","name":"end_time","schema":{"type":"string"}},"StartHeightMutuallyExclusiveWithTimeAtlasV2":{"description":"The start height indicates the beginning block height for the set of data that are returned.<br/> Inclusive by default. Mutually exclusive with `start_time`.<br/> This parameter is disabled for Community users.","in":"query","name":"start_height","schema":{"type":"integer","format":"int64","minimum":0}},"EndHeightMutuallyExclusiveWithTimeAtlasV2":{"description":"The end height indicates the ending block height for the set of data that are returned.<br/> Inclusive by default. Mutually exclusive with `end_time`.<br/> This parameter is disabled for Community users.","in":"query","name":"end_height","schema":{"type":"integer","format":"int64","minimum":0}},"BlockchainStartChainSequenceNumberV2":{"description":"Start of the `chain_sequence_number` interval.<br/> This parameter is disabled for Community users.","in":"query","name":"start_chain_sequence_number","schema":{"type":"integer","format":"int64","minimum":0}},"BlockchainEndChainSequenceNumberV2":{"description":"End of the `chain_sequence_number` interval.<br/> This parameter is disabled for Community users.","in":"query","name":"end_chain_sequence_number","schema":{"type":"integer","format":"int64","minimum":0}},"StartInclusiveAtlasV2":{"description":"Inclusive or exclusive corresponding `start_*` parameters.<br/> This parameter is disabled for Community users.","in":"query","name":"start_inclusive","schema":{"default":true,"type":"boolean"}},"EndInclusiveAtlasV2":{"description":"Inclusive or exclusive corresponding `end_*` parameters.<br/> This parameter is disabled for Community users.","in":"query","name":"end_inclusive","schema":{"default":true,"type":"boolean"}},"Timezone":{"description":"Timezone name for `start_time` and `end_time` timestamps.<br/> This parameter does not modify the output times, which are always `UTC`.<br/> Format is defined by [TZ database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).","in":"query","name":"timezone","schema":{"default":"UTC","type":"string"}},"PageSizeAtlasV2":{"description":"Number of items per single page of results.<br/> This parameter is disabled for Community users.","in":"query","name":"page_size","schema":{"default":100,"type":"integer","format":"int32","minimum":1,"maximum":10000}},"PagingFrom":{"description":"Where does the first page start, at the start of the interval or at the end.<br/> The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.","in":"query","name":"paging_from","schema":{"default":"end","enum":["start","end"],"type":"string","format":"PagingFrom"}},"Pretty":{"description":"Human-readable formatting of JSON responses.","in":"query","name":"pretty","schema":{"type":"boolean","default":false}},"NextPageToken":{"description":"Token for receiving the results from the next page of a query.<br/> Should not be used directly. To iterate through pages just use `next_page_url` response field.","in":"query","name":"next_page_token","schema":{"type":"string"}},"IgnoreUnsupportedErrors":{"description":"Ignore \"unsupported\" errors for not currently supported by Coin Metrics items.","in":"query","name":"ignore_unsupported_errors","schema":{"type":"boolean","default":false}}},"responses":{"BlockchainSubAccountsV2":{"description":"Blockchain sub-accounts.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockchainSubAccountsResponseV2"}}}},"Unauthorized":{"description":"Requested resource requires authorization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"BlockchainForbidden":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Requested resource is not available with supplied credentials."}},"schemas":{"BlockchainSubAccountsResponseV2":{"description":"Blockchain sub-accounts response.","properties":{"data":{"items":{"type":"object","properties":{"sub_account":{"$ref":"#/components/schemas/BlockchainSubAccount"},"account":{"$ref":"#/components/schemas/BlockchainAccount"},"type":{"$ref":"#/components/schemas/BlockchainAccountType"},"creation_height":{"$ref":"#/components/schemas/BlockchainBlockHeight"},"creation_time":{"$ref":"#/components/schemas/Time"},"creation_chain_sequence_number":{"$ref":"#/components/schemas/BlockchainChainSequenceNumber"},"creation_block_hash":{"$ref":"#/components/schemas/BlockchainBlockHash"},"balance":{"$ref":"#/components/schemas/BlockchainSubAccountBalance"}},"required":["sub_account","account","type","creation_height","creation_block_hash","creation_time","creation_chain_sequence_number"]}},"next_page_token":{"$ref":"#/components/schemas/NextPageToken"},"next_page_url":{"$ref":"#/components/schemas/NextPageUrl"}},"required":["data"],"type":"object"},"BlockchainSubAccount":{"description":"Sub-account id.","type":"string"},"BlockchainAccount":{"description":"Account id.","type":"string"},"BlockchainAccountType":{"description":"Account type. The possible values are: `UTXO`, `VIRTUAL`, `ACCOUNT`.","type":"string"},"BlockchainBlockHeight":{"description":"Height of the block.","type":"string","format":"int64"},"Time":{"description":"The time in ISO 8601 date-time format. Always with nanoseconds precision.","type":"string","format":"date-time"},"BlockchainChainSequenceNumber":{"description":"Chain sequence number.","type":"string","format":"int64"},"BlockchainBlockHash":{"description":"Hash of the block.","type":"string"},"BlockchainSubAccountBalance":{"description":"Sub-account latest balance.","type":"string","format":"decimal"},"NextPageToken":{"description":"Token of the next page results for a given request.","type":"string"},"NextPageUrl":{"description":"URL of the next page results for a given request.","type":"string"},"ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/ErrorObject"}},"required":["error"],"type":"object"},"ErrorObject":{"properties":{"type":{"description":"Error type string. Can be used for error identification.","type":"string"},"message":{"description":"Human-friendly error description. Can be amended without prior notification. Do not use for error identification in your code.","type":"string"}},"required":["type","description"],"type":"object"}}},"paths":{"/blockchain-v2/{asset}/sub-accounts":{"get":{"summary":"List of sub-accounts","description":"Returns a list of blockchain sub-accounts with their current balance.<br/> For rebasing assets, the balances returned are adjusted according to the current rebasing conditions.<br/> Results are ordered by tuple `(creation_chain_sequence_number, account)`.<br/> To fetch the next page of results use `next_page_url` JSON response field.","operationId":"getBlockchainV2ListOfSubAccounts","tags":["List of blockchain entities v2"],"parameters":[{"$ref":"#/components/parameters/BlockchainAsset"},{"$ref":"#/components/parameters/BlockchainAccountsV2"},{"$ref":"#/components/parameters/StartTimeMutuallyExclusiveWithHeightAtlasV2"},{"$ref":"#/components/parameters/EndTimeMutuallyExclusiveWithHeightAtlasV2"},{"$ref":"#/components/parameters/StartHeightMutuallyExclusiveWithTimeAtlasV2"},{"$ref":"#/components/parameters/EndHeightMutuallyExclusiveWithTimeAtlasV2"},{"$ref":"#/components/parameters/BlockchainStartChainSequenceNumberV2"},{"$ref":"#/components/parameters/BlockchainEndChainSequenceNumberV2"},{"$ref":"#/components/parameters/StartInclusiveAtlasV2"},{"$ref":"#/components/parameters/EndInclusiveAtlasV2"},{"$ref":"#/components/parameters/Timezone"},{"$ref":"#/components/parameters/PageSizeAtlasV2"},{"$ref":"#/components/parameters/PagingFrom"},{"$ref":"#/components/parameters/Pretty"},{"$ref":"#/components/parameters/NextPageToken"},{"$ref":"#/components/parameters/IgnoreUnsupportedErrors"}],"responses":{"200":{"$ref":"#/components/responses/BlockchainSubAccountsV2"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/BlockchainForbidden"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://gitbook-docs.coinmetrics.io/cm-api-spec/atlas/list-of-blockchain-entities-v2/list-of-sub-accounts.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
