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

# Request Quote

> Request a firm or estimate RFQ quote



## OpenAPI

````yaml /openapi.yaml get /trade/quote
openapi: 3.1.0
info:
  contact:
    email: support@boomfi.xyz
    name: API Support
  description: >-
    The BoomFi Merchants API provides a set of endpoints for merchants to manage
    their accounts, transactions, and more. Hosts differ per brand/environment;
    use the brand-specific base URL from the docs.
  title: ZBX Merchants API
  version: '1.0'
servers:
  - url: https://mapi.zbx.boomfi.xyz/v1
    description: Production
security: []
tags:
  - description: Payment links
    name: Paylinks
  - description: Billing plans
    name: Plans
  - description: Subscriptions
    name: Subscriptions
  - description: Customer records
    name: Customers
  - description: Invoices
    name: Invoices
  - description: Payments
    name: Payments
  - description: Organisation events
    name: Events
  - description: Organisation profile and display settings
    name: Organisation
  - description: Webhook and request-signing secrets
    name: Secrets
  - description: Settlement accounts
    name: Accounts
  - name: Bank Address Book
  - description: Managed virtual accounts, balances, pay-in, and payout
    name: Virtual Accounts
  - description: Partner-managed accounts, virtual accounts, pay-in, and payout
    name: Partners
  - description: Partner virtual account automations and run history
    name: Partner Automations
  - description: Partner maintain-balance automations
    name: Partner Balance Monitoring
  - description: Tradeable currencies, instruments, and swap targets
    name: Instruments
  - description: RFQ quotes
    name: Quotes
  - description: RFQ orders and one-click trades
    name: Orders
  - description: Executed trades
    name: Trades
paths:
  /trade/quote:
    get:
      tags:
        - Quotes
      summary: Request Quote
      description: Request a firm or estimate RFQ quote
      parameters:
        - description: >-
            Exact buy amount. Mutually exclusive with sell_amount for firm
            quotes.
          example: '100'
          in: query
          name: buy_amount
          schema:
            type: string
        - description: Buy-side chain ID for digital assets.
          example: '8453'
          in: query
          name: buy_chain_id
          schema:
            type: string
        - description: Buy-side currency symbol (required).
          example: USDC
          in: query
          name: buy_currency
          required: true
          schema:
            type: string
        - description: Buy-side token contract address when not the native asset.
          in: query
          name: buy_token_address
          schema:
            type: string
        - description: Settlement/deposit account ID to fund the trade from.
          example: 42
          in: query
          name: deposit_account_id
          schema:
            type: integer
        - description: Deposit method hint (defaults to Deposit when omitted).
          example: Deposit
          in: query
          name: deposit_method
          schema:
            type: string
        - description: When true, return an estimate only and do not create a firm quote.
          example: false
          in: query
          name: is_estimate_only
          schema:
            type: boolean
        - description: Sell amount(s). Mutually exclusive with buy_amount for firm quotes.
          example: '0.05'
          in: query
          name: sell_amount
          schema:
            type: string
        - description: Sell-side chain ID(s), comma-separated for baskets.
          example: '1'
          in: query
          name: sell_chain_id
          schema:
            type: string
        - description: >-
            Sell-side currency symbol (required). Comma-separated for
            multi-asset baskets.
          example: ETH
          in: query
          name: sell_currency
          required: true
          schema:
            type: string
        - description: Sell-side token address(es), comma-separated for baskets.
          in: query
          name: sell_token_address
          schema:
            type: string
        - description: Settlement account ID. Mutually exclusive with settlement_address.
          example: 42
          in: query
          name: settlement_account_id
          schema:
            type: integer
        - description: >-
            External settlement wallet address. Mutually exclusive with
            settlement_account_id.
          in: query
          name: settlement_address
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal.Response-trade_QuoteResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal.ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    internal.Response-trade_QuoteResponse:
      properties:
        data:
          allOf:
            - $ref: '#/components/schemas/trade.QuoteResponse'
          description: Response payload when the request succeeded.
        error:
          description: True when the request failed.
          type: boolean
        message:
          description: Human-readable status or error message.
          type: string
      type: object
    internal.ErrorResponse:
      properties:
        error:
          allOf:
            - $ref: '#/components/schemas/internal.ErrorStruct'
          description: Error details including HTTP-style code and message.
      type: object
    trade.QuoteResponse:
      properties:
        accepted_at:
          description: When the quote or order was accepted (RFC3339).
          type: string
        account_id:
          description: Unique identifier of the account this resource belongs to.
          type: integer
        buy_asset:
          allOf:
            - $ref: '#/components/schemas/trade.GoAssetWrapper'
          description: Asset being purchased in this quote.
        created_at:
          description: When the resource was created (RFC3339).
          type: string
        deposit_instruction:
          allOf:
            - $ref: '#/components/schemas/quote_svc.DepositInstruction'
          description: Instructions for depositing funds to fund this trade or quote.
        expires_at:
          description: Expiration time (RFC3339).
          type: string
        fees:
          allOf:
            - $ref: '#/components/schemas/quote_svc.RFQFee'
          description: Fee details applied to this trade or payment.
        id:
          description: Unique resource identifier.
          type: string
        internal:
          description: Internal-only quote details (not for client display).
        mode:
          allOf:
            - $ref: '#/components/schemas/docenums.QuoteMode'
          description: Quote mode (SellExact or BuyExact).
        org_id:
          description: Organisation ID that owns this resource.
          type: string
        properties:
          description: Additional properties as a key-value map.
        rate:
          description: >-
            Quoted exchange rate breakdown (effective rate and converted
            values).
          properties:
            buy_currency_cad_rate:
              type: number
            cad_value:
              description: Total value in CAD
              type: number
            effective_rate:
              description: buy_amount / total_sell_value
              type: number
            sell_currency_cad_rates:
              additionalProperties:
                type: number
              type: object
            usd_value:
              description: Total value in USD
              type: number
          type: object
        rejected_at:
          description: When the quote was rejected (RFC3339).
          type: string
        sell_assets:
          description: Assets sold to fund this quote.
          items:
            $ref: '#/components/schemas/trade.GoAssetWrapper'
          type: array
        settlement_instruction:
          allOf:
            - $ref: '#/components/schemas/quote_svc.SettlementInstruction'
          description: Instructions for receiving settled trade proceeds.
        source:
          description: Origin system or integration that created this resource.
          type: string
        status:
          allOf:
            - $ref: '#/components/schemas/docenums.QuoteStatus'
          description: Status of this resource.
        ttl_at:
          description: When this quote expires (RFC3339).
          type: string
        type:
          allOf:
            - $ref: '#/components/schemas/docenums.QuoteType'
          description: Resource or value type.
        updated_at:
          description: When the resource was last updated (RFC3339).
          type: string
      type: object
    internal.ErrorStruct:
      properties:
        code:
          description: |-
            Error code
            Example: 400
          example: 400
          type: integer
        errors:
          description: List of errors
          items:
            $ref: '#/components/schemas/internal.SingleError'
          type: array
        message:
          description: |-
            Error message
            Example: Insufficient quantity
          example: Insufficient quantity
          type: string
      type: object
    trade.GoAssetWrapper:
      properties:
        amount:
          description: Amount as a decimal string in major units.
          type: number
        chain_id:
          description: Blockchain chain ID.
          type: integer
        symbol:
          description: Asset or token symbol.
          type: string
        token_address:
          description: Token contract address on the chain, when not native.
          type: string
      type: object
    quote_svc.DepositInstruction:
      properties:
        account_id:
          description: Unique identifier of the account this resource belongs to.
          type: integer
        payment_method:
          allOf:
            - $ref: '#/components/schemas/docenums.PaymentMethod'
          description: Payment method used for this deposit or settlement.
      type: object
    quote_svc.RFQFee:
      properties:
        breakdown:
          additionalProperties:
            type: number
          description: '"network", "exchange", "processing"'
          type: object
        fee_currency:
          description: Currency of the fee amount.
          type: string
        total_fee:
          description: Total fee amount as a decimal string.
          type: number
      type: object
    docenums.QuoteMode:
      enum:
        - SellExact
        - BuyExact
      type: string
      x-enum-varnames:
        - QuoteModeSellExact
        - QuoteModeBuyExact
    quote_svc.SettlementInstruction:
      properties:
        account_id:
          description: Unique identifier of the account this resource belongs to.
          type: integer
        address:
          description: On-chain wallet or settlement address.
          type: string
        chain_id:
          description: Blockchain chain ID.
          type: integer
        type:
          allOf:
            - $ref: '#/components/schemas/docenums.SettlementType'
          description: Resource or value type.
      type: object
    docenums.QuoteStatus:
      enum:
        - Created
        - Pending
        - Accepted
        - Rejected
      type: string
      x-enum-varnames:
        - QuoteStatusCreated
        - QuoteStatusPending
        - QuoteStatusAccepted
        - QuoteStatusRejected
    docenums.QuoteType:
      enum:
        - Automatic
        - Manual
      type: string
      x-enum-varnames:
        - QuoteTypeAutomatic
        - QuoteTypeManual
    internal.SingleError:
      properties:
        domain:
          description: |-
            Domain
            Example: orders
          example: orders
          type: string
        reason:
          description: |-
            Error Reason
            Example: InsufficientQuantity
          example: InsufficientQuantity
          type: string
      type: object
    docenums.PaymentMethod:
      enum:
        - Unknown
        - MerchantContract
        - ProxyWallet
        - Unblock
        - Payout
        - Card
        - GooglePay
        - ApplePay
        - Paypal
        - DirectDebit
        - Ramp
        - RampCryptoSettlement
        - Refund
        - Deposit
      type: string
      x-enum-varnames:
        - PaymentMethodUnknown
        - PaymentMethodMerchantContract
        - PaymentMethodProxyWallet
        - PaymentMethodUnblock
        - PaymentMethodPayout
        - PaymentMethodCard
        - PaymentMethodGooglePay
        - PaymentMethodApplePay
        - PaymentMethodPaypal
        - PaymentMethodDirectDebit
        - PaymentMethodRamp
        - PaymentMethodRampCryptoSettlement
        - PaymentMethodRefund
        - PaymentMethodDeposit
    docenums.SettlementType:
      enum:
        - Manual
        - Automated
      type: string
      x-enum-varnames:
        - SettlementTypeManual
        - SettlementTypeAutomated
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-KEY
      type: apiKey

````