added Form C API - Crowdfunding Campaigns

Author: janlukasschroeder

README.md

@@ -32,6 +32,7 @@
 **Security Offerings APIs**
 
 - [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)
 
 **Structured Material Event Data from Form 8-K**
@@ -901,6 +902,29 @@ print(response["data"])
 
 > See the documentation for more details: https://sec-api.io/docs/form-s1-424b4-data-search-api
 
+## Form C API - Crowdfunding Campaigns
+
+Search and access Form C filings of crowdfunding campaigns from 2016 to present. The database includes information about the issuer (name, number of employees, total assets, etc), the target amount to be raised, the type of security offered, the deadline of the campaign, and more.
+
+```python
+from sec_api import FormCApi
+
+formCApi = FormCApi("YOUR_API_KEY")
+
+search_params = {
+    "query": "id:*",
+    "from": "0",
+    "size": "10",
+    "sort": [{"filedAt": {"order": "desc"}}],
+}
+
+response = formCApi.get_data(search_params)
+
+print(response["data"])
+```
+
+> See the documentation for more details: https://sec-api.io/docs/form-c-crowdfunding-api
+
 ## Form D API
 
 Search and find Form D offering filings by any filing property, e.g. total offering amount, offerings filed by hedge funds, type of securities offered and many more.

examples.py

@@ -15,6 +15,7 @@
     FormNPXApi,
     #
     Form_S1_424B4_Api,
+    FormCApi,
     FormDApi,
     #
     Item_4_02_Api,
@@ -270,6 +271,24 @@
 print(response["filings"])
 # """
 
+#
+# Form C API Example
+#
+"""
+formCApi = FormCApi("YOUR_API_KEY")
+
+search_params = {
+    "query": "id:*",
+    "from": "0",
+    "size": "10",
+    "sort": [{"filedAt": {"order": "desc"}}],
+}
+
+response = formCApi.get_data(search_params)
+
+print(response["data"])
+# """
+
 #
 # Form D API Example
 #

sec_api/__init__.py

@@ -20,6 +20,7 @@
 
 # Offering APIs
 from sec_api.index import Form_S1_424B4_Api
+from sec_api.index import FormCApi
 from sec_api.index import FormDApi
 
 # Investment Adviser API

sec_api/index.py

@@ -22,6 +22,7 @@
 #
 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"
 #
 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"
@@ -518,6 +519,36 @@ def get_data(self, query):
             handle_api_error(response)
 
 
+class FormCApi:
+    """
+    Base class for Form C API
+    https://sec-api.io/docs/form-c-crowdfunding-api
+    """
+
+    def __init__(self, api_key, proxies=None):
+        self.api_key = api_key
+        self.api_endpoint = form_C_endpoint + "?token=" + api_key
+        self.proxies = proxies if proxies else {}
+
+    def get_data(self, query):
+        response = {}
+
+        # use backoff strategy to handle "too many requests" error.
+        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:
+                # wait 500 * (x + 1) milliseconds and try again
+                time.sleep(0.5 * (x + 1))
+            else:
+                handle_api_error(response)
+        else:
+            handle_api_error(response)
+
+
 class FormDApi:
     """
     Base class for Form D API

setup.py

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