changedOutput schema / properties / dataset / description
Previous value: -"Canvas dataframe holding one row per reporting person across every parsed filing, each row carrying the issuer, form, accession, and dates alongside the person's powers. Joins against the insider and 13F dataframes on issuer_cik. Absent when canvas is unavailable or nothing parsed."New value: +"Dataframe with one row per reporting person across parsed filings; joins insider and 13F dataframes on issuer_cik. Absent when canvas is unavailable or nothing parsed."
changedOutput schema / properties / dataset / properties / name / description
Previous value: -"Dataframe handle (df_XXXXX_XXXXX) — inspect its columns with secedgar_dataframe_describe, then query it with secedgar_dataframe_query."New value: +"Dataframe handle (df_XXXXX_XXXXX) for secedgar_dataframe_describe, then secedgar_dataframe_query."
changedOutput schema / properties / dataset / properties / truncated / description
Previous value: -"True when the issuer has more structured filings than limit fetched — the dataframe holds the parsed filings only, not the whole history."New value: +"True when more structured filings exist than limit fetched."
changedOutput schema / properties / filings / items / properties / event_date / description
Previous value: -"Date of the event that required the filing (YYYY-MM-DD) — when the position actually crossed or changed, which precedes filing_date. Absent when the cover page omits it."New value: +"Date of the event that required the filing (YYYY-MM-DD). Absent when the cover page omits it."
changedOutput schema / properties / filings / items / properties / purpose_of_transaction / description
Previous value: -"Item 4 purpose-of-transaction prose — what the holder says it intends. Present on 13D filings only; 13G has no such field, which is what makes it the passive form. Absent on an amendment that restates no purpose."New value: +"Item 4 purpose of transaction, 13D only. Absent on 13G and on an amendment that restates none."
changedOutput schema / properties / filings / items / properties / purpose_truncated / description
Previous value: -"True when purpose_of_transaction was clipped to fit — read the full item with secedgar_get_filing on this accession number."New value: +"True when purpose_of_transaction was clipped; read the full item with secedgar_get_filing."
changedOutput schema / properties / filings / items / properties / reporting_persons / description
Previous value: -"Every reporting person on this filing. A joint filing lists a fund, its adviser, and its controlling principal separately, each reporting the same underlying shares."New value: +"Every reporting person; a joint filing lists a fund, its adviser, and its principal separately, each reporting the same shares."
changedOutput schema / properties / filings / items / properties / reporting_persons / items / properties / aggregate_amount_owned / description
Previous value: -"Shares beneficially owned by this person. Absent when the person reports no amount, which happens on an exit amendment reporting a zero position."New value: +"Shares beneficially owned by this person. Absent when none is reported, as on an exit amendment."
changedOutput schema / properties / filings / items / properties / reporting_persons / items / properties / cik / description
Previous value: -"Reporting person CIK, when the schedule carries one. SCHEDULE 13G never does — its cover page has no CIK field — so this is populated on 13D filings only."New value: +"Reporting person CIK. 13D only; the 13G cover page has no CIK field."
changedOutput schema / properties / filings / items / properties / reporting_persons / items / properties / citizenship / description
Previous value: -"SEC citizenship or place-of-organization code — a US state (\"DE\"), or an SEC country code (\"X1\" United States, \"E9\" Cayman Islands)."New value: +"SEC citizenship or place-of-organization code: a US state (\"DE\") or SEC country code (\"E9\" Cayman Islands)."
changedOutput schema / properties / filings / items / properties / reporting_persons / items / properties / excludes_certain_shares / description
Previous value: -"True when the reported aggregate deliberately excludes shares this person disclaims beneficial ownership of. Absent when the filing does not answer."New value: +"True when the aggregate excludes shares this person disclaims. Absent when the filing does not say."
changedOutput schema / properties / filings / items / properties / reporting_persons / items / properties / notes / description
Previous value: -"The filer's own cover-page footnote, usually the share count the percentage was computed against. Clipped when long — the full text is in the filing."New value: +"The filer's cover-page footnote, often the share count behind the percentage. Clipped when long."
changedOutput schema / properties / filings / items / properties / reporting_persons / items / properties / percent_of_class / description
Previous value: -"Percent of the class this person beneficially owns (0-100), as this person reports it. Per person, not per filing: joint filers report overlapping shares, so these do not sum to a group total."New value: +"Percent of the class this person beneficially owns (0-100). Joint filers report overlapping shares, so these do not sum."
changedOutput schema / properties / filings / items / properties / reporting_persons / items / properties / person_types / description
Previous value: -"SEC type-of-reporting-person codes — IN individual, CO corporation, PN partnership, IA investment adviser, HC holding company, OO other. One person can carry several."New value: +"SEC reporting-person codes: IN individual, CO corporation, PN partnership, IA investment adviser, HC holding company, OO other."
changedOutput schema / properties / filings / items / properties / security_class / description
Previous value: -"Title of the class of securities the schedule covers. A multi-class issuer has a separate schedule per class, so percentages are of this class only."New value: +"Class of securities the schedule covers; percentages are of this class only."
changedOutput schema / properties / filings_parsed / description
Previous value: -"Filings actually fetched and parsed — total_structured_filings capped by limit."New value: +"Filings fetched and parsed: total_structured_filings capped by limit."
changedOutput schema / properties / legacy_filings_before_coverage / description
Previous value: -"Legacy SC 13D / SC 13G filings in the issuer's recent submissions window — pre-2024-12-18 stakes this tool cannot parse. Reach them with secedgar_search_filings and read them with secedgar_get_filing. A floor, not a lifetime count: the submissions window holds the last year or 1,000 filings of every type, whichever is more."New value: +"Legacy SC 13D / SC 13G filings (pre-2024-12-18) in the recent submissions window, which this tool cannot parse; find them with secedgar_search_filings. A floor: the window holds the last year or 1,000 filings."
changedOutput schema / properties / notice / description
Previous value: -"Guidance when no filings matched — names the coverage boundary and the fallback."New value: +"Guidance when no filings matched, naming the coverage boundary and the fallback."
changedOutput schema / properties / structured_coverage_from / description
Previous value: -"First filing date on which SEC required this XML format (YYYY-MM-DD). Blockholder filings before it exist but are not parseable into this schema."New value: +"First date SEC required this XML format (YYYY-MM-DD); earlier blockholder filings cannot be parsed here."
changedOutput schema / properties / total_structured_filings / description
Previous value: -"Structured SCHEDULE 13D/13G filings matching the form filter in the issuer's recent submissions window, before the limit. The population the returned filings are the newest slice of."New value: +"Structured 13D/13G filings matching form_kind in the recent submissions window, before limit."