/api/v1/xbrl/screenCross-sectional fundamentals screen on the new XBRL engine.
Cross-sectional fundamentals screen on the new XBRL engine. Filter every US filer by the latest-TTM value of any standardized ratio or metric using composable greater-than / less-than filters, and get the matches plus the metrics you asked for back in one call. Also accepts a bounded cik/ticker list to pull N named companies' metrics in a single request.
10 tokensSince v3.115.0
Why use this
The cross-sectional screener built directly on the standardized XBRL ratio store (`xbrl.ratio_values`) — the same canonical keys and stored values as `/api/v1/xbrl/timeseries`, so a screen and a per-company time-series never disagree. Filters read the latest trailing-twelve-months (TTM) value per company and AND-combine: e.g. `roe_gt=0.15&debt_to_equity_lt=1&fcf_margin_gt=0`. Choose the returned columns with `metrics=` (any screenable key). Provide `cik=` or `ticker=` (comma-separated, up to 100) to bound the screen to named companies — this replaces per-ticker snapshot-batch calls. One indexed query, no per-company round-trips, so it stays fast across the whole ~10k-filer universe. Growth filters use the engine's canonical names: `revenue_growth_yoy` / `eps_growth_yoy` (annual), `revenue_growth_yoy_q` / `eps_growth_yoy_q` (same-quarter-prior-year), and `revenue_growth_sequential` / `eps_growth_sequential` (sequential period-over-period). Latest-period semantics: each metric is INDEPENDENTLY that company's most recent reported TTM value, so one company's returned metrics can come from different TTM periods (e.g. its newest ROE from a Q3 TTM window while a slower-filed metric is from the prior TTM window); `period_end` reports that company's newest TTM period.
Common use case
Fundamental screener / quant pre-screen: 'find every company with ROE > 15%, debt-to-equity < 1, and positive FCF margin, and return their ROE, debt-to-equity and FCF margin.' Or batch: 'give me current gross_margin and roic for these 40 tickers in one call.'
Parameters
| Name | In | Required | Default | Allowed | Description | Example |
|---|---|---|---|---|---|---|
| asset_turnover_gt | query | optional | — | — | Keep only companies whose latest-TTM asset turnover is greater than this number. AND-combined with other filters. | asset_turnover_gt=0 |
| asset_turnover_lt | query | optional | — | — | Keep only companies whose latest-TTM asset turnover is less than this number. AND-combined with other filters. | asset_turnover_lt=0 |
| book_value_per_share_gt | query | optional | — | — | Keep only companies whose latest-TTM book value per share is greater than this number. AND-combined with other filters. | book_value_per_share_gt=0 |
| book_value_per_share_lt | query | optional | — | — | Keep only companies whose latest-TTM book value per share is less than this number. AND-combined with other filters. | book_value_per_share_lt=0 |
| capex_to_depreciation_gt | query | optional | — | — | Keep only companies whose latest-TTM capex-to-depreciation ratio is greater than this number. AND-combined with other filters. | capex_to_depreciation_gt=0 |
| capex_to_depreciation_lt | query | optional | — | — | Keep only companies whose latest-TTM capex-to-depreciation ratio is less than this number. AND-combined with other filters. | capex_to_depreciation_lt=0 |
| capex_to_revenue_gt | query | optional | — | — | Keep only companies whose latest-TTM capex-to-revenue ratio is greater than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | capex_to_revenue_gt=0 |
| capex_to_revenue_lt | query | optional | — | — | Keep only companies whose latest-TTM capex-to-revenue ratio is less than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | capex_to_revenue_lt=0 |
| cash_per_share_gt | query | optional | — | — | Keep only companies whose latest-TTM cash per share is greater than this number. AND-combined with other filters. | cash_per_share_gt=0 |
| cash_per_share_lt | query | optional | — | — | Keep only companies whose latest-TTM cash per share is less than this number. AND-combined with other filters. | cash_per_share_lt=0 |
| cash_ratio_gt | query | optional | — | — | Keep only companies whose latest-TTM cash ratio is greater than this number. AND-combined with other filters. | cash_ratio_gt=0 |
| cash_ratio_lt | query | optional | — | — | Keep only companies whose latest-TTM cash ratio is less than this number. AND-combined with other filters. | cash_ratio_lt=0 |
| cash_runway_gt | query | optional | — | — | Keep only companies whose latest-TTM cash runway (months) is greater than this number. AND-combined with other filters. | cash_runway_gt=0 |
| cash_runway_lt | query | optional | — | — | Keep only companies whose latest-TTM cash runway (months) is less than this number. AND-combined with other filters. | cash_runway_lt=0 |
| current_ratio_gt | query | optional | — | — | Keep only companies whose latest-TTM current ratio is greater than this number. AND-combined with other filters. | current_ratio_gt=0 |
| current_ratio_lt | query | optional | — | — | Keep only companies whose latest-TTM current ratio is less than this number. AND-combined with other filters. | current_ratio_lt=0 |
| debt_to_assets_gt | query | optional | — | — | Keep only companies whose latest-TTM debt-to-assets ratio is greater than this number. AND-combined with other filters. | debt_to_assets_gt=0 |
| debt_to_assets_lt | query | optional | — | — | Keep only companies whose latest-TTM debt-to-assets ratio is less than this number. AND-combined with other filters. | debt_to_assets_lt=0 |
| debt_to_capital_gt | query | optional | — | — | Keep only companies whose latest-TTM debt-to-capital ratio is greater than this number. AND-combined with other filters. | debt_to_capital_gt=0 |
| debt_to_capital_lt | query | optional | — | — | Keep only companies whose latest-TTM debt-to-capital ratio is less than this number. AND-combined with other filters. | debt_to_capital_lt=0 |
| debt_to_ebitda_gt | query | optional | — | — | Keep only companies whose latest-TTM debt-to-EBITDA ratio is greater than this number. AND-combined with other filters. | debt_to_ebitda_gt=0 |
| debt_to_ebitda_lt | query | optional | — | — | Keep only companies whose latest-TTM debt-to-EBITDA ratio is less than this number. AND-combined with other filters. | debt_to_ebitda_lt=0 |
| debt_to_equity_gt | query | optional | — | — | Keep only companies whose latest-TTM debt-to-equity ratio is greater than this number. AND-combined with other filters. | debt_to_equity_gt=0 |
| debt_to_equity_lt | query | optional | — | — | Keep only companies whose latest-TTM debt-to-equity ratio is less than this number. AND-combined with other filters. | debt_to_equity_lt=1.0 |
| dio_gt | query | optional | — | — | Keep only companies whose latest-TTM days inventory outstanding (DIO) is greater than this number. AND-combined with other filters. | dio_gt=0 |
| dio_lt | query | optional | — | — | Keep only companies whose latest-TTM days inventory outstanding (DIO) is less than this number. AND-combined with other filters. | dio_lt=0 |
| dividend_per_share_gt | query | optional | — | — | Keep only companies whose latest-TTM dividend per share is greater than this number. AND-combined with other filters. | dividend_per_share_gt=0 |
| dividend_per_share_lt | query | optional | — | — | Keep only companies whose latest-TTM dividend per share is less than this number. AND-combined with other filters. | dividend_per_share_lt=0 |
| dividend_yield_gt | query | optional | — | — | Keep only companies whose latest-TTM dividend yield is greater than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | dividend_yield_gt=0 |
| dividend_yield_lt | query | optional | — | — | Keep only companies whose latest-TTM dividend yield is less than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | dividend_yield_lt=0 |
| dso_gt | query | optional | — | — | Keep only companies whose latest-TTM days sales outstanding (DSO) is greater than this number. AND-combined with other filters. | dso_gt=0 |
| dso_lt | query | optional | — | — | Keep only companies whose latest-TTM days sales outstanding (DSO) is less than this number. AND-combined with other filters. | dso_lt=0 |
| earnings_yield_gt | query | optional | — | — | Keep only companies whose latest-TTM earnings yield is greater than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | earnings_yield_gt=0 |
| earnings_yield_lt | query | optional | — | — | Keep only companies whose latest-TTM earnings yield is less than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | earnings_yield_lt=0 |
| ebitda_gt | query | optional | — | — | Keep only companies whose latest-TTM EBITDA is greater than this number. AND-combined with other filters. | ebitda_gt=0 |
| ebitda_lt | query | optional | — | — | Keep only companies whose latest-TTM EBITDA is less than this number. AND-combined with other filters. | ebitda_lt=0 |
| ebitda_margin_gt | query | optional | — | — | Keep only companies whose latest-TTM EBITDA margin is greater than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | ebitda_margin_gt=0 |
| ebitda_margin_lt | query | optional | — | — | Keep only companies whose latest-TTM EBITDA margin is less than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | ebitda_margin_lt=0 |
| eps_growth_sequential_gt | query | optional | — | — | Keep only companies whose latest-TTM sequential (period-over-period) EPS growth is greater than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | eps_growth_sequential_gt=0 |
| eps_growth_sequential_lt | query | optional | — | — | Keep only companies whose latest-TTM sequential (period-over-period) EPS growth is less than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | eps_growth_sequential_lt=0 |
| eps_growth_yoy_gt | query | optional | — | — | Keep only companies whose latest-TTM year-over-year EPS growth is greater than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | eps_growth_yoy_gt=0 |
| eps_growth_yoy_lt | query | optional | — | — | Keep only companies whose latest-TTM year-over-year EPS growth is less than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | eps_growth_yoy_lt=0 |
| eps_growth_yoy_q_gt | query | optional | — | — | Keep only companies whose latest-TTM same-quarter-year-over-year EPS growth is greater than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | eps_growth_yoy_q_gt=0 |
| eps_growth_yoy_q_lt | query | optional | — | — | Keep only companies whose latest-TTM same-quarter-year-over-year EPS growth is less than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | eps_growth_yoy_q_lt=0 |
| ev_gt | query | optional | — | — | Keep only companies whose latest-TTM enterprise value (EV) is greater than this number. AND-combined with other filters. | ev_gt=0 |
| ev_lt | query | optional | — | — | Keep only companies whose latest-TTM enterprise value (EV) is less than this number. AND-combined with other filters. | ev_lt=0 |
| ev_to_ebit_gt | query | optional | — | — | Keep only companies whose latest-TTM EV-to-EBIT ratio is greater than this number. AND-combined with other filters. | ev_to_ebit_gt=0 |
| ev_to_ebit_lt | query | optional | — | — | Keep only companies whose latest-TTM EV-to-EBIT ratio is less than this number. AND-combined with other filters. | ev_to_ebit_lt=0 |
| ev_to_ebitda_gt | query | optional | — | — | Keep only companies whose latest-TTM EV-to-EBITDA ratio is greater than this number. AND-combined with other filters. | ev_to_ebitda_gt=0 |
| ev_to_ebitda_lt | query | optional | — | — | Keep only companies whose latest-TTM EV-to-EBITDA ratio is less than this number. AND-combined with other filters. | ev_to_ebitda_lt=0 |
| ev_to_fcf_gt | query | optional | — | — | Keep only companies whose latest-TTM EV-to-free-cash-flow ratio is greater than this number. AND-combined with other filters. | ev_to_fcf_gt=0 |
| ev_to_fcf_lt | query | optional | — | — | Keep only companies whose latest-TTM EV-to-free-cash-flow ratio is less than this number. AND-combined with other filters. | ev_to_fcf_lt=0 |
| ev_to_sales_gt | query | optional | — | — | Keep only companies whose latest-TTM EV-to-sales ratio is greater than this number. AND-combined with other filters. | ev_to_sales_gt=0 |
| ev_to_sales_lt | query | optional | — | — | Keep only companies whose latest-TTM EV-to-sales ratio is less than this number. AND-combined with other filters. | ev_to_sales_lt=0 |
| fcf_margin_gt | query | optional | — | — | Keep only companies whose latest-TTM free-cash-flow margin is greater than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | fcf_margin_gt=0 |
| fcf_margin_lt | query | optional | — | — | Keep only companies whose latest-TTM free-cash-flow margin is less than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | fcf_margin_lt=0 |
| fcf_per_share_gt | query | optional | — | — | Keep only companies whose latest-TTM free cash flow per share is greater than this number. AND-combined with other filters. | fcf_per_share_gt=0 |
| fcf_per_share_lt | query | optional | — | — | Keep only companies whose latest-TTM free cash flow per share is less than this number. AND-combined with other filters. | fcf_per_share_lt=0 |
| fcf_to_ni_gt | query | optional | — | — | Keep only companies whose latest-TTM free-cash-flow-to-net-income ratio is greater than this number. AND-combined with other filters. | fcf_to_ni_gt=0 |
| fcf_to_ni_lt | query | optional | — | — | Keep only companies whose latest-TTM free-cash-flow-to-net-income ratio is less than this number. AND-combined with other filters. | fcf_to_ni_lt=0 |
| fcf_yield_gt | query | optional | — | — | Keep only companies whose latest-TTM free-cash-flow yield is greater than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | fcf_yield_gt=0 |
| fcf_yield_lt | query | optional | — | — | Keep only companies whose latest-TTM free-cash-flow yield is less than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | fcf_yield_lt=0 |
| fixed_asset_turnover_gt | query | optional | — | — | Keep only companies whose latest-TTM fixed-asset turnover is greater than this number. AND-combined with other filters. | fixed_asset_turnover_gt=0 |
| fixed_asset_turnover_lt | query | optional | — | — | Keep only companies whose latest-TTM fixed-asset turnover is less than this number. AND-combined with other filters. | fixed_asset_turnover_lt=0 |
| free_cashflow_gt | query | optional | — | — | Keep only companies whose latest-TTM free cash flow is greater than this number. AND-combined with other filters. | free_cashflow_gt=0 |
| free_cashflow_lt | query | optional | — | — | Keep only companies whose latest-TTM free cash flow is less than this number. AND-combined with other filters. | free_cashflow_lt=0 |
| gross_margin_gt | query | optional | — | — | Keep only companies whose latest-TTM gross margin is greater than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | gross_margin_gt=0 |
| gross_margin_lt | query | optional | — | — | Keep only companies whose latest-TTM gross margin is less than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | gross_margin_lt=0 |
| interest_coverage_gt | query | optional | — | — | Keep only companies whose latest-TTM interest coverage ratio is greater than this number. AND-combined with other filters. | interest_coverage_gt=0 |
| interest_coverage_lt | query | optional | — | — | Keep only companies whose latest-TTM interest coverage ratio is less than this number. AND-combined with other filters. | interest_coverage_lt=0 |
| inventory_turnover_gt | query | optional | — | — | Keep only companies whose latest-TTM inventory turnover is greater than this number. AND-combined with other filters. | inventory_turnover_gt=0 |
| inventory_turnover_lt | query | optional | — | — | Keep only companies whose latest-TTM inventory turnover is less than this number. AND-combined with other filters. | inventory_turnover_lt=0 |
| invested_capital_gt | query | optional | — | — | Keep only companies whose latest-TTM invested capital is greater than this number. AND-combined with other filters. | invested_capital_gt=0 |
| invested_capital_lt | query | optional | — | — | Keep only companies whose latest-TTM invested capital is less than this number. AND-combined with other filters. | invested_capital_lt=0 |
| liabilities_to_equity_gt | query | optional | — | — | Keep only companies whose latest-TTM total-liabilities-to-equity ratio is greater than this number. AND-combined with other filters. | liabilities_to_equity_gt=0 |
| liabilities_to_equity_lt | query | optional | — | — | Keep only companies whose latest-TTM total-liabilities-to-equity ratio is less than this number. AND-combined with other filters. | liabilities_to_equity_lt=0 |
| lt_debt_to_equity_gt | query | optional | — | — | Keep only companies whose latest-TTM long-term-debt-to-equity ratio is greater than this number. AND-combined with other filters. | lt_debt_to_equity_gt=0 |
| lt_debt_to_equity_lt | query | optional | — | — | Keep only companies whose latest-TTM long-term-debt-to-equity ratio is less than this number. AND-combined with other filters. | lt_debt_to_equity_lt=0 |
| market_cap_gt | query | optional | — | — | Keep only companies whose latest-TTM market capitalization is greater than this number. AND-combined with other filters. | market_cap_gt=0 |
| market_cap_lt | query | optional | — | — | Keep only companies whose latest-TTM market capitalization is less than this number. AND-combined with other filters. | market_cap_lt=0 |
| monthly_burn_rate_gt | query | optional | — | — | Keep only companies whose latest-TTM monthly cash burn rate is greater than this number. AND-combined with other filters. | monthly_burn_rate_gt=0 |
| monthly_burn_rate_lt | query | optional | — | — | Keep only companies whose latest-TTM monthly cash burn rate is less than this number. AND-combined with other filters. | monthly_burn_rate_lt=0 |
| net_debt_gt | query | optional | — | — | Keep only companies whose latest-TTM net debt is greater than this number. AND-combined with other filters. | net_debt_gt=0 |
| net_debt_lt | query | optional | — | — | Keep only companies whose latest-TTM net debt is less than this number. AND-combined with other filters. | net_debt_lt=0 |
| net_debt_to_ebitda_gt | query | optional | — | — | Keep only companies whose latest-TTM net-debt-to-EBITDA ratio is greater than this number. AND-combined with other filters. | net_debt_to_ebitda_gt=0 |
| net_debt_to_ebitda_lt | query | optional | — | — | Keep only companies whose latest-TTM net-debt-to-EBITDA ratio is less than this number. AND-combined with other filters. | net_debt_to_ebitda_lt=0 |
| net_margin_gt | query | optional | — | — | Keep only companies whose latest-TTM net margin is greater than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | net_margin_gt=0 |
| net_margin_lt | query | optional | — | — | Keep only companies whose latest-TTM net margin is less than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | net_margin_lt=0 |
| ocf_per_share_gt | query | optional | — | — | Keep only companies whose latest-TTM operating cash flow per share is greater than this number. AND-combined with other filters. | ocf_per_share_gt=0 |
| ocf_per_share_lt | query | optional | — | — | Keep only companies whose latest-TTM operating cash flow per share is less than this number. AND-combined with other filters. | ocf_per_share_lt=0 |
| ocf_to_ni_gt | query | optional | — | — | Keep only companies whose latest-TTM operating-cash-flow-to-net-income ratio is greater than this number. AND-combined with other filters. | ocf_to_ni_gt=0 |
| ocf_to_ni_lt | query | optional | — | — | Keep only companies whose latest-TTM operating-cash-flow-to-net-income ratio is less than this number. AND-combined with other filters. | ocf_to_ni_lt=0 |
| operating_cycle_gt | query | optional | — | — | Keep only companies whose latest-TTM operating cycle (days) is greater than this number. AND-combined with other filters. | operating_cycle_gt=0 |
| operating_cycle_lt | query | optional | — | — | Keep only companies whose latest-TTM operating cycle (days) is less than this number. AND-combined with other filters. | operating_cycle_lt=0 |
| operating_margin_gt | query | optional | — | — | Keep only companies whose latest-TTM operating margin is greater than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | operating_margin_gt=0 |
| operating_margin_lt | query | optional | — | — | Keep only companies whose latest-TTM operating margin is less than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | operating_margin_lt=0 |
| payout_ratio_gt | query | optional | — | — | Keep only companies whose latest-TTM dividend payout ratio is greater than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | payout_ratio_gt=0 |
| payout_ratio_lt | query | optional | — | — | Keep only companies whose latest-TTM dividend payout ratio is less than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | payout_ratio_lt=0 |
| pe_ratio_gt | query | optional | — | — | Keep only companies whose latest-TTM price-to-earnings (P/E) ratio is greater than this number. AND-combined with other filters. | pe_ratio_gt=0 |
| pe_ratio_lt | query | optional | — | — | Keep only companies whose latest-TTM price-to-earnings (P/E) ratio is less than this number. AND-combined with other filters. | pe_ratio_lt=0 |
| price_to_book_gt | query | optional | — | — | Keep only companies whose latest-TTM price-to-book (P/B) ratio is greater than this number. AND-combined with other filters. | price_to_book_gt=0 |
| price_to_book_lt | query | optional | — | — | Keep only companies whose latest-TTM price-to-book (P/B) ratio is less than this number. AND-combined with other filters. | price_to_book_lt=0 |
| price_to_fcf_gt | query | optional | — | — | Keep only companies whose latest-TTM price-to-free-cash-flow ratio is greater than this number. AND-combined with other filters. | price_to_fcf_gt=0 |
| price_to_fcf_lt | query | optional | — | — | Keep only companies whose latest-TTM price-to-free-cash-flow ratio is less than this number. AND-combined with other filters. | price_to_fcf_lt=0 |
| price_to_sales_gt | query | optional | — | — | Keep only companies whose latest-TTM price-to-sales (P/S) ratio is greater than this number. AND-combined with other filters. | price_to_sales_gt=0 |
| price_to_sales_lt | query | optional | — | — | Keep only companies whose latest-TTM price-to-sales (P/S) ratio is less than this number. AND-combined with other filters. | price_to_sales_lt=0 |
| price_to_tangible_book_gt | query | optional | — | — | Keep only companies whose latest-TTM price-to-tangible-book ratio is greater than this number. AND-combined with other filters. | price_to_tangible_book_gt=0 |
| price_to_tangible_book_lt | query | optional | — | — | Keep only companies whose latest-TTM price-to-tangible-book ratio is less than this number. AND-combined with other filters. | price_to_tangible_book_lt=0 |
| quick_ratio_gt | query | optional | — | — | Keep only companies whose latest-TTM quick ratio is greater than this number. AND-combined with other filters. | quick_ratio_gt=0 |
| quick_ratio_lt | query | optional | — | — | Keep only companies whose latest-TTM quick ratio is less than this number. AND-combined with other filters. | quick_ratio_lt=0 |
| rd_intensity_gt | query | optional | — | — | Keep only companies whose latest-TTM R&D intensity (R&D-to-revenue) is greater than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | rd_intensity_gt=0 |
| rd_intensity_lt | query | optional | — | — | Keep only companies whose latest-TTM R&D intensity (R&D-to-revenue) is less than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | rd_intensity_lt=0 |
| receivables_turnover_gt | query | optional | — | — | Keep only companies whose latest-TTM receivables turnover is greater than this number. AND-combined with other filters. | receivables_turnover_gt=0 |
| receivables_turnover_lt | query | optional | — | — | Keep only companies whose latest-TTM receivables turnover is less than this number. AND-combined with other filters. | receivables_turnover_lt=0 |
| retention_ratio_gt | query | optional | — | — | Keep only companies whose latest-TTM earnings retention ratio is greater than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | retention_ratio_gt=0 |
| retention_ratio_lt | query | optional | — | — | Keep only companies whose latest-TTM earnings retention ratio is less than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | retention_ratio_lt=0 |
| revenue_growth_sequential_gt | query | optional | — | — | Keep only companies whose latest-TTM sequential (period-over-period) revenue growth is greater than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | revenue_growth_sequential_gt=0 |
| revenue_growth_sequential_lt | query | optional | — | — | Keep only companies whose latest-TTM sequential (period-over-period) revenue growth is less than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | revenue_growth_sequential_lt=0 |
| revenue_growth_yoy_gt | query | optional | — | — | Keep only companies whose latest-TTM year-over-year revenue growth is greater than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | revenue_growth_yoy_gt=0 |
| revenue_growth_yoy_lt | query | optional | — | — | Keep only companies whose latest-TTM year-over-year revenue growth is less than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | revenue_growth_yoy_lt=0 |
| revenue_growth_yoy_q_gt | query | optional | — | — | Keep only companies whose latest-TTM same-quarter-year-over-year revenue growth is greater than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | revenue_growth_yoy_q_gt=0 |
| revenue_growth_yoy_q_lt | query | optional | — | — | Keep only companies whose latest-TTM same-quarter-year-over-year revenue growth is less than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | revenue_growth_yoy_q_lt=0 |
| revenue_per_share_gt | query | optional | — | — | Keep only companies whose latest-TTM revenue per share is greater than this number. AND-combined with other filters. | revenue_per_share_gt=0 |
| revenue_per_share_lt | query | optional | — | — | Keep only companies whose latest-TTM revenue per share is less than this number. AND-combined with other filters. | revenue_per_share_lt=0 |
| roa_gt | query | optional | — | — | Keep only companies whose latest-TTM return on assets (ROA) is greater than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | roa_gt=0 |
| roa_lt | query | optional | — | — | Keep only companies whose latest-TTM return on assets (ROA) is less than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | roa_lt=0 |
| roce_gt | query | optional | — | — | Keep only companies whose latest-TTM return on capital employed (ROCE) is greater than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | roce_gt=0 |
| roce_lt | query | optional | — | — | Keep only companies whose latest-TTM return on capital employed (ROCE) is less than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | roce_lt=0 |
| roe_gt | query | optional | — | — | Keep only companies whose latest-TTM return on equity (ROE) is greater than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | roe_gt=0.15 |
| roe_lt | query | optional | — | — | Keep only companies whose latest-TTM return on equity (ROE) is less than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | roe_lt=0 |
| roic_gt | query | optional | — | — | Keep only companies whose latest-TTM return on invested capital (ROIC) is greater than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | roic_gt=0 |
| roic_lt | query | optional | — | — | Keep only companies whose latest-TTM return on invested capital (ROIC) is less than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | roic_lt=0 |
| sga_ratio_gt | query | optional | — | — | Keep only companies whose latest-TTM SG&A-to-revenue ratio is greater than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | sga_ratio_gt=0 |
| sga_ratio_lt | query | optional | — | — | Keep only companies whose latest-TTM SG&A-to-revenue ratio is less than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | sga_ratio_lt=0 |
| shareholder_yield_gt | query | optional | — | — | Keep only companies whose latest-TTM shareholder yield is greater than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | shareholder_yield_gt=0 |
| shareholder_yield_lt | query | optional | — | — | Keep only companies whose latest-TTM shareholder yield is less than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | shareholder_yield_lt=0 |
| wc_to_revenue_gt | query | optional | — | — | Keep only companies whose latest-TTM working-capital-to-revenue ratio is greater than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | wc_to_revenue_gt=0 |
| wc_to_revenue_lt | query | optional | — | — | Keep only companies whose latest-TTM working-capital-to-revenue ratio is less than this number. Decimals for percent-style metrics (0.15 = 15%). AND-combined with other filters. | wc_to_revenue_lt=0 |
| working_capital_gt | query | optional | — | — | Keep only companies whose latest-TTM working capital is greater than this number. AND-combined with other filters. | working_capital_gt=0 |
| working_capital_lt | query | optional | — | — | Keep only companies whose latest-TTM working capital is less than this number. AND-combined with other filters. | working_capital_lt=0 |
| metrics | query | optional | — | — | Comma-separated list of which metric values to return for each matching company. Defaults to the filtered metrics (or all screenable metrics when only a cik/ticker list is given). Unknown keys return 400 listing the legal keys. | roe,debt_to_equity,fcf_margin |
| cik | query | optional | — | — | Comma-separated CIK list (max 100). Restricts the screen to these companies. Combine with filters/metrics to fetch a named batch. | 320193,789019 |
| ticker | query | optional | — | — | Comma-separated ticker list (max 100), resolved via the canonical ticker map; each resolver record's CIK is normalized and used for matching. Unknown tickers return 404 listing the unresolved symbols. | AAPL,MSFT,NVDA |
| limit | query | optional | — | — | Page size (default 50, max 500). | 50 |
| offset | query | optional | — | — | Row offset for pagination (default 0). | 0 |
Response schema
| Field | Type | Nullable | Description |
|---|---|---|---|
| data | array | no | Matching companies. Ordered by the primary filtered metric value (descending) then CIK, so offset pagination is repeatable. Empty on overly-narrow filters. |
| data[].cik | string | no | Company CIK (leading zeros stripped). |
| data[].ticker | string | yes | Primary ticker for the company, or null if none is mapped. |
| data[].period_end | string | yes | Period-end date (YYYY-MM-DD) of the latest TTM values returned for this company. |
| data[].metrics | object | no | Map of requested metric key to its latest-TTM value (number). A metric the company does not report at TTM is simply absent from the map (never a fabricated zero). |
| meta.pagination | object | no | Standard pagination block. total is null (an exact cross-sectional count is skipped); use has_more (a full page returned) to page forward. |
| meta.screen | object | no | Echoes the applied filters, returned metrics, grain (TTM) and latest-period semantics for transparency. |
Sample response
·
- "status": "success"
- "data":
- "meta":
- "pagination":
- "screen":
Errors
| Status | Label | Description |
|---|---|---|
| 200 | OK | Request succeeded. |
| 400 | Bad Request | Invalid query, body, or path parameter. |
| 401 | Unauthorized | Missing or invalid Authorization header / api_Token. |
| 402 | Payment Required | Insufficient token balance for this call. Top up |
| 429 | Too Many Requests | Rate limit exceeded for your tier (see /pricing for tier limits). Tier limits |
| 500 | Server Error | Unexpected server-side failure. Retry with backoff; report if persistent. |
Code samples
curl "https://api.finradar.ai/api/v1/xbrl/screen?api_Token=YOUR_API_KEY&asset_turnover_gt=asset_turnover_gt%3D0&asset_turnover_lt=asset_turnover_lt%3D0&book_value_per_share_gt=book_value_per_share_gt%3D0&book_value_per_share_lt=book_value_per_share_lt%3D0&capex_to_depreciation_gt=capex_to_depreciation_gt%3D0&capex_to_depreciation_lt=capex_to_depreciation_lt%3D0&capex_to_revenue_gt=capex_to_revenue_gt%3D0&capex_to_revenue_lt=capex_to_revenue_lt%3D0&cash_per_share_gt=cash_per_share_gt%3D0&cash_per_share_lt=cash_per_share_lt%3D0&cash_ratio_gt=cash_ratio_gt%3D0&cash_ratio_lt=cash_ratio_lt%3D0&cash_runway_gt=cash_runway_gt%3D0&cash_runway_lt=cash_runway_lt%3D0¤t_ratio_gt=current_ratio_gt%3D0¤t_ratio_lt=current_ratio_lt%3D0&debt_to_assets_gt=debt_to_assets_gt%3D0&debt_to_assets_lt=debt_to_assets_lt%3D0&debt_to_capital_gt=debt_to_capital_gt%3D0&debt_to_capital_lt=debt_to_capital_lt%3D0&debt_to_ebitda_gt=debt_to_ebitda_gt%3D0&debt_to_ebitda_lt=debt_to_ebitda_lt%3D0&debt_to_equity_gt=debt_to_equity_gt%3D0&debt_to_equity_lt=debt_to_equity_lt%3D1.0&dio_gt=dio_gt%3D0&dio_lt=dio_lt%3D0÷nd_per_share_gt=dividend_per_share_gt%3D0÷nd_per_share_lt=dividend_per_share_lt%3D0÷nd_yield_gt=dividend_yield_gt%3D0÷nd_yield_lt=dividend_yield_lt%3D0&dso_gt=dso_gt%3D0&dso_lt=dso_lt%3D0&earnings_yield_gt=earnings_yield_gt%3D0&earnings_yield_lt=earnings_yield_lt%3D0&ebitda_gt=ebitda_gt%3D0&ebitda_lt=ebitda_lt%3D0&ebitda_margin_gt=ebitda_margin_gt%3D0&ebitda_margin_lt=ebitda_margin_lt%3D0&eps_growth_sequential_gt=eps_growth_sequential_gt%3D0&eps_growth_sequential_lt=eps_growth_sequential_lt%3D0&eps_growth_yoy_gt=eps_growth_yoy_gt%3D0&eps_growth_yoy_lt=eps_growth_yoy_lt%3D0&eps_growth_yoy_q_gt=eps_growth_yoy_q_gt%3D0&eps_growth_yoy_q_lt=eps_growth_yoy_q_lt%3D0&ev_gt=ev_gt%3D0&ev_lt=ev_lt%3D0&ev_to_ebit_gt=ev_to_ebit_gt%3D0&ev_to_ebit_lt=ev_to_ebit_lt%3D0&ev_to_ebitda_gt=ev_to_ebitda_gt%3D0&ev_to_ebitda_lt=ev_to_ebitda_lt%3D0&ev_to_fcf_gt=ev_to_fcf_gt%3D0&ev_to_fcf_lt=ev_to_fcf_lt%3D0&ev_to_sales_gt=ev_to_sales_gt%3D0&ev_to_sales_lt=ev_to_sales_lt%3D0&fcf_margin_gt=fcf_margin_gt%3D0&fcf_margin_lt=fcf_margin_lt%3D0&fcf_per_share_gt=fcf_per_share_gt%3D0&fcf_per_share_lt=fcf_per_share_lt%3D0&fcf_to_ni_gt=fcf_to_ni_gt%3D0&fcf_to_ni_lt=fcf_to_ni_lt%3D0&fcf_yield_gt=fcf_yield_gt%3D0&fcf_yield_lt=fcf_yield_lt%3D0&fixed_asset_turnover_gt=fixed_asset_turnover_gt%3D0&fixed_asset_turnover_lt=fixed_asset_turnover_lt%3D0&free_cashflow_gt=free_cashflow_gt%3D0&free_cashflow_lt=free_cashflow_lt%3D0&gross_margin_gt=gross_margin_gt%3D0&gross_margin_lt=gross_margin_lt%3D0&interest_coverage_gt=interest_coverage_gt%3D0&interest_coverage_lt=interest_coverage_lt%3D0&inventory_turnover_gt=inventory_turnover_gt%3D0&inventory_turnover_lt=inventory_turnover_lt%3D0&invested_capital_gt=invested_capital_gt%3D0&invested_capital_lt=invested_capital_lt%3D0&liabilities_to_equity_gt=liabilities_to_equity_gt%3D0&liabilities_to_equity_lt=liabilities_to_equity_lt%3D0<_debt_to_equity_gt=lt_debt_to_equity_gt%3D0<_debt_to_equity_lt=lt_debt_to_equity_lt%3D0&market_cap_gt=market_cap_gt%3D0&market_cap_lt=market_cap_lt%3D0&monthly_burn_rate_gt=monthly_burn_rate_gt%3D0&monthly_burn_rate_lt=monthly_burn_rate_lt%3D0&net_debt_gt=net_debt_gt%3D0&net_debt_lt=net_debt_lt%3D0&net_debt_to_ebitda_gt=net_debt_to_ebitda_gt%3D0&net_debt_to_ebitda_lt=net_debt_to_ebitda_lt%3D0&net_margin_gt=net_margin_gt%3D0&net_margin_lt=net_margin_lt%3D0&ocf_per_share_gt=ocf_per_share_gt%3D0&ocf_per_share_lt=ocf_per_share_lt%3D0&ocf_to_ni_gt=ocf_to_ni_gt%3D0&ocf_to_ni_lt=ocf_to_ni_lt%3D0&operating_cycle_gt=operating_cycle_gt%3D0&operating_cycle_lt=operating_cycle_lt%3D0&operating_margin_gt=operating_margin_gt%3D0&operating_margin_lt=operating_margin_lt%3D0&payout_ratio_gt=payout_ratio_gt%3D0&payout_ratio_lt=payout_ratio_lt%3D0&pe_ratio_gt=pe_ratio_gt%3D0&pe_ratio_lt=pe_ratio_lt%3D0&price_to_book_gt=price_to_book_gt%3D0&price_to_book_lt=price_to_book_lt%3D0&price_to_fcf_gt=price_to_fcf_gt%3D0&price_to_fcf_lt=price_to_fcf_lt%3D0&price_to_sales_gt=price_to_sales_gt%3D0&price_to_sales_lt=price_to_sales_lt%3D0&price_to_tangible_book_gt=price_to_tangible_book_gt%3D0&price_to_tangible_book_lt=price_to_tangible_book_lt%3D0&quick_ratio_gt=quick_ratio_gt%3D0&quick_ratio_lt=quick_ratio_lt%3D0&rd_intensity_gt=rd_intensity_gt%3D0&rd_intensity_lt=rd_intensity_lt%3D0&receivables_turnover_gt=receivables_turnover_gt%3D0&receivables_turnover_lt=receivables_turnover_lt%3D0&retention_ratio_gt=retention_ratio_gt%3D0&retention_ratio_lt=retention_ratio_lt%3D0&revenue_growth_sequential_gt=revenue_growth_sequential_gt%3D0&revenue_growth_sequential_lt=revenue_growth_sequential_lt%3D0&revenue_growth_yoy_gt=revenue_growth_yoy_gt%3D0&revenue_growth_yoy_lt=revenue_growth_yoy_lt%3D0&revenue_growth_yoy_q_gt=revenue_growth_yoy_q_gt%3D0&revenue_growth_yoy_q_lt=revenue_growth_yoy_q_lt%3D0&revenue_per_share_gt=revenue_per_share_gt%3D0&revenue_per_share_lt=revenue_per_share_lt%3D0&roa_gt=roa_gt%3D0&roa_lt=roa_lt%3D0&roce_gt=roce_gt%3D0&roce_lt=roce_lt%3D0&roe_gt=roe_gt%3D0.15&roe_lt=roe_lt%3D0&roic_gt=roic_gt%3D0&roic_lt=roic_lt%3D0&sga_ratio_gt=sga_ratio_gt%3D0&sga_ratio_lt=sga_ratio_lt%3D0&shareholder_yield_gt=shareholder_yield_gt%3D0&shareholder_yield_lt=shareholder_yield_lt%3D0&wc_to_revenue_gt=wc_to_revenue_gt%3D0&wc_to_revenue_lt=wc_to_revenue_lt%3D0&working_capital_gt=working_capital_gt%3D0&working_capital_lt=working_capital_lt%3D0&metrics=roe%2Cdebt_to_equity%2Cfcf_margin&cik=320193%2C789019&ticker=AAPL%2CMSFT%2CNVDA&limit=50&offset=0" \
-H "Authorization: Bearer YOUR_JWT_TOKEN"Generate an API key in /account/credentials to run live queries (literal YOUR_API_KEY placeholder shown until then).