> ## 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. # Read the trdrs-managed provider catalog > Preview: served on the sandbox to every venue, and production availability is arranged when a venue qualifies. Trading API keys and pre-registration keys do not authorize these routes. Required scope: `venue:read`. Only trdrs-approved versions for this environment are returned. Private integrations stay with their venue. No connection, credential or execution permission is shared. ## OpenAPI ````yaml /api/openapi.json get /api/venues/{venueId}/provider-catalog/directory openapi: 3.1.0 info: title: trdrs Engine API version: 1.1.0 description: >- ## API Reference Every route the trdrs engine serves, with what to send and what comes back. It covers market data and news, trading and account state for a trader's own software, the Connect API a Connect app's backend calls and the Connect dashboard's routes, Connect pre-registration, the statements that carry a Connect account between environments, the venue routes a prop firm or brokerage runs its accounts through, and a trader's own challenges. Start with the Quickstart for your first call. The API standards hold the rules every route shares: keys, errors, rate limits, idempotency, paging and streaming. servers: - url: https://app.trdrs.co description: Production - url: / description: This engine security: [] tags: - name: Venue platform preview description: >- Run your venue: its providers, instruments, conditions, groups, routes, stages, venue rules, keys, accounts, usage, balance receipts and webhooks. These routes are in preview. They are served on the sandbox to every venue, and production access is arranged when a venue qualifies. Every route here under `/api/venues/` takes a Venue key. The back office reaches the same routes under `/api/back-office/` with a verified owner’s session, because the Venue key stays on your server, and both run the same checks. The team’s routes under `/api/organizations` serve the back office and the Connect dashboard alike, since one organization can run venues and Connect apps with one team. - name: Market data description: >- Search and look up symbols, read price history and quotes, check the server clock, and stream live bars. Crypto prices come from each provider’s public feed. Futures prices are licensed to each user and stream only from that trader’s own futures source: a login on their venue’s production Rithmic system, under their own market data subscription. A Rithmic Test login carries no market data. Futures reach the trader’s own signed-in session, and a venue’s or Connect app’s backend acting for its trader. A Trading API key reads crypto market data only. Without a source, a futures request answers 503 `feed_requires_connection` and the symbol search lists no futures. - name: News description: >- Market news and the economic calendar, from licensed and open sources, tagged with futures roots as they arrive. The content is the same for everyone, and these routes admit the same callers as market data: a licensed origin, a session or a Trading API key. Page headlines by publish time, filter them by instrument root, and stream them live over server-sent events. Thumbnails come through the image route. - name: Trading description: >- Place, change and cancel orders, protect a position with a bracket and change or withdraw it, and close or flatten positions. Every call that places an order takes a `clientOrderId` as its idempotency key. - name: Account description: >- Read an account a trader can trade: its balance, positions, working orders, fills, profit and loss history, and the live account stream. You don’t create accounts here. A trader connects their own account at a provider, or opens their own Demo on the paper book, in the trdrs app. A venue issues accounts on the paper book with Issue an account into a group, and a venue pre-registers accounts at a provider through Connect with Pre-register a trader’s account. - name: Connect description: >- Connect is the account picker a trader opens: in the trdrs app, where it lists the built-in providers and every listed venue, and in hosted Connect on a Connect app’s website, where it lists the tiles the app chose. The pre-registration routes let a venue fill Connect in the trdrs app ahead of time, for a trader who signs in to trdrs. You tell trdrs that a trader has an account at a built-in provider: their sign-in email, and optionally the account number and login name. When that trader signs in, Connect shows the account ready to link, and they sign in to the provider themselves, once. The trader types their own password, and access starts when their own login succeeds. You can list who you pre-registered and who has linked, and cancel a pre-registration that hasn’t been used. A pre-registration expires after 30 days, and sending it again refreshes it. These routes take the pre-registration key. [Register an account](/guides/register-an-account) walks through the whole flow. - name: Connect apps preview description: >- Run a Connect app: your own trading interface, whose traders connect their accounts in hosted Connect on your website and trade them on your screens. The Connect API is what your backend calls with your app’s API key: Create a Connect link, read and close it, and the account, market and trading routes with your trader named in `x-trdrs-trader`. Hosted Connect calls its own routes with the frame session a Connect link opens. The Connect dashboard calls the rest with your Connect sign-in session: your apps, each app’s name and logo, API keys, websites, tiles, white-label paper and Demos, traders and active traders, invoices, conformance runs and its Connect pass. These routes are in preview, served on the sandbox, where they are free. An app’s production opens when production records the app’s Connect pass, which the sandbox signs once the app passes its Connect conformance run. - name: Connect accounts description: >- A Connect client's team signs in to the Connect dashboard with a Connect account of its own, never a trader's, and one login reaches both environments. Production answers a short statement for the signed-in account, naming its verified email and the Connect apps it owns, and sandbox exchanges it for a sandbox session and the counterpart app of each: the sandbox app that stands for the production one. The environments share no credential: production signs the statement with its own key, and sandbox checks it with production's public key alone. These routes take the Connect dashboard's own session, from the dashboard's origin; a trader's session and every key are refused, and a Connect account's session reaches no trading, account, market or AI route. - name: Challenges description: >- List evaluation programs, enroll in one, and read a trader’s own enrollments and their history. **Preview: outside the additive-only promise**, so these shapes can change; see Versioning and stability. **They take a signed-in session, not a key**, and exist only on an engine that runs with `CHALLENGES_ENABLED`. Anywhere else every one answers `404`. paths: /api/venues/{venueId}/provider-catalog/directory: get: tags: - Venue platform preview summary: Read the trdrs-managed provider catalog description: >- Preview: served on the sandbox to every venue, and production availability is arranged when a venue qualifies. Trading API keys and pre-registration keys do not authorize these routes. Required scope: `venue:read`. Only trdrs-approved versions for this environment are returned. Private integrations stay with their venue. No connection, credential or execution permission is shared. parameters: - name: venueId in: path required: true schema: type: string format: uuid - name: after in: query schema: type: string format: uuid responses: '200': description: >- Success. The response is sent with `Cache-Control: no-store`, so don't cache it. content: application/json: schema: $ref: '#/components/schemas/ProviderDirectoryResponse' '400': description: >- The request is malformed: invalid JSON or input, a bad cursor, or a missing `Idempotency-Key` or `If-Match` header. When one value is refused, `field` names it where the check can say which. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: >- The Venue key or the session is missing, malformed, revoked or expired. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: >- The credential is valid but can't do this: the key lacks the scope or its creator is no longer an owner, the email isn't verified, a reader tried to write, or the request came from an origin that isn't trusted. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: >- The venue, account or resource doesn't exist in this environment, or isn't yours to see. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: >- The request conflicts with what is stored: the `Idempotency-Key` was used with a different body, or the version you sent is stale. The `error` code names the conflict. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '413': description: The body is larger than this route accepts. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '415': description: 'Send the body as JSON, with `Content-Type: application/json`.' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '503': description: >- trdrs can't complete the request right now, because a part of the venue platform or its credential store is unavailable. Don't assume a write happened: retry it with the same `Idempotency-Key`. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - venueKey: [] x-codeSamples: - lang: javascript label: TypeScript source: >- const res = await fetch('https://app.trdrs.co/api/venues/{venueId}/provider-catalog/directory', { headers: { Authorization: `Bearer ${process.env.TRDRS_VENUE_KEY}` }, }) const data = await res.json() - lang: shell label: cURL source: >- curl 'https://app.trdrs.co/api/venues/{venueId}/provider-catalog/directory' \ -H "Authorization: Bearer $TRDRS_VENUE_KEY" components: schemas: ProviderDirectoryResponse: type: object additionalProperties: false properties: items: type: array items: $ref: '#/components/schemas/ProviderDirectoryItem' builtIns: type: array items: $ref: '#/components/schemas/CompanyRecord' nextCursor: type: - string - 'null' format: uuid required: - items - builtIns - nextCursor example: items: [] builtIns: [] nextCursor: null ErrorResponse: type: object description: >- The body of every error response. It always carries `error`, an English sentence you can show. A refused trading request also carries `code`, one of the refusal codes, and `params`, the details of that refusal. Translate by `code` and `params`, and show a generic message for a code you don't recognize. Other errors may carry a `code` of their own. properties: error: type: string description: What went wrong, as an English sentence. code: type: string description: >- A stable machine code. On a refused trading request, it is one of the refusal codes. params: type: object description: >- The details of the refusal named by `code`, on a refused trading request. required: - error example: error: invalid_instrument ProviderDirectoryItem: type: object additionalProperties: false properties: company: $ref: '#/components/schemas/CompanyRecord' profile: $ref: '#/components/schemas/ProviderProfile' releases: type: array items: $ref: '#/components/schemas/ProviderRelease' executionPermission: const: false required: - company - profile - releases - executionPermission CompanyRecord: type: object additionalProperties: false properties: id: type: string format: uuid name: type: string blurb: type: - string - 'null' logoUrl: type: - string - 'null' logoBleed: type: boolean referralUrl: type: - string - 'null' sortOrder: type: integer builtInProvider: type: - string - 'null' enum: - rithmic - tastytrade - hyperliquid - binance - bybit - paper - null description: >- On a built-in provider's company, its provider id; null on a venue's or a public provider's. listingState: type: string enum: - draft - conformance_passed - submitted - in_review - changes_requested - approved - listed - suspended slug: type: string pattern: ^[a-z0-9]+(-[a-z0-9]+)*$ maxLength: 40 description: >- The company's name in the API, the same in sandbox and production: a built-in provider's provider id, or one made from the company's name when it was created. It can change until the company is approved, and is fixed from then on. enabled: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - name - blurb - logoUrl - logoBleed - referralUrl - sortOrder - builtInProvider - listingState - slug - enabled - createdAt - updatedAt description: >- A company on trdrs: one venue or one provider, with its brand, its listing state and its slug. Each of the six built-in providers is a company with `builtInProvider` set, and what it is and does (its kind, the asset classes its route takes, whether a venue can plug it in and how it is signed into) is its row in the provider table, which `GET /api/connect/providers` lists. ProviderProfile: type: object additionalProperties: false properties: companyId: type: string format: uuid documentationUrl: type: string format: uri connectionGuideUrl: type: string format: uri contactEmail: type: string format: email requirements: type: string assetClasses: type: array items: type: string integrationNote: type: string visibility: const: public version: type: integer minimum: 1 required: - companyId - documentationUrl - connectionGuideUrl - contactEmail - requirements - assetClasses - integrationNote - visibility - version ProviderRelease: type: object additionalProperties: false properties: id: type: string format: uuid manifest: $ref: '#/components/schemas/VenueProviderManifest' manifestHash: type: string profileVersion: type: integer state: const: listed connector: type: object additionalProperties: false properties: implementationDigest: type: string sourceRevision: type: string configurationSchemaHash: type: string connectionMode: const: dedicated productModels: type: array items: type: string enum: - linear_future - linear_spot - linear_perpetual - linear_cfd credentialIdLabel: type: string credentialLabel: type: string required: - implementationDigest - sourceRevision - configurationSchemaHash - connectionMode - productModels - credentialIdLabel - credentialLabel environment: type: string enum: - sandbox - production setup: const: dedicated createdAt: type: string format: date-time required: - id - manifest - manifestHash - profileVersion - state - connector - environment - setup - createdAt VenueProviderManifest: type: object additionalProperties: false properties: providerVersion: type: string protocolVersion: const: '1.0' schemaDigest: type: string pattern: ^[a-f0-9]{64}$ capabilities: type: object additionalProperties: false properties: accounts: type: boolean execution: type: boolean marketData: type: boolean generationFencing: type: boolean completeOrderBook: type: boolean executionHistory: type: boolean executionCorrections: type: boolean orderTypes: type: array items: type: string enum: - market - limit - stop - stop_limit timeInForce: type: array items: type: string enum: - day - gtc - ioc - fok - post_only reduceOnly: type: boolean nativeReplace: type: boolean nativeOco: type: boolean accountProvisioning: type: boolean positionModels: type: array items: type: string enum: - net - hedged replayRetentionSeconds: type: integer minimum: 0 maximum: 31536000 required: - accounts - execution - marketData - generationFencing - completeOrderBook - executionHistory - executionCorrections - orderTypes - timeInForce - reduceOnly - nativeReplace - nativeOco - accountProvisioning - positionModels - replayRetentionSeconds required: - providerVersion - protocolVersion - schemaDigest - capabilities description: >- A public provider's declaration of what it supports, checked against the provider contract. A provider must offer accounts, market data or both. One that offers execution must also offer accounts, generation fencing, a complete order book and execution history, keep at least seven days of replay, and list at least one order type, time in force and position model; one that doesn't can't declare any execution feature, and account provisioning and position models need accounts. Lists hold no duplicates, and registering a manifest doesn't certify its claims. securitySchemes: venueKey: type: http scheme: bearer description: >- The Venue key (`trdrs_vk_sandbox_…` or `trdrs_vk_production_…`), in preview. It belongs to one venue in one environment and carries the scopes it was created with. The venue's verified owner creates it while signed in. It works on the `/api/venues/{venueId}` routes and, with `trader:read` or `trader:trade`, on the account, market and trading routes, reading the venue's own traders' accounts and routing their orders, each request naming its trader in `x-trdrs-trader`. A `trdrs_sk_…` key can't be used in its place. It reaches its venue's routes and its venue's own traders, and the owner manages keys from a signed-in session. Keep it on your server. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.