form4api 0.2.0__tar.gz → 0.3.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: form4api
-Version: 0.2.0
+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

{form4api-0.2.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
@@ -83,6 +90,6 @@ class WebhookEvent:
     last_status_code: int | None
     is_dead: bool
     payload: str
-
-
-
+
+
+

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.2.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.2.0 → form4api-0.3.0}/form4api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: form4api
-Version: 0.2.0
+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

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

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "form4api"
-version = "0.2.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.2.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,

form4api-0.2.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]
-
-
-