insider-trades-api 0.1.0__tar.gz

insider_trades_api-0.1.0/.gitignore

@@ -0,0 +1,12 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.venv/
+venv/
+.env
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/

insider_trades_api-0.1.0/LICENSE

@@ -0,0 +1,180 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submitted" means any form of electronic, verbal,
+      or written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of discussing and
+      improving the Work, but excluding communication that is conspicuously
+      marked or designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and incorporated
+      within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by the combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a cross-claim
+      or counterclaim in a lawsuit) alleging that the Work or any
+      Contribution embodied within the Work constitutes direct or
+      contributory patent infringement, then any patent licenses granted to
+      You under this License for that Work shall terminate as of the date
+      such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, in
+          at least one of the following places: within a NOTICE text
+          file distributed as part of the Derivative Works; within
+          the Source form or documentation, if provided along with the
+          Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices
+          normally appear. The contents of the NOTICE file are for
+          informational purposes only and do not modify the License.
+          You may add Your own attribution notices within Derivative
+          Works that You distribute, alongside or as an addendum to
+          the NOTICE text from the Work, provided that such additional
+          attribution notices cannot be construed as modifying the License.
+
+      You may add Your own license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the
+      Derivative Works, and to permit persons to whom the Derivative
+      Works is furnished to do so, subject to the following conditions:
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or reproducing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may offer only
+      conditions consistent with this License.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 GoodTech LLC
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

insider_trades_api-0.1.0/PKG-INFO

@@ -0,0 +1,319 @@
+Metadata-Version: 2.4
+Name: insider-trades-api
+Version: 0.1.0
+Summary: Official Python SDK for the Insider Trades API — real-time SEC Form 3, 4, and 5 insider transaction data.
+Project-URL: Homepage, https://insidertrades.us
+Project-URL: Documentation, https://insidertrades.us/docs
+Project-URL: Pricing, https://insidertrades.us/pricing
+Author-email: GoodTech LLC <dev@goodtechllc.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: api-client,edgar,financial-data,fintech,form-3,form-4,form-5,insider-trading,insider-transactions,quantitative-finance,sec
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# Insider Trades API — Python SDK
+
+Official Python SDK for the [Insider Trades API](https://insidertrades.us) — real-time SEC Form 3, 4, and 5 insider transaction data.
+
+## Installation
+
+```bash
+pip install insider-trades-api
+```
+
+Requires Python 3.8+. No runtime dependencies.
+
+## Quick Start
+
+```python
+import os
+from insider_trades_api import InsiderTradesAPI
+
+client = InsiderTradesAPI(api_key=os.environ["INSIDER_TRADES_API_KEY"])
+
+# Get recent insider purchases for Apple
+result = client.get_insider_transactions(
+    issuer_ticker="AAPL",
+    transaction_types="purchase",
+    limit=10,
+)
+
+for tx in result["insiderTransactions"]:
+    owner = tx.get("reportingOwnerInformation", {})
+    print(owner.get("name"), tx.get("purchaseAmount"))
+```
+
+If you omit `api_key`, the client reads `INSIDER_TRADES_API_KEY` from the environment.
+
+Get your API key at [insidertrades.us](https://insidertrades.us).
+
+---
+
+## API Reference
+
+For the full reference including all parameters, response schemas, and plan limits, see [insidertrades.us/docs](https://insidertrades.us/docs).
+
+### `InsiderTradesAPI(api_key=None, *, timeout=30.0)`
+
+| Argument | Type | Required | Description |
+|---|---|---|---|
+| `api_key` | `str` | Yes | Your API key. Falls back to `INSIDER_TRADES_API_KEY` env var |
+| `timeout` | `float` | No | Per-request socket timeout in seconds (default `30.0`) |
+
+---
+
+### `get_insider_transactions(**params)`
+
+Retrieve SEC insider transactions from Form 3, 4, and 5 filings. All arguments are keyword-only. Returns the decoded JSON response as a `dict` with `insiderTransactions`, `count`, and `recordedTimeInUtc`.
+
+```python
+result = client.get_insider_transactions(
+    issuer_ticker="AAPL",
+    transaction_types=["purchase", "sale"],
+    filing_date_in_est_start_date="2026-01-01",
+    filing_date_in_est_end_date="2026-01-31",
+    limit=50,
+)
+print(result["count"], len(result["insiderTransactions"]))
+```
+
+| Parameter | Type | Description |
+|---|---|---|
+| `filing_id` | `str` | Direct lookup by filing ID |
+| `issuer_ticker` | `str` | Filter by ticker symbol, e.g. `"AAPL"` |
+| `issuer_cik` | `str` | Filter by issuer CIK |
+| `reporting_owner_cik` | `str` | Filter by insider CIK |
+| `accession_number` | `str` | Filter by SEC accession number |
+| `form_types` | `str \| Sequence[str]` | Form types: `"3"`, `"4"`, `"5"` (default: all) |
+| `transaction_types` | `str \| Sequence[str]` | See transaction types below |
+| `owner_roles` | `str \| Sequence[str]` | `"director"`, `"officer"`, `"tenPercentOwner"` |
+| `officer_titles` | `str \| Sequence[str]` | Normalized titles: `"CEO"`, `"CFO"`, `"COO"`, etc. |
+| `filing_date_in_est_start_date` | `str` | Filing date start `YYYY-MM-DD` (Eastern Time) |
+| `filing_date_in_est_end_date` | `str` | Filing date end `YYYY-MM-DD` (Eastern Time) |
+| `period_of_report_start_date` | `str` | Period of report start `YYYY-MM-DD` |
+| `period_of_report_end_date` | `str` | Period of report end `YYYY-MM-DD` |
+| `min_total_amount` | `float` | Minimum total dollar value |
+| `max_total_amount` | `float` | Maximum total dollar value |
+| `fieldset` | `"minimal" \| "standard" \| "full"` | Control response size (see below) |
+| `limit` | `int` | Max results, default `100`, max `900` |
+
+#### Transaction types
+
+| Value | SEC Code | Description |
+|-------|----------|-------------|
+| `"purchase"` | P | Open market purchase |
+| `"sale"` | S | Open market sale |
+| `"grant"` | A | Grant or award |
+| `"gift"` | G | Bona fide gift |
+| `"exercise"` | M | Option exercise (Rule 16b-3) |
+| `"derivativeExercise"` | O, X | Derivative exercise |
+| `"disposition"` | D | Disposition to issuer |
+| `"discretionary"` | I | Discretionary transaction |
+| `"derivativeConversion"` | C | Conversion of derivative |
+| `"derivativeExpiration"` | E, H | Expiration of derivative |
+| `"smallAcquisition"` | L | Small acquisition (Rule 16a-6) |
+| `"inheritance"` | W | Inheritance |
+| `"equitySwap"` | K | Equity swap |
+| `"tender"` | U | Tender offer / change of control |
+| `"other"` | J | Other acquisition / disposition |
+
+#### Fieldsets
+
+| Fieldset | Fields included |
+|---|---|
+| `"minimal"` | ID, issuer, owner, key amounts, dates |
+| `"standard"` | All of minimal + all aggregates, boolean flags, links, AI summary |
+| `"full"` | All of standard + raw transaction arrays (`nonDerivativeTransactions`, `derivativeTransactions`, holdings) |
+
+Default (no `fieldset`): all stored fields are returned. `minimal` and `standard` produce significantly smaller payloads — recommended for bulk queries.
+
+**Sample response:**
+
+```json
+{
+  "insiderTransactions": [
+    {
+      "id": "97e823b724619e921c68ba73b2f95f3b015fb83cc05666320b6ddf34b97cdcbe",
+      "formType": "4",
+      "accessionNumber": "0001140361-26-023363",
+      "issuerCik": "320193",
+      "issuerInformation": {
+        "cik": "0000320193",
+        "tradingSymbol": "AAPL",
+        "companyName": "Apple Inc."
+      },
+      "reportingOwnerCik": "1214128",
+      "reportingOwnerInformation": {
+        "cik": "0001214128",
+        "name": "LEVINSON ARTHUR D",
+        "city": "CUPERTINO",
+        "state": "CA",
+        "isDirector": true,
+        "isOfficer": false
+      },
+      "ownerRoles": "director",
+      "filingDateInEst": "2026-05-29",
+      "periodOfReport": "2026-05-27",
+      "totalAmount": 15551000.0,
+      "saleAmount": 15551000.0,
+      "saleCount": 1,
+      "netSharesAcquired": -50000.0,
+      "netTradingAmount": -15551000.0,
+      "hasSales": "true",
+      "hasLateTransactions": false,
+      "aff10b5One": false,
+      "summary": "Arthur D. Levinson sold 50,000 shares of Apple Inc. common stock at $311.02 per share on May 27, 2026.",
+      "linkToFilingDetail": "https://www.sec.gov/Archives/edgar/data/1214128/000114036126023363/0001140361-26-023363-index.htm"
+    }
+  ],
+  "count": 1,
+  "recordedTimeInUtc": "2026-05-29T22:30:00Z"
+}
+```
+
+---
+
+## Usage examples
+
+### Recent Form 4 purchases by date range
+
+```python
+result = client.get_insider_transactions(
+    transaction_types="purchase",
+    form_types="4",
+    filing_date_in_est_start_date="2026-05-01",
+    filing_date_in_est_end_date="2026-05-31",
+    limit=50,
+)
+```
+
+### High-value transactions over $1M
+
+```python
+result = client.get_insider_transactions(
+    min_total_amount=1_000_000,
+    transaction_types="purchase",
+    filing_date_in_est_start_date="2026-05-01",
+    filing_date_in_est_end_date="2026-05-31",
+    limit=25,
+)
+```
+
+### All transactions by a specific insider
+
+```python
+result = client.get_insider_transactions(reporting_owner_cik="1214128", limit=20)
+```
+
+### CEO transactions across all companies
+
+```python
+result = client.get_insider_transactions(
+    officer_titles=["CEO"],
+    form_types="4",
+    filing_date_in_est_start_date="2026-05-01",
+    filing_date_in_est_end_date="2026-05-31",
+    limit=20,
+)
+```
+
+### Look up a specific filing
+
+```python
+result = client.get_insider_transactions(accession_number="0001140361-26-023363")
+```
+
+---
+
+## Typing
+
+The package ships with type hints (`py.typed`). Responses are plain `dict`s; `TypedDict` definitions describe their shape for editors and type checkers.
+
+```python
+from insider_trades_api import (
+    InsiderTransaction,
+    InsiderTransactionsResponse,
+    IssuerInformation,
+    ReportingOwnerInformation,
+    NonDerivativeTransaction,
+    DerivativeTransaction,
+    NonDerivativeHolding,
+    DerivativeHolding,
+    Footnote,
+    OwnerSignature,
+)
+```
+
+> **Note:** the `has*` flags (`hasPurchases`, `hasSales`, …) are returned as the string `"true"`, not a Python `bool`. Use truthiness checks (`if tx.get("hasPurchases"):`) rather than `== True`.
+
+---
+
+## Error handling
+
+Client-side validation failures raise `ValueError` before any network call. Non-success HTTP responses raise `InsiderTradesAPIError`, which carries the HTTP `status`.
+
+```python
+from insider_trades_api import InsiderTradesAPI, InsiderTradesAPIError
+
+try:
+    result = client.get_insider_transactions(issuer_ticker="AAPL")
+except InsiderTradesAPIError as err:
+    print(err.status, err)  # e.g. 403 "InsiderTrades API error 403: Forbidden"
+```
+
+| Status | Meaning |
+|---|---|
+| 400 | Invalid parameters (bad date format, invalid CIK, inverted date range) |
+| 403 | Invalid or missing API key, or requested date range exceeds plan limit |
+| 429 | Rate limit exceeded — retried automatically up to 3 times with backoff |
+| 504 | Request timed out — retried automatically up to 3 times |
+| 500 | Server error |
+
+The SDK validates date format (`YYYY-MM-DD`), numeric CIK, and date range order before making any network request, so many errors are caught immediately without a round trip.
+
+---
+
+## Changelog
+
+### [0.1.0] - 2026-06-05
+
+- Initial release: `get_insider_transactions()` with full query parameter support
+- Filters: issuer_ticker, issuer_cik, reporting_owner_cik, transaction_types, owner_roles, officer_titles, date ranges, min_total_amount, max_total_amount, fieldset
+- Retry logic for 429 and 504 with backoff
+- Client-side input validation for date format, CIK format, and date range order
+- Full type hints (`py.typed`) including transaction arrays, holdings, and boolean flags
+- Zero runtime dependencies (stdlib only)
+
+---
+
+## Resources
+
+- Docs: [insidertrades.us/docs](https://insidertrades.us/docs)
+- Pricing: [insidertrades.us/pricing](https://insidertrades.us/pricing)
+- Dashboard: [insidertrades.us/dashboard](https://insidertrades.us/dashboard)
+- Support: [insidertrades.us](https://insidertrades.us)
+
+---
+
+## Legal disclaimer
+
+The data provided through this SDK is for **informational purposes only** and does not constitute investment advice, financial advice, trading advice, or any other type of advice. GoodTech LLC makes no representations as to the accuracy, completeness, or timeliness of the data. You are solely responsible for your use of the data. Past filings and transactions do not predict future performance. Always consult a qualified financial professional before making investment decisions.
+
+---
+
+Licensed under the [Apache 2.0 License](./LICENSE). Copyright 2026 GoodTech LLC.