# XRP Market Data

This namespace contains endpoints to retrieve metrics related to XRP Market Data.

## Price OHLCV

> This endpoint returns metrics related to XRP's Price.\
> Price OHLCV data consists of five metrics. \
> \`open\`, the opening price at the beginning of the window, \`close\`, USD closing price at the end of the window, \
> \`high\`, the highest USD price in a given window, \`low\`, the lowest USD price in a given window,\
> and \`volume\`, the total token volume traded in 24h.\
> \
> \
> \### Supported Exchanges By Market\
> \
> \| Name | Market  |    Supported Exchanges     |\
> \|--------|---------|----------------------------|\
> \| Spot   | \`spot\`  | All Exchange\*, Binance, Binance US, Bitfinex, Kucoin, Coinbase Advanced, Kraken, HTX Global |\
> \| Perpetual   | \`perpetual\`  | All Exchange\*, Binance, Deribit, Bitmex, OKX |\
> \
> \> (\*) Default exchange \<br>\
> \
> \### Supported Pairs By Exchange\
> \
> \#### ◦ Spot\
> \
> \| Name           |   Exchange     | Symbol |\
> \|----------------|--------------|----|\
> \| All Exchanges  |   \`all\_exchange\` | \`xrp\_usd\`\* |\
> \| Binance        |   \`binance\`  | \`xrp\_usdt\`\* \<br/> \`xrp\_fdusd\`\<br/> \`xrp\_btc\`\<br/> \`xrp\_eth\`\<br/> \`xrp\_bnb\`\<br/> \`xrp\_rub\`\<br/> \`xrp\_tusd\`|\
> \| Binance US            |   \`binance\_us\`     | \`xrp\_usdt\`\* |\
> \| Coinbase Advanced          |   \`coinbase\_advanced\`    | \`xrp\_eur\`\<br/> \`xrp\_usdt\`\<br/> \`xrp\_usd\`\* |\
> \| Bitfinex         |   \`bitfinex\`   | \`xrp\_usdt\`\<br/> \`xrp\_btc\`\<br/> \`xrp\_usd\`\* |\
> \| HTX Global   |   \`htx\_global\` | \`xrp\_usdt\`\*  |\
> \| Kucoin            |   \`kucoin\`     | \`xrp\_usdc\`\<br/> \`xrp\_tusd\`\<br/> \`xrp\_btc\`\<br/> \`xrp\_eth\`\<br/> \`xrp\_usdt\`\* |\
> \| Kraken            |   \`kraken\`     | \`xrp\_usdt\`\<br/> \`xrp\_eur\`\<br/> \`xrp\_aud\`\<br/> \`xrp\_eth\`\<br/> \`xrp\_btc\`\<br/> \`xrp\_usd\`\* |\
> \
> \#### ◦ Perpetual\
> \
> \| Name           |   Exchange     | Symbol |\
> \|----------------|--------------|----|\
> \| All Exchanges  |   \`all\_exchange\` | \`xrp\_usd\`\* \<br/> \`xrp\_usdt\`|\
> \| Binance        |   \`binance\`  | \`xrp\_usd\`\*|\
> \| Deribit         |   \`deribit\`   | \`xrp\_usdc\`\* |\
> \| Okx         |   \`okx\`   | \`xrp\_usdt\`\* |\
> \| Bitmex            |   \`bitmex\`     | \`xrp\_usdt\`\<br/> \`xrp\_usd\`\* |\
> \
> \### Supported Windows By Market\
> \
> \|   Market  |   Supported Windows           |\
> \|-----------|-------------------------------|\
> \| Spot      | \`min\`, \`hour\`, \`day\*\`         |\
> \| Perpetual | \`min\`, \`hour\`, \`day\*\`         |

```json
{"openapi":"3.0.0","info":{"title":"CryptoQuant Data API","version":"1.3.0"},"tags":[{"name":"XRP Market Data","description":"This namespace contains endpoints to retrieve metrics related to XRP Market Data."}],"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":{"market_xrp":{"description":"A market type from the table that we support. [See here](#operation/getPriceOHLCVXRP)","explode":false,"in":"query","name":"market","required":false,"schema":{"type":"string","default":"spot"},"style":"form"},"xrp_exchange_ohlcv":{"description":"A exchange from the table that we support. [See here](#operation/getPriceOHLCVXRP).","explode":false,"in":"query","name":"exchange","required":false,"schema":{"type":"string","default":"all_exchange"},"style":"form"},"symbol_xrp_ohlcv":{"description":"A XRP pair symbol from the table that we support. [See here](#operation/getPriceOHLCVXRP)","explode":false,"in":"query","name":"symbol","required":false,"schema":{"type":"string"},"style":"form"},"window_mhd":{"description":"Currently we support `day`, `hour`, and `min`.","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_PriceOHLCV":{"description":"Price OHLCV Data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceOHLCVSCResponse"}}}}},"schemas":{"PriceOHLCVSCResponse":{"type":"object","required":["status","result"],"properties":{"status":{"$ref":"#/components/schemas/Status"},"result":{"type":"object","required":["window","data"],"properties":{"window":{"$ref":"#/components/schemas/Window_MDHB"},"data":{"type":"array","items":{"type":"object","required":["open","high","low","close","volume"],"properties":{"date":{"$ref":"#/components/schemas/Date"},"blockheight":{"$ref":"#/components/schemas/Blockheight"},"datetime":{"type":"string","description":"The date and time formatted as YYYY-MM-DDTHH:MM:SS (UTC time). This field only appears when window=block or window=min is used."},"open":{"type":"decimal","description":"opening price at the beginning of the window."},"high":{"type":"decimal","description":"opening price at the end of the window."},"low":{"type":"decimal","description":"The highest price in a given window."},"close":{"type":"decimal","description":"The lowest price in a given window."},"volume":{"type":"decimal","description":"The total traded amount in a given window."}}}}}}}},"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_MDHB":{"type":"string","description":"The size of window. It can be day, hour, min, or block 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."},"Blockheight":{"type":"string","description":"The height of the block. This optional field only appears when window=block is used."}}},"paths":{"/xrp/market-data/price-ohlcv":{"get":{"tags":["XRP Market Data"],"summary":"Price OHLCV","description":"This endpoint returns metrics related to XRP's Price.\nPrice OHLCV data consists of five metrics. \n`open`, the opening price at the beginning of the window, `close`, USD closing price at the end of the window, \n`high`, the highest USD price in a given window, `low`, the lowest USD price in a given window,\nand `volume`, the total token volume traded in 24h.\n\n\n### Supported Exchanges By Market\n\n| Name | Market  |    Supported Exchanges     |\n|--------|---------|----------------------------|\n| Spot   | `spot`  | All Exchange*, Binance, Binance US, Bitfinex, Kucoin, Coinbase Advanced, Kraken, HTX Global |\n| Perpetual   | `perpetual`  | All Exchange*, Binance, Deribit, Bitmex, OKX |\n\n> (*) Default exchange <br>\n\n### Supported Pairs By Exchange\n\n#### ◦ Spot\n\n| Name           |   Exchange     | Symbol |\n|----------------|--------------|----|\n| All Exchanges  |   `all_exchange` | `xrp_usd`* |\n| Binance        |   `binance`  | `xrp_usdt`* <br/> `xrp_fdusd`<br/> `xrp_btc`<br/> `xrp_eth`<br/> `xrp_bnb`<br/> `xrp_rub`<br/> `xrp_tusd`|\n| Binance US            |   `binance_us`     | `xrp_usdt`* |\n| Coinbase Advanced          |   `coinbase_advanced`    | `xrp_eur`<br/> `xrp_usdt`<br/> `xrp_usd`* |\n| Bitfinex         |   `bitfinex`   | `xrp_usdt`<br/> `xrp_btc`<br/> `xrp_usd`* |\n| HTX Global   |   `htx_global` | `xrp_usdt`*  |\n| Kucoin            |   `kucoin`     | `xrp_usdc`<br/> `xrp_tusd`<br/> `xrp_btc`<br/> `xrp_eth`<br/> `xrp_usdt`* |\n| Kraken            |   `kraken`     | `xrp_usdt`<br/> `xrp_eur`<br/> `xrp_aud`<br/> `xrp_eth`<br/> `xrp_btc`<br/> `xrp_usd`* |\n\n#### ◦ Perpetual\n\n| Name           |   Exchange     | Symbol |\n|----------------|--------------|----|\n| All Exchanges  |   `all_exchange` | `xrp_usd`* <br/> `xrp_usdt`|\n| Binance        |   `binance`  | `xrp_usd`*|\n| Deribit         |   `deribit`   | `xrp_usdc`* |\n| Okx         |   `okx`   | `xrp_usdt`* |\n| Bitmex            |   `bitmex`     | `xrp_usdt`<br/> `xrp_usd`* |\n\n### Supported Windows By Market\n\n|   Market  |   Supported Windows           |\n|-----------|-------------------------------|\n| Spot      | `min`, `hour`, `day*`         |\n| Perpetual | `min`, `hour`, `day*`         |","operationId":"getPriceOHLCVXRP","parameters":[{"$ref":"#/components/parameters/market_xrp"},{"$ref":"#/components/parameters/xrp_exchange_ohlcv"},{"$ref":"#/components/parameters/symbol_xrp_ohlcv"},{"$ref":"#/components/parameters/window_mhd"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"$ref":"#/components/responses/responses_PriceOHLCV"}}}}}}
```

## Open Interest

> This endpoint returns XRP Perpetual Open Interest from derivative exchanges. \
> \| Name           |   Exchange     | Symbol |\
> \|----------------|--------------|----|\
> \| All Exchanges  |   \`all\_exchange\` | \`all\_symbol\`\* |\
> \| Binance        |   \`binance\`  | \`xrp\_usdt\`\<br/>\`xrp\_usd\`\<br/> \`all\_symbol\`\*|\
> \| Bybit          |   \`bybit\`    | \`xrp\_usdt\`\<br/>\`xrp\_usd\`\<br/> \`all\_symbol\`\*| \
> \| Bitmex         |   \`bitmex\`   | \`xrp\_usd\`\* | \
> \| HTX Global   |   \`htx\_global\` | \`xrp\_usdt\`\*  |\
> \| Kraken         |   \`kraken\`   | \`xrp\_usd\`\* |  \
> \| OKX            |   \`okx\`     | \`xrp\_usdt\`\<br/>\`xrp\_usd\`\<br/> \`all\_symbol\`\* | \
> \| Bitfinex            |   \`bitfinex\`     | \`xrp\_usdt\`\* | \
> \
> Supported exchanges for Open Interest are available in Discovery section.\
> Note we unify the unit of return value to USD for each exchange where its contract specification may vary.

```json
{"openapi":"3.0.0","info":{"title":"CryptoQuant Data API","version":"1.3.0"},"tags":[{"name":"XRP Market Data","description":"This namespace contains endpoints to retrieve metrics related to XRP Market Data."}],"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"},"symbol_xrp_oi":{"description":"A pair symbol (ticker) from the table that we support. [See here](#tag/XRPgetOpenInterest)","explode":false,"in":"query","name":"symbol","required":false,"schema":{"type":"string","default":"all_symbol"},"style":"form"},"window_mhd":{"description":"Currently we support `day`, `hour`, and `min`.","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":{"OpenInterest":{"description":"Open Interest in USD","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenInterestResponse"}}}}},"schemas":{"OpenInterestResponse":{"type":"object","required":["status","result"],"properties":{"status":{"$ref":"#/components/schemas/Status"},"result":{"type":"object","required":["window","data"],"properties":{"window":{"$ref":"#/components/schemas/Window_MDH"},"data":{"type":"array","items":{"type":"object","required":["open_interest"],"properties":{"date":{"$ref":"#/components/schemas/Date"},"datetime":{"$ref":"#/components/schemas/Datetime"},"open_interest":{"type":"string","description":"The amount of open interest in the given period and exchange. The standard unit can differ from each exchange."}}}}}}}},"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_MDH":{"type":"string","description":"The size of window. It can be day, hour, or min 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/market-data/open-interest":{"get":{"tags":["XRP Market Data"],"summary":"Open Interest","description":"This endpoint returns XRP Perpetual Open Interest from derivative exchanges. \n| Name           |   Exchange     | Symbol |\n|----------------|--------------|----|\n| All Exchanges  |   `all_exchange` | `all_symbol`* |\n| Binance        |   `binance`  | `xrp_usdt`<br/>`xrp_usd`<br/> `all_symbol`*|\n| Bybit          |   `bybit`    | `xrp_usdt`<br/>`xrp_usd`<br/> `all_symbol`*| \n| Bitmex         |   `bitmex`   | `xrp_usd`* | \n| HTX Global   |   `htx_global` | `xrp_usdt`*  |\n| Kraken         |   `kraken`   | `xrp_usd`* |  \n| OKX            |   `okx`     | `xrp_usdt`<br/>`xrp_usd`<br/> `all_symbol`* | \n| Bitfinex            |   `bitfinex`     | `xrp_usdt`* | \n\nSupported exchanges for Open Interest are available in Discovery section.\nNote we unify the unit of return value to USD for each exchange where its contract specification may vary.","operationId":"XRPgetOpenInterest","parameters":[{"$ref":"#/components/parameters/exchange"},{"$ref":"#/components/parameters/symbol_xrp_oi"},{"$ref":"#/components/parameters/window_mhd"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"$ref":"#/components/responses/OpenInterest"}}}}}}
```

## Funding Rates

> Funding rates represents traders' sentiments of which position they bet on in perpetual swaps market. Positive funding rates implies that many traders are bullish and long traders pay funding to short traders. Negative funding rates implies many traders are bearish and short traders pay funding to long traders.\
> \| Name           |   Exchange     | Symbol |\
> \|----------------|--------------|----|\
> \| All Exchanges  |   \`all\_exchange\` |\`all\_symbol\`\*|\
> \| Binance        |   \`binance\`  | \`xrp\_usdt\`\<br/>\`xrp\_usd\`\<br/>\`all\_symbol\`\* |\
> \| Bybit          |   \`bybit\`    | \`xrp\_usdt\`\<br/>\`xrp\_usd\`\<br/>\`all\_symbol\`\* | \
> \| Bitmex         |   \`bitmex\`   | \`xrp\_usd\`\* | \
> \| HTX Global   |   \`htx\_global\` | \`xrp\_usd\`\* | \
> \| OKX            |   \`okx\`     | \`xrp\_usdt\`\<br/>\`xrp\_usd\`\<br/>\`all\_symbol\`\* |

```json
{"openapi":"3.0.0","info":{"title":"CryptoQuant Data API","version":"1.3.0"},"tags":[{"name":"XRP Market Data","description":"This namespace contains endpoints to retrieve metrics related to XRP Market Data."}],"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"},"symbol_xrp_fr":{"description":"A pair symbol (ticker) from the table that we support. [See here](#tag/XRPgetFundingRates)","explode":false,"in":"query","name":"symbol","required":false,"schema":{"type":"string","default":"all_symbol"},"style":"form"},"window_mhd":{"description":"Currently we support `day`, `hour`, and `min`.","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":{"FundingRates":{"description":"Funding Rates in percentage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundingRatesResponse"}}}}},"schemas":{"FundingRatesResponse":{"type":"object","required":["status","result"],"properties":{"status":{"$ref":"#/components/schemas/Status"},"result":{"type":"object","required":["window","data"],"properties":{"window":{"$ref":"#/components/schemas/Window_MDH"},"data":{"type":"array","items":{"type":"object","required":["funding_rates"],"properties":{"date":{"$ref":"#/components/schemas/Date"},"datetime":{"$ref":"#/components/schemas/Datetime"},"funding_rates":{"type":"decimal","description":"Funding rates in the given period and exchange. The standard unit is percentage."}}}}}}}},"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_MDH":{"type":"string","description":"The size of window. It can be day, hour, or min 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/market-data/funding-rates":{"get":{"tags":["XRP Market Data"],"summary":"Funding Rates","description":"Funding rates represents traders' sentiments of which position they bet on in perpetual swaps market. Positive funding rates implies that many traders are bullish and long traders pay funding to short traders. Negative funding rates implies many traders are bearish and short traders pay funding to long traders.\n| Name           |   Exchange     | Symbol |\n|----------------|--------------|----|\n| All Exchanges  |   `all_exchange` |`all_symbol`*|\n| Binance        |   `binance`  | `xrp_usdt`<br/>`xrp_usd`<br/>`all_symbol`* |\n| Bybit          |   `bybit`    | `xrp_usdt`<br/>`xrp_usd`<br/>`all_symbol`* | \n| Bitmex         |   `bitmex`   | `xrp_usd`* | \n| HTX Global   |   `htx_global` | `xrp_usd`* | \n| OKX            |   `okx`     | `xrp_usdt`<br/>`xrp_usd`<br/>`all_symbol`* |","operationId":"XRPgetFundingRates","parameters":[{"$ref":"#/components/parameters/exchange"},{"$ref":"#/components/parameters/symbol_xrp_fr"},{"$ref":"#/components/parameters/window_mhd"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"$ref":"#/components/responses/FundingRates"}}}}}}
```

## Taker Buy Sell Stats

> Taker Buy/Sell Stats represent takers' sentiment of which position they are taking in the market. This metric is calculated with perpetual swap trades in each exchange.\
> \`taker\_buy\_volume\` is volume that takers buy.\
> \`taker\_sell\_volume\` is volume that takers sell.\
> \`taker\_total\_volume\` is the sum of \`taker\_buy\_volume\` and \`taker\_sell\_volume\`.\
> \`taker\_buy\_ratio\` is the ratio of \`taker\_buy\_volume\` divided by \`taker\_total\_volume\`.\
> \`taker\_sell\_ratio\` is the ratio of \`taker\_sell\_volume\` divided by \`taker\_total\_volume\`.\
> \`taker\_buy\_sell\_ratio\` is the ratio of \`taker\_buy\_volume\` divided by \`taker\_sell\_volume\`.\
> Note we unify the unit of return value to USD for each exchange where its contract specification may vary.\
> \| Name           |   Exchange     | Symbol |\
> \|----------------|--------------|----|\
> \| All Exchanges  |   \`all\_exchange\` | \`all\_symbol\`\* |\
> \| Binance        |   \`binance\`  | \`xrp\_usdt\`\*  |\
> \| Bybit          |   \`bybit\`    | \`xrp\_usd\`\* | \
> \| Bitmex         |   \`bitmex\`   | \`xrp\_usd\`\* | \
> \| HTX Global   |   \`htx\_global\` | \`xrp\_usd\`\*  | \
> \| OKX            |   \`okx\`     | \`xrp\_usd\`\* |

```json
{"openapi":"3.0.0","info":{"title":"CryptoQuant Data API","version":"1.3.0"},"tags":[{"name":"XRP Market Data","description":"This namespace contains endpoints to retrieve metrics related to XRP Market Data."}],"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_mhd":{"description":"Currently we support `day`, `hour`, and `min`.","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":{"TakerBuySellStats":{"description":"Taker Buy, Sell volume and ratio","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TakerBuySellStatsResponse"}}}}},"schemas":{"TakerBuySellStatsResponse":{"type":"object","required":["status","result"],"properties":{"status":{"$ref":"#/components/schemas/Status"},"result":{"type":"object","required":["window","data"],"properties":{"window":{"$ref":"#/components/schemas/Window_MDH"},"data":{"type":"array","items":{"type":"object","required":["taker_buy_volume","taker_sell_volume","taker_buy_ratio","taker_sell_ratio","taker_buy_sell_ratio"],"properties":{"date":{"$ref":"#/components/schemas/Date"},"datetime":{"$ref":"#/components/schemas/Datetime"},"taker_buy_volume":{"type":"decimal","description":"Volume that takers buy in the given period and exchange."},"taker_sell_volume":{"type":"decimal","description":"Volume that takers sell in the given period and exchange."},"taker_buy_ratio":{"type":"decimal","description":"The ratio of taker buy volume to taker total volume in the given period and exchange. Taker total volume is sum of taker buy and sell volume."},"taker_sell_ratio":{"type":"decimal","description":"The ratio of taker sell volume to taker total volume in the given period and exchange. Taker total volume is sum of taker buy and sell volume."},"taker_buy_sell_ratio":{"type":"decimal","description":"The ratio fo taker buy volume to taker sell volume in the given period and exchange."}}}}}}}},"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_MDH":{"type":"string","description":"The size of window. It can be day, hour, or min 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/market-data/taker-buy-sell-stats":{"get":{"tags":["XRP Market Data"],"summary":"Taker Buy Sell Stats","description":"Taker Buy/Sell Stats represent takers' sentiment of which position they are taking in the market. This metric is calculated with perpetual swap trades in each exchange.\n`taker_buy_volume` is volume that takers buy.\n`taker_sell_volume` is volume that takers sell.\n`taker_total_volume` is the sum of `taker_buy_volume` and `taker_sell_volume`.\n`taker_buy_ratio` is the ratio of `taker_buy_volume` divided by `taker_total_volume`.\n`taker_sell_ratio` is the ratio of `taker_sell_volume` divided by `taker_total_volume`.\n`taker_buy_sell_ratio` is the ratio of `taker_buy_volume` divided by `taker_sell_volume`.\nNote we unify the unit of return value to USD for each exchange where its contract specification may vary.\n| Name           |   Exchange     | Symbol |\n|----------------|--------------|----|\n| All Exchanges  |   `all_exchange` | `all_symbol`* |\n| Binance        |   `binance`  | `xrp_usdt`*  |\n| Bybit          |   `bybit`    | `xrp_usd`* | \n| Bitmex         |   `bitmex`   | `xrp_usd`* | \n| HTX Global   |   `htx_global` | `xrp_usd`*  | \n| OKX            |   `okx`     | `xrp_usd`* |","operationId":"XRPgetTakerBuySellStats","parameters":[{"$ref":"#/components/parameters/exchange"},{"$ref":"#/components/parameters/window_mhd"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"$ref":"#/components/responses/TakerBuySellStats"}}}}}}
```

## Liquidations

> Liquidations are sum of forced market orders to exit leveraged positions caused by price volatility. Liquidations indicate current price volatility and traders' sentiment which side they had been betting.\
> Note that Binance's liquidation data collection policy has changed since \[2021-04-27]\(<https://binance-docs.github.io/apidocs/futures/en/#change-log>), which makes the distribution of the data has changed after that.\
> \| Name           |   Exchange     | Symbol |\
> \|----------------|--------------|----|\
> \| All Exchanges  |   \`all\_exchange\` |\`all\_symbol\`\* |\
> \| Binance        |   \`binance\`  | \`xrp\_usdt\`\<br/> \`xrp\_usd\`\<br/> \`all\_symbol\`\* |\
> \| Bybit          |   \`bybit\`    | \`xrp\_usdt\`\<br/> \`xrp\_usd\`\<br/> \`all\_symbol\`\*| \
> \| Bitmex         |   \`bitmex\`   | \`xrp\_usd\`\* | \
> \| HTX Global   |   \`htx\_global\` | \`xrp\_usdt\`\*| \
> \| OKX            |   \`okx\`     | \`xrp\_usdt\`\<br/> \`xrp\_usd\`\<br/> \`all\_symbol\`\*| \
> \| Bitfinex            |   \`bitfinex\`     | \`xrp\_usdt\`\* |

```json
{"openapi":"3.0.0","info":{"title":"CryptoQuant Data API","version":"1.3.0"},"tags":[{"name":"XRP Market Data","description":"This namespace contains endpoints to retrieve metrics related to XRP Market Data."}],"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"},"symbol_liq_xrp":{"description":"A XRP pair symbol from the table that we support. [See here](#operation/XRPgetLiquidations)","explode":false,"in":"query","name":"symbol","required":false,"schema":{"type":"string","default":"all_symbol"},"style":"form"},"window_mhd":{"description":"Currently we support `day`, `hour`, and `min`.","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":{"Liquidations":{"description":"Amount of long/short liquidations orders","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LiquidationsResponse"}}}}},"schemas":{"LiquidationsResponse":{"type":"object","required":["status","result"],"properties":{"status":{"$ref":"#/components/schemas/Status"},"result":{"type":"object","required":["window","data"],"properties":{"window":{"$ref":"#/components/schemas/Window_MDH"},"data":{"type":"array","items":{"type":"object","required":["long_liquidations","short_liquidations","long_liquidations_usd","short_liquidations_usd"],"properties":{"date":{"$ref":"#/components/schemas/Date"},"datetime":{"$ref":"#/components/schemas/Datetime"},"long_liquidations":{"type":"decimal","description":"Amount of liquidated orders in long positions."},"short_liquidations":{"type":"decimal","description":"Amount of liquidated orders in short positions."},"long_liquidations_usd":{"type":"decimal","description":"Amount of liquidated orders in long positions in USD."},"short_liquidations_usd":{"type":"decimal","description":"Amount of liquidated orders in short positions in USD."}}}}}}}},"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_MDH":{"type":"string","description":"The size of window. It can be day, hour, or min 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/market-data/liquidations":{"get":{"tags":["XRP Market Data"],"summary":"Liquidations","description":"Liquidations are sum of forced market orders to exit leveraged positions caused by price volatility. Liquidations indicate current price volatility and traders' sentiment which side they had been betting.\nNote that Binance's liquidation data collection policy has changed since [2021-04-27](https://binance-docs.github.io/apidocs/futures/en/#change-log), which makes the distribution of the data has changed after that.\n| Name           |   Exchange     | Symbol |\n|----------------|--------------|----|\n| All Exchanges  |   `all_exchange` |`all_symbol`* |\n| Binance        |   `binance`  | `xrp_usdt`<br/> `xrp_usd`<br/> `all_symbol`* |\n| Bybit          |   `bybit`    | `xrp_usdt`<br/> `xrp_usd`<br/> `all_symbol`*| \n| Bitmex         |   `bitmex`   | `xrp_usd`* | \n| HTX Global   |   `htx_global` | `xrp_usdt`*| \n| OKX            |   `okx`     | `xrp_usdt`<br/> `xrp_usd`<br/> `all_symbol`*| \n| Bitfinex            |   `bitfinex`     | `xrp_usdt`* |","operationId":"XRPgetLiquidations","parameters":[{"$ref":"#/components/parameters/exchange"},{"$ref":"#/components/parameters/symbol_liq_xrp"},{"$ref":"#/components/parameters/window_mhd"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"$ref":"#/components/responses/Liquidations"}}}}}}
```

## Capitalization

> This endpoint returns metrics related to market capitalization. First, we provide \`market\_cap\`, which is total market capitalization of XRP, calculated by multiplying the total supply with its USD price.\
> \_\_\[Go to Data Guide‣]\(<https://userguide.cryptoquant.com/cryptoquant-metrics/market/capitalization-models)\\_\\>\_<br>

```json
{"openapi":"3.0.0","info":{"title":"CryptoQuant Data API","version":"1.3.0"},"tags":[{"name":"XRP Market Data","description":"This namespace contains endpoints to retrieve metrics related to XRP Market Data."}],"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":{"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_Capitalization-2":{"description":"market_cap, realized_cap, average_cap, delta_cap, thermo_cap","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas_CapitalizationResponse-2"}}}}},"schemas":{"schemas_CapitalizationResponse-2":{"type":"object","required":["status","result"],"properties":{"status":{"$ref":"#/components/schemas/Status"},"result":{"type":"object","required":["window","data"],"properties":{"window":{"$ref":"#/components/schemas/Window"},"data":{"type":"array","items":{"type":"object","required":["market_cap"],"properties":{"blockheight":{"$ref":"#/components/schemas/Blockheight"},"date":{"$ref":"#/components/schemas/Date"},"datetime":{"$ref":"#/components/schemas/Datetime"},"market_cap":{"type":"decimal","description":"Market capitalization of XRP, calculated by total_supply * price_usd_close."}}}}}}}},"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":{"type":"string","description":"The size of window. It can be day 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/market-data/capitalization":{"get":{"tags":["XRP Market Data"],"summary":"Capitalization","description":"This endpoint returns metrics related to market capitalization. First, we provide `market_cap`, which is total market capitalization of XRP, calculated by multiplying the total supply with its USD price.\n__[Go to Data Guide‣](https://userguide.cryptoquant.com/cryptoquant-metrics/market/capitalization-models)__\n","operationId":"getCapitalization","parameters":[{"$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_Capitalization-2"}}}}}}
```

## Estimated Leverage Ratio

> Estimated Leverage Ratio indicates how much leverage is used by users on average. It is defined as the ratio of open interest divided by the reserve of an exchange. This information measures traders' sentiment whether they take a high risk or low risk.\
> \_\_\[Go to User Guide‣]\(<https://userguide.cryptoquant.com/cryptoquant-metrics/market/estimated-leverage-ratio)\\_\\_\\>
> \
> \<br>\
> \
> \> \*\*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.\
> \
> \<br>

```json
{"openapi":"3.0.0","info":{"title":"CryptoQuant Data API","version":"1.3.0"},"tags":[{"name":"XRP Market Data","description":"This namespace contains endpoints to retrieve metrics related to XRP Market Data."}],"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_dh10min":{"description":"Currently, we support `day`, `hour`, and `10min`.","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_estimated-leverage-ratio":{"description":"estimated levereage ratio","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas_EstimatedLeverageRatioResponse-2"}}}}},"schemas":{"schemas_EstimatedLeverageRatioResponse-2":{"type":"object","required":["status","result"],"properties":{"status":{"$ref":"#/components/schemas/Status"},"result":{"type":"object","required":["window","data"],"properties":{"window":{"$ref":"#/components/schemas/Window_10MDH"},"data":{"type":"array","items":{"type":"object","required":["estimated_leverage_ratio"],"properties":{"date":{"$ref":"#/components/schemas/Date"},"datetime":{"$ref":"#/components/schemas/Datetime"},"estimated_leverage_ratio":{"type":"decimal","description":"estimated leverage 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_10MDH":{"type":"string","description":"The size of window. It can be day, hour, or 10min 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/market-data/estimated-leverage-ratio":{"get":{"tags":["XRP Market Data"],"summary":"Estimated Leverage Ratio","description":"Estimated Leverage Ratio indicates how much leverage is used by users on average. It is defined as the ratio of open interest divided by the reserve of an exchange. This information measures traders' sentiment whether they take a high risk or low risk.\n__[Go to User Guide‣](https://userguide.cryptoquant.com/cryptoquant-metrics/market/estimated-leverage-ratio)__\n\n<br>\n\n> **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.\n\n<br>","operationId":"getEstimatedLeverageRatio","parameters":[{"$ref":"#/components/parameters/exchange"},{"$ref":"#/components/parameters/window_dh10min"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"$ref":"#/components/responses/responses_estimated-leverage-ratio"}}}}}}
```