> ## 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. # Turn venue rules on or off > Turns venue rules, your own order limits, stages and analytics on the accounts you issue, on or off. Creating your first group turns them on, so use this to turn them off again or back on by hand. With them off, your settings stay saved but aren't applied to trading, and the response is the venue with its new setting. Required scope: `venue:configure`. Preview: served on the sandbox to every venue, and production availability is arranged when a venue qualifies. Trading API keys and Partner keys do not authorize these routes. ## OpenAPI ````yaml /api/openapi.json post /api/partner/venues/{venueId}/rules 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, Connect pre-registration, the venue routes a prop firm or brokerage runs its accounts through, and the Legacy Partner API. 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/partner/` takes a Venue key. The back office reaches the same routes under `/api/operator/` with a verified owner’s session, because a browser never holds a Venue key, and both run the same checks. Changes to these routes are additive only from here on, and the Legacy Partner API routes stay as they are. - 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 from your own login at a provider that carries them, so without one connected, a futures request answers 503 `feed_requires_connection`. - 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, set a position’s exits, 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 firm 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 or embedded on a firm’s site. It lists the built-in providers and every listed venue. The pre-registration routes let a firm fill it in ahead of time. 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. Nothing here sends a password or grants access before the trader’s 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 Partner key. They belong to Connect, not to the Legacy Partner API. The whole flow is in the **[Quick Start](/docs/guides/quick-start)**. - name: Firm accounts (legacy) description: >- Legacy Partner API. Each route here has a venue twin under `/api/partner/venues/{venueId}/accounts…`, which takes a Venue key and a named scope, and new integrations use those. This group stays for firms that predate venues, and both run the same operation. These routes issue and manage evaluation accounts on the paper book with your Partner key: the trader trades them on trdrs, and your firm owns their lifecycle. Every route sees only the accounts your firm created through this API, so an account the same trader opened themselves is invisible here. Creation is batched with a result per item, and every write carries your own `referenceId`, so a pipeline that crashes can retry safely. These routes are served where the engine runs prop evaluations. Elsewhere, every route in this group answers `404`. - name: Billing description: >- Legacy Partner API, per firm. What your firm is billed for in a month, counted from its fills, and the accounts behind the number. The venue routes Read the venue’s metered usage for a month and Read the accounts behind the venue’s usage replace these, which still take the Partner key. - name: Webhooks description: >- Legacy Partner API. The venue routes Register a webhook, List the venue’s webhooks and Read a webhook’s delivery log replace these, with a Venue key, and an endpoint registered either way receives the same events. Register an https endpoint, and trdrs pushes events to it, so your back office doesn’t have to poll. Every delivery is signed (`trdrs-signature: t=,v1=` over `${t}.${rawBody}`), so you can prove it came from trdrs and is fresh. Every delivery is also durable: a failed attempt is retried with backoff for about nine hours, and the whole log is readable, so an endpoint that was down gets its events late rather than never. The pre-registration events (`registration.*`) fire wherever Connect runs, and the account events fire where the engine runs prop evaluations. - name: Challenges description: >- Legacy Partner API. Stage policies on a venue replace the firm’s half of this, and the trader’s enrollment flow has not moved yet. These routes list evaluation programs and a trader’s own enrollments. **Preview: the one group in this reference outside the additive-only guarantee.** Their shapes will change when challenges are rebuilt; see Stability. **They take a signed-in session, not a key**, and are served only where the engine runs with `CHALLENGES_ENABLED`. Without it, the routes don’t exist and every one answers `404`. The administration half isn’t documented here, because it is trdrs’s own tooling, not part of the API. paths: /api/partner/venues/{venueId}/rules: post: tags: - Venue platform preview summary: Turn venue rules on or off description: >- Turns venue rules, your own order limits, stages and analytics on the accounts you issue, on or off. Creating your first group turns them on, so use this to turn them off again or back on by hand. With them off, your settings stay saved but aren't applied to trading, and the response is the venue with its new setting. Required scope: `venue:configure`. Preview: served on the sandbox to every venue, and production availability is arranged when a venue qualifies. Trading API keys and Partner keys do not authorize these routes. parameters: - name: venueId in: path required: true schema: type: string format: uuid - name: Idempotency-Key in: header required: true schema: type: string minLength: 1 maxLength: 128 description: >- A key you choose, 1 to 128 characters, that identifies this write. Send the same key when you retry it, so the write is never applied twice. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/VenueRulesRequest' 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/VenueRulesResponse' '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: - venueOperatorKey: [] x-codeSamples: - lang: javascript label: TypeScript source: >- const res = await fetch('https://app.trdrs.co/api/partner/venues/{venueId}/rules', { method: 'POST', headers: { 'content-type': 'application/json', Authorization: `Bearer ${process.env.TRDRS_VENUE_KEY}`, "Idempotency-Key": "example-request-1", }, body: JSON.stringify({ "enabled": false }), }) const data = await res.json() - lang: shell label: cURL source: >- curl -X POST 'https://app.trdrs.co/api/partner/venues/{venueId}/rules' \ -H "Authorization: Bearer $TRDRS_VENUE_KEY" \ -H 'Idempotency-Key: example-request-1' \ -H 'content-type: application/json' \ -d '{"enabled":false}' components: schemas: VenueRulesRequest: type: object additionalProperties: false properties: enabled: type: boolean description: >- True to turn venue rules on, false to turn them off. Sending the current state changes nothing. required: - enabled example: enabled: false VenueRulesResponse: type: object additionalProperties: false properties: venue: $ref: '#/components/schemas/VenueRecord' required: - venue example: venue: id: 00000000-0000-0000-0000-000000000001 organizationId: 00000000-0000-0000-0000-000000000001 legacyFirmId: null name: Example venue description: null environment: sandbox state: draft version: 2 createdAt: '2026-09-14T12:00:00.000Z' rules: enabled: false applies: orders: true fills: true stages: true appliesAtProvider: orders: false fills: false stages: false company: 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 VenueRecord: type: object additionalProperties: false properties: id: type: string format: uuid organizationId: type: string format: uuid legacyFirmId: type: - string - 'null' format: uuid name: type: string description: type: - string - 'null' environment: type: string enum: - sandbox - production state: type: string enum: - draft - active - halted version: type: integer createdAt: type: string format: date-time rules: type: object additionalProperties: false properties: enabled: type: boolean applies: type: object additionalProperties: false properties: orders: type: boolean fills: type: boolean stages: type: boolean required: - orders - fills - stages appliesAtProvider: type: object additionalProperties: false properties: orders: type: boolean fills: type: boolean stages: type: boolean required: - orders - fills - stages required: - enabled - applies - appliesAtProvider description: >- Venue rules: your own order limits, stages and analytics on the accounts the venue holds. `enabled` is your switch, turned on when you create your first group. `applies` says what trdrs applies today to an account issued on the paper book: `orders` (the halt, instrument list, and size and notional limits, checked before an order is accepted), `fills` (markup, collar and commission at the fill) and `stages` (eligibility read from the account's own fills). `appliesAtProvider` says the same for an account held at a provider, and all three are false there: the provider's orders and fills don't pass through these rules, and stage performance needs a verified start of the cycle that a first snapshot can't give. A false entry means the setting is saved but not applied to trading yet. company: oneOf: - $ref: '#/components/schemas/CompanyRecord' - type: 'null' description: >- The company behind this venue, which holds its brand, its roles and its listing state. Null only for an early venue no company could be matched to. required: - id - organizationId - legacyFirmId - name - description - environment - state - version - createdAt - rules - company 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 kind: type: string enum: - prop - broker - crypto - market builtInProvider: type: - string - 'null' enum: - rithmic - tastytrade - hyperliquid - binance - bybit - paper - null connectsTraders: type: boolean pluggable: type: boolean runsVenue: type: boolean listingState: type: string enum: - draft - conformance_passed - submitted - in_review - changes_requested - approved - listed - suspended enabled: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - name - blurb - logoUrl - logoBleed - referralUrl - sortOrder - kind - builtInProvider - connectsTraders - pluggable - runsVenue - listingState - enabled - createdAt - updatedAt description: >- A company on trdrs, with the roles it plays: traders connect their own accounts through it (`connectsTraders`), a venue can plug it in as a provider (`pluggable`), or it runs a venue (`runsVenue`). Where the company appears follows from those roles. Each of the six built-in providers is a company with `builtInProvider` set, and a company holds its brand and listing state. securitySchemes: venueOperatorKey: 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, and it works only on the `/api/partner/venues/{venueId}` routes. A `trdrs_sk_…` key can't be used in its place. It never lets you act as a trader, sign in or manage keys. Keep it on your server. ````