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

# List Boosts

> Your Boost orders, newest first — the ones placed on the website and in the app too — each with what it's worth now and what selling it would pay.



## OpenAPI

````yaml api-reference/openapi.json GET /portfolio/boosts
openapi: 3.1.0
info:
  title: updown Trade API
  version: 1.0.0
  description: >-
    Public REST API. Market data needs no key; `/account` (and order entry, when
    it ships) takes an API key. Prices are dollar strings: whole cents (0.55),
    or 0.1¢ steps (0.999) in the tails of a market whose price_ranges list them;
    counts are contract strings, times are epoch ms. Generated from
    packages/protocol — do not edit by hand.
servers:
  - url: https://api.updown.fast/trade-api/v1
    description: production
security: []
paths:
  /portfolio/boosts:
    get:
      summary: List Boosts
      description: >-
        Your Boost orders, newest first — the ones placed on the website and in
        the app too — each with what it's worth now and what selling it would
        pay.
      operationId: listBoosts
      parameters:
        - name: market_ticker
          in: query
          required: false
          schema:
            type: string
            pattern: ^[a-z0-9][a-z0-9-]{0,63}-\d{6}-\d{4}-\d{4}(d\d{1,2})?$
            description: >-
              Market ticker (one window of a series), e.g.
              "btc-15m-261002-1400-1415". Opaque.
        - name: client_order_id
          in: query
          required: false
          schema:
            type: string
            pattern: ^[A-Za-z0-9._:-]{1,64}$
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - pending
              - open
              - selling
              - sold
              - settling
              - settled
              - void
              - failed
        - name: limit
          in: query
          required: false
          schema:
            default: 50
            type: integer
            minimum: 1
            maximum: 100
      responses:
        '200':
          description: Your Boost orders.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BoostsResponse'
        '400':
          description: Invalid request (code BAD_REQUEST).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: No API key, or one that isn't valid (code UNAUTHORIZED).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            The key lacks the permission, or the account can't trade yet (code
            FORBIDDEN).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited (code RATE_LIMITED); wait `Retry-After` seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: The book could not be read (code EXCHANGE_UNAVAILABLE); retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    BoostsResponse:
      type: object
      properties:
        boosts:
          type: array
          items:
            type: object
            properties:
              boost_id:
                type: string
              client_order_id:
                type: string
              market_ticker:
                type: string
                pattern: ^[a-z0-9][a-z0-9-]{0,63}-\d{6}-\d{4}-\d{4}(d\d{1,2})?$
                description: >-
                  Market ticker (one window of a series), e.g.
                  "btc-15m-261002-1400-1415". Opaque.
              outcome:
                type: string
                enum:
                  - up
                  - down
              kind:
                type: string
                enum:
                  - boost
                  - multiplier
              mode:
                type: string
                enum:
                  - live
                  - shadow
              status:
                type: string
                enum:
                  - pending
                  - open
                  - selling
                  - sold
                  - settling
                  - settled
                  - void
                  - failed
              stake:
                type: string
              multiplier:
                type: string
              max_payout:
                type: string
              price_to_beat:
                type: string
                pattern: ^\d+(\.\d+)?$
                description: Price of the underlying in dollars, as a decimal string.
              value:
                type: string
              sell_proceeds:
                type: string
              close_price:
                type: string
                pattern: ^\d+(\.\d+)?$
                description: Price of the underlying in dollars, as a decimal string.
              payout:
                type: string
              credit_used:
                type: string
              paid:
                type: string
              created_ts_ms:
                type: integer
                minimum: 0
                maximum: 9007199254740991
                description: Epoch milliseconds (UTC).
              close_ts_ms:
                type: integer
                minimum: 0
                maximum: 9007199254740991
                description: Epoch milliseconds (UTC).
              settled_ts_ms:
                type: integer
                minimum: 0
                maximum: 9007199254740991
                description: Epoch milliseconds (UTC).
              bet:
                type: object
                properties:
                  order_id:
                    type: string
                  contracts:
                    type: string
                  cost:
                    type: string
                required:
                  - order_id
                  - contracts
                  - cost
                additionalProperties: false
            required:
              - boost_id
              - market_ticker
              - outcome
              - kind
              - mode
              - status
              - stake
              - multiplier
              - max_payout
              - created_ts_ms
            additionalProperties: false
      required:
        - boosts
      additionalProperties: false
    Error:
      type: object
      properties:
        code:
          type: string
          enum:
            - BAD_REQUEST
            - NOT_FOUND
            - SERIES_NOT_FOUND
            - MARKET_NOT_FOUND
            - METHOD_NOT_ALLOWED
            - RATE_LIMITED
            - UNAUTHORIZED
            - FORBIDDEN
            - ORDER_NOT_FOUND
            - IDEMPOTENCY_CONFLICT
            - ACCOUNT_BUSY
            - MARKET_NOT_OPEN
            - INSUFFICIENT_BALANCE
            - LIMIT_EXCEEDED
            - POST_ONLY_CROSS
            - SELF_TRADE
            - TRADING_PAUSED
            - ORDER_REJECTED
            - BOOST_UNAVAILABLE
            - INTERNAL_ERROR
            - EXCHANGE_UNAVAILABLE
        message:
          type: string
        details:
          type: string
      required:
        - code
        - message
      additionalProperties: false
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        An API key from your account: `Authorization: Bearer
        udk_<live|test>_<id>_<secret>`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.