Get Notional Balances POST https://api.gemini.com/v1/notionalbalances/{currency}
Returns the available balances in the supported currencies as well as the notional value in the specified currency.
Note Under the terms of the Gemini API Agreement , polling this endpoint may be subject to rate limiting .
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.
As a result of this change, requests routed via the new architecture will return fiat balances and crypto balances truncated to 15 and 19 decimal places, respectively. It is recommended that users floor the values returned from this endpoint to the correct precision until the migration has been completed.
POST v1/notionalbalances/usd
curl --request POST \
--url https://api.gemini.com/v1/notionalbalances/usd \
--header 'Content-Type: application/json' \
--header 'X-GEMINI-APIKEY: <string>' \
--header 'X-GEMINI-PAYLOAD: <string>' \
--header 'X-GEMINI-SIGNATURE: <string>' \
--data '
{
"request": "/v1/notionalbalances/usd",
"nonce": "<nonce>"
}
'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.
Headers X-GEMINI-APIKEY string · required
Your API key X-GEMINI-SIGNATURE string · required
HEX-encoded HMAC-SHA384 of payload signed with API secret X-GEMINI-PAYLOAD string · required
Base64-encoded JSON payload Content-Type string
Default: text/plain Content-Length string
Default: 0 Cache-Control string
Default: no-cache Path Parameters currency string · required
Either a fiat currency, e.g. usd or gbp, or a supported crypto-currency, e.g. gusd, btc, eth, aave, etc. Request Body request string · required
The literal string "/v1/notionalbalances/currency" nonce TimestampType | integer · required
timestamp Example: 1495127793000 account string
Required for Master API keys. The name of the account within the subaccount group. {
"request": "/v1/notionalbalances/usd",
"nonce": "<nonce>"
}Responses Properties Example
Successful operation
currency string
Currency code, see symbols and minimums amount string
The current balance amountNotional string
Amount, in notional available string
The amount that is available to trade availableNotional string
Available, in notional availableForWithdrawal string
The amount that is available to withdraw availableForWithdrawalNotional string
AvailableForWithdrawal, in notional [
{
"currency": "BTC",
"amount": "1154.62034001",
"amountNotional": "10386000.59",
"available": "1129.10517279",
"availableNotional": "10161000.71",
"availableForWithdrawal": "1129.10517279",
"availableForWithdrawalNotional": "10161000.71"
},
{
"currency": "USD",
"amount": "18722.79",
"amountNotional": "18722.79",
"available": "14481.62",
"availableNotional": "14481.62",
"availableForWithdrawal": "14481.62",
"availableForWithdrawalNotional": "14481.62"
},
{
"currency": "ETH",
"amount": "20124.50369697",
"amountNotional": "100621.31",
"available": "20124.50369697",
"availableNotional": "100621.31",
"availableForWithdrawal": "20124.50369697",
"availableForWithdrawalNotional": "100621.31"
}
]