API Reference / API Parameters / aroundRadius

Jan. 14, 2021

aroundRadius

Type: integer | "all"

Engine default: null

Parameter syntax

'aroundRadius' => radius_in_meters|'all'

aroundRadius: radius_in_meters|'all'

aroundRadius: radius_in_meters|'all'

'aroundRadius': radius_in_meters|'all'

aroundRadius = .meters(radius_in_meters)|.all

aroundRadius: AroundRadius = AroundRadius.InMeters
| AroundRadius.All

.setAroundRadius(radius_in_meters|Query.RADIUS_ALL)

.SetAroundRadius(
  new AllRadiusInt { Radius = radius_in_meters } | new AllRadiusString()
)

setAroundRadius(radius_in_meters) | setAroundRadiusAll()

opt.AroundRadius(radius_in_meters)
opt.AroundRadiusAll()

aroundRadius = Some(AroundRadius.integer(radius_in_meters))
               Some(AroundRadius.all)

Can be used in these methods:
search, browseObjects, deleteBy, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, browse_objects, delete_by, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, browseObjects, deleteBy, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, browse_objects, delete_by, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, browse, deleteBy, searchForFacetValues, generateSecuredApiKey, addAPIKey, updateAPIKey search, browseObjects, deleteObjectBy, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey searchAsync, browseAsync, deleteByAsync, searchForFacetValues Search, Browse, DeleteBy, SearchForFacetValues, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, browse, deleteBy, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, BrowseObjects, DeleteBy, SearchForFacetValues, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, browse index, delete by, search into facet values, generateSecuredApiKey, add key, update key

See code examples

About this parameter

Define the maximum radius for a geo search (in meters).

Usage notes:

This setting only works within the context of a radial (circular) geo search, enabled by aroundLatLngViaIP or aroundLatLng.
How the radius is calculated:
- If you specify the meters of the radius (instead of all), then only records that fall within the bounds of the circle (as defined by the radius) will be returned. Additionally, the ranking of the returned hits will be based on the distance from the central axis point.
- If you use all, there is no longer any filtering based on the radius. The engine returns all relevant results with a valid _geoloc attribute. The ranking is still based on the distance from the central axis point.
- If you don’t use this setting, and yet perform a radial geo search (using aroundLatLngViaIP or aroundLatLng), the radius is automatically computed from the density of the searched area. See also minimumAroundRadius, which determines the minimum size of the radius.
For this setting to have any effect on your ranking, the geo criterion must be included in your ranking formula (which is the case by default).

Options:

radius_in_meters: Integer value (in meters) representing the radius around the coordinates specified during the query.
all: Disables the radius logic and returns all results with a valid _geoloc attribute, regardless of distance. Ranking is still based on proximity to the central axis point. This option is faster than specifying a high integer value.

Examples

Set manual radius filtering

Copy

1
2
3
$results = $index->search('query', [
  'aroundRadius' => 1000 // 1km
]);

1
2
3
4
5
6
7
8
let query = Query("query")
  .set(\.aroundRadius, to: .meters(1000))

index.search(query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

Disable automatic radius filtering

Copy

1
2
3
$results = $index->search('query', [
  'aroundRadius' => 'all'
]);

1
2
3
4
5
6
7
8
let query = Query("query")
  .set(\.aroundRadius, to: .all)

index.search(query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

Swift

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

InstantSearch iOS

InstantSearch Android

Autocomplete

Crawler Configuration API

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Crawler

Magento 2

WordPress

Shopify

Salesforce Commerce Cloud B2C

Netlify

aroundRadius

About this parameter

Usage notes:

Options:

Examples

Set manual radius filtering

Disable automatic radius filtering

Did you find this page helpful?

On this page