Va

VA Facilities

Background This RESTful API provides information about physical VA facilities. Information available includes geographic location, address, phone, hours of…

Government & public#openapi#location

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Background

This RESTful API provides information about physical VA facilities. Information available includes
geographic location, address, phone, hours of operation, and available services.

VA operates several different types of facilities, the types represented in this API include:

  • Health Facilities (vha)
  • Benefits Facilities (vba)
  • Cemeteries (nca)
  • Vet Centers (vc)

To read an FAQ on how wait times are calculated, click the "For more information" link on this page.

Getting Started

Base URLs

The base URLs for the VA Facilities API in the various environments are:

  • Sandbox: https://sandbox-api.va.gov/services/va_facilities/v0
  • Production: https://api.va.gov/services/va_facilities/v0

Authorization

API requests are authorized through a symmetric API token, provided in an HTTP header with name apikey.

Response Formats

Clients may request several response formats by setting the Accept header.

  • application/json - The default JSON response format complies with JSON API. This media type is not available for bulk requests using the /facilities/all endpoint. It will return 406 Not Acceptable.
  • application/geo+json - GeoJSON-compliant format, representing each facility as a feature with a point geometry.
  • application/vnd.geo+json - Deprecated. Prefer application/geo+json.
  • text/csv - Available for the bulk download operation only. Some structured fields are omitted from the CSV response.

Response Elements

Some data elements within the response are only present for facilities of a given type:

  • The patient satisfaction scores contained in the satisfaction element are only applicable

to VA health facilities.

  • The patient wait time values contained in the wait_times element are only applicable to

VA health facilities.

  • The list of available services in the services element is only applicable to VA health and

benefits facilities.

  • The operational hours special instructions contained in the operational_hours_special_instructions element is only applicable to VA health and Vet Center facilities.

Facility ID Formats and Constraints

A facility ID has the format prefix_stationNumber. The prefix is one of nca, vc, vba, or vha. Cemeteries may be national (VA) or non-national; non-national cemeteries have the station number prefixed with an s. There are no other constraints on the format. Examples:

  • Health: vha_402GA
  • Benefits: vba_539GB
  • National cemetery: nca_063
  • Non-national cemetery: nca_s1082
  • Vet center: vc_0872MVC

Mobile Facilities

The mobile health facilities move regularly within a region. If a facility comes back from this API with "mobile": "true", the latitude/longitude and address could be inaccurate. To get the exact current location, please call the number listed.

Deprecations

  • active_status field is deprecated and replaced with operating_status.
  • application/vnd.geo+json media type is deprecated and replaced by application/geo+json

Reference

Endpoints 5

facilities

  • GETQuery facilities by location or IDs, with optional filters/facilities?ids=vha_688,vha_644&zip=80301-1000&state=CO&lat=56.7&long=-123.4&bbox[]=-105.4,39.4,-104.5,40.1&visn=0.0&type=health&services[]=string&mobile=true&page=1&per_page=10Query facilities by bounding box, latitude and longitude, state, visn, or zip code. Bounding box is specified as four bbox[] parameters, long1, lat1, long2,…
  • GETBulk download information for all facilities/facilities/allRetrieve all available facilities in a single operation, formatted as either a GeoJSON FeatureCollection or as a CSV. Due to the complexity of the facility…
  • GETRetrieve a specific facility by ID/facilities/:id
  • GETBulk download of all facility IDs/ids?type=healthRetrieves all available facility IDs only
  • GETRetrieve all VA health facilities reachable by driving within the specified time period/nearby?street_address=1350 I St. NW&city=Washington&state=DC&zip=20005-3305&lat=56.7&lng=-123.4&drive_time=90&services[]=string&page=1&per_page=20Retrieve all VA health facilities that are located within a specified drive time from a specified location based on address (street_address, city, state, and…

API details

Base URL
https://sandbox-api.va.gov/services/va_facilities/{version}
https://api.va.gov/services/va_facilities/{version}
Authentication
An API key in the apikey header
Operations
5 operations on 5 pathsGET 5
Main resources
facilities 5
Response formats
application/json application/geo+json application/vnd.geo+json
Description format
OpenAPI 3.0.1, API version 0.0.1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the VA Facilities in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the VA Facilities collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the apikey header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Query facilities by location or IDs, with optional filters” (GET /facilities?ids=vha_688,vha_644&zip=80301-1000&state=CO&lat=56.7&long=-123.4&bbox[]=-105.4,39.4,-104.5,40.1&visn=0.0&type=health&services[]=string&mobile=true&page=1&per_page=10), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the VA Facilities?

Background This RESTful API provides information about physical VA facilities. Information available includes geographic location, address, phone, hours of… It is listed under Government & public and has 5 endpoints.

Who publishes the VA Facilities?

It is listed from Va's public API description (an OpenAPI document), not published by Va on Swastik Codes. Anyone who controls va.gov can claim the profile by adding a DNS TXT record.

What is the base URL of the VA Facilities?

Its description lists 2 base URLs: https://sandbox-api.va.gov/services/va_facilities/{version}, https://api.va.gov/services/va_facilities/{version}. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the VA Facilities?

With an API key in the apikey header.

How many endpoints does the VA Facilities have?

5 operations on 5 paths (5 GET). The largest groups are facilities.

Is forking the VA Facilities free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.