GEgemini
Clearing

Create New Broker Order

Gemini Clearing also allows for brokers to facilitate trades between two Gemini customers. A broker can submit a new Gemini Clearing order that must then be confirmed by each counterparty before settlement.

post/v1/clearing/broker/new

Request

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

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 of the order

amountstring decimal required

Quoted decimal amount to purchase

expires_in_hrsinteger 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

side'buy' | 'sell' 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

accountstring

Required for Master API keys as described in 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.

Example request

{
  "nonce": "1495127793000"
}

Response

Successful operation

resultstring

Will return AwaitSourceTargetConfirm, meaning the order is waiting for both the source and the target parties to confirm the order

clearing_idstring

A unique identifier for the clearing order.

Changes

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