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.

Download files

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

Source Distribution

vbd_api-0.1.2.tar.gz (4.1 kB view details)

Uploaded Source

Built Distribution

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

vbd_api-0.1.2-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

Details for the file vbd_api-0.1.2.tar.gz.

File metadata

  • Download URL: vbd_api-0.1.2.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.11.16

File hashes

Hashes for vbd_api-0.1.2.tar.gz
Algorithm Hash digest
SHA256 21b7b05f0ed4fca1ebfc464a57964ac63a228b1326bbf8d63e60574677578e91
MD5 c3cbcd20eeec954cc023658107e406e9
BLAKE2b-256 cafcbc3298be4d43529319b07655c3a8fd8a8b05f8181503b7a878bbe4eef94b

See more details on using hashes here.

File details

Details for the file vbd_api-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: vbd_api-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 4.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.11.16

File hashes

Hashes for vbd_api-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 31e04aebbbbef27314b8e88739e9cc2cf9389537d77038c04eb4e5608d9d45c7
MD5 3cd6e8f9ee297f4584d49bc10668e855
BLAKE2b-256 001b5d138a39951e8f31bcb608cd23d0f7d27e21e0e547079c3122843c043bad

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.2 This release

2 files

0.1.1

2 files

0.1.0

2 files

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