BTC Inter Entity Flows

This namespace contains endpoints to retrieve inter entity flows data (e.g. flow between miners and exchanges). Data entries were collected from the first transaction between two entities. We constantly keep updating new entity wallets, which means that there can be slight modification in values especially for recent data points. The update is done in periodic and automatic way: Tuesday 00:00 UTC every week.

Note: This endpoint does not support Point-In-Time (PIT) accuracy due to periodic updates to wallet address clustering. Historical data may change as new entity wallets are discovered, added, and validated.

Exchange to Exchange

get

This endpoint contains metrics related to token flows between exchanges. We provide several metrics, flow_total, the total number of tokens transferred from one exchange to another, flow_mean, the mean of tokens transferred, and transactions_count_flow, the number of transactions between exchanges.

Authorizations

Access Token

AuthorizationstringRequired

For each API request, include this HTTP header: Authorization with the Bearer {access_token}. Bearer access token is the type of HTTP Authorization. You have to include access token to the HTTP header and note that leading bearer is required. You must include your access token in HTTP header in every request you make. The token is unique, issued for each client, and regularly changed(once a year). To obtain an access token, please upgrade your plan to Professional or Premium plan. You'll be able to see your access token on the API tab of your profile page after the subscription.

Query parameters

from_exchangestringRequired

An exchange from the table that we support. See here.

Example: binance

to_exchangestringRequired

An exchange from the table that we support. See here. This should not be same as from_entity.

Example: bithumb

windowstringOptional

Currently we support day, hour, and block.

Default: dayExample: day

fromanyOptional

This defines the starting time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the earliest time.

Example: 20191001T100000

toanyOptional

This defines the ending time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the latest time.

Example: 20191001T103025

limitinteger · min: 1 · max: 100000Optional

The maximum number of entries to return before the latest data point (or before to if specified). This field ranges from 1 to 100,000.

Default: 100Example: 100

formatstringOptional

A format type about return message type. Supported formats are json, csv.

Default: jsonExample: json

Responses

200

from_exchange, to_exchange, flow

application/json

get

/btc/inter-entity-flows/exchange-to-exchange

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/inter-entity-flows/exchange-to-exchange?from_exchange=binance&to_exchange=bithumb&window=day&from=20191001&limit=2"

200

from_exchange, to_exchange, flow

{
  "status": {
    "code": 200,
    "message": "success"
  },
  "result": {
    "window": "day",
    "data": [
      {
        "date": "2019-10-02",
        "flow_total": null,
        "flow_mean": null,
        "transactions_count_flow": null
      },
      {
        "date": "2019-10-01",
        "flow_total": null,
        "flow_mean": null,
        "transactions_count_flow": null
      }
    ]
  }
}

Miner to Exchange

get

This endpoint contains metrics related to token flows from mining pools to exchanges. We provide several metrics, flow_total, the total number of tokens transferred from a mining pool to an exchange, flow_mean, the mean of tokens transferred, and transactions_count_flow, the number of transactions from a mining pool to an exchange.

Authorizations

Access Token

AuthorizationstringRequired

For each API request, include this HTTP header: Authorization with the Bearer {access_token}. Bearer access token is the type of HTTP Authorization. You have to include access token to the HTTP header and note that leading bearer is required. You must include your access token in HTTP header in every request you make. The token is unique, issued for each client, and regularly changed(once a year). To obtain an access token, please upgrade your plan to Professional or Premium plan. You'll be able to see your access token on the API tab of your profile page after the subscription.

Query parameters

from_minerstringRequired

A mining pool from the table that we support. See here.

Example: f2pool

to_exchangestringRequired

An exchange from the table that we support. See here. This should not be same as from_entity.

Example: bithumb

windowstringOptional

Currently we support day, hour, and block.

Default: dayExample: day

fromanyOptional

This defines the starting time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the earliest time.

Example: 20191001T100000

toanyOptional

This defines the ending time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the latest time.

Example: 20191001T103025

limitinteger · min: 1 · max: 100000Optional

The maximum number of entries to return before the latest data point (or before to if specified). This field ranges from 1 to 100,000.

Default: 100Example: 100

formatstringOptional

A format type about return message type. Supported formats are json, csv.

Default: jsonExample: json

Responses

200

from_miner, to_exchange, flow

application/json

get

/btc/inter-entity-flows/miner-to-exchange

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/inter-entity-flows/miner-to-exchange?from_miner=f2pool&to_exchange=binance&window=day&from=20191001&limit=2"

200

from_miner, to_exchange, flow

{
  "status": {
    "code": 200,
    "message": "success"
  },
  "result": {
    "window": "day",
    "data": [
      {
        "date": "2019-10-02",
        "flow_total": null,
        "flow_mean": null,
        "transactions_count_flow": null
      },
      {
        "date": "2019-10-01",
        "flow_total": null,
        "flow_mean": null,
        "transactions_count_flow": null
      }
    ]
  }
}

Exchange to Miner

get

This endpoint contains metrics related to token flows from exchanges to mining pools. We provide several metrics, flow_total, the total number of tokens transferred from a mining pool to an exchange, flow_mean, the mean of tokens transferred, and transactions_count_flow, the number of transactions from an exchange to a mining pool.

Authorizations

Access Token

AuthorizationstringRequired

For each API request, include this HTTP header: Authorization with the Bearer {access_token}. Bearer access token is the type of HTTP Authorization. You have to include access token to the HTTP header and note that leading bearer is required. You must include your access token in HTTP header in every request you make. The token is unique, issued for each client, and regularly changed(once a year). To obtain an access token, please upgrade your plan to Professional or Premium plan. You'll be able to see your access token on the API tab of your profile page after the subscription.

Query parameters

from_exchangestringRequired

An exchange from the table that we support. See here.

Example: binance

to_minerstringRequired

A mining pool from the table that we support. See here.

Example: f2pool

windowstringOptional

Currently we support day, hour, and block.

Default: dayExample: day

fromanyOptional

This defines the starting time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the earliest time.

Example: 20191001T100000

toanyOptional

This defines the ending time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the latest time.

Example: 20191001T103025

limitinteger · min: 1 · max: 100000Optional

The maximum number of entries to return before the latest data point (or before to if specified). This field ranges from 1 to 100,000.

Default: 100Example: 100

formatstringOptional

A format type about return message type. Supported formats are json, csv.

Default: jsonExample: json

Responses

200

from_exchange, to_miner, flow

application/json

get

/btc/inter-entity-flows/exchange-to-miner

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/inter-entity-flows/exchange-to-miner?from_exchange=binance&to_miner=f2pool&window=day&from=20191001&limit=2"

200

from_exchange, to_miner, flow

{
  "status": {
    "code": 200,
    "message": "success"
  },
  "result": {
    "window": "day",
    "data": [
      {
        "date": "2019-10-02",
        "flow_total": null,
        "flow_mean": null,
        "transactions_count_flow": null
      },
      {
        "date": "2019-10-01",
        "flow_total": null,
        "flow_mean": null,
        "transactions_count_flow": null
      }
    ]
  }
}

Miner to Miner

get

This endpoint contains metrics related to token flows between mining pools. We provide several metrics, flow_total, the total number of tokens transferred from one mining pool to another, flow_mean, the mean of tokens transferred, and transactions_count_flow, the number of transactions between mining pools.

Authorizations

Access Token

AuthorizationstringRequired

For each API request, include this HTTP header: Authorization with the Bearer {access_token}. Bearer access token is the type of HTTP Authorization. You have to include access token to the HTTP header and note that leading bearer is required. You must include your access token in HTTP header in every request you make. The token is unique, issued for each client, and regularly changed(once a year). To obtain an access token, please upgrade your plan to Professional or Premium plan. You'll be able to see your access token on the API tab of your profile page after the subscription.

Query parameters

from_minerstringRequired

A mining pool from the table that we support. See here.

Example: f2pool

to_minerstringRequired

A mining pool from the table that we support. See here.

Example: f2pool

windowstringOptional

Currently we support day, hour, and block.

Default: dayExample: day

fromanyOptional

This defines the starting time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the earliest time.

Example: 20191001T100000

toanyOptional

This defines the ending time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the latest time.

Example: 20191001T103025

limitinteger · min: 1 · max: 100000Optional

The maximum number of entries to return before the latest data point (or before to if specified). This field ranges from 1 to 100,000.

Default: 100Example: 100

formatstringOptional

A format type about return message type. Supported formats are json, csv.

Default: jsonExample: json

Responses

200

from_miner, to_miner, flow

application/json

get

/btc/inter-entity-flows/miner-to-miner

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/inter-entity-flows/miner-to-miner?from_miner=f2pool&to_miner=antpool&window=day&from=20191001&limit=2"

200

from_miner, to_miner, flow

{
  "status": {
    "code": 200,
    "message": "success"
  },
  "result": {
    "window": "day",
    "data": [
      {
        "date": "2019-10-02",
        "flow_total": null,
        "flow_mean": null,
        "transactions_count_flow": null
      },
      {
        "date": "2019-10-01",
        "flow_total": null,
        "flow_mean": null,
        "transactions_count_flow": null
      }
    ]
  }
}