Add connection wizard: broker, connection rail, credentials
The three-step wizard of the Connection Manager creates or edits a broker profile: pick a broker from the catalog, pick the connection rail and environment it really offers, then fill the credentials, test the login and save.
Senzoukria · Documentation · Updated September 2026
Where to find it
- Where
- Broker Connections → Connections tab → + Add connection (Edit opens step 3 directly)
- Steps
- 1 · Broker → 2 · Connection → 3 · Credentials
- Defaults
- Environment Eval on a new profile; Connect automatically at startup off; Trading stays off
What it does
Step 1 · Broker shows the catalog as tiles, each with its kind: Prop firm, Broker, Bridge or Direct. Step 2 · Connection lists the rails that broker offers. A rail that is not implemented carries a Coming soon badge; the NinjaTrader and Quantower bridges carry Windows only outside Windows. Each Rithmic rail shows the broker's help text and one button per environment with the broker's own label, for example Evaluation or Performance Account (PA); a rail without presets offers Configure manually.
Choosing an environment sets the environment, the system name and the gateway URL as one block, because those three values are only valid together: the wrong pair is refused by Rithmic with rp_code 13, a code that looks like a rights problem. The connection name is prefilled, when empty, as the broker name, an em dash and the broker’s own label for the environment picked.
Step 3 · Credentials holds the form, the Test connection and Save connection buttons, and three helpers: the step-by-step connect assistant, the explanatory connection guide, and the preflight diagnostic that runs only on click.
Settings
| Field | Default | What it changes |
|---|---|---|
| Connection name | Broker — environment label | Label of the card; required |
| Environment | The one picked at step 2 (Eval on a blank profile) | Select limited to the environments of the chosen broker, with its labels; a legacy value shows as {env} — custom. Changing it also resets system name and gateway |
| System name | From the catalog | Rithmic system of the account, for example Apex or Rithmic Paper Trading. Becomes a select after Fetch live system list from gateway |
| Access point | Chicago (core) | Network entry to Rithmic production; rewrites the Gateway URL. Disabled for the Rithmic Test system |
| Gateway URL | From the catalog | Must start with wss:// |
| Username | empty | Required. Prop-firm accounts use a short code; direct Rithmic accounts normally use the email address |
| Password | empty | Required on a new profile; in edit mode, blank keeps the stored password |
| Connect automatically at startup | Off | Starts this profile when the app opens |
How to use it
- Pick the broker, then the environment button that matches the account you were issued; do not type a system name by hand unless you chose Custom (Rithmic).
- Type the username and password, click Test connection: it opens a socket, logs in and closes. Login OK — credentials are valid confirms the triplet and the password.
- If the test fails, run the preflight diagnostic under the form: it measures gateway, system, route, login, subscription and first tick separately, and the guide opens at the failing stage.
- Save connection. Trading is not enabled by saving; turn it on from the card when needed.
Validation and warnings
- Save and Test refuse, in order: no broker (Pick a broker first), empty name, empty username, empty system name, a gateway that does not start with wss://, and a missing password when none is stored.
- A system name that is not one of the chosen broker's systems is refused with a message listing the expected systems, unless the live list fetched from the current gateway contains it: the broker's gateway has authority over the built-in catalog.
- Funded environment: a notice says order routing stays disabled on this profile until you explicitly enable it from the connection card; market data and account feed are unaffected.
- Direct vendor or retail broker with the system Rithmic Paper Trading: a notice explains that a free Rithmic demo (the 14-day trial) cannot connect, because Rithmic does not offer the R | Protocol API to demo accounts.
- Test connection needs the password typed in the form; the stored one never leaves the vault.
Related pages
- Connection Manager
- Rithmic connection and gateways
- Rithmic footprint software
- Quantower orderflow bridge
This page in other languages
Frequently asked questions
- Why does the wizard refuse my system name?
- It is not among the systems the selected broker uses. A Lucid account presented to another firm's system is simply unknown there, and Rithmic answers permission denied. Load the live list from the gateway to confirm a system the catalog does not know yet.
- Can I change the password without retyping everything?
- Yes. Edit opens step 3 with the stored fields; only the password field is blank. Type a new one to replace it, or leave it blank to keep the stored secret.