GEgemini
Account Administration

List Accounts in Group

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.

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.

post/v1/account/list

Request

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

limit_accountsinteger

The maximum number of accounts to return. Maximum and default values are both 500.

Example request

{
  "nonce": "1495127793000",
  "timestamp": "1495127793000"
}

Response

The response will be a JSON object containing all accounts within the master group

namestring

The name of the account provided upon creation

accountstring

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 account

counterparty_idstring

The Gemini clearing counterparty ID associated with the API key making the request. Will return None for custody accounts

statusstring

Either "open" or "closed"

Example response

[
  {
    "created": "1495127793000"
  }
]

Changes

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