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 given location automatically computed from the requester’s IP address.

By computing a central geolocation (from an IP), this has 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

The precision of geo search should be set with aroundPrecision, but the accuracy of the localized IP may vary. As an example, an IP block might be assigned to a whole city. In this case, all IPs will have the center of the city as coordinates.

Usage notes

With this setting, you are using the end user’s IP to define a central axis point of a circle in geo-coordinates.
Algolia automatically calculates the size of the circular radius around this central axis.
- To control the precise size of the radius, you would use aroundRadius.
- To control a minimum size, you would use minimumAroundRadius.
If you are sending the request from your servers, you must set the X-Forwarded-For HTTP header with the front-end user’s IP address for it to be used as the basis for the computation of the search location.
Note: This setting differs from aroundLatLng, which allows you to specify the exact latitude and longitude of the center of the circle.
This parameter will be ignored if used along with insideBoundingBox or insidePolygon

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',
    'YourAdminAPIKey'
)

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
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", "YourAdminAPIKey")
{
    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"))
  )
}

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)

Did you find this page helpful?

aroundLatLngViaIP

About this parameter

Usage notes

Examples

Search around user’s IP

On this page