GEgemini
Derivatives

List Funding Payments

<div class="p-4 text-sm section-icon section-info rounded-sm flex" role="alert"> <svg view-box="0 0 24 24" > <path fill-rule="evenodd" clip-rule="evenodd" d="M4 12C4 7.58172 7.58172 4 12 4C16.4183 4 20 7.58172 20 12C20 16.4183 16.4183 20 12 20C7.58172 20 4 16.4183 4 12ZM12 2C6.47715 2 2 6.47715 2 12C2 17.5228 6.47715 22 12 22C17.5228 22 22 17.5228 22 12C22 6.47715 17.5228 2 12 2ZM11 17V11H13V17H11ZM11 9V7H13V9H11Z" /> </svg> <span> Note that the response field 'instrumentSymbol' is only attached to requests from 16th April 2024 onwards. </span> </div>

Roles

The API key you use to access this endpoint must have the Trader or Auditor role assigned. See <a href="/roles#roles">Roles</a> for more information.

The OAuth scope must have orders:read assigned to access this endpoint. See OAuth Scopes for more information.

post/v1/perpetuals/fundingPayment

Request

  • Base URL
    https://api.gemini.com
  • URL
    https://api.gemini.com/v1/perpetuals/fundingPayment
  • Auth
    API key in header X-GEMINI-APIKEY and API key in header X-GEMINI-SIGNATURE and API key in header X-GEMINI-PAYLOAD

Query parameters

string

Gemini strongly recommends using milliseconds instead of seconds for timestamps.

Timestamp formatExampleSupported request type
string (seconds)1495127793POST only
string (milliseconds)1495127793000POST only
OR
integer

Gemini strongly recommends using milliseconds instead of seconds for timestamps.

Timestamp formatExampleSupported request type
whole number (seconds)1495127793GET, POST
whole number (milliseconds)1495127793000GET, POST
Example:1495127793000

If specified, only return funding payments after this point. Default value is 24h in past. See <u>Timestamps</u> for more information

string

Gemini strongly recommends using milliseconds instead of seconds for timestamps.

Timestamp formatExampleSupported request type
string (seconds)1495127793POST only
string (milliseconds)1495127793000POST only
OR
integer

Gemini strongly recommends using milliseconds instead of seconds for timestamps.

Timestamp formatExampleSupported request type
whole number (seconds)1495127793GET, POST
whole number (milliseconds)1495127793000GET, POST
Example:1495127793000

If specified, only returns funding payment until this point. Default value is now. See <u>Timestamps</u> for more information

Headers

X-GEMINI-APIKEYstring required

Your API key

X-GEMINI-SIGNATUREstring required

HEX-encoded HMAC-SHA384 of payload signed with API secret

X-GEMINI-PAYLOADstring required

Base64-encoded JSON payload

Content-Typestring
Content-Lengthstring
Cache-Controlstring

Request body

requeststring required

The API endpoint path

accountstring

Required for Master API keys as described in Private API Invocation. The name of the account within the subaccount group. Specifies the account on which you intend to place the order. Only available for exchange accounts.

Example request

{
  "request": "/v1/perpetuals/fundingPayment",
  "nonce": "1495127793000",
  "account": "primary"
}

Response

The response will be an array of funding payment objects.

eventType'Hourly Funding Transfer' required

Event type

Example response

[
  {
    "hourlyFundingTransfer": {
      "timestamp": "1495127793000"
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.