GEgemini
Derivatives

Get Funding Payment Report File

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.

Examples

  • &fromDate=2024-04-10&toDate=2024-04-25&numRows=1000 </br> Compare and obtain the minimum records between (2024-04-10 to 2024-04-25) and 1000. If (2024-04-10 to 2024-04-25) contains 360 records. Then fetch the minimum between 360 and 1000 records only.

  • &numRows=2024-04-10&toDate=2024-04-25 </br> If (2024-04-10 to 2024-04-25) contains 360 records. Then fetch 360 records only.

  • &numRows=1000 </br> Fetch maximum 1000 records starting from Now to a historical date

  • <blank> </br> Fetch maximum 8760 records starting from Now to a historical date

get/v1/perpetuals/fundingpaymentreport/records.xlsx

Request

  • Base URL
    https://api.gemini.com
  • URL
    https://api.gemini.com/v1/perpetuals/fundingpaymentreport/records.xlsx
  • 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

fromDatestring date

If empty, will only fetch records by numRows value.

toDatestring date

If empty, will only fetch records by numRows value.

numRowsinteger

If empty, default value '8760'

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/fundingpaymentreport/records.xlsx",
  "nonce": "1495127793000",
  "account": "primary"
}

Response

XLSX file downloaded containing funding payment report.

Changes

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