addedInput schema / properties / unit
Added value: +{
+ "description": "SEC unit key to read the series in, for a concept reported in more than one (e.g. \"ZAR\" and a \"USD\" convenience translation, or \"USD/EUR\" among exchange-rate pairs). \"USD-per-shares\" is read as \"USD/shares\". When omitted, the series takes the unit of its newest value, then the unit with more periods; any other units are named in caveats.",
+ "minLength": 1,
+ "type": "string"
+}
changedOutput schema / properties / caveats / description
Previous value: -"Data-completeness warnings about the returned series. Two kinds. On quarterly results, one entry when one or two calendar quarters are absent from every recent qualifying year — SEC reports a filer's fiscal Q4 as the 10-K residual rather than a discrete quarterly fact, so the calendar quarter fiscal Q4 spans has no frame-tagged value, and a filer whose other fiscal quarters span non-calendar durations loses a second quarter the same way. Applies to calendar-year filers (no discrete Q4) as much as to off-calendar ones. On any result, one entry when the series stops well short of today — either because the concept resolved to an XBRL tag SEC has retired from the taxonomy (the current tags reported nothing), or because a current tag's series ends more than two years plus a filing window back, which is what a filer migrating to a different element or dropping the disclosure looks like. Absent when the series has nothing to flag."New value: +"Completeness warnings, absent when none apply: other units the concept is reported in, with period counts and spans (pass unit to read one); quarters missing from every recent year (SEC reports fiscal Q4 only within the 10-K); a series ending well short of today (a retired or dropped tag)."
changedOutput schema / properties / concept / description
Previous value: -"XBRL tag behind the newest value. A friendly name can walk several tags, so each row names its own."New value: +"XBRL tag behind the newest value; each row names its own tag."
changedOutput schema / properties / data / description
Previous value: -"Deduplicated time series, newest first — one value per calendar period. Where SEC's period frame sits on a proxy statement's figure (the pay-versus-performance table re-tags net income), the value comes from the filer's own report of the same period; an annual period SEC framed on a 10-Q's trailing-twelve-month figure is left out, since the filer has not closed that year."New value: +"Deduplicated series, newest first, one value per calendar period. A period SEC framed on a proxy statement figure takes the filer's own report instead; an annual period framed on a 10-Q trailing-twelve-month figure is left out."
changedOutput schema / properties / data / items / description
Previous value: -"One reported value with its period, fiscal context, source filing, and source tag."New value: +"One reported value with its period, source filing, and tag."
changedOutput schema / properties / data / items / properties / fiscal_period / description
Previous value: -"Fiscal period of the source filing (FY, Q1, Q2, Q3, Q4), not the data period. Null when the source filing did not encode a fiscal period."New value: +"Fiscal period of the source filing (FY, Q1–Q4), not of the data period. Null when not encoded."
changedOutput schema / properties / data / items / properties / fiscal_year / description
Previous value: -"Fiscal year of the source filing, not the data period — every comparative period restated in the same filing carries that filing's fiscal year, so use end (or period) as the time key. Null when the source filing did not encode a fiscal year."New value: +"Fiscal year of the source filing, not of the data period (restated comparatives carry the filing's year); key time on end. Null when not encoded."
changedOutput schema / properties / data / items / properties / tag / description
Previous value: -"XBRL tag this value was reported under — differs from concept when an older or successor tag in the friendly name answers this period."New value: +"XBRL tag this value was reported under; differs from concept when an older or successor tag answers this period."
changedOutput schema / properties / dataset / description
Previous value: -"Canvas dataframe handle holding the same time series. Use for cross-company JOINs via secedgar_dataframe_query. The source-filing fiscal keys are materialized as source_filing_fy/source_filing_fp — order, group, and window by period_end, not by those columns. Absent when canvas is unavailable."New value: +"Dataframe of the same series; fiscal keys are source_filing_fy/source_filing_fp, so order by period_end. Absent when canvas is unavailable."
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 / description / description
Previous value: -"XBRL taxonomy description of the concept tag. Often absent for company-extension tags or older concepts."New value: +"XBRL taxonomy description of the tag. Often absent for extension tags and older concepts."
changedOutput schema / properties / error / properties / data / properties / reason / description
Previous value: -"Machine-readable failure mode. Declared by this tool: `company_not_found`: The company input does not resolve to a CIK. `ambiguous_company`: The company input resolves to multiple entities and the target is ambiguous. `unknown_concept`: The concept input is neither a supported friendly name nor shaped like an XBRL tag, so no request is sent. `no_concept_data`: The company does not report any XBRL data for the resolved concept and taxonomy. `no_frame_data`: Concept exists but has no frame-aligned (standard calendar period) entries. `no_period_data`: Concept has data but the period_type filter excluded all of it. `rate_limited`: SEC is rate-limiting this server's IP — SEC answered 429, or the call was refused without being sent while the cool-down after one runs. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `company_not_found`: The company input does not resolve to a CIK. `ambiguous_company`: The company input resolves to multiple entities and the target is ambiguous. `unknown_concept`: The concept input is neither a supported friendly name nor shaped like an XBRL tag, so no request is sent. `no_concept_data`: The company does not report any XBRL data for the resolved concept and taxonomy. `no_frame_data`: Concept exists but has no frame-aligned (standard calendar period) entries. `no_period_data`: Concept has data but the period_type filter excluded all of it. `no_unit_data`: The unit input names a unit the resolved concept is not reported in for this company. `rate_limited`: SEC is rate-limiting this server's IP — SEC answered 429, or the call was refused without being sent while the cool-down after one runs. Other values are possible when a failure originates below the handler."
changedOutput schema / properties / error / properties / data / properties / reason / examples
Previous value: -[
- "company_not_found",
- "ambiguous_company",
- "unknown_concept",
- "no_concept_data",
- "no_frame_data",
- "no_period_data",
- "rate_limited"
-]New value: +[
+ "company_not_found",
+ "ambiguous_company",
+ "unknown_concept",
+ "no_concept_data",
+ "no_frame_data",
+ "no_period_data",
+ "no_unit_data",
+ "rate_limited"
+]
changedOutput schema / properties / tags_tried / description
Previous value: -"XBRL tags that were attempted (shown when using friendly names that map to multiple tags)."New value: +"XBRL tags attempted, when a friendly name maps to several."
changedOutput schema / properties / unit / description
Previous value: -"Unit of measure of the newest value (e.g., \"USD\", \"shares\", \"USD/shares\")."New value: +"Unit of every value in data (e.g., \"USD\", \"USD/shares\"): the unit input when given (an unreported one fails with no_unit_data), else the newest value's unit, then the unit with more periods. A series never mixes units."