Get Dilution Instrument Rows by Family
get_dilution_instrumentsRetrieve one instrument family's dilution rows with per-field SEC citations. Request only families you need; unavailable means not measured, not zero.
Instructions
Get ONE instrument family's rows (10 credits) with per-field SEC citations — each figure carries the accession number, filing date and the verbatim quoted sentence it was read from, so every number can be traced to a filing. Families: warrants, convertibles, preferred, shelfs, atms, elocs, s1_offerings, equity_plans, exchangeables, recent_offerings. One family per call — request the families you actually need rather than sweeping all ten. 🔴 ROW-LEVEL WITHHOLDING: withheldRows / withheldRowCount mean specific rows could NOT be verified and were blanked, so every family total in the response is a LOWER BOUND, not a complete figure. Say so — presenting a holed total as complete understates a named issuer's dilution. An empty rows array on a covered company is a measured "none found in the filings read"; an unavailable response is not. ALWAYS RETURNS 200 — read available and reason, never the HTTP status. Coverage is partial: not_covered means THIS COMPANY HAS NOT BEEN ANALYSED YET, which is different from it having no dilution and different from an outage (an outage is a 5xx). Never report a company as having no dilution on the strength of an unavailable response. NULL, absent or withheld means NOT MEASURED — it NEVER means "no dilution", "no warrants", "no shelf" or zero. A numeric 0 is a MEASURED zero and defeats a null check, so decide from the accompanying availability/withheld/reason field, never from the value itself. If a figure is absent, say it was not measured; do not describe the company as having none of that instrument. Figures are as of meta.asOfDate, from filings read through meta.filingsThrough — a stale as-of date means the answer predates anything filed since, not that nothing has happened. Share counts are rebased onto a single split basis; a row that cannot be rebased is omitted and counted rather than published on a mixed basis. Included in Signal8 Pro — without it the call returns 403 with code FEATURE_NOT_AVAILABLE and requiredTier: "pro". That is a subscription-tier upgrade, not an add-on purchase; there is no separate add-on to buy.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| family | Yes | Instrument family to return. One of: warrants, convertibles, preferred, shelfs, atms, elocs, s1_offerings, equity_plans, exchangeables, recent_offerings. | |
| ticker | Yes | Stock ticker symbol (e.g., "MNTS", "VNRX") |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No |