changedInput schema / properties / limit / description
Previous value: -"Maximum number of holdings rows to return. 13F filings from large institutions can contain thousands of positions. Default 20."New value: +"Maximum number of holdings rows to return. 13F filings from large institutions can contain thousands of positions. Default 20. Capped at 500: a larger value, up to 1000, returns what 500 returns."
changedInput schema / properties / limit / maximum
Previous value: -500New value: +1000
changedOutput schema / anyOf
Previous value: -[
- {
- "not": {
- "required": [
- "error"
- ]
- },
- "required": [
- "filer_name",
- "filer_cik",
- "filing_date",
- "accession_number",
- "total_holdings_in_filing",
- "offset",
- "holdings"
- ]
- },
- {
- "required": [
- "error"
- ]
- }
-]New value: +[
+ {
+ "not": {
+ "required": [
+ "error"
+ ]
+ },
+ "required": [
+ "filer_name",
+ "filer_cik",
+ "filing_date",
+ "accession_number",
+ "composed_accessions",
+ "total_holdings_in_filing",
+ "total_holdings_composed",
+ "offset",
+ "holdings"
+ ]
+ },
+ {
+ "required": [
+ "error"
+ ]
+ }
+]
changedOutput schema / properties / accession_number / description
Previous value: -"Accession number of this 13F-HR — pass to secedgar_get_filing."New value: +"Original 13F-HR accession for secedgar_get_filing."
changedOutput schema / properties / amendments / description
Previous value: -"Known amendments to the original report. Absent when none were found."New value: +"Known amendments, newest filed first. Absent if none."
changedOutput schema / properties / amendments / items / description
Previous value: -"Same-period amendment; its holdings are not merged."New value: +"Same-period 13F-HR/A."
changedOutput schema / properties / amendments / items / oneOf
Previous value: -[
- {
- "additionalProperties": false,
- "description": "Readable amendment.",
- "properties": {
- "accession_number": {
- "description": "Amendment accession for secedgar_get_filing.",
- "type": "string"
- },
- "amendment_type": {
- "description": "Cover-page type.",
- "enum": [
- "RESTATEMENT",
- "NEW HOLDINGS"
- ],
- "type": "string"
- },
- "filing_date": {
- "description": "Amendment filing date (YYYY-MM-DD).",
- "type": "string"
- }
- },
- "required": [
- "accession_number",
- "filing_date",
- "amendment_type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Amendment with unavailable type.",
- "properties": {
- "accession_number": {
- "description": "Amendment accession for secedgar_get_filing.",
- "type": "string"
- },
- "amendment_type": {
- "const": "UNAVAILABLE",
- "description": "Type could not be read.",
- "type": "string"
- },
- "filing_date": {
- "description": "Amendment filing date (YYYY-MM-DD).",
- "type": "string"
- },
- "unavailable_reason": {
- "description": "Why the type is unavailable; inspect with secedgar_get_filing.",
- "enum": [
- "missing_header",
- "unreadable_header",
- "lookup_failed",
- "lookup_stopped"
- ],
- "type": "string"
- }
- },
- "required": [
- "accession_number",
- "filing_date",
- "amendment_type",
- "unavailable_reason"
- ],
- "type": "object"
- }
-]New value: +[
+ {
+ "additionalProperties": false,
+ "description": "Typed amendment.",
+ "properties": {
+ "accession_number": {
+ "description": "Accession for secedgar_get_filing.",
+ "type": "string"
+ },
+ "amendment_type": {
+ "description": "Cover-page type.",
+ "enum": [
+ "RESTATEMENT",
+ "NEW HOLDINGS"
+ ],
+ "type": "string"
+ },
+ "applied_as": {
+ "description": "Composition role.",
+ "enum": [
+ "restatement",
+ "new_holdings",
+ "superseded",
+ "not_applied"
+ ],
+ "type": "string"
+ },
+ "filing_date": {
+ "description": "Filing date (YYYY-MM-DD).",
+ "type": "string"
+ }
+ },
+ "required": [
+ "accession_number",
+ "filing_date",
+ "applied_as",
+ "amendment_type"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Untyped amendment.",
+ "properties": {
+ "accession_number": {
+ "description": "Accession for secedgar_get_filing.",
+ "type": "string"
+ },
+ "amendment_type": {
+ "const": "UNAVAILABLE",
+ "description": "Type could not be read.",
+ "type": "string"
+ },
+ "applied_as": {
+ "description": "Composition role.",
+ "enum": [
+ "restatement",
+ "new_holdings",
+ "superseded",
+ "not_applied"
+ ],
+ "type": "string"
+ },
+ "filing_date": {
+ "description": "Filing date (YYYY-MM-DD).",
+ "type": "string"
+ },
+ "unavailable_reason": {
+ "description": "Why the type is unavailable; inspect with secedgar_get_filing.",
+ "enum": [
+ "missing_header",
+ "unreadable_header",
+ "lookup_failed",
+ "lookup_stopped"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "accession_number",
+ "filing_date",
+ "applied_as",
+ "amendment_type",
+ "unavailable_reason"
+ ],
+ "type": "object"
+ }
+]
addedOutput schema / properties / composed_accessions
Added value: +{
+ "description": "Accessions whose rows form holdings, in application order.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+}
changedOutput schema / properties / dataset / description
Previous value: -"Original-report positions, shaped by consolidate; join on cusip + reporting_period. Amendment positions are excluded. Absent without canvas or holdings."New value: +"Composed positions, shaped by consolidate; join on cusip + reporting_period. Absent without canvas or holdings."
changedOutput schema / properties / filer_name / description
Previous value: -"Name of the institutional filer (the 13F submitter)."New value: +"Institutional filer name (the 13F submitter)."
changedOutput schema / properties / filing_date / description
Previous value: -"Date the 13F was submitted (YYYY-MM-DD)."New value: +"Original 13F-HR filing date (YYYY-MM-DD)."
changedOutput schema / properties / holdings / description
Previous value: -"`limit` rows from `offset`: positions by market value when consolidate=true, else raw rows in filing order."New value: +"`limit` rows from `offset`: positions by value when consolidate=true, else raw rows in application order."
changedOutput schema / properties / holdings / items / properties / market_value_usd / description
Previous value: -"Whole USD at report date; pre-2023-01-03 filing values scaled from thousands. Absent if unreported."New value: +"Whole USD at report date; values filed before 2023-01-03 scaled from thousands. Absent if unreported."
addedOutput schema / properties / holdings / items / properties / source_accession_numbers
Added value: +{
+ "description": "Accessions the row came from, in application order.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+}
changedOutput schema / properties / holdings / items / required
Previous value: -[
- "issuer_name"
-]New value: +[
+ "issuer_name",
+ "source_accession_numbers"
+]
changedOutput schema / properties / notice / description
Previous value: -"Amendment disclosure, incomplete discovery, paging, and dataframe guidance."New value: +"Amendment composition, discovery, paging, and dataframe guidance."
addedOutput schema / properties / total_holdings_composed
Added value: +{
+ "description": "Composed raw row count before consolidation or paging.",
+ "type": "number"
+}
changedOutput schema / properties / total_holdings_in_filing / description
Previous value: -"Original raw row count before consolidation or paging."New value: +"Original 13F-HR raw row count."