form4api 0.1.0__tar.gz → 0.2.0__tar.gz

{form4api-0.1.0 → form4api-0.2.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.2.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.2.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.2.0}/form4api/_types.py

@@ -83,6 +83,6 @@ class WebhookEvent:
     last_status_code: int | None
     is_dead: bool
     payload: str
-
-
-
+
+
+

{form4api-0.1.0 → form4api-0.2.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.2.0}/form4api/resources/__init__.py

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

{form4api-0.1.0 → form4api-0.2.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.1.0 → form4api-0.2.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.2.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.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "form4api"
-version = "0.1.0"
+version = "0.2.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.2.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.2.0}/tests/test_client.py

@@ -110,6 +110,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))