GEgemini
Fund Management

Get Available Balances

<div class="p-4 text-sm section-icon section-info rounded-sm" role="alert"> <div class="flex"> <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> <div>Under the terms of the <a href="https://www.gemini.com/legal/api-agreement">Gemini API Agreement</a>, polling this endpoint may be subject to <a href="/rate-limit">rate limiting</a>.</div> </div> </div>

This will show the available balances in the supported currencies

<div class="p-4 text-sm section-icon section-info rounded-sm" role="alert"> <div class="flex"> <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> <div>Please note that Gemini is currently in the process of introducing new API architecture that will impact how decimal balances are returned from this endpoint for fiat and crypto assets.</div> </div> <p>As a result of this change, requests to the balances endpoint routed via the new architecture will return fiat balances and crypto balances truncated to 15 and 19 decimal places, respectively. This change has been introduced to correct for the display of miniscule residual values that do not actually represent usable balances.</p> <div>It is recommended that users floor the values returned from this endpoint to the correct precision until the migration to the new architecture has been completed.</div> </div>

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.

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

post/v1/balances

Request

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

accountstring required

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.

showPendingBalancesboolean

Whether to include pending balances such as in-flight crypto deposits or withdrawals in the balances response.

Note: Setting this field to true will result in slower response times due to additional database lookups required to retrieve pending balance information.

Example request

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

Response

The account balances

type'exchange'
currencystring

The currency symbol

amountnumber

The confirmed balance for the currency (also referred to as confirmedBalance). For crypto withdrawals, this value is not reduced until the withdrawal has been confirmed on the blockchain. This delay protects against blockchain reorganizations. Use the available field instead if you need balances that immediately reflect holds.

availablenumber

The amount available for trading. This value is reduced immediately when an order hold or withdrawal hold is placed, making it the recommended field for tracking real-time spendable balances.

availableForWithdrawalnumber

The amount available for withdrawal

pendingWithdrawalnumber

The amount pending withdrawal

pendingDepositnumber

The amount pending deposit

_timestampstring date-time

Server-side monotonically increasing clock value as an ISO 8601 timestamp. Clients can use this value to detect and filter out stale responses that may occur due to load balancing or potential stale servers.

Example response

[
  {
    "type": "exchange",
    "currency": "BTC",
    "amount": 10.5,
    "available": 9,
    "availableForWithdrawal": 9,
    "pendingWithdrawal": 1,
    "pendingDeposit": 0.5,
    "_timestamp": "2024-03-16T00:00:00.000000Z"
  }
]

Changes

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