Screener: search initial holdings (Form 3)
search_initial_holdingsScreen Form 3 holdings across the whole library: holding-level conditions in holding_filters plus company-level gates in aggregate_filters. Operators for both: >, >=, <, <=, between ([lo, hi]). Returns the matching holdings themselves — grouped by ticker (default) or flat. In grouped mode holdings_count and shares_owned_total are the company's full hit values, not the page's. Every row carries issuer_cik, accession_number, filing_date, no_securities_owned, source_url_prefix and insiders. Filings that report no holdings have no rows here; they only enter the company-level filing_count / no_securities_filing_count gates. Filter on split_adjusted_shares_owned rather than shares_owned when the window spans a corporate action. page x page_size <= 500. Dynamic credit cost 65-920, charged even when the result set is empty and on a 504 timeout. Requires the Pro plan or higher; results are limited to your plan's history window and company coverage. POST /api/v1/screener/initial-holdings; FINANCIAL_API_DOCUMENTATION.md.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 1-based page number. page x page_size <= 500. | |
| sectors | No | Canonical sector buckets (Pro+); names from list_screener_filters.sectors. | |
| sort_by | No | Grouped: ticker, holdings_count, shares_owned_total. Flat: filing_date, shares_owned, split_adjusted_shares_owned, underlying_security_shares, conversion_or_exercise_price. | |
| tickers | No | Whitelist, <= 100. Omit to scan the whole library. | |
| page_size | No | Rows per page, 1-100 (default 50). | |
| as_of_date | No | YYYY-MM-DD window end (filing date), must not be in the future. | |
| sort_order | No | "desc" (default) or "asc". | desc |
| start_date | No | YYYY-MM-DD window start (filing date). | |
| exclude_tickers | No | Blacklist, <= 100. | |
| group_by_ticker | No | When true (default), group rows by ticker; when false, return flat rows. | |
| holding_filters | No | Holding-level filters: relationship, is_derivative, direct_or_indirect (D or I), include_anomalies, exclude_likely_merged, include_unresolved_amendments, conditions (<=8 of {field, op, value}; field is one of shares_owned, split_adjusted_shares_owned, underlying_security_shares, split_adjusted_underlying_security_shares, conversion_or_exercise_price). | |
| aggregate_filters | No | Company-level gates (<=8) of {metric, op, value}; metric is one of filing_count, no_securities_filing_count, distinct_insiders, holdings_count, shares_owned_total. |