API Overview
API Overview
Section titled “API Overview”TradeX provides comprehensive APIs for all platform functionality.
REST APIs
Section titled “REST APIs”Market Data API
Section titled “Market Data API”Real-time and historical market data.
Service: Market Data Service (Go)
Base URL: https://marketdata.dokploy.samarpit.dev
Documentation: Market Data API
Features:
- Order book snapshots and depth
- Trade history
- Ticker information
- Candlestick (OHLCV) data
- Mark and index prices
- Funding rates
Metadata API
Section titled “Metadata API”Trading symbols, instruments, and configuration.
Service: Metadata Service (Go)
Base URL: https://metadata.dokploy.samarpit.dev
Documentation: Metadata API
Features:
- Symbol listing and details
- Index price configuration
- Market configuration
- Trading rules
Order API
Section titled “Order API”Order placement and management.
Service: Order Service (NestJS)
Base URL: https://order.dokploy.samarpit.dev
Documentation: Order API
Features:
- Place orders (market, limit, stop)
- Cancel orders
- Order history
- Position management
Auth API
Section titled “Auth API”Authentication and authorization.
Service: Auth Service (FastAPI)
Base URL: https://auth.dokploy.samarpit.dev
Documentation: Auth API
Features:
- User authentication
- JWT token management
- API key management
- Session management
User API
Section titled “User API”User profile and preferences.
Service: User Service (FastAPI)
Base URL: https://user.dokploy.samarpit.dev
Documentation: User API
Features:
- User profiles
- Preferences management
- KYC status
- Account settings
Wallet API
Section titled “Wallet API”Wallet operations and balance management.
Service: Wallet Service (FastAPI)
Base URL: https://wallet.dokploy.samarpit.dev
Documentation: Wallet API
Features:
- Balance queries
- Deposit and withdrawal
- Transaction history
- Hold and release operations
WebSocket APIs
Section titled “WebSocket APIs”Market Data WebSocket
Section titled “Market Data WebSocket”Real-time market data streaming.
Service: Market Data Service (Go)
WebSocket URL: wss://marketdata.dokploy.samarpit.dev/ws
Documentation: WebSocket API
Features:
- Real-time order book updates
- Live trade feeds
- Ticker updates
- Candlestick streams
- Mark and index price updates
- Funding rate updates
Getting Started
Section titled “Getting Started”- Get API Credentials: Obtain API keys from your administrator
- Choose Your Service: Select the service you need
- Read the Documentation: Explore the specific API documentation
- Start Building: Make your first API call
Authentication
Section titled “Authentication”All APIs require authentication. See the Authentication Guide for details.
Rate Limiting
Section titled “Rate Limiting”APIs are subject to rate limits. See the Rate Limiting Guide for details.