Confirm Clearing Order
POSThttps://api.gemini.com/v1/clearing/confirm
Confirm the counterparty side of a bilateral clearing order before it is settled.
curl --request POST \
--url https://api.gemini.com/v1/clearing/confirm \
--header 'Content-Type: application/json' \
--header 'X-GEMINI-APIKEY: <string>' \
--header 'X-GEMINI-PAYLOAD: <string>' \
--header 'X-GEMINI-SIGNATURE: <string>' \
--data '
{
"request": "/v1/clearing/confirm",
"nonce": "<nonce>",
"clearing_id": "OM9VNL1G",
"symbol": "btcusd",
"amount": "100",
"price": "9500.00",
"side": "sell"
}
'
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.
Headers
X-GEMINI-APIKEYstring·required
Your API keyX-GEMINI-SIGNATUREstring·required
HEX-encoded HMAC-SHA384 of payload signed with API secretX-GEMINI-PAYLOADstring·required
Base64-encoded JSON payloadContent-Typestring
Default: text/plainContent-Lengthstring
Default: 0Cache-Controlstring
Default: no-cacheRequest Body
requeststring·required
The literal string "/v1/clearing/confirm"nonceTimestampType | integer·required
timestampExample: 1495127793000clearing_idstring·required
The clearing IDsymbolstring·required
The trading pairamountstring·required
The amount to tradepricestring·required
The pricesidestring·enum·required
The direction of the tradeEnum values: buysellaccountstring
Required for Master API keys. The name of the account within the subaccount group.{
"request": "/v1/clearing/confirm",
"nonce": "<nonce>",
"clearing_id": "OM9VNL1G",
"symbol": "btcusd",
"amount": "100",
"price": "9500.00",
"side": "sell"
}
Responses
Successful operation
resultstring
Status of the confirmation operation{
"result": "confirmed"
}
