> ## 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.

# Promote a provider connection to validated

> Marks a draft connection validated, or a halted one validated again, on a check of it that passed. Name the check and the connection version you read: the check must be the connection's newest finished one, made at that version, and have read the provider version's manifest, and its 1.1 manifest too for a version pinned to 1.1. A connection that serves prices also needs the provider's market data conformance: today, the passed qualification of the catalog release the provider version runs, installed or linked, with the same manifest. A 1.1 manifest that declares environments must declare this connection's endpoint for its environment, and a production connection takes no `test` upstream while a sandbox one never trades live. A later check that fails on what the provider answered halts a validated connection (no new exposure; reductions and reads go on) until you promote it again. A validated connection is answered as it stands, and the same request again answers what it answered. Required scope: `connection:manage`. 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.



## OpenAPI

````yaml /api/openapi.json post /api/venues/{venueId}/connections/{connectionId}/promote
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}/connections/{connectionId}/promote:
    post:
      tags:
        - Venue platform preview
      summary: Promote a provider connection to validated
      description: >-
        Marks a draft connection validated, or a halted one validated again, on
        a check of it that passed. Name the check and the connection version you
        read: the check must be the connection's newest finished one, made at
        that version, and have read the provider version's manifest, and its 1.1
        manifest too for a version pinned to 1.1. A connection that serves
        prices also needs the provider's market data conformance: today, the
        passed qualification of the catalog release the provider version runs,
        installed or linked, with the same manifest. A 1.1 manifest that
        declares environments must declare this connection's endpoint for its
        environment, and a production connection takes no `test` upstream while
        a sandbox one never trades live. A later check that fails on what the
        provider answered halts a validated connection (no new exposure;
        reductions and reads go on) until you promote it again. A validated
        connection is answered as it stands, and the same request again answers
        what it answered. Required scope: `connection:manage`. 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.
      parameters:
        - name: venueId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: connectionId
          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/VenueConnectionPromoteRequest'
      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/VenueConnectionPromoteResponse'
        '400':
          description: The body is malformed, or the connection is revoked.
          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 connection doesn't exist or isn't this venue's.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: >-
            The promotion is refused: `version_conflict` (the connection moved
            on from `expectedVersion`), `validation_not_passed` (the check isn't
            this connection's, didn't pass or hasn't finished),
            `validation_stale` (a newer check finished, or the check read
            another connection version or manifest), `conformance_missing` (no
            passed market data conformance of the provider's software),
            `endpoint_not_declared`, `environment_upstream_mismatch`; or
            `idempotency_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`.
            `engine_draining` with a `Retry-After` header: the engine you
            reached is restarting for a release and did nothing. Wait for
            `Retry-After`, then send the same request again, with the same
            `clientOrderId` or `Idempotency-Key` where the route takes one:
            another engine takes it. A write refused before any route takes it
            says `server draining` as its `error`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers:
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
      security:
        - venueKey: []
      x-codeSamples:
        - lang: javascript
          label: TypeScript
          source: >-
            const res = await
            fetch('https://app.trdrs.co/api/venues/{venueId}/connections/{connectionId}/promote',
            {
              method: 'POST',
              headers: {
                'content-type': 'application/json',
                Authorization: `Bearer ${process.env.TRDRS_VENUE_KEY}`,
                "Idempotency-Key": "example-request-1",
              },
              body: JSON.stringify({
                "expectedVersion": 1,
                "validationJobId": "00000000-0000-0000-0000-000000000005"
              }),
            })

            const data = await res.json()
        - lang: shell
          label: cURL
          source: >-
            curl -X POST
            'https://app.trdrs.co/api/venues/{venueId}/connections/{connectionId}/promote'
            \
              -H "Authorization: Bearer $TRDRS_VENUE_KEY" \
              -H 'Idempotency-Key: example-request-1' \
              -H 'content-type: application/json' \
              -d '{"expectedVersion":1,"validationJobId":"00000000-0000-0000-0000-000000000005"}'
components:
  schemas:
    VenueConnectionPromoteRequest:
      type: object
      additionalProperties: false
      properties:
        expectedVersion:
          type: integer
          minimum: 1
          description: The connection's `version` as you read it.
        validationJobId:
          type: string
          format: uuid
          description: The check of the connection that passed.
      required:
        - expectedVersion
        - validationJobId
      example:
        expectedVersion: 1
        validationJobId: 00000000-0000-0000-0000-000000000005
    VenueConnectionPromoteResponse:
      type: object
      additionalProperties: false
      properties:
        connection:
          $ref: '#/components/schemas/VenueProviderConnection'
      required:
        - connection
      example:
        connection:
          id: 00000000-0000-0000-0000-000000000006
          venueId: 00000000-0000-0000-0000-000000000001
          providerVersionId: 00000000-0000-0000-0000-000000000001
          environment: sandbox
          endpoint: https://bolsador.example.com/trdrs-provider/v1/
          credentialId: bolsador
          hasCredential: true
          state: validated
          version: 2
          exposed: false
          createdAt: '2026-09-14T12:00:00.000Z'
    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
    VenueProviderConnection:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
          format: uuid
        venueId:
          type: string
          format: uuid
        providerVersionId:
          type: string
          format: uuid
        environment:
          type: string
          enum:
            - sandbox
            - production
        endpoint:
          type: string
        credentialId:
          type: string
        hasCredential:
          const: true
        state:
          type: string
          enum:
            - draft
            - validated
            - halted
            - revoked
          description: >-
            `validated` once you promoted it on a check that passed. `halted`
            after a later check failed: no new exposure, while reductions and
            reads go on, until you promote it again.
        version:
          type: integer
        exposed:
          type: boolean
          description: >-
            Whether this venue shows the plugged-in provider to its own traders
            in Connect. It is off by default, and the expose route changes it.
        createdAt:
          type: string
          format: date-time
      required:
        - id
        - venueId
        - providerVersionId
        - environment
        - endpoint
        - credentialId
        - hasCredential
        - state
        - version
        - exposed
        - createdAt
  headers:
    RetryAfter:
      description: >-
        How many seconds to wait before sending the same request again. A `503`
        carries it only when the engine did nothing, so the request may be sent
        again as it is.
      schema:
        type: integer
        minimum: 1
  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.