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

# Roxom API Documentation

> Complete API reference for the Roxom trading platform

## Welcome to Roxom API

The Roxom API provides programmatic access to our trading platform, enabling you to build applications that interact with our markets, manage orders, and access real-time market data.

## Supported Instruments

The Roxom API supports the following trading instruments:

* **US500-BTC** - SPY (SPDR S\&P 500 ETF) perpetual futures.
* **GOLD-BTC** - PAXG (Tokenized Gold) perpetual futures.
* **USDT-BTC** - Tether (USDT) perpetual futures.

<Note>
  **Symbol Format**: REST API endpoints use compound symbols like `GOLD-BTC`, while WebSocket streams may use the same format. Always refer to the specific endpoint documentation for the correct symbol format.
</Note>

<Warning>
  Private REST endpoints and the WebSocket service require authentication via `X-API-Key` and `X-API-Signature` headers using RSA-2048 signatures.
</Warning>

<Tip>
  Use the **Sandbox** environment for testing and development. Production credentials will not work with sandbox endpoints.
</Tip>

## Available APIs

<Columns cols={2}>
  <Card icon="terminal" href="/api-reference/authentication" title="REST API">
    Complete REST API reference for trading operations\
    **Production:** `https://api.roxom.com` \
    **Sandbox:** `https://api.roxom.io`
  </Card>

  <Card icon="bolt" href="/websockets/overview" title="WebSocket API">
    Real-time market data and account updates \
    **Production:** `wss://ws.roxom.com/ws` \
    **Sandbox:** `wss://ws.roxom.io/ws`
  </Card>
</Columns>

## Getting Started

Start integrating with the Roxom platform in just a few steps.

<Columns cols={2}>
  <Card icon="key" href="/api-reference/authentication" title="Authentication">
    Learn how to authenticate your API requests using API keys.
  </Card>

  <Card icon="globe" href="/api-reference/base-urls" title="Base URLs">
    Configure your application with the correct API endpoints.
  </Card>

  <Card icon="calculator" href="/api-reference/decimal-format" title="Decimal Format">
    Understand how numerical values are formatted in API responses.
  </Card>

  <Card icon="Bullseye" href="/api-reference/system/ping" title="Ping">
    Test API connectivity and response time.
  </Card>
</Columns>

## Core Features

Explore the main functionality available through our APIs.

<Columns cols={2}>
  <Card icon="chart-line" href="/api-reference/market/get-orderbook-snapshot" title="Market Data">
    Access market data and order books via the HTTP API.
  </Card>

  <Card icon="list" href="/api-reference/orders/place-order" title="Orders">
    Create, modify, and manage trading orders.
  </Card>

  <Card icon="user" href="/api-reference/accounts/get-account-balance" title="Account">
    Retrieve account information and balances.
  </Card>

  <Card icon="briefcase" href="/api-reference/positions/get-positions" title="Positions">
    View and manage your trading positions.
  </Card>
</Columns>

## Support

<Card icon="question-circle" href="mailto:help@roxom.com" title="Get Help">
  For technical support or API questions, contact our development team.
</Card>