added APIs for Regulation A filings: Form 1-A, Form 1-K, Form 1-Z

Author: janlukasschroeder

.gitignore

@@ -6,4 +6,5 @@ build
 .pypirc
 sec_api.egg-info
 deploy.sh
-sec_api/__pycache__
+sec_api/__pycache__
+requirements.txt

README.md

@@ -1,6 +1,8 @@
-# SEC API - A SEC.gov EDGAR Filings Query & Real-Time Stream API
+# SEC API - Access SEC and EDGAR Data with Python
 
-**sec-api** is a Python package allowing you to search the entire SEC EDGAR filings corpus and access petabytes of regulatory information published by public and private companies, insiders such as directors and board members, hedge and mutual funds, financial advisors, business development companies, and more. It includes:
+[![Downloads](https://pepy.tech/badge/sec-api)](https://pepy.tech/project/sec-api) [![Documentation](https://img.shields.io/badge/Documentation-sec--api.io-blue)](https://sec-api.io/docs)
+
+**sec-api** is a Python package for searching and accessing the entire SEC EDGAR filings corpus, providing access to petabytes of regulatory data from public and private companies, insiders (directors, board members, etc.), funds (ETFs, hedge funds, etc.), financial advisors, business development companies, and more. It includes:
 
 **EDGAR Filing Search & Download APIs**
 
@@ -34,6 +36,7 @@
 - [Form S-1/424B4 API - Registration Statements and Prospectuses (IPOs, Debt/Warrants/... Offerings)](#form-s-1424b4-api)
 - [Form C API - Crowdfunding Offerings & Campaigns](#form-c-api---crowdfunding-campaigns)
 - [Form D API - Private Security Offerings](#form-d-api)
+- [Regulation A APIs - Offering Statements by Small Companies (Form 1-A, Form 1-K, Form 1-Z)](#regulation-a-apis)
 
 **Structured Material Event Data from Form 8-K**
 
@@ -948,6 +951,98 @@ print(response["offerings"])
 
 > See the documentation for more details: https://sec-api.io/docs/form-d-xml-json-api
 
+## Regulation A APIs
+
+Access and search all Regulation A offering statements (Tier 1 and 2) filed with the SEC from 2015 to present. The database includes Form 1-A (offerings), Form 1-K (annual reports) and Form 1-Z (exit report) filings as well as withdrawls and amendments. Information about the issuer (total assets, debt, etc.), offering (type, total amount, offering price, auditor, etc.), and more is available.
+
+### Search All Regulation A Filings
+
+```python
+from sec_api import RegASearchAllApi
+
+regASearchAllApi = RegASearchAllApi("YOUR_API_KEY")
+
+search_params = {
+    "query": "filedAt:[2024-01-01 TO 2024-12-31]",
+    "from": "0", # increase by 50 to fetch the next 50 results
+    "size": "50",
+    "sort": [{"filedAt": {"order": "desc"}}],
+}
+
+response = regASearchAllApi.get_data(search_params)
+offeringStatement = response["data"][0]
+
+print(offeringStatement)
+```
+
+> See the documentation for more details: https://sec-api.io/docs/reg-a-offering-statements-api
+
+### Form 1-A API
+
+```python
+from sec_api import Form1AApi
+
+form1AApi = Form1AApi("YOUR_API_KEY")
+
+search_params = {
+    "query": "summaryInfo.indicateTier1Tier2Offering:Tier1",
+    "from": "0",
+    "size": "50",
+    "sort": [{"filedAt": {"order": "desc"}}],
+}
+
+response = form1AApi.get_data(search_params)
+form1A = response["data"][0]
+
+print(form1A)
+```
+
+> See the documentation for more details: https://sec-api.io/docs/reg-a-offering-statements-api
+
+### Form 1-K API
+
+```python
+from sec_api import Form1KApi
+
+form1KApi = Form1KApi("YOUR_API_KEY")
+
+search_params = {
+    "query": "fileNo:24R-00472",
+    "from": "0",
+    "size": "50",
+    "sort": [{"filedAt": {"order": "desc"}}],
+}
+
+response = form1KApi.get_data(search_params)
+form1Ks = response["data"]
+
+print(form1Ks)
+```
+
+> See the documentation for more details: https://sec-api.io/docs/reg-a-offering-statements-api
+
+### Form 1-Z API
+
+```python
+from sec_api import Form1ZApi
+
+form1ZApi = Form1ZApi("YOUR_API_KEY")
+
+search_params = {
+    "query": "cik:*",
+    "from": "0",
+    "size": "50",
+    "sort": [{"filedAt": {"order": "desc"}}],
+}
+
+response = form1ZApi.get_data(search_params)
+form1Zs = response["data"]
+
+print(form1Zs)
+```
+
+> See the documentation for more details: https://sec-api.io/docs/reg-a-offering-statements-api
+
 ## Structured Data of Material Event Disclosures under Form 8-K
 
 ### Auditor and Accountant Changes (Item 4.01)

examples.py

@@ -17,6 +17,10 @@
     Form_S1_424B4_Api,
     FormCApi,
     FormDApi,
+    RegASearchAllApi,
+    Form1AApi,
+    Form1KApi,
+    Form1ZApi,
     #
     Item_4_02_Api,
     Form_8K_Item_X_Api,
@@ -307,6 +311,88 @@
 print(response["offerings"])
 # """
 
+#
+# Regulation A Search All API Example
+#
+"""
+regASearchAllApi = RegASearchAllApi("YOUR_API_KEY")
+
+search_params = {
+    "query": "filedAt:[2024-01-01 TO 2024-12-31]",
+    "from": "0",  # increase by 50 to fetch the next 50 results
+    "size": "50",
+    "sort": [{"filedAt": {"order": "desc"}}],
+}
+
+response = regASearchAllApi.get_data(search_params)
+offeringStatement = response["data"][0]
+
+print(offeringStatement)
+# """
+
+#
+# Form 1-A API
+#
+"""
+from sec_api import Form1AApi
+
+form1AApi = Form1AApi("YOUR_API_KEY")
+
+search_params = {
+    "query": "summaryInfo.indicateTier1Tier2Offering:Tier1",
+    "from": "0",
+    "size": "50",
+    "sort": [{"filedAt": {"order": "desc"}}],
+}
+
+response = form1AApi.get_data(search_params)
+form1A = response["data"][0]
+
+print(form1A)
+# """
+
+#
+# Form 1-K API
+#
+"""
+from sec_api import Form1KApi
+
+form1KApi = Form1KApi("YOUR_API_KEY")
+
+search_params = {
+    "query": "fileNo:24R-00472",
+    "from": "0",
+    "size": "50",
+    "sort": [{"filedAt": {"order": "desc"}}],
+}
+
+response = form1KApi.get_data(search_params)
+form1Ks = response["data"]
+
+print(form1Ks)
+# """
+
+#
+# Form 1-Z API
+#
+"""
+from sec_api import Form1ZApi
+
+form1ZApi = Form1ZApi("YOUR_API_KEY")
+
+search_params = {
+    "query": "cik:*",
+    "from": "0",
+    "size": "50",
+    "sort": [{"filedAt": {"order": "desc"}}],
+}
+
+response = form1ZApi.get_data(search_params)
+form1Zs = response["data"]
+
+print(form1Zs)
+# """
+
 
 #
 # Form ADV API Example

sec_api/__init__.py

@@ -22,6 +22,10 @@
 from sec_api.index import Form_S1_424B4_Api
 from sec_api.index import FormCApi
 from sec_api.index import FormDApi
+from sec_api.index import RegASearchAllApi
+from sec_api.index import Form1AApi
+from sec_api.index import Form1KApi
+from sec_api.index import Form1ZApi
 
 # Investment Adviser API
 from sec_api.index import FormAdvApi

sec_api/index.py

@@ -23,6 +23,10 @@
 form_S1_424B4_endpoint = "https://api.sec-api.io/form-s1-424b4"
 form_d_api_endpoint = "https://api.sec-api.io/form-d"
 form_C_endpoint = "https://api.sec-api.io/form-c"
+reg_A_search_all_endpoint = "https://api.sec-api.io/reg-a/search"
+form_1A_endpoint = "https://api.sec-api.io/reg-a/form-1a"
+form_1K_endpoint = "https://api.sec-api.io/reg-a/form-1k"
+form_1Z_endpoint = "https://api.sec-api.io/reg-a/form-1z"
 #
 form_8K_item_4_02_api_endpoint = "https://api.sec-api.io/form-8k"
 form_8K_item_x_api_endpoint = "https://api.sec-api.io/form-8k"
@@ -578,6 +582,118 @@ def get_data(self, query):
             handle_api_error(response)
 
 
+class RegASearchAllApi:
+    """
+    Base class for Regulation A Search All API
+    https://sec-api.io/docs/reg-a-offering-statements-api#search-api-endpoint
+    """
+
+    def __init__(self, api_key, proxies=None):
+        self.api_key = api_key
+        self.api_endpoint = reg_A_search_all_endpoint + "?token=" + api_key
+        self.proxies = proxies if proxies else {}
+
+    def get_data(self, query):
+        response = {}
+
+        for x in range(3):
+            response = requests.post(
+                self.api_endpoint, json=query, proxies=self.proxies
+            )
+            if response.status_code == 200:
+                return response.json()
+            elif response.status_code == 429:
+                time.sleep(0.5 * (x + 1))
+            else:
+                handle_api_error(response)
+        else:
+            handle_api_error(response)
+
+
+class Form1AApi:
+    """
+    Base class for Form 1-A API
+    https://sec-api.io/docs/reg-a-offering-statements-api#form-1-a-offering-statements-api
+    """
+
+    def __init__(self, api_key, proxies=None):
+        self.api_key = api_key
+        self.api_endpoint = form_1A_endpoint + "?token=" + api_key
+        self.proxies = proxies if proxies else {}
+
+    def get_data(self, query):
+        response = {}
+
+        for x in range(3):
+            response = requests.post(
+                self.api_endpoint, json=query, proxies=self.proxies
+            )
+            if response.status_code == 200:
+                return response.json()
+            elif response.status_code == 429:
+                time.sleep(0.5 * (x + 1))
+            else:
+                handle_api_error(response)
+        else:
+            handle_api_error(response)
+
+
+class Form1KApi:
+    """
+    Base class for Form 1-K API
+    https://sec-api.io/docs/reg-a-offering-statements-api#form-1-k-annual-reports-api
+    """
+
+    def __init__(self, api_key, proxies=None):
+        self.api_key = api_key
+        self.api_endpoint = form_1K_endpoint + "?token=" + api_key
+        self.proxies = proxies if proxies else {}
+
+    def get_data(self, query):
+        response = {}
+
+        for x in range(3):
+            response = requests.post(
+                self.api_endpoint, json=query, proxies=self.proxies
+            )
+            if response.status_code == 200:
+                return response.json()
+            elif response.status_code == 429:
+                time.sleep(0.5 * (x + 1))
+            else:
+                handle_api_error(response)
+        else:
+            handle_api_error(response)
+
+
+class Form1ZApi:
+    """
+    Base class for Form 1-Z API
+    https://sec-api.io/docs/reg-a-offering-statements-api#form-1-z-exit-reports-api
+    """
+
+    def __init__(self, api_key, proxies=None):
+        self.api_key = api_key
+        self.api_endpoint = form_1Z_endpoint + "?token=" + api_key
+        self.proxies = proxies if proxies else {}
+
+    def get_data(self, query):
+        response = {}
+
+        for x in range(3):
+            response = requests.post(
+                self.api_endpoint, json=query, proxies=self.proxies
+            )
+            if response.status_code == 200:
+                return response.json()
+            elif response.status_code == 429:
+                time.sleep(0.5 * (x + 1))
+            else:
+                handle_api_error(response)
+        else:
+            handle_api_error(response)
+
+
 class FormAdvApi:
     """
     Base class for Form ADV API

setup.py

@@ -5,7 +5,7 @@
 
 setup(
     name="sec-api",
-    version="1.0.29",
+    version="1.0.30",
     author="SEC API",
     author_email="support@sec-api.io",
     description="SEC EDGAR Filings API",