Find provider locations

Search for locations and groups that match a query, where there are at least one active provider in good health. The match algorithm accounts for typos and misspelling, and the tolerance can be tuned in the input. Note that a location or group will need to be mapped to an actual provider using /network/find-providers.

POSThttps://api.bringyour.com/network/find-provider-locations

Body

application/json

querystring

max_distance_fractionnumber

enable_max_distance_fractionboolean

Response

200

Body

application/json

specsarray of ProviderSpec (object)

groupsarray of object

locationsarray of object

devicesarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.bringyour.com/network/find-provider-locations', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "specs": [
    {
      "location_id": "text",
      "location_group_id": "text",
      "client_id": "text",
      "best_available": false
    }
  ],
  "groups": [
    {
      "location_group_id": "text",
      "name": "text",
      "provider_count": 0,
      "promoted": false,
      "match_distance": 0
    }
  ],
  "locations": [
    {
      "location_id": "text",
      "location_type": "city",
      "name": "text",
      "city": "text",
      "city_location_id": "text",
      "region": "text",
      "region_location_id": "text",
      "country": "text",
      "country_location_id": "text",
      "country_code": "text",
      "provider_count": 0,
      "match_distance": 0
    }
  ],
  "devices": [
    {
      "client_id": "text",
      "device_name": "text"
    }
  ]
}