- Type:
integer | "all" - Default:
null - Scope:
search
aroundRadius parameter defines the maximum distance (in meters) from the central location within which results are returned.
Used with aroundLatLng or aroundLatLngViaIP,
this limits how far from the center Algolia will retrieve results.
Usage
- Applies only to radial searches around a location.
- Works only when [
aroundLatLng] or [aroundLatLngViaIP] is set. - The Geo ranking criterion must be in your ranking formula (included by default).
- If omitted, Algolia dynamically calculates the radius based on result density.
- To enforce a minimum radius, use
minimumAroundRadius.
Options
integer
Maximum radius in meters.
Results beyond this distance are excluded.
all
Includes all records with a
_geoloc attribute, regardless of distance from the center.
Ranks results by proximity to the center.
Faster than setting a large integer value.Example
Current API clients
Current API clients
Legacy API clients
Legacy API clients