Find providers near a member
This guide shows how to return a ranked list of providers near a member, optionally narrowed to a service type. Use it when a member needs to see care options around their current location.
The request is a member-path call. Authenticate as a member client first; see Authentication.
Search around a location
Call GET /v1/search/proximity with the centre of the search. latitude and longitude are required and use WGS84 coordinates.
Narrow the search
Three optional parameters refine the result:
For example, to find one service type within 5 kilometres:
Read the result
The response is a ranked page of providers:
Two fields matter most when presenting options to a member:
availabilityStatusandisOpenNowdescribe whether the provider can take the member now.routingReasonCodesexplain why a provider ranked where it did. Surface them so the member understands the recommendation.
Results are ordered by routing fit, which weighs service-type match and current availability alongside distance. Do not re-sort by distanceMetres alone.
Next steps
- To walk the member through a pathway and on to a chosen provider, see Navigate a member to care.
- To check how busy a location is, see Check provider wait times.