Skip to main content

Heimdall Federal Intelligence Platform — command-line client

Project description

heimdallgov

Heimdall is a federal oversight data platform, delivered through a CLI and an MCP server. This package (heimdallgov on PyPI, installs the heimdall command) is the CLI client — it talks to the Heimdall API (https://api.heimdallgov.com) to search oversight findings, look up contractor profiles, and pull compliance intel.

Install

pip install heimdallgov

Requires Python 3.10 or newer.

Authenticate

Get an API key by signing up at https://heimdallgov.com. Then either export it as an environment variable:

export HEIMDALL_API_KEY=hml_sk_...

…or save it with the CLI (stored at your user-config dir, e.g. ~/.config/heimdall/config on Linux, %APPDATA%\heimdall\config on Windows):

heimdall auth login hml_sk_...
heimdall auth whoami

Example commands

Search oversight findings

heimdall findings search cybersecurity --limit 10

Returns recent GAO / Inspector General / FAC findings that mention the keyword, with agency, severity, source, and report number.

Look up a contractor

# Search contractors_master by name
heimdall risk search "Booz Allen"

# Fetch a full profile by UEI
heimdall risk ABCDEF123456

Compliance profile

# Full compliance overview for a UEI
heimdall compliance profile ABCDEF123456

# Federal Audit Clearinghouse timeline
heimdall compliance fac ABCDEF123456 --limit 20

# Program / CFDA exposure
heimdall compliance programs ABCDEF123456

# Latest federal grant opportunities
heimdall compliance opportunities --limit 50

Check subscription / usage

heimdall auth whoami           # tier, status

Output formats

Every command renders a rich terminal table by default. Pipe through jq or use the --format json flag on most commands to get machine-readable output.

Environment variables

Variable Purpose Default
HEIMDALL_API_KEY Bearer token used for every request (none — required)
HEIMDALL_API_URL Override the API base (mostly for local dev / QA) https://api.heimdallgov.com

Full docs

https://heimdallgov.com/docs

License

MIT. Copyright 2026 Heimdall Analytics Corporation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

heimdallgov-0.1.1.tar.gz (11.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

heimdallgov-0.1.1-py3-none-any.whl (15.7 kB view details)

Uploaded Python 3

File details

Details for the file heimdallgov-0.1.1.tar.gz.

File metadata

  • Download URL: heimdallgov-0.1.1.tar.gz
  • Upload date:
  • Size: 11.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for heimdallgov-0.1.1.tar.gz
Algorithm Hash digest
SHA256 b13109eeaf35d795067fbe3cc5abb0c63ce165166ebe143fca815908cdced2ba
MD5 7e7298c1ab8b669cc42b7c326bedb9d1
BLAKE2b-256 7769fa8559d86d7280837b15825583f8c88b579406e3891e18a479de606a29fc

See more details on using hashes here.

File details

Details for the file heimdallgov-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: heimdallgov-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 15.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for heimdallgov-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5d942586cb7738166a8700d8a11c1084be6144c99534eb736a82b02016188543
MD5 d51d385ff3cffa749a16595572ad07aa
BLAKE2b-256 282d893ff35c1753515a2c7a7c69ea401543458a331d62e736adb2dfff7a4eb5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page