GEgemini
Clearing

Create New Clearing Order

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:create assigned to access this endpoint. See OAuth Scopes for more information.

post/v1/clearing/new

Request

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

symbolstring required

The trading pair

amountstring required

The amount to trade

pricestring required

The price

side'buy' | 'sell' required

The direction of the trade

counterparty_idstring

The counterparty ID

expires_in_hrsinteger

The number of hours until the order expires

accountstring

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

Example request

{
  "nonce": "1495127793000"
}

Response

Successful operation

clearing_idstring

The clearing ID

symbolstring

The trading pair

pricestring

The order price

amountstring

The order amount

side'buy' | 'sell'
statusstring

The order status

timestampmsinteger

The timestamp in milliseconds

is_confirmedboolean

Whether the order is confirmed

Example response

{
  "timestamp": "1495127793000"
}

Changes

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