secfeed 0.1.0__tar.gz

secfeed-0.1.0/PKG-INFO

@@ -0,0 +1,32 @@
+Metadata-Version: 2.1
+Name: secfeed
+Version: 0.1.0
+Summary: Python SDK for the SecFeed SEC EDGAR API
+License: MIT
+Project-URL: Homepage, https://secfeedapi.com
+Project-URL: Documentation, https://secfeedapi.com/docs/
+Keywords: sec,edgar,filings,xbrl,13f,insider trading,api
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# secfeed (Python)
+
+Client for the [SecFeed](https://secfeedapi.com) SEC EDGAR API. No dependencies, Python 3.8+.
+
+```bash
+pip install secfeed
+```
+
+```python
+from secfeed import Client
+
+sf = Client("sf_...")  # free key at https://secfeedapi.com
+sf.filings('ticker:AAPL AND formType:"10-K"', size=5)
+sf.insider_trades(ticker="NVDA", code="P")
+sf.financial_statements("AAPL")
+sf.events_8k(item="5.02")
+for filing in sf.stream(form_types=["8-K"]):
+    print(filing["companyName"], filing["formType"])
+```
+
+Every endpoint in the [API docs](https://secfeedapi.com/docs/) has a method. Errors raise `SecFeedError`.

secfeed-0.1.0/README.md

@@ -0,0 +1,21 @@
+# secfeed (Python)
+
+Client for the [SecFeed](https://secfeedapi.com) SEC EDGAR API. No dependencies, Python 3.8+.
+
+```bash
+pip install secfeed
+```
+
+```python
+from secfeed import Client
+
+sf = Client("sf_...")  # free key at https://secfeedapi.com
+sf.filings('ticker:AAPL AND formType:"10-K"', size=5)
+sf.insider_trades(ticker="NVDA", code="P")
+sf.financial_statements("AAPL")
+sf.events_8k(item="5.02")
+for filing in sf.stream(form_types=["8-K"]):
+    print(filing["companyName"], filing["formType"])
+```
+
+Every endpoint in the [API docs](https://secfeedapi.com/docs/) has a method. Errors raise `SecFeedError`.

secfeed-0.1.0/pyproject.toml

@@ -0,0 +1,19 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "secfeed"
+version = "0.1.0"
+description = "Python SDK for the SecFeed SEC EDGAR API"
+requires-python = ">=3.8"
+readme = "README.md"
+license = {text = "MIT"}
+keywords = ["sec", "edgar", "filings", "xbrl", "13f", "insider trading", "api"]
+
+[project.urls]
+Homepage = "https://secfeedapi.com"
+Documentation = "https://secfeedapi.com/docs/"
+
+[tool.setuptools]
+packages = ["secfeed"]

secfeed-0.1.0/secfeed/__init__.py

@@ -0,0 +1,150 @@
+"""SecFeed Python SDK. Stdlib only.
+
+    pip install secfeed
+
+    from secfeed import Client
+    sf = Client("sf_...")
+    sf.filings('ticker:AAPL AND formType:"10-K"')
+    sf.insider_trades(ticker="NVDA", code="P")
+    for filing in sf.stream(form_types=["8-K"]): ...
+"""
+import json
+import urllib.parse
+import urllib.request
+
+__all__ = ["Client", "SecFeedError"]
+
+
+class SecFeedError(Exception):
+    pass
+
+
+class Client:
+    def __init__(self, api_key, base_url="https://secfeedapi.com"):
+        self.key, self.base = api_key, base_url.rstrip("/")
+
+    def _req(self, method, path, params=None, body=None, raw=False):
+        q = urllib.parse.urlencode({k: v for k, v in (params or {}).items() if v is not None})
+        req = urllib.request.Request(f"{self.base}{path}{'?' + q if q else ''}", method=method,
+                                     data=json.dumps(body).encode() if body is not None else None,
+                                     headers={"Authorization": f"Bearer {self.key}", "Content-Type": "application/json"})
+        try:
+            with urllib.request.urlopen(req, timeout=120) as r:
+                data = r.read()
+        except urllib.error.HTTPError as e:
+            raise SecFeedError(f"{e.code}: {e.read().decode(errors='replace')}") from None
+        return data if raw else json.loads(data)
+
+    # search
+    def filings(self, query, start=0, size=50, sort="desc"):
+        return self._req("POST", "/v1/filings", body={"query": query, "from": start, "size": size, "sort": sort})
+
+    def full_text_search(self, query, form_types=None, start_date=None, end_date=None, page=1):
+        return self._req("GET", "/v1/full-text-search", {"query": query, "formTypes": ",".join(form_types or []) or None,
+                                                         "startDate": start_date, "endDate": end_date, "page": page})
+
+    # documents
+    def files(self, cik, accession_no):
+        return self._req("GET", "/v1/files", {"cik": cik, "accessionNo": accession_no})
+
+    def download(self, url):
+        return self._req("GET", "/v1/download", {"url": url}, raw=True)
+
+    def pdf(self, url):
+        return self._req("GET", "/v1/pdf", {"url": url}, raw=True)
+
+    def extract(self, url, item, type="text"):
+        return self._req("GET", "/v1/extractor", {"url": url, "item": item, "type": type}, raw=True).decode()
+
+    # financials
+    def xbrl_to_json(self, accession_no=None, htm_url=None, cik=None):
+        return self._req("GET", "/v1/xbrl-to-json", {"accessionNo": accession_no, "htmUrl": htm_url, "cik": cik})
+
+    def financial_statements(self, ticker, form_type="10-K", n=1):
+        return self._req("GET", "/v1/financial-statements", {"ticker": ticker, "formType": form_type, "n": n})
+
+    def company_facts(self, ticker):
+        return self._req("GET", "/v1/xbrl/company-facts", {"ticker": ticker})
+
+    def frames(self, concept, period, unit="USD"):
+        return self._req("GET", "/v1/xbrl/frames", {"concept": concept, "period": period, "unit": unit})
+
+    # ownership, events, forms
+    def insider_trades(self, **filters):
+        return self._req("GET", "/v1/insider-trading", filters)
+
+    def holdings_13f(self, cusip=None, cik=None, period=None):
+        return self._req("GET", "/v1/form-13f/holdings", {"cusip": cusip, "cik": cik, "period": period})
+
+    def form(self, family, **filters):
+        """family: form-144, form-13f, form-13d-13g, form-d, form-c, reg-a, n-port, n-cen, n-px"""
+        return self._req("GET", f"/v1/{family}", filters)
+
+    def events_8k(self, item=None, **filters):
+        return self._req("GET", "/v1/form-8k", {"item": item, **filters})
+
+    # company data & reference
+    def entity(self, ticker_or_cik):
+        return self._req("GET", "/v1/entities", {"cik": ticker_or_cik})
+
+    def map_ticker(self, ticker):
+        return self._req("GET", "/v1/mapping/ticker", {"ticker": ticker})
+
+    def map_cusip(self, cusip):
+        return self._req("GET", "/v1/mapping/cusip", {"cusip": cusip})
+
+    def shares_outstanding(self, ticker):
+        return self._req("GET", "/v1/shares-outstanding", {"ticker": ticker})
+
+    def auditor(self, ticker):
+        return self._req("GET", "/v1/auditor", {"ticker": ticker})
+
+    def executive_compensation(self, ticker):
+        return self._req("GET", "/v1/executive-compensation", {"ticker": ticker})
+
+    def directors(self, ticker):
+        return self._req("GET", "/v1/directors", {"ticker": ticker})
+
+    def subsidiaries(self, ticker):
+        return self._req("GET", "/v1/subsidiaries", {"ticker": ticker})
+
+    # datasets extracted from proxy statements, audit reports and enforcement releases
+    # filters: cik, ticker, accessionNo, startDate, endDate, from, size, and data.<path>=value
+    def dataset(self, path, **filters):
+        return self._req("GET", f"/v1/{path}", filters)
+
+    def audit_report_content(self, id):
+        return self._req("GET", "/v1/audit-reports/content", {"id": id}, raw=True).decode()
+
+    def ipos(self, **filters):
+        return self._req("GET", "/v1/ipo", filters)
+
+    # enforcement
+    def enforcement(self, kind="litigation-releases", page=0, details=False):
+        return self._req("GET", f"/v1/enforcement/{kind}", {"page": page, "details": str(details).lower()})
+
+    # real time
+    def stream(self, form_types=None, ciks=None):
+        """Yield each new filing as a dict, as soon as EDGAR publishes it."""
+        q = urllib.parse.urlencode({"formTypes": ",".join(form_types or []), "ciks": ",".join(map(str, ciks or []))})
+        req = urllib.request.Request(f"{self.base}/v1/stream?{q}", headers={"Authorization": f"Bearer {self.key}"})
+        with urllib.request.urlopen(req) as r:
+            for line in r:
+                if line.startswith(b"data: "):
+                    yield json.loads(line[6:])
+
+    def add_webhook(self, url, form_types=None, ciks=None):
+        return self._req("POST", "/v1/webhooks", body={"url": url, "formTypes": form_types or [], "ciks": ciks or []})
+
+
+DATASETS = {
+    "director_compensation": "director-compensation", "executive_compensation_governance": "executive-compensation-governance",
+    "severance_change_in_control": "severance-change-in-control", "board_oversight": "board-oversight",
+    "shareholder_rights": "shareholder-rights", "esg_oversight": "esg-oversight", "compliance_signals": "compliance-signals",
+    "vote_standards": "vote-standards", "shareholder_proposals_proxy_contests": "shareholder-proposals-proxy-contests",
+    "insider_5pct_holder_ownership": "insider-5pct-holder-ownership", "fund_reorganizations": "fund-reorganizations",
+    "audit_reports_financial_statements": "audit-reports/financial-statements", "audit_reports_icfr": "audit-reports/icfr",
+    "enforcement_actions": "sec-enforcement-actions",
+}
+for _name, _path in DATASETS.items():  # sf.board_oversight(ticker="AAPL") and so on
+    setattr(Client, _name, lambda self, _p=_path, **filters: self.dataset(_p, **filters))

secfeed-0.1.0/secfeed.egg-info/PKG-INFO

@@ -0,0 +1,32 @@
+Metadata-Version: 2.1
+Name: secfeed
+Version: 0.1.0
+Summary: Python SDK for the SecFeed SEC EDGAR API
+License: MIT
+Project-URL: Homepage, https://secfeedapi.com
+Project-URL: Documentation, https://secfeedapi.com/docs/
+Keywords: sec,edgar,filings,xbrl,13f,insider trading,api
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# secfeed (Python)
+
+Client for the [SecFeed](https://secfeedapi.com) SEC EDGAR API. No dependencies, Python 3.8+.
+
+```bash
+pip install secfeed
+```
+
+```python
+from secfeed import Client
+
+sf = Client("sf_...")  # free key at https://secfeedapi.com
+sf.filings('ticker:AAPL AND formType:"10-K"', size=5)
+sf.insider_trades(ticker="NVDA", code="P")
+sf.financial_statements("AAPL")
+sf.events_8k(item="5.02")
+for filing in sf.stream(form_types=["8-K"]):
+    print(filing["companyName"], filing["formType"])
+```
+
+Every endpoint in the [API docs](https://secfeedapi.com/docs/) has a method. Errors raise `SecFeedError`.

secfeed-0.1.0/secfeed.egg-info/SOURCES.txt

@@ -0,0 +1,7 @@
+README.md
+pyproject.toml
+secfeed/__init__.py
+secfeed.egg-info/PKG-INFO
+secfeed.egg-info/SOURCES.txt
+secfeed.egg-info/dependency_links.txt
+secfeed.egg-info/top_level.txt

secfeed-0.1.0/secfeed.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

secfeed-0.1.0/secfeed.egg-info/top_level.txt

@@ -0,0 +1 @@
+secfeed

secfeed-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+