GEgemini
Staking

Unstake Crypto Funds

Initiates Staking withdrawals.

Roles

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

post/v1/staking/unstake

Request

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

accountstring

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

providerIdstring required

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

currencystring required

Currency code, see symbols

amountstring decimal required

The amount of currency to withdraw

Example request

{
  "nonce": "1495127793000"
}

Response

The staking withdrawal transaction

transactionIdstring

A unique identifier for the staking transaction

amountnumber

The amount deposited

amountPaidSoFarnumber

The amount redeemed successfully

amountRemainingnumber

The amount pending to be redeemed

currencystring

Currency code

requestInitiatedstring

In ISO datetime with timezone format

Example response

{
  "transactionId": "MPZ7LDD8",
  "amount": 20,
  "amountPaidSoFar": 20,
  "currency": "MATIC",
  "requestInitiated": "2022-11-02T19:49:20.153Z"
}

Changes

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