Skip to content

Commit a39ea28

Browse files
Add Datasets download example to Quick Start
1 parent d376d8b commit a39ea28

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ The full API documentation is available at [sec-api.io/docs](https://sec-api.io/
2525
pip install sec-api
2626
```
2727

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

3032
```python
@@ -40,7 +42,18 @@ data = downloadApi.get_file(filing_url)
4042
print(data[:1000])
4143
```
4244

43-
Get your free API key on [sec-api.io](https://sec-api.io/signup) and replace `YOUR_API_KEY` with it.
45+
**Download Entire Datasets of SEC Filings**
46+
47+
```python
48+
from sec_api import Datasets
49+
50+
datasets = Datasets(api_key="YOUR_API_KEY")
51+
52+
# downloads all 10-K filings (1993-present) to ./sec-api-datasets/form-10k-content/YYYY/YYYY-MM.zip
53+
datasets.download("form-10k-content")
54+
# all 13-F institutional holdings
55+
datasets.download("form-13f-holdings")
56+
```
4457

4558
## Feature Overview
4659

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
setup(
77
name="sec-api",
8-
version="1.0.34",
8+
version="1.0.35",
99
author="SEC API",
1010
author_email="support@sec-api.io",
1111
description="SEC EDGAR Filings API",

0 commit comments

Comments
 (0)