Skip to main content

balanceproof

Python client for BalanceProof: US public-company fundamentals from SEC EDGAR, where each balance sheet, income statement and cash flow is checked against its own totals when the filing reports the lines needed (otherwise it is marked not testable instead of passing), and a filing that does not add up is flagged with the reason instead of passed through.

pip install "balanceproof[pandas]"
import balanceproof as bp

client = bp.Client("YOUR_KEY")        # free key: https://balanceproof.dev/dashboard
                                      # or set BALANCEPROOF_API_KEY

client.balance_sheet("AAPL")
client.statements("AAPL", period="quarterly")

# The balance sheet's verdict, also returned as `check` inside balance_sheet().
v = client.check("CELH")
v["identity_status"]      # "balanced", "missing_tag", "broken", "not_testable", ...
v["reconciles"]           # True / False, or None when the filing cannot be tested
v["attribution"]          # "none", "filer", "extraction" (a line we did not read), "unknown"
if v["attribution"] == "extraction":
    ...                   # the filer's own totals agree: use the stated totals

# Point-in-time (Pro and above): only what had been filed by that date,
# so a backtest never sees a figure before it was public.
client.balance_sheet("AAPL", as_of="2025-03-01")

# A pandas panel, one row per company and period.
df = client.panel(["AAPL", "MSFT", "KO"], ["revenue", "net_income", "operating_cash_flow"],
                  period="quarterly")
clean = df[df.checks_failed.str.len() == 0]      # drop periods that failed a check

# Failed checks and restatements across every company (Pro: 90 days, Business: all).
feed = client.exceptions(type="restatement")
client.to_frame(feed)

Derived figures (Q4 as the year minus nine months, Q2/Q3 cash flow from year-to-date filings) are listed in each period's derived.

A call that needs a higher plan raises balanceproof.PlanRequired, whose required_plan names it.

Metadata

Release files for balanceproof 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for balanceproof 0.1.1
File Size Uploaded Provenance Actions
balanceproof-0.1.1.tar.gz 6.5 kB With provenance Details for balanceproof-0.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for balanceproof 0.1.1
File Interpreter ABI Platform Actions
balanceproof-0.1.1-py3-none-any.whl Python 3 none any Details for balanceproof-0.1.1-py3-none-any.whl

Total release size: 12.2 kB

Release files / balanceproof-0.1.1.tar.gz

Download URL balanceproof-0.1.1.tar.gz
Size 6.5 kB
Tags Source
SHA-256 checksum
How to use checksums
9efabf89dc4a0c8356e8f01ef985db4777d9ac342e85d1e97a88cbf6f29c3bd4
BLAKE2b-256 checksum
How to use checksums
b5cd1dab6c1028ecc799fd7c437ae04dcc83302d6e070a81c2c7b25f07d384d1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 29, 2026.

Transparency log

Release files / balanceproof-0.1.1-py3-none-any.whl

Download URL balanceproof-0.1.1-py3-none-any.whl
Size 5.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a29625b70eb0f8b77be13379bbf16b7f1f615313f59ecab4c7cbce2974e054a0
BLAKE2b-256 checksum
How to use checksums
e32f816e6fc31076d07132a000be66ae1918ea1d94cf8891b9227c8b6ef525e5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 29, 2026.

Transparency log

Security for balanceproof 0.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for balanceproof-0.1.1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 29, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page