GEgemini
Staking

List Staking Balances

This will show the available balance in Staking as well as the available balance for withdrawal.

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/balances/staking

Request

  • Base URL
    https://api.gemini.com
  • URL
    https://api.gemini.com/v1/balances/staking
  • 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/balances/staking"

accountstring

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

Example request

{
  "nonce": "1495127793000"
}

Response

The staking balances

typestring

Will always be "Staking"

currencystring

Currency code, see symbols and minimums

balancenumber

The current Staking balance

availablenumber

The amount that is available to trade

availableForWithdrawalnumber

The Staking amount that is available to redeem to exchange account

balanceByProviderobject

Example response

[
  {
    "type": "Staking",
    "currency": "MATIC",
    "balance": 10,
    "availableForWithdrawal": 10
  }
]

Changes

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