Withdrawals

Contents

• Exchange Withdrawals (FlowOutXNtv, FlowOutXUSD)

• Exchange Withdrawals (Total) (FlowOutExNtv, FlowOutExUSD)

• Exchange Withdrawals, Incl EtoE (FlowOutExInclUSD)

• Withdrawal Count (FlowTfrOutXCnt)

Exchange Withdrawals

Definition

The sum withdrawn from an exchange that day.

Name	MetricID	Unit	Interval
Bitfinex Withdrawals (native units)	FlowOutBFXNtv	Native units	1 block, 1 day
Bitfinex Withdrawals (USD)	FlowOutBFXUSD	USD	1 block, 1 day
BitMEX Withdrawals (native units)	FlowOutBMXNtv	Native units	1 block, 1 day
BitMEX Withdrawals (USD)	FlowOutBMXUSD	USD	1 block, 1 day
Binance Withdrawals (native units)	FlowOutBNBNtv	Native units	1 block, 1 day
Binance Withdrawals (USD)	FlowOutBNBUSD	USD	1 block, 1 day
Bitstamp Withdrawals (native units)	FlowOutBSPNtv	Native units	1 block, 1 day
Bitstamp Withdrawals (USD)	FlowOutBSPUSD	USD	1 block, 1 day
Bittrex Withdrawals (native units)	FlowOutBTXNtv	Native units	1 block, 1 day
Bittrex Withdrawals (USD)	FlowOutBTXUSD	USD	1 block, 1 day
Bybit Withdrawals (native units)	FlowOutBITNtv	Native units	1 day
Bybit Withdrawals (USD)	FlowOutBITUSD	USD	1 day
Coinbase Withdrawals (native units)	FlowOutCBSNtv	Native units	1 day
Coinbase Withdrawals (USD)	FlowOutCBSUSD	USD	1 day
Crypto.com Withdrawals (native units)	FlowOutCRONtv	Native units	1 day
Crypto.com Withdrawals (USD)	FlowOutCROUSD	USD	1 day
Deribit Withdrawals (native units)	FlowOutDERNtv	Native units	1 day
Deribit Withdrawals (USD)	FlowOutDERUSD	USD	1 day
Gate.io Withdrawals (native units)	FlowOutGIONtv	Native units	1 day
Gate.io Withdrawals (USD)	FlowOutGIOUSD	USD	1 day
Gemini Withdrawals (native units)	FlowOutGEMNtv	Native units	1 block, 1 day
Gemini Withdrawals (USD)	FlowOutGEMUSD	USD	1 block, 1 day
HitBTC Withdrawals (native units)	FlowOutHBTNtv	Native units	1 day
HitBTC Withdrawals (USD)	FlowOutHBTUSD	USD	1 day
Huobi Withdrawals (native units)	FlowOutHUONtv	Native units	1 block, 1 day
Huobi Withdrawal (USD)	FlowOutHUOUSD	USD	1 block, 1 day
Korbit Withdrawals (native units)	FlowOutKORNtv	Native units	1 day
Korbit Withdrawals (USD)	FlowOutKORUSD	USD	1 day
Kraken Withdrawals (native units)	FlowOutKRKNtv	Native units	1 block, 1 day
Kraken Withdrawals (USD)	FlowOutKRKUSD	USD	1 block, 1 day
Kucoin Withdrawals (native units)	FlowOutKCNNtv	Native units	1 day
Kucoin Withdrawals (USD)	FlowOutKCNUSD	USD	1 day
MEXC Withdrawals (native units)	FlowOutMXCNtv	Native units	1 day
MEXC Withdrawals (USD)	FlowOutMXCUSD	USD	1 day
NBX Withdrawals (native units)	FlowOutNBXNtv	Native units	1 day
NBX Withdrawals (USD)	FlowOutNBXUSD	USD	1 day
OKX Withdrawals (native units)	FlowOutOKXNtv	Native units	1 day
OKX Withdrawals (USD)	FlowOutOKXUSD	USD	1 day
Poloniex Withdrawals (native units)	FlowOutPOLNtv	Native units	1 block, 1 day
Poloniex Withdrawals (USD)	FlowOutPOLUSD	USD	1 block, 1 day
SwissBorg Withdrawals (native units)	FlowOutSBGNtv	Native units	1 day
SwissBorg Withdrawals (USD)	FlowOutSBGUSD	USD	1 day

Details

• Native units are considered as withdrawn if they leave the control of an address we identify as being owned by an exchange.

Asset-Specific Details

• This metric might not be available for all assets. Either that exchange doesn’t support this asset (BitMEX only trades in BTC for example), or we deemed that our coverage of the exchange was not complete enough to release the metric for it.

• For Bitcoin, this metric excludes the effect of change outputs:

• • If a transaction spends 100 BTC from exchange A but 90 BTC are sent back to it as change, the flow is -10 BTC, not -100 BTC and +90 BTC.

Release History

• Released in the 4.0 release of NDP

Availability for Assets

Coin Metrics CoverageCoin Metrics Coverage

Exchange Withdrawals (Total)

Definition

The sum withdrawn from exchanges that day, excluding exchange to exchange activity.

Name	MetricID	Unit	Interval
Exchange Withdrawals (native units)	FlowOutExNtv	Native units	1 block, 1 day
Exchange Withdrawals (USD)	FlowOutExUSD	USD	1 block, 1 day

Details

• This metric captures interactions between users of a cryptoasset and exchanges supporting that market. It excludes inter-exchange activity.

• If a transaction sends 90 units from exchange B to exchange A, it doesn’t count towards this metric.

• If a transaction spends 10 units from exchange A and sends 5 units to exchange B and 5 units to unknown destination, it counts as a 5 units outflow for exchanges overall, 10 units outflow for exchange A, 5 units inflow for exchange B

Release History

• Released in the 4.0 release of NDP

Availability for Assets

Coin Metrics CoverageCoin Metrics Coverage

Exchange Withdrawals, Incl EtoE (USD)

Definition

The sum USD value withdrawn from exchanges that day, including exchange to exchange activity.

Name	MetricID	Unit	Interval
Exchange Withdrawals, Incl EtoE (USD)	FlowOutExInclUSD	USD	1 block, 1 day

Details

• Computed as FlowOutExInclNtv * PriceUSD

• If a transaction sends 90 units from exchange B to exchange A, it counts towards this metric.

• If a transaction moves 90 units inside exchange A (cold to hot or equivalent), it doesn’t count towards this metric.

Release History

• Released in the 4.0 release of NDP

Availability for Assets

Coin Metrics CoverageCoin Metrics Coverage

Withdrawal Cnt

Definition

The sum count of transfers from any address belonging to exchange Bitfinex in that interval. If the recipient address also belongs to Bitfinex, the transfer is not counted.

Name	MetricID	Unit	Interval
Bitfinex Withdrawal Cnt	FlowTfrOutBFXCnt	Transfers	1 block, 1 day
BitMEX Withdrawal Cnt	FlowTfrOutBMXCnt	Transfers	1 block, 1 day
Binance Withdrawal Cnt	FlowTfrOutBNBCnt	Transfers	1 block, 1 day
Bitstamp Withdrawal Cnt	FlowTfrOutBSPCnt	Transfers	1 block, 1 day
Bittrex Withdrawal Cnt	FlowTfrOutBTXCnt	Transfers	1 block, 1 day
ByBit Withdrawal Cnt	FlowTfrOutBITCnt	Transfers	1 day
Coinbase Withdrawal Cnt	FlowTfrOutCBSCnt	Transfers	1 day
Crypto.com Withdrawal Cnt	FlowTfrOutCROCnt	Transfers	1 day
Deribit Withdrawal Cnt	FlowTfrOutDERCnt	Transfers	1 day
Exchange Deposit Cnt	FlowTfrToExCnt	Transfers	1 block, 1 day
Gate.io Withdrawal Cnt	FlowTfrOutGIOCnt	Transfers	1 day
Gemini Withdrawal Cnt	FlowTfrOutGEMCnt	Transfers	1 block, 1 day
HitBTC Withdrawal Cnt	FlowTfrOutHBTCnt	Transfers	1 day
Huobi Withdrawal Cnt	FlowTfrOutHUOCnt	Transfers	1 block, 1 day
Korbit Withdrawal Cnt	FlowTfrOutKORCnt	Transfers	1 day
Kraken Withdrawal Cnt	FlowTfrOutKRKCnt	Transfers	1 block, 1 day
Kucoin Withdrawal Cnt	FlowTfrOutKCNCnt	Transfers	1 day
MEXC Withdrawal Cnt	FlowTfrOutMXCCnt	Transfers	1 day
NBX Withdrawal Cnt	FlowTfrOutNBXCnt	Transfers	1 day
OKX Withdrawal Cnt	FlowTfrOutOKXCnt	Transfers	1 day
Poloniex Withdrawal Cnt	FlowTfrOutPOLCnt	Transfers	1 block, 1 day
SwissBorg Withdrawal Cnt	FlowTfrOutSBGCnt	Transfers	1 day

Details

• Coinbase (i.e., miner reward) transactions are not counted.

Asset-Specific Details

• For account-based protocols, if both sender and recipient belong to Bitfinex, then the transfer is not counted.

• For UTXO-based protocols, this metric applies the following logic:

  • If the input addresses belong to Bitfinex, then only the outputs where the address doesn’t belong to Bitfinex are counted as transfers from Bitfinex.

Release History

• Version 4.2 of CM Network Data Pro Daily Macro (End of Day)

Availability for Assets

Coin Metrics CoverageCoin Metrics Coverage

API Endpoints

Withdrawal metrics can be accessed using these endpoints:

• timeseries/asset-metrics

and by passing in the metric ID's FlowOut* and FlowTfrOut* in the metrics parameter.

Asset metrics

get

Returns requested metrics for specified assets. Results for block by block metrics (1b frequency) are ordered by tuple (asset, height, block_hash), all other metrics are ordered by tuple (asset, time). You can change the sorting using sort query parameter. Supported output formats are json (default) and csv, use format query parameter to override it. To fetch the next page of results use next_page_url JSON response field or x-next-page-url CSV HTTP header if present. If multiple metrics are requested in the same time the strict policy for partially available metrics among requested ones is applied:

Authorizations

Query parameters

assetsstring[]Required

Comma separated list of assets. Use the /catalog-all/assets endpoint for the full list of supported assets or specify asterisk (*) in order to get metrics for all supported assets.

metricsstring[]Required

Comma separated metrics to request time series data for. Information on all available metrics can be found on page https://coverage.coinmetrics.io/asset-metrics-v2. Use the /catalog-all/metrics or /catalog-all/assets endpoint for the full list of supported metrics per asset.

Example: ["AdrActCnt","BlkHgt"]

frequencystringOptional

Frequency of the metrics. Supported values are 1b (block by block), 1s (one second), 1m (one minute), 5m (five minutes), 10m (ten minutes), 1h (one hour), 1d (one day), 1d-ny-close (one day at New York close time). Please refer to the /catalog/metrics endpoint for the full list. Use the /catalog-all/assets endpoint for the full list of supported frequencies per asset-metric pair.

Default: 1dExample: 1b

statusstring · enumOptional

Which metric values do you want to see. Applicable only for "reviewable" metrics. You can find them in the /catalog/metrics endpoint.

Default: allPossible values:

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 and start_hash. 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.

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 and end_hash. 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.

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 and start_hash.

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 and end_hash. This parameter is disabled for Community users.

start_hashstringOptional

The start hash indicates the beginning block height for the set of data that are returned. Inclusive by default. Mutually exclusive with start_time and start_height.

end_hashstringOptional

The end hash indicates the ending block height for the set of data that are returned. Inclusive by default. Mutually exclusive with end_time and end_height.

start_inclusivebooleanOptional

Inclusive or exclusive corresponding start_* parameters.

Default: true

end_inclusivebooleanOptional

Inclusive or exclusive corresponding end_* parameters.

Default: true

min_confirmationsinteger · int32 · max: 99Optional

Specifies how many blocks behind the chain tip block by block metrics (1b frequency) are based on. Default for btc is 2 and 99 for eth. For example, a min_confirmations of 0 means metrics are being calculated for the block at the tip of the chain (the latest block received by our node) whereas a min_confirmations of 6 means that metrics are being applied to the block that is 6 blocks behind the chain tip (i.e., the 7th block if the chain tip is block 1).

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. The value of this parameter is ignored if the endpoint supports the format parameter and its value is set to json_stream.

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:

sortstring · enumOptional

How results will be sorted. Metrics with 1b frequency are sorted by (asset, height, block_hash) tuples by default. Metrics with other frequencies are sorted by (asset, time) by default. If you want to sort 1d metrics by (time, asset) you should choose time as value for the sort parameter. Sorting by time is useful if you request metrics for a set of assets.

Default: assetPossible values:

limit_per_assetinteger · int32Optional

How many entries per asset result should contain. For example, this combination of parameters assets=btc,eth&metrics=ReferenceRate&limit_per_asset=1 returns the latest ReferenceRate values for btc and eth.

prettybooleanOptional

Human-readable formatting of JSON responses.

Default: false

formatstring · enumOptional

Format of the response.

Default: jsonPossible values:

null_as_zerobooleanOptional

Nulls are represented as zeros in the response.

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_forbidden_errorsbooleanOptional

Ignore "forbidden" errors for the items you currently don't have access to.

Default: false

ignore_unsupported_errorsbooleanOptional

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

Default: false

Responses

200

Time series of metrics for an asset.

application/jsontext/csv

400

Asset not found.

application/json

401

Requested resource requires authorization.

application/json

403

Requested resource is not available with supplied credentials.

application/json

414

Provided URI is too long. It must not be greater than 10000 symbols.

get

HTTPcURLJavaScriptPython

GET /v4/timeseries/asset-metrics HTTP/1.1
Host: api.coinmetrics.io
Accept: */*

{
  "data": [
    {
      "asset": "btc",
      "time": "2020-02-29T00:00:00.000000000Z",
      "PriceUSD": "8582.09029964933",
      "SplyBMXNtv": "283220.10827406",
      "SplyBMXNtv-status": "reviewed",
      "SplyBMXNtv-status-time": "2020-03-01T09:59:13.847251000Z"
    },
    {
      "asset": "btc",
      "time": "2020-03-01T00:00:00.000000000Z",
      "PriceUSD": "8541.77389392169",
      "SplyBMXNtv": "284691.32323907",
      "SplyBMXNtv-status": "reviewed",
      "SplyBMXNtv-status-time": "2020-03-02T14:00:02.622168000Z"
    }
  ],
  "next_page_token": "0.MjAyMC0wNi0wN1QwMDowMDowMFo,MjAyMC0wNi0wN1QwMDowMDowMFo",
  "next_page_url": "https://api.coinmetrics.io/v4/timeseries/asset-metrics?api_key=<your_key>&pretty=true&assets=btc&metrics=SplyBMXNtv,PriceUSD&page_size=2&next_page_token=0.MjAyMC0wNi0wN1QwMDowMDowMFo,MjAyMC0wNi0wN1QwMDowMDowMFo"
}

Shell

curl --compressed "https://api.coinmetrics.io/v4/timeseries/asset-metrics?metrics=FlowOutBFXUSD&assets=btc&pretty=true&api_key=<your_key>"

Python

import requests
response = requests.get('https://api.coinmetrics.io/v4/timeseries/asset-metrics?metrics=FlowOutBFXUSD&assets=btc&pretty=true&api_key=<your_key>').json()
print(response)

Python Client

from coinmetrics.api_client import CoinMetricsClient

api_key = "<API_KEY>"
client = CoinMetricsClient(api_key)

print(
    client.get_asset_metrics(
        metrics="FlowOutBFXUSD", 
        assets="btc",
    ).to_dataframe()
)