Nexus/API Reference/Account and capabilities

What this key can trade right now

GEThttps://app.skylit.ai/api/nexus/v1/trading/capabilities

The asset classes, order types, futures contracts and futures accounts this key can trade right now, plus your per-key limits. Call it when your bot starts, so it asks instead of guessing.

Options and stocks always list market as their only order type. The futures block is there only when your account has futures paper trading. When it doesn't, the futures entry under assetClasses says why. The first call creates your futures practice account if you don't have one yet, as Nexus does when you open the futures ticket.

Authorization

Authorization: Bearer <your API key>

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

Responses

  • 200

    What you can trade.

  • 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.

  • 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
    • assetClassesobject[]

      One entry per asset class: assetClass, available, orderTypes, and reason when it isn't available.

    • orderTypesstring[]

      What every asset class takes (market). Futures list more under futures.

    • testOrdersboolean

      Whether "test": true is accepted.

    • futuresobject

      Only when your account has futures: marketOpen, reopensAt while closed, maxOrderQuantity, orderTypes, bracket, modify, the contracts you can trade (with the front month, tick size and value, commission, and whether there's a live price) and your accounts (each a FuturesAccount).

    • limitsobject

      Your per-key writesPerMinute and readsPerMinute.

Last updated

Was this page helpful?