Docs
Nexus/API Reference/Options and stocks

List your options and stock trades

GEThttps://app.skylit.ai/api/nexus/v1/trades

Your own options and stock trades, newest first. Futures aren't listed here: read them with the futures account and order history routes.

With test=true it lists your test log instead (your 10 newest test orders, futures ones included) and never a real trade.

Authorization

Authorization: Bearer <your API key>

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

Query parameters

  • statusstringdefault all

    Which trades to list.

    openclosedall
  • limitintegerdefault 50min 1 · max 200

    Page size. Anything over 200 is read as 200.

  • offsetintegerdefault 0min 0 · max 100000

    How many trades to skip.

  • teststringdefault false

    true lists your test log instead of your trades.

    truefalse

Responses

  • 200

    Your trades. meta.total counts every match, not just this page.

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

  • 429

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

Response fields

  • dataobject[]
    • idstringuuid
    • userIdstringuuid
    • tickerstring
    • strikenumber
    • expirationstringdate
    • directionstring
      callput
    • assetClassstring
      optionsstocks
    • averageEntryPricenumber
    • currentPricenumber

      The latest mark.

    • totalQuantityinteger
    • remainingQuantityinteger
    • statusstring
      activeclosed
    • entryDatestringdate-time
    • exitDatestringdate-time
    • exitsobject[]
    • sourcestring

      api on a trade a key opened.

    • testboolean

      true on a test order.

  • metaobject
    • totalinteger
    • limitinteger
    • offsetinteger
    • testboolean

      With test=true: this is your test log.

    • maxRowsinteger

      With test=true: how many test orders the log keeps (10).

Last updated

Was this page helpful?