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

# Trading API availability

> Reports executionAvailable=false and the reserved mutation scopes. inputChains describes validation coverage only, not live signing admission. Copy inputs retain the released copy contract's five chains.



## OpenAPI

````yaml https://www.oceanx.trade/api/v1/openapi.json get /api/v1/spot/capabilities
openapi: 3.1.0
info:
  title: OceanX Developer API
  version: 1.0.0
  description: >-
    OceanX Developer API v1 (beta). Covers every public route and method: market
    data, charts, token/risk facts, wallet analytics, tracker, copy reads,
    alerts, owned account wallet/funding reads, spot quotes and perps. Scope and
    availability are operation-specific. Spot execution, copy execution, account
    withdrawals, developer webhooks and prediction trading are not public v1
    capabilities. Perps order submission and collateral rebalance remain
    unavailable; their error contracts are explicit. Documentation:
    https://docs.oceanx.trade/api/overview.
  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: Perps
    description: Cross-venue market data and explicit account-wallet execution limitations.
  - 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.
  - name: Copy Trading
    description: Key-owner follow, fill and PnL reads; no execution authority.
  - name: Price Alerts
    description: Key-owner alert management through the existing evaluator; no webhooks.
paths:
  /api/v1/spot/capabilities:
    get:
      tags:
        - Spot
      summary: Trading API availability
      description: >-
        Reports executionAvailable=false and the reserved mutation scopes.
        inputChains describes validation coverage only, not live signing
        admission. Copy inputs retain the released copy contract's five chains.
      operationId: getSpotTradingCapabilities
      responses:
        '200':
          description: Closed trading API capability report.
          content:
            application/json:
              schema:
                type: object
                required:
                  - executionAvailable
                  - blockedOn
                  - inputChains
                  - operations
                  - note
                properties:
                  executionAvailable:
                    const: false
                  blockedOn:
                    const: signing-contracts
                  inputChains:
                    type: array
                    items:
                      type: string
                      enum:
                        - solana
                        - ethereum
                        - optimism
                        - bnb
                        - gnosis
                        - unichain
                        - polygon
                        - monad
                        - sonic
                        - xlayer
                        - hyperevm
                        - sei
                        - abstract
                        - megaeth
                        - robinhood
                        - mantle
                        - arc
                        - base
                        - plasma
                        - arbitrum
                        - celo
                        - avalanche
                        - ink
                        - berachain
                  operations:
                    type: array
                    items:
                      type: object
                      required:
                        - path
                        - method
                        - scope
                        - kinds
                        - available
                      properties:
                        path:
                          type: string
                        method:
                          const: POST
                        scope:
                          enum:
                            - spot.trade
                            - spot.orders
                            - copy.trade
                        kinds:
                          type: array
                          items:
                            type: string
                        available:
                          const: false
                  note:
                    type: string
        '401':
          description: API key required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: md.read required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: REST rate limit exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: API-key verification dependency failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Admission dependencies unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        requestId:
          type: string
          description: Request identifier on new token endpoints.
        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_…`. Required scopes are
        operation-specific: market reads use md.read, tracker uses tracker.read,
        copy reads use copy.read, alert operations use alerts.read or
        alerts.write, and owned wallet/funding reads require explicit
        account.read. New scopes require explicit selection and grant no trading
        authority. Existing perps operations retain their documented scopes.

````

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