List Accounts in Group
POSThttps://api.gemini.com/v1/account/list
A Master API key can be used to get the accounts within the group. A maximum of 500 accounts can be listed in a single API call.
curl --request POST \
--url https://api.gemini.com/v1/account/list \
--header 'Content-Type: application/json' \
--header 'X-GEMINI-APIKEY: <string>' \
--header 'X-GEMINI-PAYLOAD: <string>' \
--header 'X-GEMINI-SIGNATURE: <string>' \
--data '
{
"request": "/v1/account/list",
"nonce": "<nonce>",
"limit_accounts": 100,
"timestamp": 1632485834721
}
'
Roles
The API key you use to access this endpoint must be a Master level key. See Roles for more information.
The OAuth scope must have account:read assigned to access this endpoint. See OAuth Scopes for more information.
Headers
X-GEMINI-APIKEYstring·required
Your API keyX-GEMINI-SIGNATUREstring·required
HEX-encoded HMAC-SHA384 of payload signed with API secretX-GEMINI-PAYLOADstring·required
Base64-encoded JSON payloadContent-Typestring
Default: text/plainContent-Lengthstring
Default: 0Cache-Controlstring
Default: no-cacheRequest Body
requeststring·required
The literal string "/v1/account/list"nonceTimestampType | integer·required
timestampExample: 1495127793000limit_accountsinteger
The maximum number of accounts to return. Maximum and default values are both 500.timestampstring | integer
Gemini strongly recommends using milliseconds instead of seconds for timestamps.Timestamp format
Example
Supported request type
string (seconds)
1495127793
POST only
string (milliseconds)
1495127793000
POST only
whole number (seconds)
1495127793
GET, POST
whole number (milliseconds)
1495127793000
GET, POST
{
"request": "/v1/account/list",
"nonce": "<nonce>",
"limit_accounts": 100,
"timestamp": 1632485834721
}
Responses
The response will be a JSON object containing all accounts within the master group
namestring
The name of the account provided upon creationaccountstring
Nickname of the specific account (will take the name given, remove all symbols, replace all " " with "-" and make letters lowercase)typestring
Either "exchange" or "custody" depending on type of accountcounterparty_idstring
The Gemini clearing counterparty ID associated with the API key making the request. Will return `None` for custody accountscreatedstring | integer
Gemini strongly recommends using milliseconds instead of seconds for timestamps.Timestamp format
Example
Supported request type
string (seconds)
1495127793
POST only
string (milliseconds)
1495127793000
POST only
whole number (seconds)
1495127793
GET, POST
whole number (milliseconds)
1495127793000
GET, POST
statusstring
Either "open" or "closed"[
{
"name": "Primary",
"account": "primary",
"type": "exchange",
"counterparty_id": "EMONNYXH",
"created": 1495127793000,
"status": "open"
},
{
"name": "My Custody Account",
"account": "my-custody-account",
"type": "custody",
"counterparty_id": null,
"created": 1565970772000,
"status": "open"
},
{
"name": "Other exchange account!",
"account": "other-exchange-account",
"type": "exchange",
"counterparty_id": "EMONNYXK",
"created": 1565970772000,
"status": "closed"
}
]
