integrations.sh
← all integrations

va.gov – facilities

OpenAPI apis-guru location

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 .

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

Homepage
https://api.apis.guru/v2/specs/va.gov:facilities/0.0.1.json
Provider
va.gov:facilities / facilities
OpenAPI version
3.0.1
Spec (JSON)
https://api.apis.guru/v2/specs/va.gov/facilities/0.0.1/openapi.json
Spec (YAML)
https://api.apis.guru/v2/specs/va.gov/facilities/0.0.1/openapi.yaml

Tools (7)

Extracted live via the executor SDK.

  • facilities.getAllFacilities

    Retrieve all available facilities in a single operation, formatted as either a GeoJSON FeatureCollection or as a CSV. Due to the complexity of the facility resource type, the CSV response contains a subset of available facility data - specifically it omits the available services, patient satisfaction, and patient wait time data.

  • facilities.getFacilitiesByLocation

    Query facilities by bounding box, latitude and longitude, state, visn, or zip code. Bounding box is specified as four bbox[] parameters, long1, lat1, long2, lat2. (Relative order is unimportant.)

    A query by latitude and longitude returns all facilities in the system, sorted by distance from that location.

    All location queries support filtering by facility type, available services, and mobile status.

    One can also retrieve facilities by ID using a comma-separated list like ?ids=id1,id2. When requesting multiple facilities by ID, the API will return as many results as it can find matches for, omitting IDs where there is no match. It will not return an HTTP error code if it is unable to match a requested ID. Clients may supply IDs up to the limit their HTTP client enforces for URI path lengths. (Usually 2048 characters.)

    Results are paginated. JSON responses include pagination information in the standard JSON API "links" and "meta" elements.

    Parameter combinations

    You may optionally specify page and per_page with any query. You must specify one of the following parameter combinations:

    • bbox[], with the option of any combination of type, services[], or mobile

    • ids

    • lat and long, with the option of any combination of ids, type, services[], or mobile

    • state, with the option of any combination of type, services[], or mobile

    • visn

    • zip, with the option of any combination of type, services[], or mobile

    Invalid combinations will return 400 Bad Request.

  • facilities.getFacilityById

    Retrieve a specific facility by ID

  • facilities.getFacilityIds

    Retrieves all available facility IDs only

  • facilities.getNearbyFacilities

    Retrieve all VA health facilities that are located within a specified drive time from a specified location based on address (street_address, city, state, and zip) or coordinates (lat and lng). Optional filter parameters include drive_time and services[].

    Results of this operation are paginated. Responses include pagination information in the standard JSON API "links" and "meta" elements.

    The "attributes" element has information about the drive-time band that contains the requested location for each facility in the response. The values of min_time and max_time are in minutes. For example, a facility returned with a matched min_time of 10 and max_time of 20 is a 10 to 20 minute drive from the requested location.

    To retrieve full details for nearby facilities, see the documentation for /facilities?ids.

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools