Spread Screener

API Routes & Documentation

Complete documentation for all API endpoints and frontend routes

API Endpoints

GET

/api/spreads

Get spreads data with optional filtering

Parameters:

exchange(string)Filter by exchange (e.g., binance, okx, hyperliquid)
type(string)Filter by type (e.g., spot, futures)
min_spread_percent(number)Minimum spread percentage
max_spread_percent(number)Maximum spread percentage
order_by(string)Sort field (default: spread_percent)
limit(number)Maximum number of results (default: 100)

Example:

/api/spreads?exchange=binance&type=spot&min_spread_percent=0.5

Frontend Routes

/Homepage with app overview and navigation
/spreadsInteractive spreads data table with filtering
/routesAPI documentation and routes overview

Usage Notes

  • • All API responses are in JSON format
  • • Spread percentages are returned as decimal values (e.g., 0.015 for 1.5%)
  • • Timestamps are in ISO 8601 format
  • • Filters are applied using AND logic
  • • Results are sorted by spread percentage in descending order by default