Docs
Nexus/API Reference/Futures resting orders

Read one futures order

GEThttps://app.skylit.ai/api/nexus/v1/trading/accounts/{account}/orders/{orderId}

One order as it stands now, with its bracket. An order is looked up in the named account only, so the right id on the wrong account answers 404 order_not_found. A futures test order's id answers with the test order, marked "test": true.

Authorization

Authorization: Bearer <your API key>

Required. A missing header returns 401; an invalid, revoked or expired key returns 403.

Path parameters

  • accountstringrequired

    practice, evaluation or funded (when you have exactly one running), or a futures account id from capabilities.

  • orderIdstringuuidrequired

    The order's id, from the open, the working list or the history.

Responses

  • 200

    The order.

  • 401

    No key, or a key that isn't valid. Codes: missing_api_key, invalid_api_key.

  • 403

    The key works but the account can't do this. Codes: account_suspended, nexus_access_denied, futures_access_denied.

  • 404

    Not on your account. Codes: trade_not_found, account_not_found, order_not_found.

  • 429

    Over a rate limit. Wait Retry-After seconds, then retry. Code: rate_limited.

  • 503

    Try again in a moment (honour Retry-After when it's sent). Codes: stale_quote, no_live_price, rules_pending, unavailable, auth_unavailable, access_check_unavailable, api_keys_unavailable, trades_api_disabled.

Response fields

  • dataobject

    A futures order. It's not a Trade: futures keep their own book. Prices are in index points, money in cents.

    • idstringuuid
    • assetClassstring
      futures
    • sourcestring

      api when a key placed it. Left out on an order you placed in Nexus.

    • accountobject
    • symbolstring

      The contract, like NQZ26.

    • sidestring
      buysell
    • quantityinteger
    • rolestring
      entryclosestop_losstake_profit
    • orderTypestring
      marketlimitstop
    • statusstring

      held is a stop or target waiting for its entry to fill.

      workingheldfilledcancelledrejected
    • statusReasonstring

      Why it was cancelled or rejected.

    • limitPricenumber
    • stopPricenumber
    • trailingDistancenumber

      A trailing stop: how far behind the price it follows, in points.

    • fillPricenumber
    • placedAtstringdate-time
    • filledAtstringdate-time
    • parentIdstringuuid

      On a stop or target: the entry it was placed with.

    • bracketobject[]

      The stop and target placed with this order, each a FuturesOrder with its own id.

    • clientOrderIdstring
    • keyIdstring

      The public id of the key that placed it.

    • commissionCentsinteger
    • realizedPnlCentsinteger

      Gross realized P/L of this fill. 0 on a fill that only opened.

    • testboolean

      true on a test order.

Last updated

Was this page helpful?