GEgemini
Account Administration

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.

post/v1/roles

Request

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

Example request

{
  "request": "/v1/roles",
  "nonce": "1495127793000"
}

Response

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.

Changes

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