aroundLatLngViaIP

Type: boolean

Engine default: false

Parameter syntax

'aroundLatLngViaIP' => true|false

aroundLatLngViaIP: true|false

aroundLatLngViaIP: true|false

'aroundLatLngViaIP': True|False

aroundLatLngViaIP = true|false

aroundLatLngViaIP: Boolean = true|false

.AroundLatitudeLongitudeViaIP(true|false)

.setAroundLatLngViaIP(true|false)

AroundLatLngViaIP(true|false)

aroundLatLngViaIP = Some(true|false)

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

See code examples

About this parameter

Search for entries around a central location automatically computed from the user’s IP address, enabling a geographical search within a circular area.

A circle around the central location is automatically computed based on the density of records near that point. The radius will be small if many hits are close to the central location. The less hits near the center, the larger the radius will be.

Only records that fall within the bounds of this circle are returned. Records are ranked according to their distance from the central location. If you set getRankingInfo to true, each result will include the distance from the central location.

You can adjust the minimum and maximum radius:

To determine maximum radius, use aroundRadius
To determine minimum radius, use minimumAroundRadius.

You can set geo search precision with aroundPrecision, but the accuracy may vary. For example, a block of IP addresses might be assigned to a whole city and all IPs will use the city center as the central location.

Guides Filter results around a location

Geo location

Geographical search with InstantSearch.js

Demo Airport search demo

Usage notes

If you’re sending the request from your servers, set the X-Forwarded-For HTTP header to the user’s IP address to help Algolia determine their central location.

This parameter is ignored if used with insideBoundingBox or insidePolygon.

To specify the exact latitude and longitude of the central location, use aroundLatLng instead.

Examples

Search around user’s IP

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
$client = new \Algolia\AlgoliaSearch\SearchClient::create(
  'YourApplicationID',
  'YourSearchOnlyAPIKey'
);

$index = $client->initIndex('index_name');

/*
'94.228.178.246' should be replaced with the actual IP you would like
to search around. Depending on your stack there are multiple ways to get this
information.
*/
$results = $index->search('query', [
  'aroundLatLngViaIP' => true,
  'X-Forwarded-For' => '94.228.178.246'
]);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# '94.228.178.246' should be replaced with the actual IP you would like
# to search around. Depending on your stack there are multiple ways to get this
# information.

ip = '94.228.178.246'

client = Algolia::Search::Client.create('YourApplicationID', 'YourSearchOnlyAPIKey')
index = client.init_index('index_name')

results = index.search('query', {
  aroundLatLngViaIP: true,
  headers: {
    'X-Forwarded-For': ip
  }
})

1
2
3
4
5
6
7
8
9
10
11
12
13
// '94.228.178.246' should be replaced with the actual IP you would like
// to search around. Depending on your stack there are multiple ways to get this
// information.
// This is only needed when you're making a request from Node.js. If you make
// your request in the browser, then this is added automatically.
index.search('query', {
  aroundLatLngViaIP: true,
  headers: {
    'X-Forwarded-For': '94.228.178.246'
  }
}).then(({ hits }) => {
  console.log(hits);
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# '94.228.178.246' should be replaced with the actual IP you would like
# to search around. Depending on your stack there are multiple ways to get this
# information.
config = SearchConfig(
    'YourApplicationID',
    'YourWriteAPIKey'
)

ip = '94.228.178.246'

config.headers['X-Forwarded-For'] = ip

client = SearchClient.create_with_config(config)
index = client.init_index('index_name')

results = index.search('query', {
    'aroundLatLngViaIP': True
})

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
/// '94.228.178.246' should be replaced with the actual IP you would like
/// to search around. Depending on your stack there are multiple ways to get this
/// information.
let configuration = SearchConfiguration(
  applicationID: "YourApplicationID",
  apiKey: "YourSearchOnlyAPIKey"
)
  .set(\.defaultHeaders, to: ["X-Forwarded-For": "94.228.178.246"])
let client = SearchClient(configuration: configuration)
let index = client.index(withName: "index_name")

let query = Query("query")
  .set(\.aroundLatLngViaIP, to: true)

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

1
2
3
4
5
6
7
8
9
10
11
12
13
val configuration = ConfigurationSearch(
    ApplicationID("YourApplicationID"),
    APIKey("YourSearchOnlyAPIKey"),
    defaultHeaders = mapOf("X-Forwarded-For" to "94.228.178.246")
)
val client = ClientSearch(configuration)
val index = client.initIndex(IndexName("index_name"))

val query = query("query") {
    aroundLatLngViaIP = true
}

index.search(query)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// '94.228.178.246' should be replaced with the actual IP you would like
// to search around. Depending on your stack there are multiple ways to get this
// information.
var configuration = new SearchConfig("YourApplicationID", "YourWriteAPIKey")
{
    DefaultHeaders = new Dictionary<string, string> { { "X-Forwarded-For", "94.228.178.246" } }
};

SearchClient client = new SearchClient(configuration);

index.Search<T>(new Query("query")
{
    AroundLatLngViaIP = true
});

1
2
3
4
5
6
7
8
9
10
// '94.228.178.246' should be replaced with the actual IP you would like
// to search around. Depending on your stack there are multiple ways to get this
// information.

index.search(
  new Query("query")
    .setAroundLatLngViaIP(true),
  new RequestOptions()
    .addExtraHeader("X-Forwarded-For", "94.228.178.246")
);

1
2
3
4
5
6
7
8
9
10
11
12
// '94.228.178.246' should be replaced with the actual IP you would like
// to search around. Depending on your stack there are multiple ways to get this
// information.
extraHeaders := opt.ExtraHeaders(map[string]string{
  "X-Forwarded-For", "94.228.178.246",
})

res, err := index.Search(
  "query",
  opt.AroundLatLngViaIP(true),
  extraHeaders,
)

1
2
3
4
5
6
7
8
9
10
11
12
// '94.228.178.246' should be replaced with the actual IP you would like
// to search around. Depending on your stack there are multiple ways to get this
// information.

client.execute {
  search into "myIndex" query Query(
    query = Some("query"),
    aroundLatLngViaIP = Some(true)
  ) options RequestsOptions(
    extraHeaders = Some(Map("X-Forwarded-For" -> "94.228.178.246"))
  )
}

Did you find this page helpful?

aroundLatLngViaIP

About this parameter

Usage notes

Examples

Search around user’s IP

On this page