Nexus/API Reference/Ports

Rename a port

PATCHhttps://app.skylit.ai/api/nexus/v1/trading/ports/{id}

Give a port a new name, Main and Bot included. The same rename sent twice is the same rename (200). It counts as a write.

POST .../restart and .../ranked answer 405 web_only: restarting and ranking a port are only in Nexus, signed in as yourself. POST .../archive answers 405 use_delete: delete a port with DELETE on this path.

Authorization

Authorization: Bearer <your API key>

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

Path parameters

  • idstringuuidrequired

    The port's id, from the list.

Request body

  • namestringrequired

Responses

  • 200

    The renamed port.

  • 400

    The request was refused and nothing changed. Codes: bad_request (an unknown field or a body that isn't JSON), bad_name (1 to 32 characters, no control characters), bad_starting_cash (missing, or not one of limits.startingCashChoices).

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

  • 404

    Code: port_not_found. No live port with that id on your account. Someone else's port answers the same.

  • 409

    Codes: port_limit (you already have 5 ports: delete one first), name_taken (a live port of yours already has that name, whatever the capitals; a retried create lands here too).

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

      One of your ports. Money is in dollars.

Last updated

Was this page helpful?