BTC Exchange Flows

This endpoint returns the flows of BTC into exchange wallets for as far back as we track. We constantly keep updating new exchange 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. Supported exchanges can be found in the /btc/status/entity-list endpoint. In addition to that, we support the following aggregated exchanges:

Supported Aggregated Exchanges

Name	Exchange	Status
All Exchanges	all_exchange	Validated
Spot Exchanges	spot_exchange	Validated
Derivative Exchanges	derivative_exchange	Validated

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 exchange wallets are discovered, added, and validated.

Reserve

get

This endpoint returns the full historical on-chain balance of Bitcoin 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

exchangestringRequired

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

Example: binance

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

The amount of BTC on a given exchange on this window.

application/json

get

/btc/exchange-flows/reserve

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/exchange-flows/reserve?exchange=binance&window=day&from=20191001&limit=2"

200

The amount of BTC on a given exchange on this window.

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

Netflow

get

The difference between coins flowing into exchanges and flowing out of exchanges. Netflow usually helps us to figure out an increase of idle coins waiting to be traded in a certain time frame.

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

exchangestringRequired

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

Example: binance

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

netflow_total

application/json

get

/btc/exchange-flows/netflow

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/exchange-flows/netflow?exchange=binance&window=day&from=20191001&limit=2"

200

netflow_total

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

Inflow

get

This endpoint returns the inflow of BTC into exchange wallets for as far back as we track. The average inflow is the average transaction value for transactions flowing into exchange wallets on a given day.

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

exchangestringRequired

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

Example: binance

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

inflow_total, inflow_top10, inflow_mean

application/json

get

/btc/exchange-flows/inflow

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/exchange-flows/inflow?exchange=binance&window=day&from=20191001&limit=2"

200

inflow_total, inflow_top10, inflow_mean

{
  "status": {
    "code": 200,
    "message": "success"
  },
  "result": {
    "window": "day",
    "data": [
      {
        "date": "2019-10-02",
        "inflow_total": null,
        "inflow_top10": null,
        "inflow_mean": null
      },
      {
        "date": "2019-10-01",
        "inflow_total": null,
        "inflow_top10": null,
        "inflow_mean": null
      }
    ]
  }
}

Outflow

get

This endpoint returns the outflow of BTC into exchange wallets for as far back as we track. The average outflow is the average transaction value for transactions flowing into exchange wallets on a given day.

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

exchangestringRequired

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

Example: binance

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

outflow_total, outflow_top10, outflow_mean

application/json

get

/btc/exchange-flows/outflow

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/exchange-flows/outflow?exchange=binance&window=day&from=20191001&limit=2"

200

outflow_total, outflow_top10, outflow_mean

{
  "status": {
    "code": 200,
    "message": "success"
  },
  "result": {
    "window": "day",
    "data": [
      {
        "date": "2019-10-02",
        "outflow_total": null,
        "outflow_top10": null,
        "outflow_mean": null
      },
      {
        "date": "2019-10-01",
        "outflow_total": null,
        "outflow_top10": null,
        "outflow_mean": null
      }
    ]
  }
}

Transactions Count

get

This endpoint returns the number of transactions flowing in/out of Bitcoin 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

exchangestringRequired

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

Example: binance

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

transactions_count_inflow, transactions_count_outflow

application/json

get

/btc/exchange-flows/transactions-count

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/exchange-flows/transactions-count?exchange=binance&window=day&from=20191001&limit=2"

200

transactions_count_inflow, transactions_count_outflow

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

Addresses Count

get

This endpoint returns the number of addresses involved in inflow/outflow transactions.

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

exchangestringRequired

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

Example: binance

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

The number of addresses evoking inflow/outflow transactions to exchange wallets

application/json

get

/btc/exchange-flows/addresses-count

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/exchange-flows/addresses-count?exchange=binance&window=day&from=20191001&limit=2"

200

The number of addresses evoking inflow/outflow transactions to exchange wallets

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

In-House Flow

get

This endpoint returns the in-house flow of BTC within wallets of the same exchange for as far back as we track. The average in-house flow is the average transaction value for transactions flowing within wallets on a given day.

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

exchangestringRequired

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

Example: binance

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

flow_total, flow_mean, transactions_count_flow

application/json

get

/btc/exchange-flows/in-house-flow

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/exchange-flows/in-house-flow?exchange=binance&window=day&from=20191001&limit=2"

200

flow_total, flow_mean, transactions_count_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
      }
    ]
  }
}