Request

To receive a response about the location of a mobile device, send a POST request to the geolocation resource. Pass the data in JSON format:

• In standard form.
• In compressed form.

Yandex Locator processes the request data in the following order:

1. Wi-Fi access points.
2. Mobile network signals.
3. IP address.

If Yandex Locator determines the location, it returns the response with the point's coordinates and the accuracy radius. Otherwise, you'll get a error message.

The Yandex Locator API has a limit on the number of requests per second (RPS): up to 1800. It's calculated as the sum of requests from the client and from the server.

Standard requestStandard request

Pass the data about the mobile device and its environment in the json request parameter.

Host: api.lbs.yandex.net
POST /geolocation

json={
   "common": {
      "version": "1.0",
      "api_key": "ABM6WU0BAAAANfFuIQIAV1pUEYIBeogyUNvVbhNaJPWeM-AAAAAAAAAAAACRXgDsaYNpZWpBczn4Lq6QmkwK6g=="
   },
   "gsm_cells": [
       {
          "countrycode": 250,
          "operatorid": 2,
          "cellid": 197403650,
          "lac": 9900,
          "signal_strength": -80,
          "age": 1000
       }
   ],
   "wifi_networks": [
       {
          "mac": "2CD02D814C80",
          "signal_strength": -68,
          "age": 500,
       },
       {
          "mac": "E4AA5DE28CD0",
          "signal_strength": -60,
          "age": 500,
       }
   ],
   "ip": {
     "address_v4": "95.108.173.231"
   }
}

curl -X POST 'http://api.lbs.yandex.net/geolocation' -d 'json={"common": {"version": "1.0", "api_key": "ABM6WU0BAAAANfFuIQIAV1pUEYIBeogyUNvVbhNaJPWeM-AAAAAAAAAAAACRXgDsaYNpZWpBczn4Lq6QmkwK6g=="}, "gsm_cells": [ { "countrycode": 250, "operatorid": 2, "cellid": 197403650, "lac": 9900, "signal_strength": -80, "age": 1000} ], "wifi_networks": [ {"mac": "2CD02D814C80", "signal_strength": -68, "age": 500}, {"mac": "E4AA5DE28CD0", "signal_strength": -60, "age": 500} ], "ip": {"address_v4": "95.108.173.231"}}'

KeysKeys

Request with compressed dataRequest with compressed data

Compress the JSON with data using the gzip utility and pass it in the request. Specify the Content-Type: multipart/from-data header and set any non-zero value to the gzip parameter.

In the request of the multipart/from-data type, include two parts:

1. gzip: Indicator of the request with compressed data.
2. json: Parameter containing the compressed JSON data.

In each part of the request, specify the value of one parameter after the boundary separator and the Content-Disposition header that contains the parameter name. The parameter value must be separated from the preceding headers with an empty string.

Send a POST request to the geolocation resource.

POST /geolocation?gzip=1
Host: api.lbs.yandex.net
Accept-Encoding: identity
Content-Type: multipart/form-data; boundary=YANDEXLOCATORBOUNDARY
Content-length: 538

--YANDEXLOCATORBOUNDARY
Content-Disposition: form-data; name="gzip"

1
--YANDEXLOCATORBOUNDARY
Content-Disposition: form-data; name="json"
Content-Type: application/octet-stream
Content-Transfer-Encoding: binary

COMPRESSED DATA
--YANDEXLOCATORBOUNDARY--

curl -X POST 'http://api.lbs.yandex.net/geolocation?gzip=1' -H 'Content-Type: multipart/form-data' -F json=@data.json.gz

KeysKeys