Skip to main content

Overview

The Hotstuff API provides REST and WebSocket endpoints for trading, market data, and blockchain information.

Mainnet URLs

  • REST-API: https://api.hotstuff.trade
  • WSS: wss://api.hotstuff.trade/ws

Testnet URLs

  • REST-API: https://testnet-api.hotstuff.trade
  • WSS: wss://testnet-api.hotstuff.trade/ws

Endpoints

  • General: Health checks and API information
  • Node Info: Blockchain node status and peer information
  • Global: Market data for all trading instruments
  • Account-specific: User positions, orders, and transaction history
  • WebSocket: Real-time market data and order updates

Response Format

All responses use JSON format with standard HTTP status codes:
  • 200 - Success
  • 400 - Bad request
  • 401 - Unauthorized
  • 403 - Forbidden
  • 404 - Not found
  • 429 - Rate limit exceeded
  • 500 - Server error
  • 503 - Service unavailable
  • 504 - Gateway timeout