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

# Base URLs

> Configure your application with the correct API endpoints

## API Endpoints

Roxom provides different base URLs for various environments and API types.

### Production Environment

<CodeGroup>
  ```http REST API theme={null}
  https://api.roxom.com/api
  ```

  ```http WebSocket API theme={null}
  wss://ws.roxom.com/ws
  ```
</CodeGroup>

### Sandbox Environment

<CodeGroup>
  ```http REST API theme={null}
  https://api.roxom.io/api
  ```

  ```http WebSocket API theme={null}
  wss://ws.roxom.io/ws
  ```
</CodeGroup>

<Note>
  Use the sandbox environment for testing and development. Sandbox API keys only work with sandbox endpoints.
</Note>

### API Versioning

All REST API endpoints are versioned. The current version is `v1` and is included in the URL path:

```http theme={null}
https://api.roxom.com/api/v1/{endpoint}
```

## SSL/TLS Requirements

All API communication must use HTTPS/WSS protocols. HTTP connections are not supported and will be rejected.

## Configuration Examples

### Environment Variables

```bash theme={null}
# Production
ROXOM_API_BASE_URL=https://api.roxom.com
ROXOM_WS_BASE_URL=wss://api.roxom.com/ws

# Sandbox
ROXOM_API_BASE_URL=https://api.roxom.io
ROXOM_WS_BASE_URL=wss://api.roxom.io/ws
```

### Python Configuration

```python theme={null}
import os

class RoxomConfig:
    BASE_URL = os.getenv('ROXOM_API_BASE_URL', 'https://api.roxom.com')
    WS_URL = os.getenv('ROXOM_WS_BASE_URL', 'wss://api.roxom.com/ws')
    API_VERSION = 'v1'

    @property
    def rest_endpoint(self):
        return f"{self.BASE_URL}/{self.API_VERSION}"
```

### JavaScript Configuration

```javascript theme={null}
const config = {
  baseUrl: process.env.ROXOM_API_BASE_URL || 'https://api.roxom.com',
  wsUrl: process.env.ROXOM_WS_BASE_URL || 'wss://api.roxom.com/ws',
  apiVersion: 'v1',

  get restEndpoint() {
    return `${this.baseUrl}/${this.apiVersion}`;
  }
};
```

## Ping

Before integrating, verify that the API is accessible:

```bash theme={null}
curl -X GET "https://api.roxom.com/ping" \
  -H "Content-Type: application/json"
```

Expected response:

```text theme={null}
pong
```

## Next Steps

<CardGroup cols={2}>
  <Card title="Ping" icon="heartbeat" href="/api-reference/system/ping">
    Test API connectivity and monitor system status
  </Card>

  <Card title="Market Data" icon="chart-line" href="/api-reference/market/get-orderbook-snapshot">
    Start accessing order book and market data over HTTP
  </Card>
</CardGroup>