# XRP Flow Indicator

This namespace contains endpoints to retrieve metrics related to XRP Flow Indicators.

## Exchange Inflow Value Distribution

> Exchange Inflow Value Distribution is a metric that shows the amount distribution of xrp tokens flowed into exchange wallets according to its value. <br>

```json
{"openapi":"3.0.0","info":{"title":"CryptoQuant Data API","version":"1.3.0"},"tags":[{"name":"XRP Flow Indicator","description":"This namespace contains endpoints to retrieve metrics related to XRP Flow Indicators."}],"servers":[{"url":"https://api.cryptoquant.com/v1/","description":"Default server"}],"security":[{"Access Token":[]}],"components":{"securitySchemes":{"Access Token":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"For each API request, include this HTTP header:\n`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.\nYou 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](https://cryptoquant.com/pricing) to Professional or Premium plan. You'll be able to see your access token on the [API tab](https://cryptoquant.com/settings/api) of your profile page after the subscription."}},"parameters":{"exchange":{"description":"An exchange from the table that we support. [See here](#tag/BTC-Exchange-Flows).","explode":false,"in":"query","name":"exchange","required":true,"schema":{"type":"string"},"style":"form"},"window_dbh":{"description":"Currently we support `day`, `hour`, and `block`.","explode":false,"in":"query","name":"window","schema":{"type":"string","default":"day"},"style":"form"},"from":{"description":"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.","explode":false,"in":"query","name":"from","required":false,"schema":{"YYYYMMDDTHHMMSS":{"type":"string"}},"style":"form"},"to":{"description":"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.","explode":false,"in":"query","name":"to","required":false,"schema":{"YYYYMMDDTHHMMSS":{"type":"string"}},"style":"form"},"limit":{"description":"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.","explode":false,"in":"query","name":"limit","required":false,"schema":{"type":"integer","default":100,"minimum":1,"maximum":100000},"style":"form"},"format":{"description":"A format type about return message type. Supported formats are json, csv.","explode":false,"in":"query","name":"format","required":false,"schema":{"type":"string","default":"json"},"style":"form"}},"responses":{"exchange-inflow-value-distribution":{"description":"exchange inflow's distribution band by the amount of the trasferred tokens(xrp) at once","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExchangeInflowValueDistributionResponse"}}}}},"schemas":{"ExchangeInflowValueDistributionResponse":{"type":"object","required":["status","result"],"properties":{"status":{"$ref":"#/components/schemas/Status"},"result":{"type":"object","required":["window","data"],"properties":{"window":{"$ref":"#/components/schemas/Window_DBH"},"data":{"type":"array","items":{"type":"object","required":["range_1000_below","range_1001_to_10000","range_10001_to_100000","range_100001_to_1000000","range_1000000_over"],"properties":{"blockheight":{"$ref":"#/components/schemas/Blockheight"},"date":{"$ref":"#/components/schemas/Date"},"datetime":{"$ref":"#/components/schemas/Datetime"},"range_1000_below":{"type":"decimal","description":"Exchange Inflow distribution value of which transferred xrp value is 1000 or less."},"range_1001_to_10000":{"type":"decimal","description":"Exchange Inflow distribution value of which transferred xrp value is more than 1000 or less than 10000."},"range_10001_to_100000":{"type":"decimal","description":"Exchange Inflow distribution value of which transferred xrp value is more than 10000 or less than 100000."},"range_100001_to_1000000":{"type":"decimal","description":"Exchange Inflow distribution value of which transferred xrp value is more than 1000 or less than 100000."},"range_1000000_over":{"type":"decimal","description":"Exchange Inflow distribution value of which transferred xrp value is 1000000 or more."}}}}}}}},"Status":{"type":"object","description":"The status object is return with most of requests and indicates if the request was successful. If it is not successful, error information is included.","properties":{"code":{"type":"integer","format":"int32","description":"HTTP status code"},"message":{"type":"string","description":"Text description of the error or success."}},"required":["code","message"]},"Window_DBH":{"type":"string","description":"The size of window. It can be day, hour, or block, and it depends on the user request."},"Blockheight":{"type":"string","description":"The height of the block. This optional field only appears when window=block is used."},"Date":{"type":"string","description":"The date in YYYY-DD-MM. This optional field only appears when window=day is used."},"Datetime":{"type":"string","description":"The date and time formatted as YYYY-MM-DD HH:MM:SS (UTC time). This field only appears when window=block is used."}}},"paths":{"/xrp/flow-indicator/exchange-inflow-value-distribution":{"get":{"tags":["XRP Flow Indicator"],"summary":"Exchange Inflow Value Distribution","description":"Exchange Inflow Value Distribution is a metric that shows the amount distribution of xrp tokens flowed into exchange wallets according to its value. \n","operationId":"getExchangeInflowValueDistribution","parameters":[{"$ref":"#/components/parameters/exchange"},{"$ref":"#/components/parameters/window_dbh"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"$ref":"#/components/responses/exchange-inflow-value-distribution"}}}}}}
```

## Exchange Outflow Value Distribution

> Exchange Outflow Value Distribution is a metric that shows the amount distribution of xrp tokens flowed out from exchange wallets according to its value. <br>

```json
{"openapi":"3.0.0","info":{"title":"CryptoQuant Data API","version":"1.3.0"},"tags":[{"name":"XRP Flow Indicator","description":"This namespace contains endpoints to retrieve metrics related to XRP Flow Indicators."}],"servers":[{"url":"https://api.cryptoquant.com/v1/","description":"Default server"}],"security":[{"Access Token":[]}],"components":{"securitySchemes":{"Access Token":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"For each API request, include this HTTP header:\n`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.\nYou 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](https://cryptoquant.com/pricing) to Professional or Premium plan. You'll be able to see your access token on the [API tab](https://cryptoquant.com/settings/api) of your profile page after the subscription."}},"parameters":{"exchange":{"description":"An exchange from the table that we support. [See here](#tag/BTC-Exchange-Flows).","explode":false,"in":"query","name":"exchange","required":true,"schema":{"type":"string"},"style":"form"},"window_dbh":{"description":"Currently we support `day`, `hour`, and `block`.","explode":false,"in":"query","name":"window","schema":{"type":"string","default":"day"},"style":"form"},"from":{"description":"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.","explode":false,"in":"query","name":"from","required":false,"schema":{"YYYYMMDDTHHMMSS":{"type":"string"}},"style":"form"},"to":{"description":"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.","explode":false,"in":"query","name":"to","required":false,"schema":{"YYYYMMDDTHHMMSS":{"type":"string"}},"style":"form"},"limit":{"description":"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.","explode":false,"in":"query","name":"limit","required":false,"schema":{"type":"integer","default":100,"minimum":1,"maximum":100000},"style":"form"},"format":{"description":"A format type about return message type. Supported formats are json, csv.","explode":false,"in":"query","name":"format","required":false,"schema":{"type":"string","default":"json"},"style":"form"}},"responses":{"exchange-outflow-value-distribution":{"description":"exchange outflow's distribution band by the amount of the trasferred tokens(xrp) at once","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExchangeOutflowValueDistributionResponse"}}}}},"schemas":{"ExchangeOutflowValueDistributionResponse":{"type":"object","required":["status","result"],"properties":{"status":{"$ref":"#/components/schemas/Status"},"result":{"type":"object","required":["window","data"],"properties":{"window":{"$ref":"#/components/schemas/Window_DBH"},"data":{"type":"array","items":{"type":"object","required":["range_1000_below","range_1001_to_10000","range_10001_to_100000","range_100001_to_1000000","range_1000000_over"],"properties":{"blockheight":{"$ref":"#/components/schemas/Blockheight"},"date":{"$ref":"#/components/schemas/Date"},"datetime":{"$ref":"#/components/schemas/Datetime"},"range_1000_below":{"type":"decimal","description":"Exchange Outflow distribution value of which transferred xrp value is 1000 or less."},"range_1001_to_10000":{"type":"decimal","description":"Exchange Outflow distribution value of which transferred xrp value is more than 1000 or less than 10000."},"range_10001_to_100000":{"type":"decimal","description":"Exchange Outflow distribution value of which transferred xrp value is more than 10000 or less than 100000."},"range_100001_to_1000000":{"type":"decimal","description":"Exchange Outflow distribution value of which transferred xrp value is more than 1000 or less than 100000."},"range_1000000_over":{"type":"decimal","description":"Exchange Outflow distribution value of which transferred xrp value is 1000000 or more."}}}}}}}},"Status":{"type":"object","description":"The status object is return with most of requests and indicates if the request was successful. If it is not successful, error information is included.","properties":{"code":{"type":"integer","format":"int32","description":"HTTP status code"},"message":{"type":"string","description":"Text description of the error or success."}},"required":["code","message"]},"Window_DBH":{"type":"string","description":"The size of window. It can be day, hour, or block, and it depends on the user request."},"Blockheight":{"type":"string","description":"The height of the block. This optional field only appears when window=block is used."},"Date":{"type":"string","description":"The date in YYYY-DD-MM. This optional field only appears when window=day is used."},"Datetime":{"type":"string","description":"The date and time formatted as YYYY-MM-DD HH:MM:SS (UTC time). This field only appears when window=block is used."}}},"paths":{"/xrp/flow-indicator/exchange-outflow-value-distribution":{"get":{"tags":["XRP Flow Indicator"],"summary":"Exchange Outflow Value Distribution","description":"Exchange Outflow Value Distribution is a metric that shows the amount distribution of xrp tokens flowed out from exchange wallets according to its value. \n","operationId":"getExchangeOutflowValueDistribution","parameters":[{"$ref":"#/components/parameters/exchange"},{"$ref":"#/components/parameters/window_dbh"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"$ref":"#/components/responses/exchange-outflow-value-distribution"}}}}}}
```

## Exchange Inflow Count Value Distribution

> Exchange Inflow Count Value Distribution is a metric that shows the number of transactions of xrp tokens flowed into exchange wallets according to its value segment. <br>

```json
{"openapi":"3.0.0","info":{"title":"CryptoQuant Data API","version":"1.3.0"},"tags":[{"name":"XRP Flow Indicator","description":"This namespace contains endpoints to retrieve metrics related to XRP Flow Indicators."}],"servers":[{"url":"https://api.cryptoquant.com/v1/","description":"Default server"}],"security":[{"Access Token":[]}],"components":{"securitySchemes":{"Access Token":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"For each API request, include this HTTP header:\n`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.\nYou 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](https://cryptoquant.com/pricing) to Professional or Premium plan. You'll be able to see your access token on the [API tab](https://cryptoquant.com/settings/api) of your profile page after the subscription."}},"parameters":{"exchange":{"description":"An exchange from the table that we support. [See here](#tag/BTC-Exchange-Flows).","explode":false,"in":"query","name":"exchange","required":true,"schema":{"type":"string"},"style":"form"},"window_dbh":{"description":"Currently we support `day`, `hour`, and `block`.","explode":false,"in":"query","name":"window","schema":{"type":"string","default":"day"},"style":"form"},"from":{"description":"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.","explode":false,"in":"query","name":"from","required":false,"schema":{"YYYYMMDDTHHMMSS":{"type":"string"}},"style":"form"},"to":{"description":"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.","explode":false,"in":"query","name":"to","required":false,"schema":{"YYYYMMDDTHHMMSS":{"type":"string"}},"style":"form"},"limit":{"description":"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.","explode":false,"in":"query","name":"limit","required":false,"schema":{"type":"integer","default":100,"minimum":1,"maximum":100000},"style":"form"},"format":{"description":"A format type about return message type. Supported formats are json, csv.","explode":false,"in":"query","name":"format","required":false,"schema":{"type":"string","default":"json"},"style":"form"}},"responses":{"exchange-inflow-count-value-distribution":{"description":"number of transactions of each exchange inflow's distribution band by the amount of the trasferred tokens(xrp) at once","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExchangeInflowCountValueDistributionResponse"}}}}},"schemas":{"ExchangeInflowCountValueDistributionResponse":{"type":"object","required":["status","result"],"properties":{"status":{"$ref":"#/components/schemas/Status"},"result":{"type":"object","required":["window","data"],"properties":{"window":{"$ref":"#/components/schemas/Window_DBH"},"data":{"type":"array","items":{"type":"object","required":["range_1000_below","range_1001_to_10000","range_10001_to_100000","range_100001_to_1000000","range_1000000_over"],"properties":{"blockheight":{"$ref":"#/components/schemas/Blockheight"},"date":{"$ref":"#/components/schemas/Date"},"datetime":{"$ref":"#/components/schemas/Datetime"},"range_1000_below":{"type":"decimal","description":"Number of transactions of exchange inflow's value band of which transferred xrp value is 1000 or less."},"range_1001_to_10000":{"type":"decimal","description":"Number of transactions of exchange inflow's value band of which transferred xrp value is more than 1000 or less than 10000."},"range_10001_to_100000":{"type":"decimal","description":"Number of transactions of exchange inflow's value band of which transferred xrp value is more than 10000 or less than 100000."},"range_100001_to_1000000":{"type":"decimal","description":"Number of transactions of exchange inflow's value band of which transferred xrp value is more than 1000 or less than 100000."},"range_1000000_over":{"type":"decimal","description":"Number of transactions of exchange inflow's value band of which transferred xrp value is 1000000 or more."}}}}}}}},"Status":{"type":"object","description":"The status object is return with most of requests and indicates if the request was successful. If it is not successful, error information is included.","properties":{"code":{"type":"integer","format":"int32","description":"HTTP status code"},"message":{"type":"string","description":"Text description of the error or success."}},"required":["code","message"]},"Window_DBH":{"type":"string","description":"The size of window. It can be day, hour, or block, and it depends on the user request."},"Blockheight":{"type":"string","description":"The height of the block. This optional field only appears when window=block is used."},"Date":{"type":"string","description":"The date in YYYY-DD-MM. This optional field only appears when window=day is used."},"Datetime":{"type":"string","description":"The date and time formatted as YYYY-MM-DD HH:MM:SS (UTC time). This field only appears when window=block is used."}}},"paths":{"/xrp/flow-indicator/exchange-inflow-count-value-distribution":{"get":{"tags":["XRP Flow Indicator"],"summary":"Exchange Inflow Count Value Distribution","description":"Exchange Inflow Count Value Distribution is a metric that shows the number of transactions of xrp tokens flowed into exchange wallets according to its value segment. \n","operationId":"getExchangeInflowCountValueDistribution","parameters":[{"$ref":"#/components/parameters/exchange"},{"$ref":"#/components/parameters/window_dbh"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"$ref":"#/components/responses/exchange-inflow-count-value-distribution"}}}}}}
```

## Exchange Outflow Count Value Distribution

> Exchange Outflow Count Value Distribution is a metric that shows the number of transactions of xrp tokens flowed into exchange wallets according to its value segment. <br>

```json
{"openapi":"3.0.0","info":{"title":"CryptoQuant Data API","version":"1.3.0"},"tags":[{"name":"XRP Flow Indicator","description":"This namespace contains endpoints to retrieve metrics related to XRP Flow Indicators."}],"servers":[{"url":"https://api.cryptoquant.com/v1/","description":"Default server"}],"security":[{"Access Token":[]}],"components":{"securitySchemes":{"Access Token":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"For each API request, include this HTTP header:\n`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.\nYou 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](https://cryptoquant.com/pricing) to Professional or Premium plan. You'll be able to see your access token on the [API tab](https://cryptoquant.com/settings/api) of your profile page after the subscription."}},"parameters":{"exchange":{"description":"An exchange from the table that we support. [See here](#tag/BTC-Exchange-Flows).","explode":false,"in":"query","name":"exchange","required":true,"schema":{"type":"string"},"style":"form"},"window_dbh":{"description":"Currently we support `day`, `hour`, and `block`.","explode":false,"in":"query","name":"window","schema":{"type":"string","default":"day"},"style":"form"},"from":{"description":"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.","explode":false,"in":"query","name":"from","required":false,"schema":{"YYYYMMDDTHHMMSS":{"type":"string"}},"style":"form"},"to":{"description":"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.","explode":false,"in":"query","name":"to","required":false,"schema":{"YYYYMMDDTHHMMSS":{"type":"string"}},"style":"form"},"limit":{"description":"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.","explode":false,"in":"query","name":"limit","required":false,"schema":{"type":"integer","default":100,"minimum":1,"maximum":100000},"style":"form"},"format":{"description":"A format type about return message type. Supported formats are json, csv.","explode":false,"in":"query","name":"format","required":false,"schema":{"type":"string","default":"json"},"style":"form"}},"responses":{"exchange-outflow-count-value-distribution":{"description":"number of transactions of each exchange outflow's distribution band by the amount of the trasferred tokens(xrp) at once","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExchangeOutflowCountValueDistributionResponse"}}}}},"schemas":{"ExchangeOutflowCountValueDistributionResponse":{"type":"object","required":["status","result"],"properties":{"status":{"$ref":"#/components/schemas/Status"},"result":{"type":"object","required":["window","data"],"properties":{"window":{"$ref":"#/components/schemas/Window_DBH"},"data":{"type":"array","items":{"type":"object","required":["range_1000_below","range_1001_to_10000","range_10001_to_100000","range_100001_to_1000000","range_1000000_over"],"properties":{"blockheight":{"$ref":"#/components/schemas/Blockheight"},"date":{"$ref":"#/components/schemas/Date"},"datetime":{"$ref":"#/components/schemas/Datetime"},"range_1000_below":{"type":"decimal","description":"Number of transactions of exchange outflow's value band of which transferred xrp value is 1000 or less."},"range_1001_to_10000":{"type":"decimal","description":"Number of transactions of exchange outflow's value band of which transferred xrp value is more than 1000 or less than 10000."},"range_10001_to_100000":{"type":"decimal","description":"Number of transactions of exchange outflow's value band of which transferred xrp value is more than 10000 or less than 100000."},"range_100001_to_1000000":{"type":"decimal","description":"Number of transactions of exchange outflow's value band of which transferred xrp value is more than 1000 or less than 100000."},"range_1000000_over":{"type":"decimal","description":"Number of transactions of exchange outflow's value band of which transferred xrp value is 1000000 or more."}}}}}}}},"Status":{"type":"object","description":"The status object is return with most of requests and indicates if the request was successful. If it is not successful, error information is included.","properties":{"code":{"type":"integer","format":"int32","description":"HTTP status code"},"message":{"type":"string","description":"Text description of the error or success."}},"required":["code","message"]},"Window_DBH":{"type":"string","description":"The size of window. It can be day, hour, or block, and it depends on the user request."},"Blockheight":{"type":"string","description":"The height of the block. This optional field only appears when window=block is used."},"Date":{"type":"string","description":"The date in YYYY-DD-MM. This optional field only appears when window=day is used."},"Datetime":{"type":"string","description":"The date and time formatted as YYYY-MM-DD HH:MM:SS (UTC time). This field only appears when window=block is used."}}},"paths":{"/xrp/flow-indicator/exchange-outflow-count-value-distribution":{"get":{"tags":["XRP Flow Indicator"],"summary":"Exchange Outflow Count Value Distribution","description":"Exchange Outflow Count Value Distribution is a metric that shows the number of transactions of xrp tokens flowed into exchange wallets according to its value segment. \n","operationId":"getExchangeOutflowCountValueDistribution","parameters":[{"$ref":"#/components/parameters/exchange"},{"$ref":"#/components/parameters/window_dbh"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"$ref":"#/components/responses/exchange-outflow-count-value-distribution"}}}}}}
```

## Exchange Supply Ratio

> The ratio of exchange's xrp reserve compared to total supply of xrp.<br>

```json
{"openapi":"3.0.0","info":{"title":"CryptoQuant Data API","version":"1.3.0"},"tags":[{"name":"XRP Flow Indicator","description":"This namespace contains endpoints to retrieve metrics related to XRP Flow Indicators."}],"servers":[{"url":"https://api.cryptoquant.com/v1/","description":"Default server"}],"security":[{"Access Token":[]}],"components":{"securitySchemes":{"Access Token":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"For each API request, include this HTTP header:\n`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.\nYou 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](https://cryptoquant.com/pricing) to Professional or Premium plan. You'll be able to see your access token on the [API tab](https://cryptoquant.com/settings/api) of your profile page after the subscription."}},"parameters":{"exchange":{"description":"An exchange from the table that we support. [See here](#tag/BTC-Exchange-Flows).","explode":false,"in":"query","name":"exchange","required":true,"schema":{"type":"string"},"style":"form"},"window_dh":{"description":"Currently, we support `day` and `hour`.","explode":false,"in":"query","name":"window","schema":{"type":"string","default":"day"},"style":"form"},"from":{"description":"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.","explode":false,"in":"query","name":"from","required":false,"schema":{"YYYYMMDDTHHMMSS":{"type":"string"}},"style":"form"},"to":{"description":"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.","explode":false,"in":"query","name":"to","required":false,"schema":{"YYYYMMDDTHHMMSS":{"type":"string"}},"style":"form"},"limit":{"description":"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.","explode":false,"in":"query","name":"limit","required":false,"schema":{"type":"integer","default":100,"minimum":1,"maximum":100000},"style":"form"},"format":{"description":"A format type about return message type. Supported formats are json, csv.","explode":false,"in":"query","name":"format","required":false,"schema":{"type":"string","default":"json"},"style":"form"}},"responses":{"responses_exchange-supply-ratio-2":{"description":"exchange supply ratio","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas_ExchangeSupplyRatioResponse-2"}}}}},"schemas":{"schemas_ExchangeSupplyRatioResponse-2":{"type":"object","required":["status","result"],"properties":{"status":{"$ref":"#/components/schemas/Status"},"result":{"type":"object","required":["window","data"],"properties":{"window":{"$ref":"#/components/schemas/Window_DH"},"data":{"type":"array","items":{"type":"object","required":["exchange_supply_ratio"],"properties":{"date":{"$ref":"#/components/schemas/Date"},"datetime":{"$ref":"#/components/schemas/Datetime"},"exchange_supply_ratio":{"type":"decimal","description":"exchange supply ratio"}}}}}}}},"Status":{"type":"object","description":"The status object is return with most of requests and indicates if the request was successful. If it is not successful, error information is included.","properties":{"code":{"type":"integer","format":"int32","description":"HTTP status code"},"message":{"type":"string","description":"Text description of the error or success."}},"required":["code","message"]},"Window_DH":{"type":"string","description":"The size of window. It can be day or hour, and it depends on the user request."},"Date":{"type":"string","description":"The date in YYYY-DD-MM. This optional field only appears when window=day is used."},"Datetime":{"type":"string","description":"The date and time formatted as YYYY-MM-DD HH:MM:SS (UTC time). This field only appears when window=block is used."}}},"paths":{"/xrp/flow-indicator/exchange-supply-ratio":{"get":{"tags":["XRP Flow Indicator"],"summary":"Exchange Supply Ratio","description":"The ratio of exchange's xrp reserve compared to total supply of xrp.\n","operationId":"getExchangeToExchange","parameters":[{"$ref":"#/components/parameters/exchange"},{"$ref":"#/components/parameters/window_dh"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"$ref":"#/components/responses/responses_exchange-supply-ratio-2"}}}}}}
```
