Skip to content

Screening Tools

These are the core tools behind market screening workflows.

search_instruments

  • Helps you filter symbols by setup logic.
  • Typical output: instruments[], total_matches, pagination fields.
  • Common fields: symbol, sector, industry, last_price, avg_volume, indicators.

get_instrument

  • Helps you deep-check one symbol after a scan.
  • Typical output: profile, pricing, sector/industry, valuation, indicator context.

get_filter_options

  • Helps you discover valid filter values for your screen.
  • Typical output: facets like sectors[], industries[], and counts.