GEgemini
Staking

List Staking Rewards

This will show the historical Staking reward payments and accrual.

Roles

The API key you use to access this endpoint must have the Trader, Fund Manager or Auditor role assigned. See Roles for more information.

post/v1/staking/rewards

Request

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

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 literal string "/v1/staking/rewards"

accountstring

Required for Master API keys as described in Private API Invocation. The name of the account within the subaccount group.

sincestring required

In iso datetime with timezone format

untilstring

In iso datetime with timezone format, default to current time as of server time

providerIdstring

Borrower Id, in uuid4 format. providerId is accessible from the Staking rates response

currencystring

Currency code, see symbols

Example request

{
  "nonce": "1495127793000"
}

Response

A nested JSON object, organized by provider, then currency

Example response

{
  "provider_uuid": {
    "currency_symbol": {
      "providerId": "62b21e17-2534-4b9f-afcf-b7edb609dd8d",
      "currency": "MATIC",
      "accrualTotal": 0.103994,
      "ratePeriods": [
        {
          "providerId": "62b21e17-2534-4b9f-afcf-b7edb609dd8d",
          "currency": "MATIC",
          "apyPct": 5.75,
          "ratePct": 5.592369,
          "numberOfAccruals": 1,
          "accrualTotal": 0.0065678,
          "firstAccrualAt": "2022-08-23T20:00:00.000Z",
          "lastAccrualAt": "2022-08-23T20:00:00.000Z"
        }
      ]
    }
  }
}

Changes

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