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:create assigned to access this endpoint. See OAuth Scopes for more information.
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
Request Body
requeststring·required
The literal string "/v1/clearing/broker/new"
nonceTimestampType | integer·required
timestampExample: 1495127793000
source_counterparty_idstring·required
A symbol that corresponds with the counterparty sourcing the clearing trade
target_counterparty_idstring·required
A symbol that corresponds with the counterparty where the clearing trade is targeted
symbolstring·required
The [symbol](/market-data/symbols-and-minimums) of the order
amountstring (decimal)·required
Quoted decimal amount to purchase
expires_in_hrsinteger (float)·required
The number of hours before the trade expires. Your counterparty will need to confirm the order before this time expires.
pricestring (decimal)·required
Quoted decimal amount to spend per unit
sidestring·enum·required
"buy" or "sell". This side will be assigned to the `source_counterparty_id`. The opposite side will be sent to the `target_counterparty_id`Enum values: buysell
accountstring
Required for Master API keys as described in [Private API Invocation](/authentication/api-key#private-api-invocation). The name of the account within the subaccount group. Specifies the broker account on which to place the order. Only available for exchange accounts.
