Get Account Detail
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.
Headers
X-GEMINI-APIKEY
string · requiredYour API key
X-GEMINI-SIGNATURE
string · requiredHEX-encoded HMAC-SHA384 of payload signed with API secret
X-GEMINI-PAYLOAD
string · requiredBase64-encoded JSON payload
Content-Type
stringDefault: text/plainContent-Length
stringDefault: 0Cache-Control
stringDefault: no-cache
Request Body
request
string · requiredThe literal string "/v1/account"
account
stringRequired 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.
Responses
account
objectContains information on the requested account
users
object[]Contains an array of JSON objects with user information for the requested account
memo_reference_code
stringReturns wire memo reference code for linked bank account
Create New Account
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.
Headers
X-GEMINI-APIKEY
string · requiredYour API key
X-GEMINI-SIGNATURE
string · requiredHEX-encoded HMAC-SHA384 of payload signed with API secret
X-GEMINI-PAYLOAD
string · requiredBase64-encoded JSON payload
Content-Type
stringDefault: text/plainContent-Length
stringDefault: 0Cache-Control
stringDefault: no-cache
Request Body
request
string · requiredThe literal string "/v1/account/create"
name
string · requiredA unique name for the new account
type
stringEither
exchange
orcustody
is accepted. Will generate an exchange account ifexchange
or parameter is missing. Will generate a custody account ifcustody
.
Responses
account
stringAccount reference string for use in APIs based off the provided
name
fieldtype
stringWill return the type of account generated.
exchange
if an exchange account was created,custody
if a custody account was created
Rename Account
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.
Headers
X-GEMINI-APIKEY
string · requiredYour API key
X-GEMINI-SIGNATURE
string · requiredHEX-encoded HMAC-SHA384 of payload signed with API secret
X-GEMINI-PAYLOAD
string · requiredBase64-encoded JSON payload
Content-Type
stringDefault: text/plainContent-Length
stringDefault: 0Cache-Control
stringDefault: no-cache
Request Body
request
string · requiredThe literal string "/v1/account/rename".
account
stringOnly 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.newName
stringA unique name for the new account. If not provided, name will not change.
newAccount
stringA unique shortname for the new account. If not provided, shortname will not change.
Responses
name
stringNew name for the account based off the provided
newName
field. Only returned ifnewName
was provided in the request.account
stringNew shortname for the account based off the provided
newAccount
field. Only returned ifnewAccount
was provided in the request.
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.
Headers
X-GEMINI-APIKEY
string · requiredYour API key
X-GEMINI-SIGNATURE
string · requiredHEX-encoded HMAC-SHA384 of payload signed with API secret
X-GEMINI-PAYLOAD
string · requiredBase64-encoded JSON payload
Content-Type
stringDefault: text/plainContent-Length
stringDefault: 0Cache-Control
stringDefault: no-cache
Request Body
request
string · requiredThe literal string "/v1/account/list"
limit_accounts
integerThe maximum number of accounts to return. Maximum and default values are both 500.
timestamp
timestamp
Responses
name
stringThe name of the account provided upon creation
account
stringNickname of the specific account (will take the name given, remove all symbols, replace all " " with "-" and make letters lowercase)
type
stringEither "exchange" or "custody" depending on type of account
counterparty_id
stringThe Gemini clearing counterparty ID associated with the API key making the request. Will return
None
for custody accountscreated
timestamp
status
stringEither "open" or "closed"
Roles Endpoint
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.
Headers
X-GEMINI-APIKEY
string · requiredYour API key
X-GEMINI-SIGNATURE
string · requiredHEX-encoded HMAC-SHA384 of payload signed with API secret
X-GEMINI-PAYLOAD
string · requiredBase64-encoded JSON payload
Content-Type
stringDefault: text/plainContent-Length
stringDefault: 0Cache-Control
stringDefault: no-cache
Request Body
request
string · requiredThe literal string "/v1/roles"
Example: /v1/rolesnonce
requiredtimestamp
Responses
isAuditor
boolean · requiredTrue
if the Auditor role is assigned to the API keys.False
otherwise.isFundManager
boolean · requiredTrue
if the Fund Manager role is assigned to the API keys.False
otherwise.isTrader
boolean · requiredTrue
if the Trader role is assigned to the API keys.False
otherwise.counterparty_id
stringOnly returned for master-level API keys. The Gemini clearing counterparty ID associated with the API key making the request.
isAccountAdmin
booleanOnly returned for master-level API keys.
True
if the Administrator role is assigned to the API keys.False
otherwise.