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

# Get best-rate estimate for a swap



## OpenAPI

````yaml /api-reference/openapi.yaml get /estimate
openapi: 3.1.0
info:
  title: Privata Wallet API
  version: 1.2.0
  summary: REST API for integrating Privata swap aggregator into crypto wallets.
  description: |
    Privata is a non-custodial swap aggregator. Wallets call this API to fetch
    quotes from 50+ providers, create exchange orders with deposit addresses,
    and track order lifecycle via webhooks or Server-Sent Events.

    Wire format is snake_case. The official JS/TS SDK (`@privata/wallet-api`)
    exposes camelCase and handles the conversion at the SDK boundary.
  contact:
    name: Privata partner support
    email: partners@privataswap.com
    url: https://docs.privataswap.com
  license:
    name: Proprietary
servers:
  - url: https://api.privataswap.com/partner/v1
    description: Production
  - url: https://api.privataswap.com/v2/exchange
    description: ChangeNOW-compatible layer (legacy clients)
security:
  - apiKey: []
tags:
  - name: Public
    description: Read endpoints. Work without an API key at lower rate-limit.
  - name: Orders
    description: Create and track exchange orders.
  - name: Refunds
    description: Refund capability and partner-confirmed refund actions.
  - name: Streaming
    description: SSE event stream for order status.
  - name: Webhooks
    description: Outbound HTTP callbacks to your endpoint.
  - name: Partner
    description: Self-service stats and history for the authenticated partner.
  - name: Health
    description: Uptime probe surface.
paths:
  /estimate:
    get:
      tags:
        - Public
      summary: Get best-rate estimate for a swap
      parameters:
        - in: query
          name: from
          required: true
          schema:
            type: string
            example: BTC
        - in: query
          name: to
          required: true
          schema:
            type: string
            example: XMR
        - in: query
          name: from_network
          schema:
            type: string
            example: btc
        - in: query
          name: to_network
          schema:
            type: string
            example: xmr
        - in: query
          name: amount
          required: true
          schema:
            type: string
            example: '0.05'
        - in: query
          name: side
          schema:
            type: string
            enum:
              - send
              - receive
            default: send
        - in: query
          name: include
          description: Set to `all` to receive quotes from every provider.
          schema:
            type: string
            enum:
              - best
              - all
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Estimate'
        '400':
          $ref: '#/components/responses/Error'
      security: []
components:
  schemas:
    Estimate:
      type: object
      properties:
        from:
          type: string
        to:
          type: string
        amount_from:
          type: string
        amount_to:
          type: string
        rate:
          type: string
        provider:
          type: string
          example: exolix
        eta_seconds:
          type: integer
          example: 1800
        quote_id:
          type: string
        expires_at:
          type: string
          format: date-time
        markup_applied_bps:
          type: integer
        warnings:
          type: array
          items:
            type: string
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              enum:
                - INVALID_KEY
                - RATE_LIMITED
                - INVALID_PAIR
                - AMOUNT_TOO_LOW
                - AMOUNT_TOO_HIGH
                - NO_PROVIDERS_AVAILABLE
                - PROVIDER_ERROR
                - QUOTE_EXPIRED
                - ORDER_NOT_FOUND
                - DUPLICATE_ACTIVE_ORDER
                - REFUND_WINDOW_EXPIRED
                - REFUND_NOT_PROGRAMMATIC
                - STABLE_TARGET_REQUIRED
                - WEBHOOK_PAUSED
                - SCOPE_REQUIRED
            message:
              type: string
            request_id:
              type: string
  responses:
    Error:
      description: Error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Partner API key issued in the dashboard. Use `pk_live_...` in
        production, `pk_test_...` against sandbox.

````