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)
check = client.source_check("PTSD is rated under diagnostic code 9411")
print(check["verdict"], check["sources"])    # supported [...]

# 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.1.tar.gz (3.9 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.1-py3-none-any.whl (3.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vbd_api-0.1.1.tar.gz
  • Upload date:
  • Size: 3.9 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.1.tar.gz
Algorithm Hash digest
SHA256 2c394d7a615044b7cd8f349cd1184c11cd404596ab14fafca84ae7efffb98c76
MD5 9e78cc5a46d499b2069ff5518a1b8570
BLAKE2b-256 c1feca9bea13497a3d8b621d2eb1e1de8c1a70f28bef5a3167b9a8337fb5042e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vbd_api-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 3.8 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 159cf793da5a1d936c0432a0d50dae0b8d58b0a9618d616bd84fd4bb3efc4a6e
MD5 2ccbdb63b2f72d4e6b0926d108b0a78d
BLAKE2b-256 8545390c0195935f93b78623890e0c0cba605f87b630b8c2f366af5e25590d25

See more details on using hashes here.

Release history Release notifications | RSS feed

0.1.2

2 files

This release

0.1.1 This release

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