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 ...

# 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")

# 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.0.tar.gz (3.6 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.0-py3-none-any.whl (3.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vbd_api-0.1.0.tar.gz
  • Upload date:
  • Size: 3.6 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.0.tar.gz
Algorithm Hash digest
SHA256 e20005dccc22c22db819a1145dae7e4fc797cb94a222009b8ec4ffe340488636
MD5 7f72fc6863417ddaa509078a8cadb1fe
BLAKE2b-256 e1a98c902b45fa00a0a1316928c4ec25bd84a50e2932563fb54c081241b1a707

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vbd_api-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 3.5 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8289a66bc886765f2f4fddbab19d17673dd44ad09cb913f26f5fd17cc2db51f8
MD5 b961caf449d383cbb32ad8f2625bdcc4
BLAKE2b-256 39bd5bac7852474f5c44cb5837322857655cbfa1e3ca71efebf0b278b287768a

See more details on using hashes here.

Release history Release notifications | RSS feed

0.1.2

2 files

0.1.1

2 files

This release

0.1.0 This release

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