Skip to content

Commit bf6df2e

Browse files
added full-text search API and filing render API
1 parent ad521ff commit bf6df2e

File tree

9 files changed

+136
-276
lines changed

9 files changed

+136
-276
lines changed

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ build
44
.idea
55
.pypirc
66
sec_api.egg-info
7-
sec_api.egg-info/*
7+
sec_api.egg-info

README.md

+67-6
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,16 @@ Get your free API key on [sec-api.io](https://sec-api.io) and replace `YOUR_API_
4242

4343
# SEC EDGAR Filings Query API
4444

45-
The below example retrieves all 10-Q filings filed by TSLA in 2020.
45+
The query API allows you to search and filter all 18 million filings published on SEC EDGAR.
46+
47+
---
48+
49+
The example below retrieves all 10-Q filings filed by TSLA in 2020.
4650

4751
```python
4852
from sec_api import QueryApi
4953

50-
queryApi = QueryApi(api_key='YOUR_API_KEY')
54+
queryApi = QueryApi(api_key="YOUR_API_KEY")
5155

5256
query = {
5357
"query": { "query_string": {
@@ -93,13 +97,21 @@ query = {
9397
filings = queryApi.get_filings(query)
9498
```
9599

100+
> See the documentation for more details: https://sec-api.io/docs/query-api
101+
102+
96103

97104
# SEC EDGAR Filings Real-Time Stream API
98105

106+
The stream API provides a live stream (aka feed) of newly published filings on SEC EDGAR.
107+
A new filing is sent to your connected client as soon as its published.
108+
109+
---
110+
99111
Install the `socketio` client:
100112

101113
```bash
102-
pip install python-engineio==3.14.2 python-socketio[client]==4.6.0`
114+
pip install python-engineio==3.14.2 python-socketio[client]==4.6.0
103115
```
104116

105117
Run the example script below. Get your free API key on [sec-api.io](https://sec-api.io)
@@ -110,18 +122,67 @@ import socketio
110122

111123
sio = socketio.Client()
112124

113-
@sio.on('connect', namespace='/all-filings')
125+
@sio.on("connect", namespace="/all-filings")
114126
def on_connect():
115127
print("Connected to https://api.sec-api.io:3334/all-filings")
116128

117-
@sio.on('filing', namespace='/all-filings')
129+
@sio.on("filing", namespace="/all-filings")
118130
def on_filings(filing):
119131
print(filing)
120132

121-
sio.connect('https://api.sec-api.io:3334?apiKey=YOUR_API_KEY', namespaces=['/all-filings'])
133+
sio.connect("https://api.sec-api.io:3334?apiKey=YOUR_API_KEY", namespaces=["/all-filings"])
122134
sio.wait()
123135
```
124136

137+
# Full-Text Search API
138+
139+
Full-text search allows you to search the full text of all EDGAR filings submitted since 2001.
140+
The full text of a filing includes all data in the filing itself as well as all attachments (such as exhibits) to the filing.
141+
142+
---
143+
144+
The example below returns all 8-K and 10-Q filings and their exhibits, filed between 01-01-2021 and 14-06-2021,
145+
that include the exact phrase "LPCN 1154".
146+
147+
148+
```python
149+
from sec_api import FullTextSearchApi
150+
151+
fullTextSearchApi = FullTextSearchApi(api_key="YOUR_API_KEY")
152+
153+
query = {
154+
"query": '"LPCN 1154"',
155+
"formTypes": ['8-K', '10-Q'],
156+
"startDate": '2021-01-01',
157+
"endDate": '2021-06-14',
158+
}
159+
160+
filings = fullTextSearchApi.get_filings(query)
161+
162+
print(filings)
163+
```
164+
165+
> See the documentation for more details: https://sec-api.io/docs/full-text-search-api
166+
167+
168+
# Filing Render API
169+
170+
Used to fetch the content of any filing or exhibit.
171+
172+
173+
```python
174+
from sec_api import RenderApi
175+
176+
renderApi = RenderApi(api_key="YOUR_API_KEY")
177+
178+
url = "https://www.sec.gov/Archives/edgar/data/1662684/000110465921082303/tm2119986d1_8k.htm"
179+
180+
filing = renderApi.get_filing(url)
181+
182+
print(filing)
183+
```
184+
185+
> See the documentation for more details: https://sec-api.io/docs/sec-filings-render-api
125186
126187

127188
# Response Format

sec_api.egg-info/PKG-INFO

-248
This file was deleted.

sec_api.egg-info/SOURCES.txt

-8
This file was deleted.

sec_api.egg-info/dependency_links.txt

-1
This file was deleted.

sec_api.egg-info/top_level.txt

-1
This file was deleted.

sec_api/__init__.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
name = "sec_api"
2-
from sec_api.index import QueryApi
2+
from sec_api.index import QueryApi
3+
from sec_api.index import FullTextSearchApi
4+
from sec_api.index import RenderApi

0 commit comments

Comments
 (0)