Docs
Nexus/API Reference/Futures

Read a futures account

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

Balance, open and day P/L, positions, what rests on the account, and for an evaluation or funded account the rule meter (room to the daily loss limit and the max loss floor, the profit target, the contract cap). Every number is the one the Nexus account panel shows.

Open P/L, equity and day P/L are left out when a held contract has no live price. A number nobody measured isn't sent. Reads work on any of your accounts, challenge entries and ended accounts included.

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.

Responses

  • 200

    The account.

  • 400

    The request was refused before anything was traded. Codes: bad_request, bad_contract, invalid_quantity, invalid_price, unsupported_asset_class, unsupported_order_type, only_market_orders, test_orders_unavailable, test_modify_unavailable.

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

  • 422

    Read fine, but the market or the account says no. Codes: market_closed, contract_expired, contract_not_offered, price_outside_market, insufficient_buying_power, account_not_tradable, account_ambiguous, reduce_only_would_open, order_refused.

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

      A FuturesAccount plus statusReason, startingBalanceCents, dayStartBalanceCents, tradingDay, and when every position is priced openPnlCents, equityCents and dayPnlCents.

    • positionsobject[]
    • workingOrdersobject[]
    • rulesobject

      Evaluation and funded accounts only: the rule meter, as the Nexus account panel reads it. Room to the daily loss limit (toDailyLimitCents), to the max loss floor (toMaxLossCents), to the profit target (toTargetCents), the contract cap (maxContracts, openContracts), trading days and what blocks a pass (passBlockedBy).

Last updated

Was this page helpful?