API Reference / API Parameters / aroundLatLng

Jan. 14, 2021

aroundLatLng

Type: string

Engine default: null

Parameter syntax

'aroundLatLng' => 'latitude, longitude' // 2 floats

aroundLatLng: 'latitude, longitude' # 2 floats

aroundLatLng: 'latitude, longitude' // 2 floats

'aroundLatLng': 'latitude, longitude' # 2 floats

aroundLatLng = Point(latitude, longitude)

aroundLatLng: Point = Point(latitude, longitude)

.setAroundLatLng("latitude, longitude") // 2 floats

.AroundLatitudeLongitude("latitude, longitude") // 2 floats

.setAroundLatLng("latitude, longitude") // 2 floats

opt.AroundLatLng("latitude, longitude") // 2 floats

aroundLatLng = Some("latitude, longitude") // 2 floats

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

Search for entries around a central geolocation, enabling a geo search within a circular area.

By defining this central point, there are three consequences:

a radius / circle is computed automatically, based on the density of the records near the point defined by this setting
only records that fall within the bounds of the circle are returned
records are ranked according to the distance from the center of the circle

Usage notes:

With this setting, you are defining a central point of a circle, whose geo-coordinates are expressed as two floats separated by a comma.
Note: This setting differs from aroundLatLngViaIP, which uses the end user’s IP to determine the geo-coordinates.
This parameter will be ignored if used along with insideBoundingBox or insidePolygon
To control the maximum size of the radius, you would use aroundRadius.
To control the minimum size, you would use minimumAroundRadius.
The size of this radius depends on the density of the area around the central point. If there are a large number of hits close to the central point, the radius can be small. The less hits near the center, the larger the radius will be.
Note: If the results returned are less than the number of hits per page (hitsPerPage), then the number returned will be less than the hitsPerPage. For example, if you recieve 15 results, you could still see a larger number of hits per page, such as hitsPerPage=20.

Examples

Search around a position

Copy

1
2
3
$results = $index->search('query', [
  'aroundLatLng' => '40.71, -74.01'
]);

1
2
3
4
5
6
7
8
let query = Query("query")
  .set(\.aroundLatLng, to: Point(latitude: 40.71, longitude: -74.01))

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

aroundLatLng

About this parameter

Usage notes:

Examples

Search around a position

Did you find this page helpful?

On this page