Skip to content

Commit 2383efc

Browse files
Update README with new banner, entity counts, and quick start
- Replace header text/logo with banner image - Update entity count from 800K+ to 1.1M+, included all financial advisors: firm-level RIAs (SEC and state registered), individuals (IARs), ERAs - Expand filing type details with license agreements, cybersecurity incidents, etc. - Reorder imports to show ESM first, add API key signup note - Simplify download example with inline URL and setApiKey call
1 parent 9201314 commit 2383efc

1 file changed

Lines changed: 14 additions & 17 deletions

File tree

README.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
1-
# SEC-API.io JavaScript API Library
1+
# SEC-API.io TypeScript and JavaScript Library
22

3-
<a href="https://sec-api.io/docs"><img src="https://sec-api.io/favicon.svg" alt="" width="48" align="left"/></a>
4-
5-
**The industry-standard for SEC & EDGAR data**, trusted by the world's largest hedge funds, investment banks, exchanges, law firms, and universities. Developed by PhDs in finance and physics.
6-
7-
<br clear="left"/>
3+
![banner](https://sec-api.io/v2/media/product/gh-repo-banner-card-1500x400.png)
84

95
[![Documentation](https://img.shields.io/badge/Documentation-sec--api.io-blue)](https://sec-api.io/docs)
106
[![npm downloads](https://img.shields.io/npm/dm/sec-api)](https://www.npmjs.com/package/sec-api)
117

12-
- **20+ million EDGAR filings** and **100+ million exhibits** — from investor presentations, credit agreements, M&A, government contracts, and executive employment agreements to board composition and subsidiaries
13-
- **800,000+ entities, survivorship-bias free** — covers every SEC-regulated filer that ever reported, including delisted companies, dissolved funds, terminated advisors, and entities no longer reporting. From insiders and public/private companies to ETFs, mutual funds, hedge funds, foreign private issuers, BDCs, REITs, shell companies, and more
14-
- **All 500+ EDGAR form types** — annual and quarterly reports (10-K, 10-Q, 20-F, 40-F), proxy statements (DEF 14A) and voting records, registration statements and prospectuses, and everything in between, including form types no longer in use
8+
- **20+ million EDGAR filings** and **100+ million exhibits** — from license agreements, investor presentations, and other Reg FD disclosures, over insider trading, credit & bond agreements, bylaws, IPOs, secondaries & shelf offerings, M&A terms, government contracts, audit reports, SEC enforcement actions, AAERs, and executive employment agreements to board composition, subsidiaries, public float and cybersecurity incidents.
9+
- **1.1M+ entities, survivorship-bias free** — covers every SEC-regulated filer that ever reported, including delisted companies, dissolved funds, terminated advisors, and entities no longer reporting. From insiders and public/private companies to financial advisors, ETFs, mutual funds, hedge funds, money-market funds, institutional investors, foreign private issuers, BDCs, REITs, shell companies, brokers, dealers, asset-backed securities issuers, SROs, and more.
10+
- **All 500+ EDGAR form types** — annual and quarterly reports (10-K, 10-Q, 20-F, 40-F), proxy voting statements (DEF 14A, PRE 14) and voting records, registration statements and prospectuses, and everything in between, including form types no longer in use.
1511
- **Full historical time range** — from 1993 to present, with data updated in real-time
1612

1713
The full API documentation is available at [sec-api.io/docs](https://sec-api.io/docs).
@@ -25,24 +21,25 @@ npm install sec-api
2521
Both CommonJS and ESM imports are supported:
2622

2723
```js
28-
const { downloadApi } = require('sec-api'); // CommonJS
2924
import { downloadApi } from 'sec-api'; // ESM
25+
const { downloadApi } = require('sec-api'); // CommonJS
3026
```
3127

28+
Get your free API key on [sec-api.io](https://sec-api.io/signup) and replace `YOUR_API_KEY` with it.
29+
3230
**Download EDGAR Filings Free of Charge**
3331

3432
```js
3533
const { downloadApi } = require('sec-api');
3634

37-
// optional, only needed for higher rate limits.
38-
// downloadApi.setApiKey('YOUR_API_KEY');
39-
40-
const filingUrl =
41-
'https://www.sec.gov/Archives/edgar/data/1318605/000162828025045968/tsla-20250930.htm';
35+
downloadApi.setApiKey('YOUR_API_KEY');
4236

43-
const data = await downloadApi.getFile(filingUrl);
37+
// 200 downloads / second per account
38+
const filing = await downloadApi.getFile(
39+
'https://www.sec.gov/Archives/edgar/data/1318605/000162828025045968/tsla-20250930.htm',
40+
);
4441

45-
console.log(data.slice(0, 1000));
42+
console.log(filing.slice(0, 1000));
4643
```
4744

4845
## Feature Overview

0 commit comments

Comments
 (0)