Skip to main content
Version: pre-release (v0.79)

List funding periods

GET 

/api/v2/funding-periods/:marketId

Get a list of funding periods for a perpetual market.

Request

Path Parameters

    marketId stringrequired

    Market ID to get funding periods for.

Query Parameters

    dateRange.startTimestamp int64

    Timestamp in Unix nanoseconds indicating the start of the date range.

    dateRange.endTimestamp int64

    Timestamp in Unix nanoseconds indicating the end of the date range.

    pagination.first int32

    Number of records to be returned that sort greater than row identified by cursor supplied in 'after'.

    pagination.after string

    If paging forwards, the cursor string for the last row of the previous page.

    pagination.last int32

    Number of records to be returned that sort less than row identified by cursor supplied in 'before'.

    pagination.before string

    If paging forwards, the cursor string for the first row of the previous page.

    pagination.newestFirst boolean

    Whether to order the results with the newest records first. If not set, the default value is true.

Responses

A successful response.

Schema
    fundingPeriods object

    Page of funding period data and corresponding page information.

    edges object[]

    Page of funding period data and their corresponding cursors.

  • Array [
  • cursor string

    Cursor that can be used to fetch further pages.

    node object

    Funding period data.

    end int64

    Time in Unix nanoseconds when the funding period ended.

    externalTwap string

    TWAP for this period based on the external data-points.

    fundingPayment string

    Funding payment for this period as the difference between the time-weighted average price of the external and internal data point.

    fundingRate string

    Percentage difference between the time-weighted average price of the external and internal data point.

    internalTwap string

    TWAP for this period based on the internal data-points.

    marketId string

    ID of the market for which this funding period relates to.

    seq uint64

    Sequence number of the funding period.

    start int64

    Time in Unix nanoseconds when the funding period started.

  • ]
  • pageInfo object

    Page information that is used for fetching further pages.

    endCursor string

    End cursor.

    hasNextPage boolean

    Indicator if there is a next page.

    hasPreviousPage boolean

    Indicator if there is a previous page.

    startCursor string

    Start cursor.

Loading...