Skip to main content

openfolio (Python SDK)

Thin, zero-dependency client for the OpenFolio public-query API — clean public government data (134 datasets / 49M records), entity- and parcel-keyed.

Install (from repo, until the PyPI release)

pip install "git+https://github.com/dodenbach/blueoceanleads.git#subdirectory=public-query/sdk/python"
# or from a checkout:
pip install -e public-query/sdk/python

First call

import openfolio
c = openfolio.Client(api_key="pq_...")        # or export OPENFOLIO_API_KEY=pq_...

c.search("BROOKLYN BREWERY", limit=5)          # 2 credits
c.parcel("4098390003")                         # 1 credit — owner + permits + evictions + ...
c.entity("REPUBLIC SERVICES OF FLORIDA")       # 2 credits — cross-source dossier
c.owns("EIN:123456789")                        # 3 credits — ownership portfolio
c.context(zip="11432")                         # 1 credit — ACS/FEMA/BLS/NOAA/EIA stack
c.datasets(); c.freshness(); c.account()       # free

c.last_credits                                 # {'charged': 2, 'remaining': 498}
for r in c.iter_search("liquor license", page_size=100, max_records=300):
    ...                                        # paged (each page = one metered call)

No key yet? POST /signup {"email": "..."} on the API returns a key + 500 free credits.

CLI

export OPENFOLIO_API_KEY=pq_...
openfolio search "BROOKLYN BREWERY" --limit 5
openfolio parcel 4098390003
openfolio entity "REPUBLIC SERVICES OF FLORIDA"
openfolio context --zip 11432
openfolio balance

Metadata

Release files for openfolio 0.1.0

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

Source distribution (sdist)

Source distribution for openfolio 0.1.0
File Size Uploaded Provenance Actions
openfolio-0.1.0.tar.gz 5.1 kB Without provenance Details for openfolio-0.1.0.tar.gz

Built distribution (wheel)

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

Total release size: 11.1 kB

Release files / openfolio-0.1.0.tar.gz

Download URL openfolio-0.1.0.tar.gz
Size 5.1 kB
Tags Source
SHA-256 checksum
How to use checksums
d1695323fafbf6b1b26115b41ee4781c21d0f91bb9dbfc2b826980a9ffa98b33
BLAKE2b-256 checksum
How to use checksums
91cebeeaf766f32050d9d8dab70d3494ba3650b862624962c3615735dae11ed6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.2

Release files / openfolio-0.1.0-py3-none-any.whl

Download URL openfolio-0.1.0-py3-none-any.whl
Size 6.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cbdbd8a0ac5048d6e427a795e52d0c898b782513fd435331304b0ed38a60b06e
BLAKE2b-256 checksum
How to use checksums
e1cb4d353f18a1adb1c8198cf1e026180f20f8bc3bd5ff5321d8965ccb3beedd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.2

Security for openfolio 0.1.0

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

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.0 This release

2 release files No 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