For AI agents: the documentation index is at /llms.txt, and this page is available as Markdown at /institutional/manage-clients.md.

Manage clients

A client is an account we set up under your firm for one of the parties you trade for. Every order names a client, so you need your client ids even on a principal account, which has one client for your firm. Read your clients and change their self-trade prevention setting here.

We create your clients when we set up your account. Through the API you can read them and change one setting, self-trade prevention. There is no public endpoint to create a client.

Self-trade prevention (STP) stops an order from filling against another order from the same client. Depending on the setting, the exchange cancels the incoming order or both orders.

How you use clients

Each client has an id, and every order carries one in client_id. Over REST, your JWT carries your client id, so you can leave client_id out. How you choose it depends on your account model:

  • Principal: you have one client, your firm, and every order uses its id.

  • Fully disclosed: each disclosed client has its own id, and you book each order to one of them.

  • Omnibus agency: orders book to your pooled account's client, and you allocate fills afterwards from your drop copy feed.

Next: Trade over FIX

Was this page helpful?YesNo