Skip to main content
Version: release (v0.77)

List funding payments

GET 

/api/v2/funding-payments

Get a list of funding payment gains and losses for a party as a result of their position on a perpetual market when a funding period ends.

Request

Query Parameters

    partyId stringrequired

    Party ID to get funding payment for.

    marketId string

    Restrict funding payments returned to those generated by the given market.

    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
    fundingPayments object

    Page of funding period data and corresponding page information.

    edges object[]

    Page of funding payment data and their corresponding cursors.

  • Array [
  • cursor string

    Cursor that can be used to fetch further pages.

    node object

    Funding payment data.

    amount string

    Funding payment amount, where a positive value indicates an earned payment received and a negative value a loss.

    fundingPeriodSeq uint64

    Funding period sequence this payment was calculated from.

    marketId string

    Market that produced the funding payment.

    partyId string

    Party that received the funding payment.

    timestamp int64

    Timestamp, in Unix nanoseconds, at which this funding payment occurred.

  • ]
  • 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...