Net Flows

Contents

• Net Flows (FlowNetXNtv)

Net Flows

Definiton

The net unit value sent or withdrawn to/from an exchange in that interval.

Name	MetricID	Unit	Interval
Bitfinex Net Flows (native units)	FlowNetBFXNtv	Native units	1 day
Bitfinex Net Flows (USD)	FlowNetBFXUSD	USD	1 day
BitMEX Net Flows (native units)	FlowNetBMXNtv	Native units	1 day
BitMEX Net Flows (USD)	FlowNetBMXUSD	USD	1 day
Binance Net Flows (native units)	FlowNetBNBNtvFlow	Native units	1 day
Binance Net Flows (USD)	FlowNetBNBUSD	USD	1 day
Bitstamp Net Flows (native units)	FlowNetBSPNtv	Native units	1 day
Bitstamp Net Flows (USD)	FlowNetBSPUSD	USD	1 day
Bittrex Net Flows (native units)	FlowNetBTXNtvFlow	Native units	1 day
Bittrex Net Flows (USD)	FlowNetBTXUSD	USD	1 day
Bybit Net Flows (native units)	FlowNetBITNtv	Native units	1 day
Bybit Net Flows (USD)	FlowNetBITUSD	USD	1 day
Coinbase Net Flows (native units)	FlowNetCBSNtv	Native units	1 day
Coinbase Net Flows (USD)	FlowNetCBSUSD	USD	1 day
Crypto.com Net Flows (native units)	FlowNetCRONtv	Native units	1 day
Crypto.com Net Flows (USD)	FlowNetCROUSD	USD	1 day
Deribit Net Flows (native units)	FlowNetDERNtv	Native units	1 day
Deribit Net Flows (USD)	FlowNetDERUSD	USD	1 day
Gate.io Net Flows (native units)	FlowNetGIONtv	Native units	1 day
Gate.io Net Flows (USD)	FlowNetGIOUSD	USD	1 day
Gemini Net Flows (native units)	FlowNetGEMNtv	Native units	1 day
Gemini Net Flows (USD)	FlowNetGEMUSD	USD	1 day
HitBTC Net Flows (native units)	FlowNetHBTNtv	Native units	1 day
HitBTC Net Flows (USD)	FlowNetHBTUSD	USD	1 day
Huobi Net Flows (native units)	FlowNetHUONtv	Native units	1 day
Huobi Net Flows (USD)	FlowNetHUOUSD	USD	1 day
Korbit Net Flows (native units)	FlowNetKORNtv	Native units	1 day
Korbit Net Flows (USD)	FlowNetKORUSD	USD	1 day
Kraken Net Flows (native units)	FlowNetKRKNtv	Native units	1 day
Kraken Net Flows (USD)	FlowNetKRKUSD	USD	1 day
Kucoin Net Flows (native units)	FlowNetKCNNtv	Native units	1 day
Kucoin Net Flows (USD)	FlowNetKCNUSD	USD	1 day
MEXC Net Flows (native units)	FlowNetMXCNtv	Native units	1 day
MEXC Net Flows (USD)	FlowNetMXCUSD	USD	1 day
NBX Net Flows (native units)	FlowNetNBXNtv	Native units	1 day
NBX Net Flows (USD)	FlowNetNBXUSD	USD	1 day
OKX Net Flows (native units)	FlowNetOKXNtv	Native units	1 day
OKX Net Flows (USD)	FlowNetOKXUSD	USD	1 day
Poloniex Net Flows (native units)	FlowNetPOLNtv	Native units	1 day
Poloniex Net Flows (USD)	FlowNetPOLUSD	USD	1 day
SwissBorg Net Flows (native units)	FlowNetSBGNtv	Native units	1 day
SwissBorg Net Flows (USD)	FlowNetSBGUSD	USD	1 day

Details

• Native units are considered as sent to an exchange if they are sent to an address we identify as being owned by an exchange.

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

• This metric is the net of the sends and withdrawals that interval.

• USD metrics are computed as FlowNet{Exchange}Ntv * PriceUSD

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 sends 90 BTC to exchange A but also withdraws 50 BTC from it, the flow is +40 BTC, not +90 BTC and -50 BTC.

Release History

• Released in the 4.0 release of NDP

Availability for Assets

Coin Metrics CoverageCoin Metrics Coverage

API Endpoints

Net Flow metrics can be accessed using these endpoints:

• timeseries/asset-metrics

and by passing in the metric ID's FlowNet* 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: allAvailable options:

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: endAvailable options:

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: assetAvailable options:

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: jsonAvailable options:

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

application/jsontext/csv

objectoptional

Time series of asset metrics.

application/json

application/json

application/json

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=FlowNetBFXNtv&assets=btc&pretty=true&api_key=<your_key>"

Python

import requests
response = requests.get('https://api.coinmetrics.io/v4/timeseries/asset-metrics?metrics=FlowNetBFXNtv&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="FlowNetBFXNtv", 
        assets="btc",
    ).to_dataframe()
)