Skip to content

Commit a576af5

Browse files
janlukasschroederjanlukasschroeder
committed
Add API wrappers, tests, and comprehensive README with response examples
- Add DownloadApi class (inherits RenderApi for backward compat), AuditFeesApi, EdgarIndexApi, and 3 new FormAdvApi methods (get_other_business_names, get_separately_managed_accounts, get_financial_industry_affiliations) - Update Download API endpoint from archive.sec-api.io to edgar-mirror.sec-api.io - Add integration test suite (40 tests) covering all API classes - Add collapsible response examples to all README sections with full example response links, matching the NPM package structure - Split Form ADV, Insider Trading (Form 3/4/5), and Form N-PX into sub-sections - Add Bulk Datasets section, Quick Start code, and complete TOC with verified links - Add examples/api-responses/ with JSON response files for all APIs
1 parent 7fa3490 commit a576af5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+14362
-397
lines changed

‎.gitignore‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
venv
22
env
3+
.env
34
dist
45
build
56
.idea
67
.pypirc
78
sec_api.egg-info
89
deploy.sh
910
sec_api/__pycache__
10-
requirements.txt
11+
requirements.txt
12+
tmp
13+
.superseded
14+
TODO.md

‎README.md‎

Lines changed: 2196 additions & 393 deletions
Large diffs are not rendered by default.

‎examples/api-responses/aaer.json‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
{
2+
"total": {
3+
"value": 427,
4+
"relation": "eq"
5+
},
6+
"data": [
7+
{
8+
"id": "b2dfd65355cdf4c4a629103a211882ce",
9+
"dateTime": "2024-12-31T12:19:45-05:00",
10+
"aaerNo": "AAER-4554",
11+
"releaseNo": [
12+
"34-102060"
13+
],
14+
"respondents": [
15+
{
16+
"name": "Accell Audit & Compliance, PA",
17+
"type": "company"
18+
}
19+
],
20+
"respondentsText": "Accell Audit & Compliance, PA",
21+
"urls": [
22+
{
23+
"type": "primary",
24+
"url": "https://www.sec.gov/files/litigation/admin/2024/34-102060.pdf"
25+
}
26+
],
27+
"summary": "The SEC has instituted public administrative proceedings against Accell Audit & Compliance, PA, resulting in a suspension and a $75,000 penalty for failing to exercise due professional care in auditing Ignite International Brands, Ltd.'s financial statements.",
28+
"tags": [
29+
"auditing misconduct",
30+
"fraudulent financial reporting"
31+
],
32+
"entities": [
33+
{
34+
"name": "Accell Audit & Compliance, PA",
35+
"type": "company",
36+
"role": "respondent"
37+
},
38+
{
39+
"name": "Ignite International Brands, Ltd.",
40+
"type": "company",
41+
"role": "entity audited"
42+
}
43+
],
44+
"complaints": [
45+
"Accell failed to exercise due professional care or skepticism, or to obtain sufficient appropriate audit evidence for a significant, unusual sale to an Ignite-related party that did not occur during the reporting period.",
46+
"Accell staff knew about, but failed to address, inconsistencies and contradictory evidence, and misrepresented the timing and facts of the supposed sale.",
47+
"Accell issued an unqualified audit opinion on Ignite’s 2020 financial statements, falsely stating its opinion that the statements 'present fairly, in all material respects, the financial position of the company'.",
48+
"Accell’s actions aided and abetted Ignite’s fraudulent financial reporting."
49+
],
50+
"parallelActionsTakenBy": [],
51+
"hasAgreedToSettlement": true,
52+
"hasAgreedToPayPenalty": true,
53+
"penaltyAmounts": [
54+
{
55+
"penaltyAmount": "75000",
56+
"penaltyAmountText": "$75,000",
57+
"imposedOn": "Accell Audit & Compliance, PA"
58+
}
59+
],
60+
"requestedRelief": [
61+
"suspension from appearing or practicing before the Commission"
62+
],
63+
"violatedSections": [
64+
"Section 10(b) of the Exchange Act",
65+
"Rule 10b-5"
66+
],
67+
"otherAgenciesInvolved": []
68+
}
69+
]
70+
}

‎examples/api-responses/audit-fees.json‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
{
2+
"total": {
3+
"value": 10000,
4+
"relation": "gte"
5+
},
6+
"data": [
7+
{
8+
"id": "a522dfd61d00caa01da0b4f4b38607c5",
9+
"accessionNo": "0001717547-26-000026",
10+
"formType": "DEF 14A",
11+
"filedAt": "2026-04-01T08:33:43-04:00",
12+
"periodOfReport": "2026-05-13",
13+
"entities": [
14+
{
15+
"cik": "1717547",
16+
"ticker": "BRSP",
17+
"companyName": "BrightSpire Capital, Inc. (Filer)",
18+
"irsNo": "384046290",
19+
"fiscalYearEnd": "1231",
20+
"stateOfIncorporation": "MD",
21+
"sic": "6798 Real Estate Investment Trusts",
22+
"act": "34",
23+
"fileNo": "001-38377",
24+
"filmNo": "26824836"
25+
}
26+
],
27+
"records": [
28+
{
29+
"year": 2025,
30+
"auditFees": 1251363,
31+
"auditRelatedFees": null,
32+
"taxFees": null,
33+
"allOtherFees": null,
34+
"totalFees": 1251363,
35+
"auditor": "Deloitte & Touche LLP"
36+
},
37+
{
38+
"year": 2024,
39+
"auditFees": 1487239,
40+
"auditRelatedFees": null,
41+
"taxFees": 714695,
42+
"allOtherFees": null,
43+
"totalFees": 2201934,
44+
"auditor": "Ernst & Young"
45+
}
46+
]
47+
}
48+
]
49+
}

‎examples/api-responses/directors-board-members.json‎

Lines changed: 231 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,231 @@
1+
{
2+
"total": {
3+
"value": 20,
4+
"relation": "eq"
5+
},
6+
"data": [
7+
{
8+
"id": "42fe18db08211769589dc61fbd461443",
9+
"filedAt": "2026-01-08T16:31:36-05:00",
10+
"accessionNo": "0001308179-26-000008",
11+
"cik": "320193",
12+
"ticker": "AAPL",
13+
"entityName": "Apple Inc.",
14+
"directors": [
15+
{
16+
"name": "Alex Gorsky",
17+
"position": "Former Chair and CEO, Johnson & Johnson; Director",
18+
"age": "65",
19+
"directorClass": "II",
20+
"dateFirstElected": "2021",
21+
"isIndependent": false,
22+
"committeeMemberships": [
23+
"Nominating Committee",
24+
"People and Compensation Committee"
25+
],
26+
"qualificationsAndExperience": [
27+
"executive leadership experience",
28+
"brand marketing expertise",
29+
"experience in health and technology"
30+
]
31+
},
32+
{
33+
"name": "Andrea Jung",
34+
"position": "President and CEO, Grameen America; Director",
35+
"age": "67",
36+
"directorClass": "I",
37+
"dateFirstElected": "2008",
38+
"isIndependent": null,
39+
"committeeMemberships": [
40+
"Nominating Committee",
41+
"People and Compensation Committee (Chair)"
42+
],
43+
"qualificationsAndExperience": [
44+
"executive leadership experience",
45+
"global business perspective",
46+
"extensive brand marketing and consumer products experience",
47+
"service as a chair and chief executive officer of a large international public company"
48+
]
49+
},
50+
{
51+
"name": "Art Levinson",
52+
"position": "Board Chair; Chair of the Board",
53+
"age": "75",
54+
"directorClass": "",
55+
"dateFirstElected": "2000",
56+
"isIndependent": null,
57+
"committeeMemberships": [
58+
"Audit Committee",
59+
"People and Compensation Committee"
60+
],
61+
"qualificationsAndExperience": [
62+
"Founder and CEO, Calico",
63+
"executive leadership experience",
64+
"financial expertise",
65+
"brand marketing experience",
66+
"expertise in the health sector",
67+
"technology and innovation"
68+
]
69+
},
70+
{
71+
"name": "Deirdre O’Brien",
72+
"position": "Senior Vice President, Retail + People",
73+
"age": "59",
74+
"directorClass": "",
75+
"dateFirstElected": "",
76+
"isIndependent": null,
77+
"committeeMemberships": [],
78+
"qualificationsAndExperience": [
79+
"Oversees Apple’s retail stores and online teams",
80+
"Leads Apple’s People team",
81+
"Joined Apple in July 1988",
82+
"Served in various roles including Vice President, People and Operations"
83+
]
84+
},
85+
{
86+
"name": "Kate Adams",
87+
"position": "Senior Vice President, General Counsel and Secretary",
88+
"age": "61",
89+
"directorClass": "",
90+
"dateFirstElected": "November 2017",
91+
"isIndependent": null,
92+
"committeeMemberships": [],
93+
"qualificationsAndExperience": [
94+
"Oversees all of Apple’s legal matters",
95+
"Experience in corporate governance",
96+
"Experience in intellectual property",
97+
"Experience in litigation",
98+
"Experience in compliance",
99+
"Experience in global security",
100+
"Experience in privacy",
101+
"Former General Counsel of Honeywell International Inc.",
102+
"Partner at the law firm of Sidley Austin LLP"
103+
]
104+
},
105+
{
106+
"name": "Kevan Parekh",
107+
"position": "Senior Vice President, Chief Financial Officer",
108+
"age": "54",
109+
"directorClass": "",
110+
"dateFirstElected": "",
111+
"isIndependent": null,
112+
"committeeMemberships": [],
113+
"qualificationsAndExperience": [
114+
"oversees Apple’s accounting, business support, financial planning and analysis, treasury, investor relations, internal audit, and tax functions",
115+
"joined Apple in June 2013",
116+
"previous positions include Vice President, Financial Planning and Analysis and Vice President, Worldwide Finance for Sales, Marketing, and Retail",
117+
"held various senior leadership roles at Thomson Reuters and General Motors"
118+
]
119+
},
120+
{
121+
"name": "Monica Lozano",
122+
"position": "Former President and CEO, College Futures Foundation; Director",
123+
"age": "69",
124+
"directorClass": "I",
125+
"dateFirstElected": "2021",
126+
"isIndependent": null,
127+
"committeeMemberships": [
128+
"Audit Committee"
129+
],
130+
"qualificationsAndExperience": [
131+
"executive leadership experience",
132+
"experience in operations and strategic planning",
133+
"media and marketing experience",
134+
"retired President and Chief Executive Officer of the College Futures Foundation",
135+
"co-founded The Aspen Institute Latinos and Society Program"
136+
]
137+
},
138+
{
139+
"name": "Ron Sugar",
140+
"position": "Former Chair and CEO, Northrop Grumman Corporation; Director",
141+
"age": "77",
142+
"directorClass": "I",
143+
"dateFirstElected": "2010",
144+
"isIndependent": null,
145+
"committeeMemberships": [
146+
"Audit Committee"
147+
],
148+
"qualificationsAndExperience": [
149+
"executive leadership experience as a chairman and chief executive officer of a large international public company",
150+
"financial expertise as a former chief financial officer",
151+
"experience in worldwide operations",
152+
"understanding of advanced technology",
153+
"experience with government relations and public policy",
154+
"global business perspective from tenure at global companies and service on other boards"
155+
]
156+
},
157+
{
158+
"name": "Sabih Khan",
159+
"position": "Chief Operating Officer",
160+
"age": "59",
161+
"directorClass": "",
162+
"dateFirstElected": "",
163+
"isIndependent": null,
164+
"committeeMemberships": [],
165+
"qualificationsAndExperience": [
166+
"oversaw Apple’s worldwide operations",
167+
"led global supply chain team",
168+
"managed environmental and social initiatives",
169+
"supervised AppleCare customer service and support",
170+
"held positions of Senior Vice President, Operations and Vice President, Product Operations",
171+
"worked at GE Plastics"
172+
]
173+
},
174+
{
175+
"name": "Sue Wagner",
176+
"position": "Co-founder and Director, BlackRock; Chair",
177+
"age": "64",
178+
"directorClass": "I",
179+
"dateFirstElected": "2014",
180+
"isIndependent": null,
181+
"committeeMemberships": [
182+
"People and Compensation Committee",
183+
"Nominating Committee",
184+
"Audit Committee"
185+
],
186+
"qualificationsAndExperience": [
187+
"operational experience and a global business perspective",
188+
"service as chief operating officer of a large multinational public company",
189+
"extensive financial expertise",
190+
"experience in the highly regulated financial services industry",
191+
"co-founder of BlackRock, Inc.",
192+
"served as BlackRock’s Vice Chair",
193+
"member of BlackRock’s Global Executive Committee and Global Operating Committee",
194+
"led the alternative investments and international client businesses"
195+
]
196+
},
197+
{
198+
"name": "Tim Cook",
199+
"position": "CEO; Chief Executive Officer",
200+
"age": "65",
201+
"directorClass": "",
202+
"dateFirstElected": "2011",
203+
"isIndependent": null,
204+
"committeeMemberships": [],
205+
"qualificationsAndExperience": [
206+
"extensive executive leadership experience in the technology industry",
207+
"management of worldwide operations",
208+
"sales, service, and support"
209+
]
210+
},
211+
{
212+
"name": "Wanda Austin",
213+
"position": "Former President and CEO, The Aerospace Corporation; Director",
214+
"age": "71",
215+
"directorClass": "I",
216+
"dateFirstElected": "2024",
217+
"isIndependent": true,
218+
"committeeMemberships": [
219+
"Audit Committee"
220+
],
221+
"qualificationsAndExperience": [
222+
"executive leadership experience",
223+
"expertise in advanced technology and innovation",
224+
"experience with environment, cybersecurity, and public policy",
225+
"global business perspective"
226+
]
227+
}
228+
]
229+
}
230+
]
231+
}

0 commit comments

Comments
 (0)