GEgemini
Orders

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

post/v1/wrap/{symbol}

Request

  • Base URL
    https://api.gemini.com
  • URL
    https://api.gemini.com/v1/wrap/{symbol}
  • Auth
    API key in header X-GEMINI-APIKEY and API key in header X-GEMINI-SIGNATURE and API key in header X-GEMINI-PAYLOAD

Path parameters

symbolstring required

Trading pair symbol <br /> <br />

BTCUSD, etc. See <u>symbols and minimums</u>.

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/wrap/symbol"

amountstring required

The amount to wrap

side'buy' | 'sell'

"buy" or "sell"

client_order_idstring

A client-specified order id

accountstring

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

Example request

{
  "nonce": "1495127793000"
}

Response

Successful operation

orderIdstring

The order ID

pairstring

Trading pair symbol

pricestring

The price of the order

priceCurrencystring

The currency in which the order is priced

sidestring

Either "buy" or "sell"

quantitystring

The amount that was executed

quantityCurrencystring

The currency label for the quantity field

totalSpendstring

Total quantity spent for the order

totalSpendCurrencystring

Currency of the totalSpend

feestring

The amount charged

feeCurrencystring

Currency that the fee was paid in

depositFeestring

The deposit fee quantity

depositFeeCurrencystring

Currency in which depositFee is taken

Changes

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