> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trdrs.co/llms.txt
> Use this file to discover all available pages before exploring further.

# How trdrs fits together

> One structure: a venue has providers, every provider says how it is signed into, the trader signs in once, and level 2 is optional. The words this site uses, and where to start for the job you have.

Every venue has providers. Every provider declares how it is signed into. Accounts on any
provider can optionally get level 2: rules on orders, stages and analytics, which read fills
from wherever that provider keeps them. The trader has one way in: sign in to trdrs.

```mermaid theme={null}
flowchart TD
  V["Venue<br/>brand · listing · keys"]
  V --> R["Rithmic<br/>login: trader's own · system name"]
  V --> T["Tastytrade<br/>login: OAuth"]
  V --> B["Binance, Bybit<br/>login: API key"]
  V --> H["Hyperliquid<br/>login: wallet key"]
  V --> P["trdrs paper book<br/>login: none · the firm issues accounts,<br/>or the trader opens their own Demo"]
  V --> O["A firm's own provider<br/>login: firm's credentials · public provider"]
  TR["Trader<br/>signs in to trdrs; the accounts the firm attached are in the list;<br/>a provider that needs its own login asks for it once"]
  R & T & B & H & P & O --> TR
  L2["Level 2, optional<br/>rules on orders · stages · analytics"]
  L2 -.-> V
```

* A firm such as **Tradeify** lists "Rithmic, system Tradeify". That is Tradeify bringing its
  Rithmic into its venue, on the built-in Rithmic provider, with the trader's own login. It keeps
  its own back office and stops at accounts.
* A firm such as **Meridian** issues evaluation accounts on the paper book and turns level 2 on.
* The trader never sees how the firm attached an account. They sign in and it is there. A
  provider that needs its own login asks for it once.
* One engine, two owners: a trader's own **Demo** is an account on the paper book the trader
  creates and governs. A firm-issued evaluation account runs on the same paper book under the
  firm's rules and is never called a demo.

## The words

One word per thing. These are the words every page on this site uses.

| Word                   | Means                                                                                                                    |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| **Venue**              | a firm's whole setup on trdrs: brand, listing, keys, providers, groups, accounts                                         |
| **Group**              | a set of accounts with one route and one set of rules. A prop firm or a broker is a group                                |
| **Provider**           | a market a venue's accounts trade through                                                                                |
| **Built-in provider**  | a provider we wrote: Rithmic, Tastytrade, Hyperliquid, Binance, Bybit, the trdrs paper book                              |
| **Public provider**    | a provider someone else wrote against the published provider contract and passed the self-check                          |
| **Login style**        | how a provider is signed into: trader's own login, OAuth, API key, wallet key, firm's credentials, none                  |
| **Paper book**         | our own simulated market. The engine under a trader's Demo and a firm's issued accounts                                  |
| **Demo**               | a trader's own practice account on the paper book. Only that                                                             |
| **Connect**            | the trader's account picker in the trading app                                                                           |
| **Listed**             | a venue approved to appear in Connect                                                                                    |
| **Level 2**            | the venue running rules, stages and analytics on its accounts. Optional                                                  |
| **Venue key**          | the one key a venue's backend uses                                                                                       |
| **Trading API key**    | the key a trader's own software uses for market data, orders and account state                                           |
| **Back office**        | the /developer page                                                                                                      |
| **Legacy Partner API** | the firm-operations half of the old Partner API, being replaced by venue routes. Pre-registration is Connect's and stays |

In the trading guides, the outside market where an order rests is "the market" or the provider's
name.

## What a venue can do, what a provider can do

One table per thing. "Applied" means an order from the trading app goes through it in the sandbox
and the trader sees the result; "saved" means the back office stores it and nothing on the order
path reads it yet.

### A venue

| A venue can                                                                                                                                    | Where                                      | Standing                                                                  |
| ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | ------------------------------------------------------------------------- |
| Set its brand: name, logo, blurb; get Listed so it appears in Connect                                                                          | Back office, Overview                      | Applied                                                                   |
| Hold one Venue key for its backend, and a key for pre-registering traders                                                                      | Back office, Developers                    | Applied                                                                   |
| Read its usage, the receipt of a balance operation, and the five per-account risk controls, and register webhooks, all with that one Venue key | Venue API, key or session                  | Applied; the legacy Partner routes stay until every firm portal has moved |
| Pick a provider its accounts trade through, from the ones it can plug in                                                                       | Providers tab, "Providers you can plug in" | Applied: the paper book and Hyperliquid today                             |
| Plug in a public provider: register its declaration, connect, validate, discover and bind accounts                                             | Providers tab                              | Built, preview; no real service has run through it                        |
| Show or hide a plugged-in provider to its own traders                                                                                          | Providers tab, "Shown to your traders"     | Applied; off by default                                                   |
| Issue accounts on the paper book into a group; list, credit, debit, reset, halt, resume, read analytics                                        | Accounts tab                               | Applied                                                                   |
| Run groups, each with one route and one set of rules; a prop firm or a broker is a group                                                       | Groups and routes                          | Applied                                                                   |
| List the instruments its accounts may trade, and turn each one on or off                                                                       | Instruments tab                            | Applied at the order                                                      |
| Set limits: order size, position size, notional, instrument list, entry halt                                                                   | Conditions tab                             | Applied at the order                                                      |
| Set its markup, its route's collar and its commission                                                                                          | Conditions and Routes tabs                 | Applied at the fill                                                       |
| Set margin, financing and a stop-out ratio                                                                                                     | Conditions tab                             | Saved; applied with broker groups                                         |
| Run stages: profit target, trading days, disqualifying rules, and a drawdown rule (static or trailing, daily or total)                         | Stages tab                                 | Applied; a breach flattens and locks                                      |
| Advance an account past a stage into a successor account in the next group                                                                     | Stages, eligibility and advance            | Applied                                                                   |
| Turn level 2 on or off                                                                                                                         | Overview, "Where setup stands"             | Applied; the first group turns it on                                      |
| Copy fills into its own provider account (hedging)                                                                                             |                                            | Not built                                                                 |
| Run stages and read analytics on accounts held at a provider, from the provider's records of their fills                                       | Stages and Accounts tabs                   | Applied; the advance and the drawdown rule stay on the paper book         |
| Apply its order limits, markup and commission to an account held at a provider                                                                 |                                            | Not built (item 7)                                                        |

### A provider

| A provider can                                                                                          | Built-in                                                                                                                                     | Public                                                      |
| ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
| Declare how it is signed into: trader's own login, OAuth, API key, wallet key, firm's credentials, none | Rithmic: trader's own login plus a system name · Tastytrade: OAuth · Hyperliquid: wallet key · Binance and Bybit: API key · paper book: none | In its declaration; firm's credentials when it says nothing |
| Be a tile a trader connects through in Connect                                                          | Rithmic, Tastytrade, Hyperliquid, Binance, Bybit                                                                                             | Once Listed                                                 |
| Be plugged into a venue as the market its accounts trade through                                        | Hyperliquid and the paper book today; Rithmic once a firm-credential path exists                                                             | Once it passes the self-check                               |
| Hold a firm-issued account and a trader's own Demo                                                      | The paper book                                                                                                                               | No                                                          |
| Take an order the venue's conditions admitted, with the venue's markup, collar and commission           | The paper book                                                                                                                               | Yes, over the provider contract                             |
| Report fills, positions and account state the venue reads                                               | The paper book (its own rows); the others through their own account view                                                                     | Yes, over the provider contract                             |
| Be the account a firm hedges into                                                                       |                                                                                                                                              | Not built                                                   |

A company can play several of these at once: Hyperliquid is a tile and a provider a venue can plug
in; Meridian runs a venue and is a tile because it is listed. Where a company shows up follows
from those roles.

## Who are you?

<CardGroup cols={2}>
  <Card title="A firm listing a built-in provider" icon="plug" href="/guides/brokers-overview">
    Like Tradeify: your traders already hold accounts at Rithmic or another built-in provider. Set
    up your venue, name the provider and system, get listed, and pre-register your traders so
    Connect shows their accounts ready to link.
  </Card>

  <Card title="A firm issuing accounts on the paper book" icon="building" href="/guides/prop-firms-overview">
    Like Meridian: you sell evaluations. Your venue issues the accounts, prices them, sets the
    stage rule, and governs them with a Venue key. Level 2 is yours to turn on.
  </Card>

  <Card title="Building a trading app" icon="code" href="/guides/build-a-front-end">
    You write the screens. Market data, orders, exits and account state over one base URL with a
    Trading API key, and the chart library the platform itself runs.
  </Card>

  <Card title="Writing a public provider" icon="server" href="/partner-platform/conformance/provider-self-check">
    You run a market, or a firm's own liquidity. Implement the provider contract, pass the
    self-check, and a venue can plug you in. A datafeed alone has a shorter path.
  </Card>
</CardGroup>

## Where each key fits

| Key                                                               | Held by                                                                   | Reaches                                                                                                                            |
| ----------------------------------------------------------------- | ------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| [Venue key](/guides/venue-keys) (`trdrs_vk_…`)                    | your venue's backend                                                      | `/api/partner/venues/{venueId}/…`: configuration, the venue's accounts, usage and webhooks, behind named scopes. One key is enough |
| [Trading API key](/partner-platform/overview/keys) (`trdrs_sk_…`) | a trader's own software, or your trading app's server                     | market data, news, trading, account state and risk controls for the accounts the key's owner holds                                 |
| Partner key (`trdrs_sk_…`)                                        | a firm's backend, for Connect pre-registration and the Legacy Partner API | `/api/partner/` outside the venue routes                                                                                           |
| Session                                                           | a signed-in person in a browser                                           | the trading app and the back office; `/api/operator/venues/…` for a venue owner                                                    |

A browser never holds a key. The back office uses the signed-in session for everything a person
does, and your backend holds the keys.

## Where to go next

<CardGroup cols={3}>
  <Card title="Quick Start" icon="rocket" href="/partner-platform/quick-start">
    A key, a first call, a venue, a first order.
  </Card>

  <Card title="Sandbox" icon="flask" href="/sandbox">
    The isolated environment every key here starts in.
  </Card>

  <Card title="Build" icon="hammer" href="/build">
    The guides, filed by layer: trading platform, Connect, venue, providers.
  </Card>
</CardGroup>
