List of balance updates

Returns a list of blockchain accounts balance updates. Results are ordered by tuple (chain_sequence_number, block_hash). To fetch the next page of results use next_page_url JSON response field. Results are limited to the last 30 days for Community users.

get

https://api.coinmetrics.io/v4https://community-api.coinmetrics.io/v4

/blockchain-v2/{asset}/balance-updates

Authorizations

api_key

api_keystringRequired

Coin Metrics API key can be specified as ?api_key= query parameter.

Path parameters

assetstringRequired

Asset name.

Query parameters

accountsstring[]Optional

Optional comma separated list of accounts to filter a response.
The list must contain a single element for Community users.

limit_per_accountinteger · int32Optional

How many entries per account the result should contain. It is applicable when multiple accounts are requested.
For Community users, this parameter is disabled and the limit is fixed to 100.

sub_accountsstring[]Optional

Optional comma separated list of sub-accounts to filter a response.
This parameter is disabled for Community users.

txidsstring[]Optional

Optional comma separated list of transaction identifiers (txid) to filter a response.
The list must contain a single element for Community users.

block_hashesstring[]Optional

Optional comma separated list of block hashes to filter a response.
The list must contain a single element for Community users.

denominationsstring[]Optional

Optional comma separated list of denominations to filter a response.
The list must contain a single element for Community users.

start_timestringOptional

Start of the time interval.
This field refers to the time field in the response.
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.
Inclusive by default. Mutually exclusive with start_height.
UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it.
If start_time is omitted, response will include time series from the earliest time available.
This parameter is disabled for Community users.

end_timestringOptional

End of the time interval.
This field refers to the time field in the response.
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.
Inclusive by default. Mutually exclusive with end_height.
UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it.
If end_time is omitted, response will include time series up to the latest time available.
This parameter is disabled for Community users.

start_heightinteger · int64Optional

The start height indicates the beginning block height for the set of data that are returned.
Inclusive by default. Mutually exclusive with start_time.
This parameter is disabled for Community users.

end_heightinteger · int64Optional

The end height indicates the ending block height for the set of data that are returned.
Inclusive by default. Mutually exclusive with end_time.
This parameter is disabled for Community users.

start_chain_sequence_numberinteger · int64Optional

Start of the chain_sequence_number interval.
This parameter is disabled for Community users.

end_chain_sequence_numberinteger · int64Optional

End of the chain_sequence_number interval.
This parameter is disabled for Community users.

include_sub_accountsbooleanOptional

Boolean indicating if the response should contain sub-accounts.
This parameter is disabled for Community users.

Default: false

chainstringOptional

Chain type. Supported values are main and all (includes both main and stale).
This parameter is disabled for Community users.

Default: main

start_inclusivebooleanOptional

Inclusive or exclusive corresponding start_* parameters.
This parameter is disabled for Community users.

Default: true

end_inclusivebooleanOptional

Inclusive or exclusive corresponding end_* parameters.
This parameter is disabled for Community users.

Default: true

timezonestringOptional

Timezone name for start_time and end_time timestamps.
This parameter does not modify the output times, which are always UTC.
Format is defined by TZ database.

Default: UTCExample: America/New_York

page_sizeinteger · int32 · min: 1 · max: 10000Optional

Number of items per single page of results.
This parameter is disabled for Community users.

Default: 100

paging_fromstring · enumOptional

Where does the first page start, at the start of the interval or at the end.
The value of this parameter is ignored if the endpoint supports the format parameter and its value is set to json_stream.

Default: endPossible values:

prettybooleanOptional

Human-readable formatting of JSON responses.

Default: false

next_page_tokenstringOptional

Token for receiving the results from the next page of a query.
Should not be used directly. To iterate through pages just use next_page_url response field.

ignore_unsupported_errorsbooleanOptional

Ignore "unsupported" errors for not currently supported by Coin Metrics items.

Default: false

Responses

200

Blockchain balance updates.

application/json

Blockchain balance updates response.

next_page_tokenstringOptional

Token of the next page results for a given request.

next_page_urlstringOptional

URL of the next page results for a given request.

401

Requested resource requires authorization.

application/json

403

Requested resource is not available with supplied credentials.

application/json

get/blockchain-v2/{asset}/balance-updates

ShellPythonPython Client

# Gets list of balance-updates for USDC
curl --compressed "https://api.coinmetrics.io/v4/blockchain-v2/usdc/balance-updates?start_time=2021-01-01&end_time=2021-01-02&pretty=true&api_key=<your_key>"

{
  "data": [
    {
      "block_hash": "0000000000000000000439ea9434c8b20e5e30459022865a7a7fd31e4233538b",
      "height": 649240,
      "consensus_time": "2020-09-20T16:49:48.000000000Z",
      "credit": false,
      "total_received": 0.03823664,
      "total_sent": 0.03632737,
      "chain_sequence_number": 2788464567269277,
      "account": "112dvb4DogEpcp3yUR59HQuN1LFJbPErAT",
      "account_creation_height": 645045,
      "change": -0.00195697,
      "rebasing_numerator": 1,
      "rebasing_denominator": 1,
      "rebasing_rounding_mode": "DOWN",
      "previous_balance": 0.00386624,
      "new_balance": 0.00190927,
      "transaction_sequence_number": 0,
      "txid": "379580cd4910e3ce306ee2129fd1a29ef0a6f86e984d1e7f26c181b4cb83ba51",
      "sub_account": {
        "previous_balance": 0.00195697,
        "new_balance": 0,
        "sub_account": "d5633404739f275af7af6012f4e03e32235857751e382a420d1683582a09afb1-1161",
        "n_debits": 1,
        "n_credits": 1,
        "previous_credit_height": 648382,
        "previous_chain_sequence_number": 2784779485328037,
        "total_received": 0.00195697,
        "total_sent": 0.00195697,
        "creation_height": 648382
      },
      "n_debits": 5,
      "n_credits": 6,
      "previous_debit_height": 649240,
      "previous_credit_height": 649073,
      "previous_chain_sequence_number": 2788464567269275
    },
    {
      "block_hash": "0000000000000000000439ea9434c8b20e5e30459022865a7a7fd31e4233538b",
      "height": 649240,
      "consensus_time": "2020-09-20T16:49:48.000000000Z",
      "credit": false,
      "total_received": 0.03823664,
      "total_sent": 0.03823664,
      "chain_sequence_number": 2788464567269279,
      "account": "112dvb4DogEpcp3yUR59HQuN1LFJbPErAT",
      "account_creation_height": 645045,
      "change": -0.00190927,
      "rebasing_numerator": 1,
      "rebasing_denominator": 1,
      "rebasing_rounding_mode": "DOWN",
      "previous_balance": 0.00190927,
      "new_balance": 0,
      "transaction_sequence_number": 0,
      "txid": "379580cd4910e3ce306ee2129fd1a29ef0a6f86e984d1e7f26c181b4cb83ba51",
      "sub_account": {
        "previous_balance": 0.00190927,
        "new_balance": 0,
        "sub_account": "468effb920e280e966a993918acde9a37118c0daf16d5fc067b1522661e1bab9-1259",
        "n_debits": 1,
        "n_credits": 1,
        "previous_credit_height": 648906,
        "previous_chain_sequence_number": 2787030048192699,
        "total_received": 0.00190927,
        "total_sent": 0.00190927,
        "creation_height": 648906
      },
      "n_debits": 6,
      "n_credits": 6,
      "previous_debit_height": 649240,
      "previous_credit_height": 649073,
      "previous_chain_sequence_number": 2788464567269277
    }
  ],
  "next_page_token": "Mjc4ODQ2NDU2NzI2OTI3N3wwMDAwMDAwMDAwMDAwMDAwMDAwNDM5ZWE5NDM0YzhiMjBlNWUzMDQ1OTAyMjg2NWE3YTdmZDMxZTQyMzM1Mzhi",
  "next_page_url": "https://api.coinmetrics.io/v4/blockchain-v2/btc/balance-updates?api_key=<your_key>&pretty=true&include_sub_accounts=true&page_size=2&next_page_token=Mjc4ODQ2NDU2NzI2OTI3N3wwMDAwMDAwMDAwMDAwMDAwMDAwNDM5ZWE5NDM0YzhiMjBlNWUzMDQ1OTAyMjg2NWE3YTdmZDMxZTQyMzM1Mzhi"
}