edgrapi 0.1.0__tar.gz

edgrapi-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Paper and Beyond
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

edgrapi-0.1.0/PKG-INFO

@@ -0,0 +1,111 @@
+Metadata-Version: 2.4
+Name: edgrapi
+Version: 0.1.0
+Summary: Tiny Python client for the Edgrapi SEC EDGAR data API: financials, insider trades, 8-K events, 13F holdings, and 13D/13G stakes as clean JSON.
+Author-email: Paper and Beyond <support@edgrapi.com>
+License: MIT
+Project-URL: Homepage, https://edgrapi.com
+Project-URL: Documentation, https://edgrapi.com/docs
+Project-URL: Repository, https://github.com/paperandbeyond23-gif/edgrapi-python
+Project-URL: Issues, https://github.com/paperandbeyond23-gif/edgrapi-python/issues
+Keywords: sec,edgar,sec edgar,13f,insider trading,form 4,8-k,10-k,xbrl,financial data,financial statements,api
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.20
+Dynamic: license-file
+
+# edgrapi
+
+A tiny Python client for the [Edgrapi](https://edgrapi.com) SEC EDGAR data API.
+
+Parsed SEC filings as clean JSON: company financials, insider trades (Form 4),
+8-K events, 13F fund holdings, and 13D/13G activist stakes. There's **no LLM in
+the data path** — every value is lifted straight from the filing, so you can
+verify any number on EDGAR yourself.
+
+The heavy lifting (XBRL parsing, CUSIP mapping, quarter-over-quarter diffs)
+happens server-side, so this client stays tiny and has one dependency
+(`requests`).
+
+## Install
+
+```bash
+pip install edgrapi
+```
+
+Get a free API key (100 calls/month, no card) at <https://edgrapi.com>.
+
+## Usage
+
+```python
+from edgrapi import Client
+
+c = Client("your_key")
+
+# Financials — income statement, balance sheet, cash flow (normalized from XBRL)
+c.fundamentals("AAPL")
+c.fundamentals("AAPL", period="quarterly", limit=8)
+c.ratios("AAPL")
+
+# Insider trades (Form 4), scored buy vs sell
+c.insider("NVDA")
+
+# 8-K material events, item-coded
+c.events("TSLA")
+c.events("TSLA", notable=True)   # skip routine 8-Ks
+
+# 13F fund holdings, diffed against last quarter
+c.holdings("berkshire")          # famous-fund alias
+c.holdings("burry")
+
+# 13D / 13G activist stakes
+c.activist("AAPL")
+
+# Company profile + CIK, and recent filings
+c.company("MSFT")
+c.filings("MSFT", form="10-K")
+
+# Extracted 10-K / 10-Q sections (business, risk factors, MD&A)
+c.sections("AAPL")
+```
+
+Every method returns the parsed JSON body as a `dict`.
+
+## Errors
+
+Failed calls raise `EdgrapiError`, which carries the HTTP status and the
+server's detail:
+
+```python
+from edgrapi import Client, EdgrapiError
+
+c = Client("your_key")
+try:
+    c.fundamentals("NOTATICKER")
+except EdgrapiError as e:
+    print(e.status, e.detail)   # e.g. 404 unknown ticker
+```
+
+Common statuses: `401` bad key, `402` / `429` out of credits, `404` unknown
+ticker. Calls that return no data are not charged. The exact credit cost of each
+call comes back in the `X-Credits-Cost` response header, and your remaining
+balance in `X-Credits-Remaining`.
+
+## Notes
+
+- This is a thin HTTP client. The API it talks to is a hosted service; if you'd
+  rather run everything locally with no API key, [edgartools](https://github.com/dgunning/edgartools)
+  is an excellent open-source library that parses EDGAR on your own machine.
+- Data is public SEC EDGAR content, surfaced for research. Not investment advice.
+
+## License
+
+[MIT](LICENSE).

edgrapi-0.1.0/README.md

@@ -0,0 +1,87 @@
+# edgrapi
+
+A tiny Python client for the [Edgrapi](https://edgrapi.com) SEC EDGAR data API.
+
+Parsed SEC filings as clean JSON: company financials, insider trades (Form 4),
+8-K events, 13F fund holdings, and 13D/13G activist stakes. There's **no LLM in
+the data path** — every value is lifted straight from the filing, so you can
+verify any number on EDGAR yourself.
+
+The heavy lifting (XBRL parsing, CUSIP mapping, quarter-over-quarter diffs)
+happens server-side, so this client stays tiny and has one dependency
+(`requests`).
+
+## Install
+
+```bash
+pip install edgrapi
+```
+
+Get a free API key (100 calls/month, no card) at <https://edgrapi.com>.
+
+## Usage
+
+```python
+from edgrapi import Client
+
+c = Client("your_key")
+
+# Financials — income statement, balance sheet, cash flow (normalized from XBRL)
+c.fundamentals("AAPL")
+c.fundamentals("AAPL", period="quarterly", limit=8)
+c.ratios("AAPL")
+
+# Insider trades (Form 4), scored buy vs sell
+c.insider("NVDA")
+
+# 8-K material events, item-coded
+c.events("TSLA")
+c.events("TSLA", notable=True)   # skip routine 8-Ks
+
+# 13F fund holdings, diffed against last quarter
+c.holdings("berkshire")          # famous-fund alias
+c.holdings("burry")
+
+# 13D / 13G activist stakes
+c.activist("AAPL")
+
+# Company profile + CIK, and recent filings
+c.company("MSFT")
+c.filings("MSFT", form="10-K")
+
+# Extracted 10-K / 10-Q sections (business, risk factors, MD&A)
+c.sections("AAPL")
+```
+
+Every method returns the parsed JSON body as a `dict`.
+
+## Errors
+
+Failed calls raise `EdgrapiError`, which carries the HTTP status and the
+server's detail:
+
+```python
+from edgrapi import Client, EdgrapiError
+
+c = Client("your_key")
+try:
+    c.fundamentals("NOTATICKER")
+except EdgrapiError as e:
+    print(e.status, e.detail)   # e.g. 404 unknown ticker
+```
+
+Common statuses: `401` bad key, `402` / `429` out of credits, `404` unknown
+ticker. Calls that return no data are not charged. The exact credit cost of each
+call comes back in the `X-Credits-Cost` response header, and your remaining
+balance in `X-Credits-Remaining`.
+
+## Notes
+
+- This is a thin HTTP client. The API it talks to is a hosted service; if you'd
+  rather run everything locally with no API key, [edgartools](https://github.com/dgunning/edgartools)
+  is an excellent open-source library that parses EDGAR on your own machine.
+- Data is public SEC EDGAR content, surfaced for research. Not investment advice.
+
+## License
+
+[MIT](LICENSE).

edgrapi-0.1.0/edgrapi/__init__.py

@@ -0,0 +1,123 @@
+# -*- coding: utf-8 -*-
+"""edgrapi — a tiny Python client for the Edgrapi SEC EDGAR data API.
+
+Parsed SEC filings as clean JSON: company financials, insider trades (Form 4),
+8-K events, 13F fund holdings, and 13D/13G activist stakes. No LLM in the data
+path — every value is lifted straight from the filing, so you can verify any
+number on EDGAR yourself.
+
+Get a free API key (100 calls/month) at https://edgrapi.com.
+
+    from edgrapi import Client
+    c = Client("your_key")
+    c.fundamentals("AAPL")     # income statement, balance sheet, cash flow
+    c.insider("AAPL")          # Form 4 trades, scored buy vs sell
+    c.events("AAPL")           # 8-K events, item-coded
+    c.holdings("berkshire")    # 13F holdings, diffed vs last quarter
+"""
+import urllib.parse
+
+import requests
+
+__version__ = "0.1.0"
+__all__ = ["Client", "EdgrapiError"]
+
+DEFAULT_BASE = "https://api.edgrapi.com"
+
+
+class EdgrapiError(Exception):
+    """Raised when the API returns a non-2xx status. Carries the HTTP status and
+    the server's error detail so you can act on it (e.g. 401 = bad key, 402/429 =
+    out of credits, 404 = unknown ticker)."""
+
+    def __init__(self, status, detail):
+        self.status = status
+        self.detail = detail
+        super().__init__("Edgrapi %s: %s" % (status, detail))
+
+
+class Client:
+    """Client for the Edgrapi SEC-data API.
+
+    Args:
+        api_key: your key from https://edgrapi.com (free tier available).
+        base_url: override the API host (defaults to https://api.edgrapi.com).
+        timeout: per-request timeout in seconds.
+        session: an existing ``requests.Session`` to reuse, if you want.
+
+    Every method returns the parsed JSON body as a dict. Failed calls raise
+    ``EdgrapiError``. The exact credit cost of a call is returned by the API in
+    the ``X-Credits-Cost`` response header; the balance in ``X-Credits-Remaining``.
+    """
+
+    def __init__(self, api_key, base_url=DEFAULT_BASE, timeout=30, session=None):
+        if not api_key:
+            raise ValueError("api_key is required — get a free one at https://edgrapi.com")
+        self.api_key = api_key
+        self.base_url = base_url.rstrip("/")
+        self.timeout = timeout
+        self._s = session or requests.Session()
+        self._s.headers.update({
+            "X-API-Key": api_key,
+            "User-Agent": "edgrapi-python/%s" % __version__,
+            "Accept": "application/json",
+        })
+
+    # ---- internals ----
+    @staticmethod
+    def _enc(v):
+        return urllib.parse.quote(str(v).strip(), safe="")
+
+    def _get(self, path, **params):
+        params = {k: v for k, v in params.items() if v is not None}
+        resp = self._s.get(self.base_url + path, params=params, timeout=self.timeout)
+        if resp.status_code >= 400:
+            detail = resp.text
+            try:
+                body = resp.json()
+                detail = body.get("detail") or body.get("error") or detail
+            except ValueError:
+                pass
+            raise EdgrapiError(resp.status_code, detail)
+        return resp.json()
+
+    # ---- company & filings ----
+    def company(self, ticker):
+        """Company profile and CIK for a ticker."""
+        return self._get("/v1/company/%s" % self._enc(ticker))
+
+    def filings(self, ticker, form=None, limit=None):
+        """Recent SEC filings for a company, optionally filtered by ``form``."""
+        return self._get("/v1/filings/%s" % self._enc(ticker), form=form, limit=limit)
+
+    # ---- financials ----
+    def fundamentals(self, ticker, period=None, limit=None):
+        """Income statement, balance sheet and cash flow, normalized from XBRL.
+        ``period`` is 'annual' or 'quarterly'."""
+        return self._get("/v1/fundamentals/%s" % self._enc(ticker), period=period, limit=limit)
+
+    def ratios(self, ticker):
+        """Computed financial ratios for a company."""
+        return self._get("/v1/ratios/%s" % self._enc(ticker))
+
+    def sections(self, ticker, form=None):
+        """Extracted 10-K / 10-Q sections (business, risk factors, MD&A, ...)."""
+        return self._get("/v1/sections/%s" % self._enc(ticker), form=form)
+
+    # ---- insider, events & ownership ----
+    def insider(self, ticker, limit=None, form=None):
+        """Form 4 insider transactions, scored buy vs sell (code P = open-market buy)."""
+        return self._get("/v1/insider/%s" % self._enc(ticker), limit=limit, form=form)
+
+    def events(self, ticker, limit=None, notable=None):
+        """8-K material events with item codes; ``notable=True`` skips routine ones."""
+        return self._get("/v1/events/%s" % self._enc(ticker), limit=limit, notable=notable)
+
+    def activist(self, identifier, limit=None):
+        """13D / 13G activist stakes for a company (ticker or CIK)."""
+        return self._get("/v1/activist/%s" % self._enc(identifier), limit=limit)
+
+    def holdings(self, identifier, limit=None, changes=None):
+        """13F fund holdings, diffed against the prior quarter. ``identifier`` can be
+        a famous-fund alias (e.g. 'berkshire'), a manager name, or a CIK."""
+        return self._get("/v1/holdings/%s" % self._enc(identifier), limit=limit, changes=changes)

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

@@ -0,0 +1,111 @@
+Metadata-Version: 2.4
+Name: edgrapi
+Version: 0.1.0
+Summary: Tiny Python client for the Edgrapi SEC EDGAR data API: financials, insider trades, 8-K events, 13F holdings, and 13D/13G stakes as clean JSON.
+Author-email: Paper and Beyond <support@edgrapi.com>
+License: MIT
+Project-URL: Homepage, https://edgrapi.com
+Project-URL: Documentation, https://edgrapi.com/docs
+Project-URL: Repository, https://github.com/paperandbeyond23-gif/edgrapi-python
+Project-URL: Issues, https://github.com/paperandbeyond23-gif/edgrapi-python/issues
+Keywords: sec,edgar,sec edgar,13f,insider trading,form 4,8-k,10-k,xbrl,financial data,financial statements,api
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.20
+Dynamic: license-file
+
+# edgrapi
+
+A tiny Python client for the [Edgrapi](https://edgrapi.com) SEC EDGAR data API.
+
+Parsed SEC filings as clean JSON: company financials, insider trades (Form 4),
+8-K events, 13F fund holdings, and 13D/13G activist stakes. There's **no LLM in
+the data path** — every value is lifted straight from the filing, so you can
+verify any number on EDGAR yourself.
+
+The heavy lifting (XBRL parsing, CUSIP mapping, quarter-over-quarter diffs)
+happens server-side, so this client stays tiny and has one dependency
+(`requests`).
+
+## Install
+
+```bash
+pip install edgrapi
+```
+
+Get a free API key (100 calls/month, no card) at <https://edgrapi.com>.
+
+## Usage
+
+```python
+from edgrapi import Client
+
+c = Client("your_key")
+
+# Financials — income statement, balance sheet, cash flow (normalized from XBRL)
+c.fundamentals("AAPL")
+c.fundamentals("AAPL", period="quarterly", limit=8)
+c.ratios("AAPL")
+
+# Insider trades (Form 4), scored buy vs sell
+c.insider("NVDA")
+
+# 8-K material events, item-coded
+c.events("TSLA")
+c.events("TSLA", notable=True)   # skip routine 8-Ks
+
+# 13F fund holdings, diffed against last quarter
+c.holdings("berkshire")          # famous-fund alias
+c.holdings("burry")
+
+# 13D / 13G activist stakes
+c.activist("AAPL")
+
+# Company profile + CIK, and recent filings
+c.company("MSFT")
+c.filings("MSFT", form="10-K")
+
+# Extracted 10-K / 10-Q sections (business, risk factors, MD&A)
+c.sections("AAPL")
+```
+
+Every method returns the parsed JSON body as a `dict`.
+
+## Errors
+
+Failed calls raise `EdgrapiError`, which carries the HTTP status and the
+server's detail:
+
+```python
+from edgrapi import Client, EdgrapiError
+
+c = Client("your_key")
+try:
+    c.fundamentals("NOTATICKER")
+except EdgrapiError as e:
+    print(e.status, e.detail)   # e.g. 404 unknown ticker
+```
+
+Common statuses: `401` bad key, `402` / `429` out of credits, `404` unknown
+ticker. Calls that return no data are not charged. The exact credit cost of each
+call comes back in the `X-Credits-Cost` response header, and your remaining
+balance in `X-Credits-Remaining`.
+
+## Notes
+
+- This is a thin HTTP client. The API it talks to is a hosted service; if you'd
+  rather run everything locally with no API key, [edgartools](https://github.com/dgunning/edgartools)
+  is an excellent open-source library that parses EDGAR on your own machine.
+- Data is public SEC EDGAR content, surfaced for research. Not investment advice.
+
+## License
+
+[MIT](LICENSE).

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

@@ -0,0 +1,9 @@
+LICENSE
+README.md
+pyproject.toml
+edgrapi/__init__.py
+edgrapi.egg-info/PKG-INFO
+edgrapi.egg-info/SOURCES.txt
+edgrapi.egg-info/dependency_links.txt
+edgrapi.egg-info/requires.txt
+edgrapi.egg-info/top_level.txt

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

@@ -0,0 +1 @@
+

edgrapi-0.1.0/edgrapi.egg-info/requires.txt

@@ -0,0 +1 @@
+requests>=2.20

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

@@ -0,0 +1 @@
+edgrapi

edgrapi-0.1.0/pyproject.toml

@@ -0,0 +1,35 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "edgrapi"
+version = "0.1.0"
+description = "Tiny Python client for the Edgrapi SEC EDGAR data API: financials, insider trades, 8-K events, 13F holdings, and 13D/13G stakes as clean JSON."
+readme = "README.md"
+requires-python = ">=3.8"
+license = { text = "MIT" }
+authors = [{ name = "Paper and Beyond", email = "support@edgrapi.com" }]
+keywords = [
+  "sec", "edgar", "sec edgar", "13f", "insider trading", "form 4",
+  "8-k", "10-k", "xbrl", "financial data", "financial statements", "api",
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Financial and Insurance Industry",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Topic :: Office/Business :: Financial",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = ["requests>=2.20"]
+
+[project.urls]
+Homepage = "https://edgrapi.com"
+Documentation = "https://edgrapi.com/docs"
+Repository = "https://github.com/paperandbeyond23-gif/edgrapi-python"
+Issues = "https://github.com/paperandbeyond23-gif/edgrapi-python/issues"
+
+[tool.setuptools]
+packages = ["edgrapi"]

edgrapi-0.1.0/setup.cfg

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