form4api 0.1.0__tar.gz → 0.3.0__tar.gz

{form4api-0.1.0 → form4api-0.3.0}/PKG-INFO

@@ -1,104 +1,104 @@
-Metadata-Version: 2.4
-Name: form4api
-Version: 0.1.0
-Summary: Python client for the Form4API — real-time SEC Form 4 insider trading data
-License-Expression: MIT
-Project-URL: Homepage, https://form4api.com
-Project-URL: Documentation, https://form4api.com/docs
-Project-URL: Repository, https://github.com/theodor90/form4api-py.git
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: httpx>=0.27
-Provides-Extra: dev
-Requires-Dist: pytest>=8; extra == "dev"
-Requires-Dist: pytest-httpx>=0.30; extra == "dev"
-Requires-Dist: respx>=0.21; extra == "dev"
-Dynamic: license-file
-
-# form4api
-
-Python client for [Form4API](https://form4api.com) — real-time SEC Form 4 insider trading data.
-
-Supports Python 3.11+. Uses `httpx` for both sync and async HTTP.
-
-## Installation
-
-```bash
-pip install form4api
-```
-
-## Sync quickstart
-
-```python
-from form4api import Form4ApiClient
-
-client = Form4ApiClient("YOUR_API_KEY")
-
-# Recent open-market purchases at Apple
-txns = client.transactions.list(ticker="AAPL", code="P", per_page=5)
-for t in txns:
-    print(t.insider_name, t.shares_amount, "@", t.price_per_share)
-
-# Company overview
-company = client.companies.get("MSFT")
-print(company.name, company.active_insiders, "active insiders")
-
-# Insider detail
-insider = client.insiders.get("0001234567")
-print(insider.name, insider.officer_title)
-
-# Cluster-buy signals (Business plan)
-signals = client.signals.list(ticker="NVDA")
-for sig in signals:
-    if sig.is_cluster_buy:
-        print(sig.company_name, sig.insider_count, "buyers")
-```
-
-## Async quickstart
-
-```python
-import asyncio
-from form4api import AsyncForm4ApiClient
-
-async def main():
-    async with AsyncForm4ApiClient("YOUR_API_KEY") as client:
-        txns = await client.transactions.list(ticker="AAPL", per_page=5)
-        for t in txns:
-            print(t.insider_name, t.shares_amount, "@", t.price_per_share)
-
-asyncio.run(main())
-```
-
-## Resources
-
-| Resource | Methods |
-|---|---|
-| `client.transactions` | `.list(**params)`, `.paginate(**params)` |
-| `client.insiders` | `.get(cik)`, `.transactions(cik, **params)` |
-| `client.companies` | `.get(ticker)`, `.insiders(ticker)` |
-| `client.signals` | `.list(**params)` — Business plan |
-| `client.webhooks` | `.create(url, event_types)`, `.list()`, `.delete(id)`, `.events(**params)` |
-
-## Error handling
-
-```python
-from form4api import Form4ApiClient, AuthError, PlanError, RateLimitError, NotFoundError
-
-client = Form4ApiClient("YOUR_API_KEY")
-
-try:
-    signals = client.signals.list()
-except PlanError as e:
-    print(f"Upgrade to {e.required_plan}")
-except RateLimitError as e:
-    print(f"Retry after {e.retry_after}s")
-except AuthError:
-    print("Invalid API key")
-except NotFoundError:
-    print("Resource not found")
-```
-
-## License
-
-MIT
+Metadata-Version: 2.4
+Name: form4api
+Version: 0.3.0
+Summary: Python client for the Form4API — real-time SEC Form 4 insider trading data
+License-Expression: MIT
+Project-URL: Homepage, https://form4api.com
+Project-URL: Documentation, https://form4api.com/docs
+Project-URL: Repository, https://github.com/theodor90/form4api-py.git
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.27
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: pytest-httpx>=0.30; extra == "dev"
+Requires-Dist: respx>=0.21; extra == "dev"
+Dynamic: license-file
+
+# form4api
+
+Python client for [Form4API](https://form4api.com) — real-time SEC Form 4 insider trading data.
+
+Supports Python 3.11+. Uses `httpx` for both sync and async HTTP.
+
+## Installation
+
+```bash
+pip install form4api
+```
+
+## Sync quickstart
+
+```python
+from form4api import Form4ApiClient
+
+client = Form4ApiClient("YOUR_API_KEY")
+
+# Recent open-market purchases at Apple
+txns = client.transactions.list(ticker="AAPL", code="P", per_page=5)
+for t in txns:
+    print(t.insider_name, t.shares_amount, "@", t.price_per_share)
+
+# Company overview
+company = client.companies.get("MSFT")
+print(company.name, company.active_insiders, "active insiders")
+
+# Insider detail
+insider = client.insiders.get("0001234567")
+print(insider.name, insider.officer_title)
+
+# Cluster-buy signals (Business plan)
+signals = client.signals.list(ticker="NVDA")
+for sig in signals:
+    if sig.is_cluster_buy:
+        print(sig.company_name, sig.insider_count, "buyers")
+```
+
+## Async quickstart
+
+```python
+import asyncio
+from form4api import AsyncForm4ApiClient
+
+async def main():
+    async with AsyncForm4ApiClient("YOUR_API_KEY") as client:
+        txns = await client.transactions.list(ticker="AAPL", per_page=5)
+        for t in txns:
+            print(t.insider_name, t.shares_amount, "@", t.price_per_share)
+
+asyncio.run(main())
+```
+
+## Resources
+
+| Resource | Methods |
+|---|---|
+| `client.transactions` | `.list(**params)`, `.paginate(**params)` |
+| `client.insiders` | `.search(name, **params)`, `.get(cik)`, `.transactions(cik, **params)` |
+| `client.companies` | `.get(ticker)`, `.insiders(ticker)` |
+| `client.signals` | `.list(**params)` — Business plan |
+| `client.webhooks` | `.create(url, event_types)`, `.list()`, `.delete(id)`, `.events(**params)` |
+
+## Error handling
+
+```python
+from form4api import Form4ApiClient, AuthError, PlanError, RateLimitError, NotFoundError
+
+client = Form4ApiClient("YOUR_API_KEY")
+
+try:
+    signals = client.signals.list()
+except PlanError as e:
+    print(f"Upgrade to {e.required_plan}")
+except RateLimitError as e:
+    print(f"Retry after {e.retry_after}s")
+except AuthError:
+    print("Invalid API key")
+except NotFoundError:
+    print("Resource not found")
+```
+
+## License
+
+MIT

{form4api-0.1.0 → form4api-0.3.0}/README.md

@@ -57,7 +57,7 @@ asyncio.run(main())
 | Resource | Methods |
 |---|---|
 | `client.transactions` | `.list(**params)`, `.paginate(**params)` |
-| `client.insiders` | `.get(cik)`, `.transactions(cik, **params)` |
+| `client.insiders` | `.search(name, **params)`, `.get(cik)`, `.transactions(cik, **params)` |
 | `client.companies` | `.get(ticker)`, `.insiders(ticker)` |
 | `client.signals` | `.list(**params)` — Business plan |
 | `client.webhooks` | `.create(url, event_types)`, `.list()`, `.delete(id)`, `.events(**params)` |

{form4api-0.1.0 → form4api-0.3.0}/form4api/_types.py

@@ -9,11 +9,18 @@ class Transaction:
     company_name: str
     insider_name: str
     insider_cik: str
+    insider_title: str | None
+    is_director: bool
+    is_officer: bool
+    is10_pct_owner: bool
     accession_number: str
     security_title: str
     transaction_code: str
+    is_open_market: bool
+    is10b5_plan: bool
     shares_amount: float
     price_per_share: float | None
+    total_value: float | None
     shares_owned_after: float | None
     direct_indirect: str | None
     is_derivative: bool

{form4api-0.1.0 → form4api-0.3.0}/form4api/_webhook_utils.py

@@ -18,6 +18,6 @@ def verify_webhook(payload: str | bytes, signature: str, secret: str) -> bool:
         payload = payload.encode()
     expected = "sha256=" + hmac.new(secret.encode(), payload, hashlib.sha256).hexdigest()
     return hmac.compare_digest(expected, signature)
-
-
-
+
+
+

{form4api-0.1.0 → form4api-0.3.0}/form4api/resources/__init__.py

@@ -11,6 +11,6 @@ __all__ = [
     "TransactionsResource",
     "WebhooksResource",
 ]
-
-
-
+
+
+

{form4api-0.1.0 → form4api-0.3.0}/form4api/resources/_insiders.py

@@ -12,6 +12,17 @@ class InsidersResource:
     def __init__(self, client: Form4ApiClient) -> None:
         self._client = client
 
+    def search(
+        self,
+        name: str,
+        *,
+        page: int = 1,
+        per_page: int = 20,
+    ) -> list[Insider]:
+        params: dict[str, str] = {"name": name, "page": str(page), "per_page": str(per_page)}
+        data = self._client._get("/v1/insiders", params)
+        return [Insider(**item) for item in data]
+
     def get(self, cik: str) -> Insider:
         data = self._client._get(f"/v1/insiders/{cik}")
         return Insider(**data)

form4api-0.3.0/form4api/resources/_signals.py

@@ -0,0 +1,57 @@
+from __future__ import annotations
+
+from collections.abc import Generator
+from typing import TYPE_CHECKING
+
+from form4api._types import InsiderSignal
+
+if TYPE_CHECKING:
+    from form4api._client import Form4ApiClient
+
+
+class SignalsResource:
+    def __init__(self, client: Form4ApiClient) -> None:
+        self._client = client
+
+    def list(
+        self,
+        *,
+        ticker: str | None = None,
+        cluster_buy: bool | None = None,
+        cluster_sell: bool | None = None,
+        page: int = 1,
+        per_page: int = 100,
+    ) -> list[InsiderSignal]:
+        params: dict[str, str] = {"page": str(page), "per_page": str(per_page)}
+        if ticker is not None:
+            params["ticker"] = ticker
+        if cluster_buy is not None:
+            params["cluster_buy"] = str(cluster_buy).lower()
+        if cluster_sell is not None:
+            params["cluster_sell"] = str(cluster_sell).lower()
+        data = self._client._get("/v1/signals", params)
+        return [InsiderSignal(**item) for item in data]
+
+    def paginate(
+        self,
+        *,
+        ticker: str | None = None,
+        cluster_buy: bool | None = None,
+        cluster_sell: bool | None = None,
+        per_page: int = 100,
+    ) -> Generator[list[InsiderSignal], None, None]:
+        page = 1
+        while True:
+            batch = self.list(
+                ticker=ticker, cluster_buy=cluster_buy, cluster_sell=cluster_sell,
+                page=page, per_page=per_page,
+            )
+            if not batch:
+                break
+            yield batch
+            if len(batch) < per_page:
+                break
+            page += 1
+
+
+

{form4api-0.1.0 → form4api-0.3.0}/form4api/resources/_transactions.py

@@ -22,6 +22,7 @@ class TransactionsResource:
         code: str | None = None,
         from_date: str | None = None,
         to_date: str | None = None,
+        exclude_10b5: bool | None = None,
         page: int = 1,
         per_page: int = 50,
     ) -> list[Transaction]:
@@ -38,6 +39,8 @@ class TransactionsResource:
             params["from"] = from_date
         if to_date is not None:
             params["to"] = to_date
+        if exclude_10b5 is not None:
+            params["exclude_10b5"] = str(exclude_10b5).lower()
         data = self._client._get("/v1/transactions", params)
         return [Transaction(**item) for item in data]
 
@@ -50,6 +53,7 @@ class TransactionsResource:
         code: str | None = None,
         from_date: str | None = None,
         to_date: str | None = None,
+        exclude_10b5: bool | None = None,
         per_page: int = 50,
     ) -> Generator[list[Transaction], None, None]:
         page = 1
@@ -57,7 +61,7 @@ class TransactionsResource:
             batch = self.list(
                 ticker=ticker, cik=cik, insider_cik=insider_cik,
                 code=code, from_date=from_date, to_date=to_date,
-                page=page, per_page=per_page,
+                exclude_10b5=exclude_10b5, page=page, per_page=per_page,
             )
             if not batch:
                 break

{form4api-0.1.0 → form4api-0.3.0}/form4api.egg-info/PKG-INFO

@@ -1,104 +1,104 @@
-Metadata-Version: 2.4
-Name: form4api
-Version: 0.1.0
-Summary: Python client for the Form4API — real-time SEC Form 4 insider trading data
-License-Expression: MIT
-Project-URL: Homepage, https://form4api.com
-Project-URL: Documentation, https://form4api.com/docs
-Project-URL: Repository, https://github.com/theodor90/form4api-py.git
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: httpx>=0.27
-Provides-Extra: dev
-Requires-Dist: pytest>=8; extra == "dev"
-Requires-Dist: pytest-httpx>=0.30; extra == "dev"
-Requires-Dist: respx>=0.21; extra == "dev"
-Dynamic: license-file
-
-# form4api
-
-Python client for [Form4API](https://form4api.com) — real-time SEC Form 4 insider trading data.
-
-Supports Python 3.11+. Uses `httpx` for both sync and async HTTP.
-
-## Installation
-
-```bash
-pip install form4api
-```
-
-## Sync quickstart
-
-```python
-from form4api import Form4ApiClient
-
-client = Form4ApiClient("YOUR_API_KEY")
-
-# Recent open-market purchases at Apple
-txns = client.transactions.list(ticker="AAPL", code="P", per_page=5)
-for t in txns:
-    print(t.insider_name, t.shares_amount, "@", t.price_per_share)
-
-# Company overview
-company = client.companies.get("MSFT")
-print(company.name, company.active_insiders, "active insiders")
-
-# Insider detail
-insider = client.insiders.get("0001234567")
-print(insider.name, insider.officer_title)
-
-# Cluster-buy signals (Business plan)
-signals = client.signals.list(ticker="NVDA")
-for sig in signals:
-    if sig.is_cluster_buy:
-        print(sig.company_name, sig.insider_count, "buyers")
-```
-
-## Async quickstart
-
-```python
-import asyncio
-from form4api import AsyncForm4ApiClient
-
-async def main():
-    async with AsyncForm4ApiClient("YOUR_API_KEY") as client:
-        txns = await client.transactions.list(ticker="AAPL", per_page=5)
-        for t in txns:
-            print(t.insider_name, t.shares_amount, "@", t.price_per_share)
-
-asyncio.run(main())
-```
-
-## Resources
-
-| Resource | Methods |
-|---|---|
-| `client.transactions` | `.list(**params)`, `.paginate(**params)` |
-| `client.insiders` | `.get(cik)`, `.transactions(cik, **params)` |
-| `client.companies` | `.get(ticker)`, `.insiders(ticker)` |
-| `client.signals` | `.list(**params)` — Business plan |
-| `client.webhooks` | `.create(url, event_types)`, `.list()`, `.delete(id)`, `.events(**params)` |
-
-## Error handling
-
-```python
-from form4api import Form4ApiClient, AuthError, PlanError, RateLimitError, NotFoundError
-
-client = Form4ApiClient("YOUR_API_KEY")
-
-try:
-    signals = client.signals.list()
-except PlanError as e:
-    print(f"Upgrade to {e.required_plan}")
-except RateLimitError as e:
-    print(f"Retry after {e.retry_after}s")
-except AuthError:
-    print("Invalid API key")
-except NotFoundError:
-    print("Resource not found")
-```
-
-## License
-
-MIT
+Metadata-Version: 2.4
+Name: form4api
+Version: 0.3.0
+Summary: Python client for the Form4API — real-time SEC Form 4 insider trading data
+License-Expression: MIT
+Project-URL: Homepage, https://form4api.com
+Project-URL: Documentation, https://form4api.com/docs
+Project-URL: Repository, https://github.com/theodor90/form4api-py.git
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.27
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: pytest-httpx>=0.30; extra == "dev"
+Requires-Dist: respx>=0.21; extra == "dev"
+Dynamic: license-file
+
+# form4api
+
+Python client for [Form4API](https://form4api.com) — real-time SEC Form 4 insider trading data.
+
+Supports Python 3.11+. Uses `httpx` for both sync and async HTTP.
+
+## Installation
+
+```bash
+pip install form4api
+```
+
+## Sync quickstart
+
+```python
+from form4api import Form4ApiClient
+
+client = Form4ApiClient("YOUR_API_KEY")
+
+# Recent open-market purchases at Apple
+txns = client.transactions.list(ticker="AAPL", code="P", per_page=5)
+for t in txns:
+    print(t.insider_name, t.shares_amount, "@", t.price_per_share)
+
+# Company overview
+company = client.companies.get("MSFT")
+print(company.name, company.active_insiders, "active insiders")
+
+# Insider detail
+insider = client.insiders.get("0001234567")
+print(insider.name, insider.officer_title)
+
+# Cluster-buy signals (Business plan)
+signals = client.signals.list(ticker="NVDA")
+for sig in signals:
+    if sig.is_cluster_buy:
+        print(sig.company_name, sig.insider_count, "buyers")
+```
+
+## Async quickstart
+
+```python
+import asyncio
+from form4api import AsyncForm4ApiClient
+
+async def main():
+    async with AsyncForm4ApiClient("YOUR_API_KEY") as client:
+        txns = await client.transactions.list(ticker="AAPL", per_page=5)
+        for t in txns:
+            print(t.insider_name, t.shares_amount, "@", t.price_per_share)
+
+asyncio.run(main())
+```
+
+## Resources
+
+| Resource | Methods |
+|---|---|
+| `client.transactions` | `.list(**params)`, `.paginate(**params)` |
+| `client.insiders` | `.search(name, **params)`, `.get(cik)`, `.transactions(cik, **params)` |
+| `client.companies` | `.get(ticker)`, `.insiders(ticker)` |
+| `client.signals` | `.list(**params)` — Business plan |
+| `client.webhooks` | `.create(url, event_types)`, `.list()`, `.delete(id)`, `.events(**params)` |
+
+## Error handling
+
+```python
+from form4api import Form4ApiClient, AuthError, PlanError, RateLimitError, NotFoundError
+
+client = Form4ApiClient("YOUR_API_KEY")
+
+try:
+    signals = client.signals.list()
+except PlanError as e:
+    print(f"Upgrade to {e.required_plan}")
+except RateLimitError as e:
+    print(f"Retry after {e.retry_after}s")
+except AuthError:
+    print("Invalid API key")
+except NotFoundError:
+    print("Resource not found")
+```
+
+## License
+
+MIT

{form4api-0.1.0 → form4api-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "form4api"
-version = "0.1.0"
+version = "0.3.0"
 description = "Python client for the Form4API — real-time SEC Form 4 insider trading data"
 requires-python = ">=3.11"
 dependencies = ["httpx>=0.27"]

{form4api-0.1.0 → form4api-0.3.0}/setup.cfg

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

{form4api-0.1.0 → form4api-0.3.0}/tests/test_client.py

@@ -23,11 +23,18 @@ TX = {
     "companyName": "Apple Inc.",
     "insiderName": "Cook Timothy D",
     "insiderCik": "0001214156",
+    "insiderTitle": "Chief Executive Officer",
+    "isDirector": False,
+    "isOfficer": True,
+    "is10PctOwner": False,
     "accessionNumber": "0001234567-26-000001",
     "securityTitle": "Common Stock",
     "transactionCode": "P",
+    "isOpenMarket": True,
+    "is10b5Plan": False,
     "sharesAmount": 1000.0,
     "pricePerShare": 212.45,
+    "totalValue": 212450.0,
     "sharesOwnedAfter": 5000.0,
     "directIndirect": "D",
     "isDerivative": False,
@@ -110,6 +117,18 @@ def test_transactions_paginate_stops_on_short_page(client):
 
 # ── insiders ──────────────────────────────────────────────────────────────────
 
+@respx.mock
+def test_insiders_search_returns_list(client):
+    route = respx.get(f"{BASE}/v1/insiders").mock(return_value=httpx.Response(200, json=[INSIDER]))
+    results = client.insiders.search("Cook")
+    assert route.called
+    qs = dict(route.calls[0].request.url.params)
+    assert qs["name"] == "Cook"
+    assert len(results) == 1
+    assert isinstance(results[0], Insider)
+    assert results[0].name == "Cook Timothy D"
+
+
 @respx.mock
 def test_insiders_get_returns_typed_object(client):
     respx.get(f"{BASE}/v1/insiders/0001214156").mock(return_value=httpx.Response(200, json=INSIDER))

form4api-0.1.0/form4api/resources/_signals.py

@@ -1,29 +0,0 @@
-from __future__ import annotations
-
-from typing import TYPE_CHECKING
-
-from form4api._types import InsiderSignal
-
-if TYPE_CHECKING:
-    from form4api._client import Form4ApiClient
-
-
-class SignalsResource:
-    def __init__(self, client: Form4ApiClient) -> None:
-        self._client = client
-
-    def list(
-        self,
-        *,
-        ticker: str | None = None,
-        page: int = 1,
-        per_page: int = 100,
-    ) -> list[InsiderSignal]:
-        params: dict[str, str] = {"page": str(page), "per_page": str(per_page)}
-        if ticker is not None:
-            params["ticker"] = ticker
-        data = self._client._get("/v1/signals", params)
-        return [InsiderSignal(**item) for item in data]
-
-
-