Nexus/API Reference/Ports

List your ports

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

Your live ports, Main and Bot first, and the limits that apply to them.

  • Money here is in dollars, not cents: cashBalance: 24100 is $24,100.00.
  • account is what to send beside the port on an order or a read: agent for Bot and every extra port, null for Main (send it with account left out).
  • Read limits instead of hard-coding them.

If ports are ever switched off on the server, this answers 403 feature_disabled. It counts as a read.

Authorization

Authorization: Bearer <your API key>

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

Responses

  • 200

    Your ports and the limits.

  • 401

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

  • 403

    The key works but this can't be done. Codes: feature_disabled (ports are switched off on the server: leave port out), account_suspended, nexus_access_denied.

  • 429

    Over a rate limit. Wait Retry-After seconds, then retry. Codes: rate_limited, and stream_limit_reached (too many live streams open: 3 per key, 6 per account).

  • 500

    Something went wrong on our side. If you sent a clientOrderId, retry with the same one. Code: internal_error.

Response fields

  • dataobject
    • portsobject[]
    • limitsobject

Last updated

Was this page helpful?