Added
v1.4.0 - 2025-07-26
14 days ago by ReadMe CLI
✨ Added - New Endpoint and Enhanced Features
New REST Endpoint: Index Price Retrieval
- Added
GET /index_priceendpoint for retrieving current index prices- Supported markets: BTC, ETH, ARB
- Data source: Real-time Chainlink oracle feeds via WebSocket streaming
- Response format: Direct numerical value (e.g.,
106500.25) - Authentication: API key required
- Use cases: Portfolio valuation, risk management, strategy analysis, settlement reference
WebSocket Rate Limiting Implementation
- Added per-API-key rate limiting for market data WebSocket messages:
get_ob_state_by_instruments: 15 requests per minute per API keyget_ob_state_by_market: 15 requests per minute per API key
- Enhanced error responses with reset time and remaining request information
- Sliding window algorithm with 60-second windows for fair usage distribution
WebSocket Documentation Enhancements
- Added comprehensive timestamp format clarification:
- Event wrapper timestamps (
timestamp_ms): 13-digit milliseconds for event ordering - Data payload timestamps (
timestamp): Usually 13-digit milliseconds for data-specific times - Creation timestamps (
creation_timestamp): 10-digit seconds for order/request creation
- Event wrapper timestamps (
🔧 Changed - Rate Limiting and Performance
WebSocket Rate Limiting Behavior
- Rate limits now apply per API key instead of global limits
- Enhanced rate limit responses include specific reset timing and remaining request counts
- Alternative guidance provided encouraging subscription-based real-time updates over polling
