Skip to main content

vbd-api

Official Python client for the Veteran Benefit Desk API: structured, source linked VA benefits data with permanent VBD IDs, provenance in every response, and honest review tiers.

You are only charged credits for successful responses. Errors and not found lookups are always free.

Install

pip install vbd-api

Quickstart

from vbd_api import VBD

client = VBD(api_key="vbd_sbx_...")  # free key at https://veteranbenefitdesk.com/developers/signup

# Diagnostic codes
ptsd = client.get_diagnostic_code("9411")
print(ptsd["data"]["title"])                 # PTSD
print(ptsd["vbd"]["id"])                     # VBD:DC:9411
print(ptsd["provenance"]["sources"])         # 38 CFR Part 4 ...
print(ptsd["citation_text"])                 # ready to paste attribution line

# Conditions
client.search_conditions(q="knee", limit=10)
client.get_condition("tinnitus")

# VA forms
client.search_forms(q="disability")
client.get_form("21-526EZ")

# State benefits (2 credits)
client.get_state_benefits("TX", category="property_tax")

# Source check: verify a general statement against the corpus (paid plans, 10 credits per billed call)
check = client.source_check("PTSD is rated under diagnostic code 9411", type="diagnostic_code", max_sources=3)
print(check["verdict"], check["confidence"])  # supported 1
print(check["sources"])                       # citations with source_name, vbd_id, source_url, last_reviewed
# Individualized advice requests ("should I file...") return an unbilled abstain verdict.

# Your usage (free)
client.usage()

# Metering info from the last call
print(client.last_receipt_id, client.credits_remaining)

Errors

All API errors raise vbd_api.VBDError with .status and .detail:

from vbd_api import VBD, VBDError

try:
    client.get_diagnostic_code("99999")
except VBDError as e:
    print(e.status, e.detail)  # 404 Unknown diagnostic code... (not billed)

Notes

  • Veteran Benefit Desk is independent and not affiliated with the U.S. Department of Veterans Affairs or any government agency.
  • Data is general educational information from public sources. It is not legal, medical, individualized claims, or representative advice.
  • License: commercial use with attribution ("Data via Veteran Benefit Desk"). Training rights are not granted by default.

Metadata

Release files for vbd-api 0.1.2

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

Source distribution (sdist)

Source distribution for vbd-api 0.1.2
File Size Uploaded Provenance Actions
vbd_api-0.1.2.tar.gz 4.1 kB Without provenance Details for vbd_api-0.1.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for vbd-api 0.1.2
File Interpreter ABI Platform Actions
vbd_api-0.1.2-py3-none-any.whl Python 3 none any Details for vbd_api-0.1.2-py3-none-any.whl

Total release size: 8.1 kB

Release files / vbd_api-0.1.2.tar.gz

Download URL vbd_api-0.1.2.tar.gz
Size 4.1 kB
Tags Source
SHA-256 checksum
How to use checksums
21b7b05f0ed4fca1ebfc464a57964ac63a228b1326bbf8d63e60574677578e91
BLAKE2b-256 checksum
How to use checksums
cafcbc3298be4d43529319b07655c3a8fd8a8b05f8181503b7a878bbe4eef94b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.16

Release files / vbd_api-0.1.2-py3-none-any.whl

Download URL vbd_api-0.1.2-py3-none-any.whl
Size 4.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
31e04aebbbbef27314b8e88739e9cc2cf9389537d77038c04eb4e5608d9d45c7
BLAKE2b-256 checksum
How to use checksums
001b5d138a39951e8f31bcb608cd23d0f7d27e21e0e547079c3122843c043bad
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.16

Security for vbd-api 0.1.2

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.

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