arche-sdk 0.1.0__tar.gz

arche_sdk-0.1.0/.gitignore

@@ -0,0 +1,147 @@
+# ============================================================================
+# Arche API - .gitignore
+# Disciplined, minimal, and security-safe.
+# ============================================================================
+
+# --- Claude Code ---
+# Local settings and worktrees stay private; shared project skills, settings
+# and hooks are tracked. settings.local.json stays ignored.
+.claude/*
+!.claude/skills/
+!.claude/settings.json
+!.claude/hooks/
+
+# --- Python bytecode / caches ---
+__pycache__/
+*.py[cod]
+*.pyd
+
+# --- Virtual environments ---
+.venv/
+venv/
+ENV/
+
+# --- Test / type / lint caches ---
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+htmlcov/
+.coverage
+coverage.xml
+coverage.json
+
+# --- Environment / secrets files ---
+.env
+.env.*
+!.env.example
+!.env.development.sample
+!.env.production.sample
+!.env.ci.sample
+.envrc
+
+# --- Logs & archives ---
+*.log
+*.zip
+# The webhook probe receiver deploys from its committed package.
+!infra/production/webhook_probe_receiver/handler.zip
+
+# --- OS / editor junk ---
+.DS_Store
+.idea/
+.vscode/
+inspectionProfile.xml
+
+# --- Node / frontend ---
+node_modules/
+dist/
+
+# --- Build artifacts ---
+build/
+*.so
+
+# --- Packaging metadata (setuptools) ---
+*.egg-info
+*.egg-info/
+
+
+# --- Native build artifacts (project-specific) ---
+native/build/
+native/__pycache__/
+native/*.so
+native/*.pyd
+native/*.dll
+native/*.dylib
+native/*.egg-info/
+native/compile_commands.json
+
+# --- Project-specific generated artifacts ---
+artifacts/
+.tmp/
+tmp_*
+*.local.csv
+*.local.json
+*.local.jsonl
+audit_report.json
+docs/project_structure.txt
+
+# --- Repo-private / tooling docs (do not publish) ---
+AGENTS.md
+
+# ---------------------------------------------------------------------------
+# AI / Codex / LLM tooling artifacts (NEVER COMMIT)
+# ---------------------------------------------------------------------------
+.codex/
+.codex-cache/
+.codex-output/
+.codex-tmp/
+.ai/
+.ai-cache/
+.ai-output/
+.llm/
+.llm-cache/
+.copilot/
+.cursor/
+.cursor-cache/
+.cursor-tmp/
+
+scratch/
+scratchpad/
+tmp-ai/
+tmp-llm/
+
+*.prompt.md
+*.prompt.txt
+*.agent.md
+*.agent.log
+*.llm.log
+*.llm.json
+
+# ---------------------------------------------------------------------------
+# Terraform (NEVER COMMIT: state, plans, secrets, provider dirs)
+# ---------------------------------------------------------------------------
+**/.terraform/
+*.tfstate
+*.tfstate.*
+*.tfplan
+tfplan
+crash.log
+crash.*.log
+**/*.tfvars
+**/*.tfvars.json
+.terraform.lock.hcl.bak
+**/.terraform.lock.hcl.bak
+
+# ---------------------------------------------------------------------------
+# VPN / key material (NEVER COMMIT)
+# ---------------------------------------------------------------------------
+**/*.ovpn
+**/*.pem
+**/*.key
+**/*.p12
+**/*.pfx
+
+# The OpenAPI snapshot test writes its normalized comparison here on a
+# mismatch. Refreshing the snapshot leaves them behind, where `git add -A`
+# sweeps them into the next commit.
+tests/openapi/debug/
+.aider*

arche_sdk-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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, whether in Source or
+      Object form, 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 any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to 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 otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently 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 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 a Contribution incorporated 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, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, 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 copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   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 redistributing 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 consequential 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 any and 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 act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

arche_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,280 @@
+Metadata-Version: 2.5
+Name: arche-sdk
+Version: 0.1.0
+Summary: Official Python SDK for Arche public data APIs
+Project-URL: Homepage, https://arche.fi
+Project-URL: Documentation, https://docs.arche.fi/sdks/python
+Project-URL: Repository, https://github.com/ProtosSystems/arche-api
+Project-URL: Issues, https://github.com/ProtosSystems/arche-api/issues
+Author: Arche
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: api,arche,edgar,finance,sdk
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: pydantic<3,>=2.7
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Arche Python SDK
+
+Typed, production-grade Python SDK for Arche public data APIs.
+
+This initial release covers the primary public data surface:
+- Companies
+- Filings
+- Statements
+- Narratives
+- Bulk export (Scale and Enterprise plans)
+
+It does not include protected control-plane, billing, org/team/project/environment admin, usage, webhook, MCP, or internal ops routes.
+
+## Installation
+
+```bash
+pip install arche-sdk
+```
+
+For local monorepo usage:
+
+```bash
+pip install -e sdks/python
+```
+
+## Authentication
+
+### API key
+
+```python
+from arche_sdk import ArcheClient
+
+client = ArcheClient(api_key="your_api_key")
+```
+
+### Bearer token for protected portal/control-plane routes
+
+```python
+from arche_sdk import ArcheClient
+
+client = ArcheClient(bearer_token="your_jwt_or_token")
+```
+
+Use bearer auth only for protected portal/control-plane or internal routes that
+explicitly require it. Public runtime API examples and quickstarts should use
+`api_key`.
+
+`api_key` and `bearer_token` are mutually exclusive; passing both raises
+`ValueError`.
+
+## Quickstart
+
+### Companies
+
+```python
+from arche_sdk import ArcheClient
+
+with ArcheClient(api_key="...") as client:
+    company = client.companies.get("0000320193")
+    resolved = client.companies.resolve("AAPL")
+    completeness = client.companies.get_completeness("0000320193")
+```
+
+### Naming a company
+
+Every method that takes a `cik` also accepts a ticker symbol in its place, and a
+`ciks` list accepts tickers. Digits are sent as a CIK and anything else as a
+ticker, which the API resolves to the company whose filings hold its statements
+on the request's date; one list must hold CIKs only or tickers only. A
+`company_id` (narratives) takes the company UUID, the CIK or the ticker.
+
+```python
+with ArcheClient(api_key="...") as client:
+    versions = client.statements.list("AAPL", statement_type="INCOME_STATEMENT")
+    derived = client.statements.get_derived_metrics_time_series(
+        ciks=["AAPL", "MSFT"],
+        statement_type="INCOME_STATEMENT",
+        metrics=["GROSS_MARGIN"],
+        frequency="annual",
+    )
+```
+
+### Filings
+
+```python
+with ArcheClient(api_key="...") as client:
+    page = client.filings.list("0000320193", filing_types=["10-K"], page=1, page_size=20)
+    filing = client.filings.get("0000320193", "0000320193-24-000001")
+    statements = client.filings.list_statements("0000320193", "0000320193-24-000001")
+```
+
+### Statements
+
+```python
+with ArcheClient(api_key="...") as client:
+    versions = client.statements.list("0000320193", statement_type="INCOME_STATEMENT")
+    timeline = client.statements.get_restatement_timeline(
+        "0000320193", "INCOME_STATEMENT", 2024, "FY"
+    )
+    derived = client.statements.get_derived_metrics_time_series(
+        ciks=["0000320193"],
+        statement_type="INCOME_STATEMENT",
+        metrics=["GROSS_MARGIN"],
+        frequency="annual",
+    )
+
+    # As known at a date, only the statements asked for: here the FY2024
+    # income statement. snapshot_hash still names the full as-of selection.
+    as_of = client.statements.get_as_of_financials_page(
+        "2025-03-31",
+        "AAPL",
+        limit=10,
+        statement_type="INCOME_STATEMENT",
+        fiscal_year_from=2024,
+        fiscal_year_to=2024,
+        fiscal_period="FY",
+    )
+```
+
+### Narratives
+
+```python
+with ArcheClient(api_key="...") as client:
+    narratives = client.narratives.list(
+        "11111111-1111-1111-1111-111111111111",
+        as_of="2024-12-31",
+        narrative_type="CHANGE_SUMMARY",
+    )
+```
+
+### Bulk export
+
+Scale and Enterprise plans can take a complete local copy of the served corpus
+as Parquet files instead of paging the API. `sync()` fetches only what changed:
+
+```python
+with ArcheClient(api_key="...") as client:
+    result = client.bulk.sync("./arche-corpus")
+
+    print(result.snapshot_id, len(result.downloaded), "downloaded")
+    print(len(result.skipped), "already held")
+```
+
+Download URLs are issued under the bulk-data license, which the organization
+accepts once per license version. Until it has, `sync()` raises
+`BulkLicenseNotAcceptedError`. Read the license and accept it from the SDK; the
+person named confirms they may bind the organization:
+
+```python
+with ArcheClient(api_key="...") as client:
+    current = client.bulk.license()
+    print(current.license_version, current.accepted)
+    if not current.accepted:
+        print(current.text)
+        client.bulk.accept_license(name="Jane Doe", email="jane@example.com")
+```
+
+`accept_license()` accepts the version and SHA-256 that `license()` returns, so
+the acceptance is of the text served at that moment. Accepting a version the
+organization already accepted returns the existing record unchanged.
+
+Run it again tomorrow against the same directory and it transfers only the
+partitions whose bytes moved. A file is skipped when the local copy already
+hashes to the `sha256` the snapshot's manifest records, so the skip is a
+statement about the bytes on disk rather than about a timestamp, and an
+interrupted sync resumes correctly. Digests are remembered in
+`<destination>/.arche-bulk-sync.json` so a second sync does not reread
+gigabytes to prove nothing changed; a file whose size or modification time
+differs from the record is rehashed rather than trusted, and `rehash=True`
+ignores the record entirely.
+
+Restrict the sync, or watch it:
+
+```python
+def show(event):
+    print(f"[{event.index}/{event.total}] {event.action} {event.path}")
+
+with ArcheClient(api_key="...") as client:
+    client.bulk.sync("./arche-corpus", datasets=["statements", "financials"], progress=show)
+```
+
+Read the contract, browse snapshots, or fetch one file:
+
+```python
+with ArcheClient(api_key="...") as client:
+    for dataset in client.bulk.datasets():
+        print(dataset.dataset, dataset.partition_column, [c.name for c in dataset.columns])
+
+    manifest = client.bulk.snapshot()          # "latest" by default
+    print(manifest.snapshot_id, manifest.read_at, manifest.bytes)
+
+    changed = [item.path for item in manifest.files if item.changed]
+    client.bulk.download_file(manifest.snapshot_id, changed[0], "./arche-corpus")
+```
+
+Every download is verified against the manifest's checksum and raises
+`ChecksumMismatchError` on a mismatch, removing the partial file. A manifest
+path that would write outside the destination is refused rather than resolved. The URLs are
+presigned and carry their own credentials: the SDK fetches them without an API
+key, and each one is charged its file's full size against the organization's
+daily download allowance when it is issued, not when the bytes move. Past the
+allowance the API answers `RateLimitError` with code
+`BULK_DOWNLOAD_BUDGET_EXCEEDED`.
+
+Read the files with any Parquet reader. Partition directories are named
+`fiscal_year_2025`, not Hive's `fiscal_year=2025`, because the files already
+carry the partition as a column:
+
+```python
+import duckdb
+
+duckdb.sql("SELECT * FROM './arche-corpus/financials/*/*.parquet' LIMIT 5").show()
+```
+
+## Pagination
+
+List endpoints return `Page[T]` with `page`, `page_size`, `total`, and `items`.
+
+```python
+with ArcheClient(api_key="...") as client:
+    first_page = client.filings.list("0000320193", page=1, page_size=50)
+    if first_page.has_next:
+        second_page = client.filings.list("0000320193", page=2, page_size=50)
+
+    for filing in client.filings.iter_all("0000320193", page_size=100):
+        print(filing.accession_id)
+```
+
+## Error handling
+
+```python
+from arche_sdk import ArcheClient
+from arche_sdk.errors import APIError, RateLimitError
+
+try:
+    with ArcheClient(api_key="...") as client:
+        client.companies.get("0000000000")
+except RateLimitError as exc:
+    print(exc.retry_after, exc.rate_limit_remaining)
+except APIError as exc:
+    print(exc.status_code, exc.code, exc.message, exc.trace_id, exc.request_id)
+```
+
+## Request ID and trace ID
+
+- The SDK sends `X-Request-ID` on every request (auto-generated when missing).
+- On API errors, the SDK exposes:
+  - `request_id` from response `X-Request-ID`
+  - `trace_id` from canonical error envelope (`error.trace_id`)
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE).