Cumulative Futures Funding Rate

Definition

The cumulative funding rate is the total funding rate that would be accumulated by contract holders over a specified time period.

Name	MetricID	Unit	Interval
Funding rate, cumulative, futures, USD-margined, 1 day	futures_cumulative_funding_rate_usd_margin_1d	Dimensionless	1 hour
Funding rate, cumulative, futures, USD-margined, 7 days	futures_cumulative_funding_rate_usd_margin_7d	Dimensionless	1 hour
Funding rate, cumulative, futures, USD-margined, 30 days	futures_cumulative_funding_rate_usd_margin_30d	Dimensionless	1 hour
Funding rate, cumulative, futures, coin-margined, 1 day	futures_cumulative_funding_rate_coin_margin_1d	Dimensionless	1 hour
Funding rate, cumulative, futures, coin-margined, 7 days	futures_cumulative_funding_rate_coin_margin_7d	Dimensionless	1 hour
Funding rate, cumulative, futures, coin-margined, 30 days	futures_cumulative_funding_rate_coin_margin_30d	Dimensionless	1 hour
Funding rate, cumulative, futures, all-margined, 1 day	futures_cumulative_funding_rate_all_margin_1d	Dimensionless	1 hour
Funding rate, cumulative, futures, all-margined, 7 days	futures_cumulative_funding_rate_all_margin_7d	Dimensionless	1 hour
Funding rate, cumulative, futures, all-margined, 30 days	futures_cumulative_funding_rate_all_margin_30d	Dimensionless	1 hour

Details

The futures_cumulative_funding_rate_usd_margin_* metrics represent the cumulative average funding rate weighted by open interest from futures markets where the margin asset is U.S. dollars or stablecoins over the previous specified time period.

The futures_cumulative_funding_rate_coin_margin_* metrics represent the cumulative average funding rate weighted by open interest from futures markets where the margin asset is equivalent to the underlying base asset over the previous specified time period.

The futures_cumulative_funding_rate_all_margin_* metrics represent the cumulative average funding rate weighted by open interest from all futures markets, regardless of the margin asset, over the previous specified time period.

These metrics have a publication frequency of once per hour and represent the cumulative realized funding rate over the previous 1 day, 7 day, and 30 day time periods.

For example, at the market level, the cumulative funding rate for binance-BTCUSDT-future over the course of one day would be the cumulative product of the three 8-hour funding settlement rates reported that day. For these metrics, with the CFR being calculated for assets, we leverage our Aggregate Futures Funding Rate to perform this calculation across all relevant markets.

To accumulate the rates hour-over-hour, we first convert the AFR to an hourly rate, multiply the rates together, then convert the product back to the desired rate.

$$CFR_{L}=\prod_{i=1}^{L} (1 + AFR_{1h,i}) - 1$$

$$AFR_{1h,i} = \frac{AFR_{8h,i}}{8}$$

where $AFR_{i}$ is the Aggregate Funding Rate at timestamp $i$. The increments $i$ are hourly, as $AFR$ is published hourly. Thus, futures_cumulative_funding_rate_usd_margin_1dis the accumulation of funding rates over the last 24 hours, futures_cumulative_funding_rate_usd_margin_7d is the accumulation of funding rates over the last 168 hours, etc.

API Endpoints

Cumulative Futures Funding Rates can be accessed using the timeseries/asset-metrics and timeseries/exchange-asset-metrics endpoints by passing in futures_cumulative_funding_rate_usd_margin_* to the metrics parameter.

Asset metrics

Returns requested metrics for specified assets.<br/><br/> Results for block by block metrics (1b frequency) are ordered by tuple (asset, height, block_hash), all other metrics are ordered by tuple (asset, time). You can change the sorting using sort query parameter.<br/><br/> Supported output formats are json (default) and csv, use format query parameter to override it.<br/> To fetch the next page of results use next_page_url JSON response field or x-next-page-url CSV HTTP header if present.<br/><br/> If multiple metrics are requested in the same time the strict policy for partially available metrics among requested ones is applied: <ul>

<li>missing metric name in the JSON response means that the metric is "not a supported metric" for the asset and frequency while some other requested metrics are supported.</li> <li>`null` value of the metric means "no data in the database" while some other requested metrics have data.</li> </ul>

get

/timeseries/asset-metrics

Authorizations

Query parameters

assetsstring[]required

Comma separated list of assets.<br/> Use the /catalog-all/assets endpoint for the full list of supported assets or specify asterisk (*) in order to get metrics for all supported assets.

metricsstring[]required

Comma separated metrics to request time series data for.<br/> Information on all available metrics can be found on page https://docs.coinmetrics.io/info/metrics.<br/> Use the /catalog-all/metrics or /catalog-all/assets endpoint for the full list of supported metrics per asset.

Example: ["AdrActCnt","BlkHgt"]

frequencystring · default: 1d

Frequency of the metrics. Supported values are 1b (block by block), 1s (one second), 1m (one minute), 10m (ten minutes), 1h (one hour), 1d (one day), 1d-ny-close (one day at New York close time). Please refer to the /catalog/metrics endpoint for the full list.<br/> Use the /catalog-all/assets endpoint for the full list of supported frequencies per asset-metric pair.

Example: 1b

statusstring · enum · default: all

Which metric values do you want to see. Applicable only for "reviewable" metrics. You can find them in the /catalog/metrics endpoint.

Options: all, flash, reviewed, revised

start_timestring

Start of the time interval.<br/> This field refers to the time field in the response.<br/> Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120.<br/> Inclusive by default. Mutually exclusive with start_height and start_hash.<br/> UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it.<br/> If start_time is omitted, response will include time series from the earliest time available.

end_timestring

End of the time interval.<br/> This field refers to the time field in the response.<br/> Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120.<br/> Inclusive by default. Mutually exclusive with end_height and end_hash.<br/> UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it.<br/> If end_time is omitted, response will include time series up to the latest time available.

start_heightinteger · int64

The start height indicates the beginning block height for the set of data that are returned.<br/> Inclusive by default. Mutually exclusive with start_time and start_hash.

end_heightinteger · int64

The end height indicates the ending block height for the set of data that are returned.<br/> Inclusive by default. Mutually exclusive with end_time and end_hash.<br/> This parameter is disabled for Community users.

start_hashstring

The start hash indicates the beginning block height for the set of data that are returned.<br/> Inclusive by default. Mutually exclusive with start_time and start_height.

end_hashstring

The end hash indicates the ending block height for the set of data that are returned.<br/> Inclusive by default. Mutually exclusive with end_time and end_height.

start_inclusiveboolean · default: true

Inclusive or exclusive corresponding start_* parameters.

end_inclusiveboolean · default: true

Inclusive or exclusive corresponding end_* parameters.

min_confirmationsinteger · int32 · max: 99

Specifies how many blocks behind the chain tip block by block metrics (1b frequency) are based on. Default for btc is 2 and 99 for eth. For example, a min_confirmations of 0 means metrics are being calculated for the block at the tip of the chain (the latest block received by our node) whereas a min_confirmations of 6 means that metrics are being applied to the block that is 6 blocks behind the chain tip (i.e., the 7th block if the chain tip is block 1).

timezonestring · default: UTC

Timezone name for start_time and end_time timestamps.<br/> This parameter does not modify the output times, which are always UTC.<br/> Format is defined by TZ database.

Example: America/New_York

page_sizeinteger · int32 · min: 1 · max: 10000 · default: 100

Number of items per single page of results.<br/> The value of this parameter is ignored if the endpoint supports the format parameter and its value is set to json_stream.

paging_fromstring · enum · default: end

Where does the first page start, at the start of the interval or at the end.

Options: start, end

sortstring · enum · default: asset

How results will be sorted. Metrics with 1b frequency are sorted by (asset, height, block_hash) tuples by default. Metrics with other frequencies are sorted by (asset, time) by default. If you want to sort 1d metrics by (time, asset) you should choose time as value for the sort parameter.<br/> Sorting by time is useful if you request metrics for a set of assets.

Options: asset, height, time

limit_per_assetinteger · int32

How many entries per asset result should contain. For example, this combination of parameters assets=btc,eth&metrics=ReferenceRate&limit_per_asset=1 returns the latest ReferenceRate values for btc and eth.

prettyboolean · default: false

Human-readable formatting of JSON responses.

formatstring · enum · default: json

Format of the response.

Options: json, csv

null_as_zeroboolean · default: false

Nulls are represented as zeros in the response.

next_page_tokenstring

Token for receiving the results from the next page of a query.<br/> Should not be used directly. To iterate through pages just use next_page_url response field.

ignore_forbidden_errorsboolean · default: false

Ignore HTTP 403 Forbidden errors

ignore_unsupported_errorsboolean · default: false

Ignore errors for unsupported assets, metrics or frequencies.

Responses

application/jsontext/csv

application/json

application/json

application/json

200

400

401

403

414

200

application/json

text/csv

application/json

Example of a message with daily metrics.

Example of a message with block by block metrics.

Example of a message with 1s metrics.

Example of a message with daily metrics.

{
  "data": [
    {
      "asset": "btc",
      "time": "2020-02-29T00:00:00.000000000Z",
      "PriceUSD": "8582.09029964933",
      "SplyBMXNtv": "283220.10827406",
      "SplyBMXNtv-status": "reviewed",
      "SplyBMXNtv-status-time": "2020-03-01T09:59:13.847251000Z"
    },
    {
      "asset": "btc",
      "time": "2020-03-01T00:00:00.000000000Z",
      "PriceUSD": "8541.77389392169",
      "SplyBMXNtv": "284691.32323907",
      "SplyBMXNtv-status": "reviewed",
      "SplyBMXNtv-status-time": "2020-03-02T14:00:02.622168000Z"
    }
  ],
  "next_page_token": "0.MjAyMC0wNi0wN1QwMDowMDowMFo,MjAyMC0wNi0wN1QwMDowMDowMFo",
  "next_page_url": "https://api.coinmetrics.io/v4/timeseries/asset-metrics?api_key=<your_key>&pretty=true&assets=btc&metrics=SplyBMXNtv,PriceUSD&page_size=2&next_page_token=0.MjAyMC0wNi0wN1QwMDowMDowMFo,MjAyMC0wNi0wN1QwMDowMDowMFo"
}

Time series of metrics for an asset.

Shell

curl --compressed "https://api.coinmetrics.io/v4/timeseries/asset-metrics?assets=btc&metrics=futures_cumulative_funding_rate_usd_margin_1d&limit_per_asset=1&api_key=<your_key>"

Python

import requests
response = requests.get('https://api.coinmetrics.io/v4/timeseries/asset-metrics?assets=btc&metrics=futures_cumulative_funding_rate_usd_margin_1d&limit_per_asset=1&api_key=<your_key>
print(response)

Python Client

from coinmetrics.api_client import CoinMetricsClient

api_key = "<API_KEY>"
client = CoinMetricsClient(api_key)

print(
    client.get_asset_metrics(
        assets=["btc"], metrics=['futures_cumulative_funding_rate_usd_margin_1d'], frequency='1d', limit_per_market=1
    ).to_dataframe()
)

Exchange-asset metrics

Returns metrics for specified exchange-asset.<br/> Results are ordered by tuple (exchange_asset, time).<br/> To fetch the next page of results use next_page_url JSON response field.<br/>

get

/timeseries/exchange-asset-metrics

Authorizations

Query parameters

exchange_assetsstring[]required

Comma separated list of exchange-asset pairs or patterns like exchange-* or *-asset.

metricsstring[]required

Comma separated metrics to request time series data for.<br/> Information on all available metrics can be found on page https://docs.coinmetrics.io/info/pair_metrics.<br/> Use the /catalog-all/exchange-assets endpoint for the full list of supported metrics per exchange-asset combination.

Example: ["open_interest_reported_future_usd","volume_reported_spot_usd_1d"]

frequencystring · default: 1d

Frequency of the exchange-asset metrics. Supported values are 5m, 1h, 1d.

start_timestring

Start of the time interval.<br/> This field refers to the time field in the response.<br/> Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120.<br/> Inclusive by default.<br/> UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it.<br/> If start_time is omitted, response will include time series from the earliest time available.

end_timestring

End of the time interval.<br/> This field refers to the time field in the response.<br/> Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120.<br/> Inclusive by default.<br/> UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it.<br/> If end_time is omitted, response will include time series up to the latest time available.

start_inclusiveboolean · default: true

Inclusive or exclusive corresponding start_* parameters.

end_inclusiveboolean · default: true

Inclusive or exclusive corresponding end_* parameters.

timezonestring · default: UTC

Timezone name for start_time and end_time timestamps.<br/> This parameter does not modify the output times, which are always UTC.<br/> Format is defined by TZ database.

Example: America/New_York

page_sizeinteger · int32 · min: 1 · max: 10000 · default: 100

Number of items per single page of results.<br/> The value of this parameter is ignored if the endpoint supports the format parameter and its value is set to json_stream.

paging_fromstring · enum · default: end

Where does the first page start, at the start of the interval or at the end.

Options: start, end

sortstring · enum · default: exchange_asset

How results will be sorted. Metrics are sorted by (exchange_asset, time) by default. If you want to sort 1d metrics by (time, exchange_asset) you should choose time as value for the sort parameter.<br/> Sorting by time is useful if you request metrics for a set of exchange-assets.

Options: exchange_asset, time

limit_per_exchange_assetinteger · int32

How many entries per exchange_asset result should contain. For example, this combination of parameters exchange_assets=binance-btc,coinbase-eth&metrics=volume_trusted_spot_usd_1h&limit_per_exchange_asset=1 returns the latest volume_trusted_spot_usd_1h values for binance-btc and coinbase-eth.

prettyboolean · default: false

Human-readable formatting of JSON responses.

formatstring · enum · default: json

Format of the response.

Options: json, csv

next_page_tokenstring

Token for receiving the results from the next page of a query.<br/> Should not be used directly. To iterate through pages just use next_page_url response field.

Responses

application/json

application/json

application/json

application/json

200

400

401

403

414

200

{
  "data": [
    {
      "exchange_asset": "binance-btc",
      "time": "2021-10-04T00:00:00.000000000Z",
      "open_interest_reported_future_usd": "3469621227.0258"
    },
    {
      "exchange_asset": "binance-btc",
      "time": "2021-10-05T00:00:00.000000000Z",
      "open_interest_reported_future_usd": "3562791590.02995"
    },
    {
      "exchange_asset": "binance-btc",
      "time": "2021-10-06T00:00:00.000000000Z",
      "open_interest_reported_future_usd": "3970248573.60142"
    },
    {
      "exchange_asset": "binance-btc",
      "time": "2021-10-07T00:00:00.000000000Z",
      "open_interest_reported_future_usd": "4110308192.96416"
    }
  ]
}

Time series of exchange-asset metrics.

Shell

curl --compressed "https://api.coinmetrics.io/v4/timeseries/exchange-asset-metrics?exchange_assets=binance-btc&metrics=futures_cumulative_funding_rate_usd_margin_1d&limit_per_exchange_asset=1&api_key=<your_key>"

Python

import requests
response = requests.get('https://api.coinmetrics.io/v4/timeseries/exchange-asset-metrics?exchange_assets=binance-btc&metrics=futures_cumulative_funding_rate_usd_margin_1d&limit_per_exchange_asset=1&api_key=<your_key>
print(response)

Python Client

from coinmetrics.api_client import CoinMetricsClient

api_key = "<API_KEY>"
client = CoinMetricsClient(api_key)

print(
    client.get_exchange_asset_metrics(
        exchanges=["binance-btc"], metrics=['futures_cumulative_funding_rate_usd_margin_1d'], frequency='1d', limit_per_market=1
    ).to_dataframe()
)

Example

{
  "data" : [ {
    "asset" : "btc",
    "time" : "2023-09-18T19:00:00.000000000Z",
    "futures_cumulative_funding_rate_coin_margin_1d" : "0.0000748325509789538"
  }, {
    "asset" : "btc",
    "time" : "2023-09-18T20:00:00.000000000Z",
    "futures_cumulative_funding_rate_coin_margin_1d" : "0.0000725858255383738"
  }, {
    "asset" : "btc",
    "time" : "2023-09-18T21:00:00.000000000Z",
    "futures_cumulative_funding_rate_coin_margin_1d" : "0.0000703397006305284"
  }, {
    "asset" : "btc",
    "time" : "2023-09-18T22:00:00.000000000Z",
    "futures_cumulative_funding_rate_coin_margin_1d" : "0.0000678449650222124"
  }, {
    "asset" : "btc",
    "time" : "2023-09-18T23:00:00.000000000Z",
    "futures_cumulative_funding_rate_coin_margin_1d" : "0.0000653489780522154"
  } ]
}

• asset: The id of the asset.\

• time: The exchange-reported time in ISO 8601 date-time format. Always with nanoseconds precision.\

• futures_cumulative_funding_rate_coin_margin_1d: The cumulative funding rate.

Release History

• Released on September 19, 2023

Availability for Assets

https://coverage.coinmetrics.io/asset-metrics/futures_cumulative_funding_rate_coin_margin_1dcoverage.coinmetrics.io