v1

latestOpenAPI 3.0.12026-07-1453737.4 KB

facilities

Retrieve all VA health facilities reachable by driving within the specified time period

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.

get/nearby

Query parameters

street_addressstring

Street address of the location from which drive time will be calculated.

citystring

City of the location from which drive time will be calculated.

statestring

Two character state code of the location from which drive time will be calculated.

zipstring

or #####-####

Zip code of the location from which drive time will be calculated.

latnumber float

Latitude of the location from which drive time will be calculated.

lngnumber float

Longitude of the location from which drive time will be calculated.

drive_time10 | 20 | 30 | 40 | 50 | 60 | 70 | 80 | 90

Filter to only include facilities that are within the specified number of drive time minutes from the requested location.

services[]string[]

Optional facility service search filter

pageinteger

Page of results to return per paginated response.

per_pageinteger

Number of results to return per paginated response.

Response

Success

Example response

{
  "data": [
    {
      "attributes": {
        "max_time": 20,
        "min_time": 10
      },
      "id": "vha_688",
      "type": "va_health_facility"
    }
  ],
  "meta": {
    "band_version": "APR2021"
  }
}