Metadata-Version: 2.4
Name: filingsift
Version: 0.1.0
Summary: Dependency-free client for the FilingSift REST API v1
Author: FilingSift
License-Expression: Apache-2.0
Project-URL: Homepage, https://filingsift.com/
Project-URL: Documentation, https://filingsift.com/api/
Project-URL: API Reference, https://filingsift.com/openapi.yaml
Project-URL: Source, https://github.com/JasinHurst/FilingSift
Project-URL: Issues, https://github.com/JasinHurst/FilingSift/issues
Keywords: SEC,EDGAR,filings,finance,API
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Office/Business :: Financial
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Dynamic: license-file

# FilingSift Python SDK

This is the official dependency-free Python client for FilingSift REST schema
1.0.0. Install the current release from PyPI:

```bash
python3 -m pip install filingsift==0.1.0
```

```python
from filingsift import FilingSiftClient

client = FilingSiftClient()
company = client.get_company("AAPL")
print(company["data"]["events"])
```

Pass `api_key=` for account routes. Keep the key in a server-side secret and
never commit it or use it in browser code. The client returns the REST response
unchanged so accession, filing URL, exact evidence, hashes, uncertainty, and
verification remain available. Missing and refused values remain missing; the
SDK never substitutes zero.

Supported helpers cover company lookup, structured filing-reader documents,
side-by-side passage comparison, binary evidence-report PDF export, filing
comparisons, full-text and within-filing search, financing screens, comparison matrices, deep financing intelligence, issuer timelines, quality candidates,
saved-search management, coverage and onboarding status, watchlist onboarding,
Monitoring v1, CSV export, merged analyst tables, deterministic source-linked Excel workbooks, and checksum manifests. Personal annotations, research folders, saved dashboard views, and memo drafts require a browser session and remain web workspace features. Use `request()` for any other documented v1 operation.


## License

The Python SDK source contained in this directory is licensed under the Apache
License 2.0. That SDK-specific license does not change the proprietary license
applying to the rest of the FilingSift repository, service, extraction engine,
data, or documentation.
