v36

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2024-11-1856109168.6 KB

Screen the market for stocks

A stock screener endpoint to screen the market for stocks by a variety of filter options.

get/api/screener/stocks

Query parameters

has_dividendsboolean
is_s_p_500boolean
issue_typesstring[]
max_marketcapinteger
min_volumeinteger
order'premium' | 'call_volume' | 'put_volume' | 'marketcap'
order_direction'asc' | 'desc'

Response

A list of stocks matching the filters

Example response

{
  "data": [
    {
      "ticker": "AAPL",
      "close": "182.91",
      "sector": "Technology",
      "call_volume": 990943,
      "put_volume": 808326,
      "call_premium": "9908777.0",
      "put_premium": "163537151",
      "week_52_high": "198.23",
      "week_52_low": "124.17",
      "implied_move": "2.2398043036460877",
      "implied_move_perc": "0.012247398860706955",
      "total_open_interest": 7549486,
      "marketcap": "2965813810400",
      "volatility": "0.18338055163621902",
      "avg_30_day_call_volume": "679430.000000000000",
      "avg_30_day_put_volume": "401961.285714285714",
      "iv_rank": "0.2136848270893097",
      "next_earnings_date": "2023-10-26",
      "next_dividend_date": "2023-10-26"
    }
  ]
}