changedOutput schema / anyOf
Previous value: -[
- {
- "not": {
- "required": [
- "error"
- ]
- },
- "required": [
- "issuer_name",
- "issuer_cik",
- "transactions",
- "filings_scanned"
- ]
- },
- {
- "required": [
- "error"
- ]
- }
-]New value: +[
+ {
+ "not": {
+ "required": [
+ "error"
+ ]
+ },
+ "required": [
+ "issuer_name",
+ "issuer_cik",
+ "transactions",
+ "filings_scanned",
+ "filings_other_issuer"
+ ]
+ },
+ {
+ "required": [
+ "error"
+ ]
+ }
+]
changedOutput schema / properties / dataset / description
Previous value: -"Canvas dataframe holding the full parsed transaction set from the scanned filings (the inline transactions[] is a preview capped at limit). Each row carries the issuer (issuer_cik, issuer_ticker) plus the transaction fields, so it aggregates net buy/sell by insider and joins across issuers. Query with secedgar_dataframe_query. Absent when canvas is unavailable or no transactions were parsed."New value: +"Dataframe of every parsed transaction, issuer keys on each row, for net buy/sell by insider and cross-issuer joins. 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 Form 4 filings exist beyond those parsed — past the newest-filings sample, or, with a date window, inside the window beyond the 100-filing cap or past the 10 archive pages read. Narrow the window to reach the rest."New value: +"True when Form 4 filings exist past those parsed (the newest-filings sample, or a window's 100-filing or 10-page cap); narrow the window to reach them."
addedOutput schema / properties / filings_other_issuer
Added value: +{
+ "description": "Scanned Form 4 filings naming a different issuer, filed by this company as a reporting owner of another (e.g., a 10% holder of a fund). They are that issuer's activity, so they add no transactions here or in the dataframe.",
+ "type": "number"
+}
changedOutput schema / properties / filings_scanned / description
Previous value: -"Number of Form 4 filings scanned to produce the result."New value: +"Form 4 filings scanned, including those in filings_other_issuer."
changedOutput schema / properties / history_scanned_through / description
Previous value: -"Filing date of the oldest Form 4 parsed (YYYY-MM-DD). Present only when a date window was given; absent when the window held no Form 4 filing."New value: +"Filing date of the oldest Form 4 parsed (YYYY-MM-DD). Present only with a date window that held a Form 4."
changedOutput schema / properties / notice / description
Previous value: -"Guidance when results are empty after filtering — explains the filter applied and suggests alternatives."New value: +"Why the result is empty (the filter, or every scanned filing naming another issuer), and the dataframe pointer when staged."
changedOutput schema / properties / transactions / description
Previous value: -"Insider transactions, newest filing first. Preview capped at `limit` — the full scanned set lives on the canvas dataframe (see `dataset`)."New value: +"Insider transactions, newest filing first, capped at limit; the dataframe holds the full parsed set."
changedOutput schema / properties / transactions / items / properties / direction / description
Previous value: -"Whether shares were acquired or disposed. \"acquire\" = buy, award, exercise; \"dispose\" = sale, gift, return. Absent when shares_traded is absent."New value: +"\"acquire\" (buy, award, exercise) or \"dispose\" (sale, gift, return). Absent when shares_traded is."
changedOutput schema / properties / transactions / items / properties / is_derivative / description
Previous value: -"True for derivative security transactions (options, RSUs, convertible notes). False for direct equity transactions."New value: +"True for derivative securities (options, RSUs, convertible notes); false for direct equity."
changedOutput schema / properties / transactions / items / properties / ownership_nature / description
Previous value: -"Nature of indirect ownership (e.g., \"By Trust\", \"By Spouse\"). Only present when ownership_type is indirect."New value: +"Nature of indirect ownership (e.g., \"By Trust\"). Present only when ownership_type is indirect."
changedOutput schema / properties / transactions / items / properties / ownership_type / description
Previous value: -"D = direct ownership, I = indirect (through a trust, family member, etc.). Absent when not reported."New value: +"Direct, or indirect (through a trust, family member, etc.). Absent when not reported."
changedOutput schema / properties / transactions / items / properties / price_per_share / description
Previous value: -"Price per share in USD. 0 for gifts and RSU awards (no cash consideration). Absent when not reported."New value: +"Price per share in USD; 0 for gifts and RSU awards. Absent when not reported."
changedOutput schema / properties / transactions / items / properties / shares_owned_after / description
Previous value: -"Total shares owned after this transaction, as reported. Absent when omitted by the filer."New value: +"Shares owned after this transaction, as reported. Absent when omitted."
changedOutput schema / properties / transactions / items / properties / shares_traded / description
Previous value: -"Absolute number of shares involved (always positive). Absent when the filing omits this field. Use `direction` to distinguish acquisitions from disposals."New value: +"Shares involved, always positive; direction gives the sign. Absent when the filing omits it."
changedOutput schema / properties / transactions / items / properties / transaction_code / description
Previous value: -"Single-letter SEC transaction code: P = purchase, S = sale, M = exercise, A = award, G = gift, F = tax withholding, C = conversion, others exist."New value: +"SEC transaction code: P purchase, S sale, M exercise, A award, G gift, F tax withholding, C conversion, among others."
changedOutput schema / properties / transactions / items / properties / transaction_type / description
Previous value: -"Human-readable description of the transaction code (e.g., \"purchase\", \"sale\", \"conversion_of_derivative\")."New value: +"Plain-language name of the code (e.g., \"purchase\", \"conversion_of_derivative\")."