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

# Route quote

> Returns the existing Raptor route quote without building, signing, submitting, or reading a wallet. Requires `md.read` and costs one request from the quote bucket. `/build` and `/execute` are deliberately not public in this release and remain separately gated.



## OpenAPI

````yaml https://www.oceanx.trade/api/v1/openapi.json post /api/v1/route
openapi: 3.1.0
info:
  title: OceanX Developer API
  version: 1.0.0
  description: >-
    Public API for the OceanX trading platform. Currently in beta and free to
    use while in beta.


    This spec covers the **spot quote** domain. The wallet **tracker** and
    **perps** domains are documented at https://docs.oceanx.trade/api/overview
    and are not yet described here.
  contact:
    url: https://docs.oceanx.trade
  termsOfService: https://www.oceanx.trade/legal/terms
  license:
    name: Proprietary
    url: https://www.oceanx.trade/legal/terms
servers:
  - url: https://www.oceanx.trade
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Router
    description: >-
      Read-only Raptor route quotes and public Solana transaction status. Build
      and execution remain separately gated.
  - name: Market Data
    description: Read-only OceanX market context sourced and cached by VM producers.
  - name: Spot
    description: >-
      Executable Solana swap quotes off OceanX's own router, and the exit
      checker that reports whether a whole position can be sold.
  - name: Callouts
    description: >-
      Public token callouts — user-posted token calls with live click/volume
      attribution stats. Read-only.
paths:
  /api/v1/route:
    post:
      tags:
        - Router
      summary: Route quote
      description: >-
        Returns the existing Raptor route quote without building, signing,
        submitting, or reading a wallet. Requires `md.read` and costs one
        request from the quote bucket. `/build` and `/execute` are deliberately
        not public in this release and remain separately gated.
      operationId: postRouterRoute
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
                - inputMint
                - outputMint
              properties:
                inputMint:
                  type: string
                  pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$
                  description: Base58 Solana mint address.
                outputMint:
                  type: string
                  pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$
                  description: Base58 Solana mint address.
                amount:
                  type: string
                  pattern: ^\d+$
                  description: >-
                    Atomic (base-unit) amount as a decimal integer string. A
                    string, not a number, because a large 9-decimal balance
                    exceeds Number.MAX_SAFE_INTEGER and would be corrupted by
                    JSON float parsing.
                  example: '1000000000'
                uiAmount:
                  type: number
                  exclusiveMinimum: 0
                inputDecimals:
                  type: integer
                  minimum: 0
                  maximum: 18
                slippageBps:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 50
                dexes:
                  type: string
                  maxLength: 256
                pools:
                  type: string
                  maxLength: 256
                maxHops:
                  type: integer
                  minimum: 1
                  maximum: 4
                onlyDirectRoutes:
                  type: boolean
      responses:
        '200':
          description: Raptor quote response.
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
              description: Requests allowed per window.
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: Requests left.
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Unix seconds when the window resets.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '400':
          description: Failed validation before reaching the engine.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing, malformed or revoked API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The key is valid but lacks the required scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No route exists for this pair and size.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited. Honour `Retry-After`.
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
              description: Requests allowed per window.
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: Requests left.
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Unix seconds when the window resets.
            Retry-After:
              schema:
                type: integer
              description: Seconds to wait.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: The routing engine is unreachable or timed out. Retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Stable machine-readable code. Branch on this, not the message.
              example: no_route
            message:
              type: string
              description: Human-readable detail. May change.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An OceanX API key, created in the app under Settings → Developer API.
        Send it as `Authorization: Bearer ox_live_…`. These endpoints require
        the `md.read` scope, which is on every key by default.

````