REST API

Account Administration (1.0.0)

Endpoint

Get Account Detail

POST

https://api.gemini.com

/v1/account

The account API will return detail about the specific account requested such as users, country codes, etc.

Roles

The API key you use to access this endpoint can be either a Master or Account level key with any role assigned. See Roles for more information.

Get Account Detail › 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
Default: text/plain
Content-Lengthstring
Default: 0
Cache-Controlstring
Default: no-cache

Get Account Detail › Request Body

requeststring · required
The literal string "/v1/account"
noncerequired
The nonce, as described in Private API Invocation

accountstring
Required for Master API keys as described in Private API Invocation. The name of the account within the subaccount group. Master API keys can get all account names using the Get Accounts endpoint.

Get Account Detail › Responses

Successful operation

accountobject
Contains information on the requested account
usersobject[]
Contains an array of JSON objects with user information for the requested account
memo_reference_codestring
Returns wire memo reference code for linked bank account
virtual_account_numberstring
Virtual account number for the account. Only populated if applicable for the account

Create New Account

POST

https://api.gemini.com

/v1/account/create

A Master API key can create a new exchange account within the group. This API will return the name of your new account for use with the account parameter in when using Master API keys to perform account level functions. Please see the example.

Roles

The API key you use to access this endpoint must be a Master level key and have the Administrator role assigned. See Roles for more information.

Create New Account › 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
Default: text/plain
Content-Lengthstring
Default: 0
Cache-Controlstring
Default: no-cache

Create New Account › Request Body

requeststring · required
The literal string "/v1/account/create"
noncerequired
The nonce, as described in Private API Invocation
namestring · required
A unique name for the new account

typestring
Either exchange or custody is accepted. Will generate an exchange account if exchange or parameter is missing. Will generate a custody account if custody.

Create New Account › Responses

Successful operation

accountstring
Account reference string for use in APIs based off the provided name field
typestring
Will return the type of account generated. exchange if an exchange account was created, custody if a custody account was created

Rename Account

POST

https://api.gemini.com

/v1/account/rename

A Master or Account level API key can rename an account within the group.

Roles

The API key you use to access this endpoint can be either a Master or Account level API key and must have the Administrator role assigned. See Roles for more information.

Rename Account › 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
Default: text/plain
Content-Lengthstring
Default: 0
Cache-Controlstring
Default: no-cache

Rename Account › Request Body

requeststring · required
The literal string "/v1/account/rename".
noncerequired
The nonce, as described in Private API Invocation

accountstring
Only required when using a master api-key. The shortname of the account within the subaccount group. Master API keys can get all account shortnames from the account field returned by the Get Accounts endpoint.
newNamestring
A unique name for the new account. If not provided, name will not change.
newAccountstring
A unique shortname for the new account. If not provided, shortname will not change.

Rename Account › Responses

An element containing the updated name of the account.

namestring
New name for the account based off the provided newName field. Only returned if newName was provided in the request.
accountstring
New shortname for the account based off the provided newAccount field. Only returned if newAccount was provided in the request.

List Accounts in Group

POST

https://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.

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.

List Accounts in Group › 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
Default: text/plain
Content-Lengthstring
Default: 0
Cache-Controlstring
Default: no-cache

List Accounts in Group › Request Body

requeststring · required
The literal string "/v1/account/list"
noncerequired
The nonce, as described in Private API Invocation

limit_accountsinteger
The maximum number of accounts to return. Maximum and default values are both 500.
timestamp
Only return accounts created on or before the supplied timestamp. If not provided, the 500 most recently created accounts are returned.

List Accounts in Group › Responses

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
created
The timestamp of account creation, displayed as number of milliseconds since 1970-01-01 UTC. This will be transmitted as a JSON number
statusstring
Either "open" or "closed"

Roles Endpoint

POST

https://api.gemini.com

/v1/roles

The v1/roles endpoint will return a string of the role of the current API key. The response fields will be different for account-level and master-level API keys.

Roles Endpoint › 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
Default: text/plain
Content-Lengthstring
Default: 0
Cache-Controlstring
Default: no-cache

Roles Endpoint › Request Body

requeststring · required
The literal string "/v1/roles"
Example: /v1/roles
nonceTimestampType · required
timestamp

Roles Endpoint › Responses

The response will be a JSON object indicating the assigned roles to the set of API keys used to call /v1/roles. The Auditor role cannot be combined with other roles. Fund Manager and Trader can be combined.

isAuditorboolean · required
True if the Auditor role is assigned to the API keys. False otherwise.
isFundManagerboolean · required
True if the Fund Manager role is assigned to the API keys. False otherwise.
isTraderboolean · required
True if the Trader role is assigned to the API keys. False otherwise.

counterparty_idstring
Only returned for master-level API keys. The Gemini clearing counterparty ID associated with the API key making the request.
isAccountAdminboolean
Only returned for master-level API keys.True if the Administrator role is assigned to the API keys. False otherwise.

Instant OAuth