GEgemini
Clearing

List Clearing Brokers

Roles

The API key you use to access this endpoint must have the Trader role assigned. See Roles for more information.

The OAuth scope must have clearing:read assigned to access this endpoint. See OAuth Scopes for more information.

post/v1/clearing/broker/list

Request

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

symbolstring

Trading pair

fundedboolean

Default value false if not set

statusstring

Filter by status

limit_ordersinteger

The maximum number of orders to return

accountstring

Required for Master API keys. The name of the account within the subaccount group.

Example request

{
  "nonce": "1495127793000",
  "expiration_start": "1495127793000",
  "expiration_end": "1495127793000",
  "submission_start": "1495127793000",
  "submission_end": "1495127793000",
  "timestamp": "1495127793000"
}

Response

Successful operation

resultstring

Status of the operation

Changes

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