Order

GET /order
Api key

Retrieve an order. Requires a valid API key sent with the x-api-key header.

Query parameters

  • id string Required

    ID of order

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • code integer

      Response code

    • msg string

      Diagnostic message

    • result object

      Request result

      Hide result attributes Show result attributes object
      • id string

        Unique identifier of order

      • pair string

        Market of order

      • price number

        Current price of order

      • price_orig number

        Original price of order

      • qty_orig number

        Original quantity of order

      • qty_orig_usd number

        Original USD quantity of order

      • qty_remaining number

        Quantity not yet filled

      • qty_filled number

        Quantity that has been filled

      • side string

        BUY or SELL

      • status string

        ACTIVE, CANCELLED or COMPLETED

      • time number

        Time of last update, in milliseconds

      • time_in_force string

        Time in force. Can be GTC (Good Till Cancelled), FOK (Fill Or Kill) or IOC (Immediate Or Cancel).

      • type string

        Type of order. Can be LIMIT or MARKET.

      • oco string

        OCO ID of order

      • icebergs number

        Icebergs on order

      • trigger_price number

        Trigger price of order

      • trigger_event string

        Trigger event of order. Can be MARK_PRICE, INDEX_PRICE, LAST_PRICE or null.

      • close_on_trigger boolean
      • reduce_only boolean

        If true, the order can only decrease the size of your position.

      • post_only boolean

        If true, the order can only trade as maker.

      • hidden boolean

        If true, the order does not show in the order book.
  • 503 application/json

    Error

    Hide response attributes Show response attributes object
    • code integer
    • msg string
    • result object
GET /order 
curl \
 --request GET 'https://api.testnet.everstrike.io/order?id=string' \
 --header "x-api-key: $API_KEY"
Response examples (200) 
{
  "code": 200,
  "msg": "null",
  "result": {
    "id": "781a8e80393f11e98e2643f8c5a993ce",
    "oco": null,
    "pair": "USD_BTCCALL_PERP",
    "side": "SELL",
    "time": 1551128037224,
    "type": "LIMIT",
    "fills": [],
    "price": 200,
    "hidden": false,
    "status": "ACTIVE",
    "icebergs": null,
    "qty_orig": 0.02225,
    "post_only": false,
    "price_orig": 200,
    "reduce_only": false,
    "qty_orig_usd": 3.09956993634425,
    "qty_remaining": 0.02225,
    "time_in_force": "GTC",
    "trigger_event": null,
    "trigger_price": null,
    "close_on_trigger": false
  }
}
Response examples (503) 
{
  "code": 503,
  "msg": "Invalid request",
  "result": {}
}