GEgemini
Orders

Get Order Status

<div class="p-4 text-sm section-icon section-info rounded-sm" role="alert"> <div class="flex"> <svg view-box="0 0 24 24" > <path fill-rule="evenodd" clip-rule="evenodd" d="M4 12C4 7.58172 7.58172 4 12 4C16.4183 4 20 7.58172 20 12C20 16.4183 16.4183 20 12 20C7.58172 20 4 16.4183 4 12ZM12 2C6.47715 2 2 6.47715 2 12C2 17.5228 6.47715 22 12 22C17.5228 22 22 17.5228 22 12C22 6.47715 17.5228 2 12 2ZM11 17V11H13V17H11ZM11 9V7H13V9H11Z" /> </svg> <div>Gemini recommends using our <a href="/websocket/order-events/about">WebSocket Order Events</a> API to receive order status changes. It's much better because you'll be notified of order status changes as they happen.</div> </div> <p>Under the terms of the <a href="https://www.gemini.com/legal/api-agreement">Gemini API Agreement</a>, polling this endpoint may be subject to <a href="/rate-limit">rate limiting</a>.</p> <p>Enabled for perpetuals accounts from July 10th, 0100hrs ET onwards. Trade info for all perpetuals orders submitted prior to this timing, will not be available through this API.</p> </div>

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

post/v1/order/status

Request

  • Base URL
    https://api.gemini.com
  • URL
    https://api.gemini.com/v1/order/status
  • 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 API endpoint path

accountstring

Required for Master API keys as described in Private API Invocation. The name of the account within the subaccount group. Specifies the account on which you intend to place the order. Only available for exchange accounts.

order_idinteger required

The order id to get information on. The order_id represents a whole number and is transmitted as an unsigned 64-bit integer in JSON format. order_id cannot be used in combination with client_order_id.

client_order_idstring

The client_order_id used when placing the order. client_order_id cannot be used in combination with order_id

include_tradesboolean

Either True or False. If True the endpoint will return individual trade details of all fills from the order.

Example request

{
  "request": "/v1/order/status",
  "nonce": "1495127793000",
  "account": "primary",
  "order_id": 123456789012345
}

Response

The order status

order_idstring integer

The order id

client_order_idstring integer

An optional client-specified order id

symbolstring

The symbol of the order

exchangestring

Will always be "gemini"

pricestring decimal

The price the order was issued at

avg_execution_pricestring decimal

The average price at which this order as been executed so far. 0 if the order has not been executed at all.

side'buy' | 'sell'
type'exchange limit' | 'exchange stop limit' | 'exchange market'

Description of the order

optionsstring[]

An array containing at most one supported order execution option. See Order execution options for details.

is_liveboolean

true if the order is active on the book (has remaining quantity and has not been canceled)

is_cancelledboolean

true if the order has been canceled. Note the spelling, "cancelled" instead of "canceled". This is for compatibility reasons.

reasonstring

Populated with the reason your order was canceled, if available.

was_forcedboolean

Will always be false.

executed_amountstring decimal

The amount of the order that has been filled.

remaining_amountstring decimal

The amount of the order that has not been filled.

original_amountstring decimal

The originally submitted amount of the order.

is_hiddenboolean

Will always return false.

Example response

{
  "timestamp": "1495127793000",
  "timestampms": "1495127793000",
  "trades": [
    {
      "timestamp": "1495127793000",
      "timestampms": "1495127793000",
      "type": "Buy",
      "fee_currency": "USD",
      "fee_amount": "1.23",
      "tid": 17379712930,
      "exchange": "gemini"
    }
  ]
}

Changes

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