POST /v2/geolocation
Спецификация OpenAPI
2GIS geolocation API (2.0.0)
2GIS Radar team: radar@2gis.ru
API позволяет получить данные о местоположении устройства
Получить местоположение
Получить предполагаемое местоположение на основе информации об окружающих точках доступа Wi-Fi и/или сотовых вышках
query Parameters
| key | string API-ключ 2ГИС, для получения см. Обзор |
Request Body schema: application/jsonrequired
| sessionUUID required | string UUID сессии. Рекомендуется держать неизменным на протяжении сессии работы пользователя с приложением |
| captureTimestampUnix required | number <int64> >= 0 Время получения информации о наблюдаемых вышках, точках доступа Wi-Fi и местоположении от системы в секундах |
Array of objects (wifiAccessPoint) Наблюдаемые в данный момент точки доступа Wi-Fi | |
object (mobileNetwork) | |
| ip | string Внешний IP-адрес устройства (рекомендуется передавать, если запрос делается не напрямую с устройства, а через бэкенд приложения) |
object Данные о местоположении, полученные от GNSS-приёмника. Используются анонимизированно для улучшения работы сервиса |
Responses
Response Schema: application/json
| state | string Value: "geoposition_located" |
| statusCode | number Value: 200 |
object (predicted_location) |
Request samples
- Payload
Content type
application/json
{- "sessionUUID": "4dec3e75-8966-475a-9541-b4a8fbaaeda2",
- "captureTimestampUnix": 1624539922,
- "wifiAccessPoints": [
- {
- "lastSeenMs": 233,
- "macAddress": "a4:4c:c8:52:2a:20",
- "rttDistanceMm": 7,
- "signalStrengthDBm": -63.6,
- "ageMs": 369,
- "frequencyGHz": 2.4,
- "standard": "IEEE 802.11mc",
- "ssid": "Home Printer 1"
}
], - "mobileNetwork": {
- "homeMobileCountryCode": 505,
- "homeMobileNetworkCode": 217,
- "cellTowers": [
- {
- "lastSeenMs": 496,
- "cellID": 4321,
- "networkType": "string",
- "locationAreaCode": 19733,
- "ageMs": 766,
- "signalStrengthDBm": -71.3,
- "timingAdvance": 11
}
]
}, - "ip": "5.128.120.163",
- "gnssLocation": {
- "latitude": 52.953096,
- "longitude": 87.935501,
- "horizontalAccuracyM": 57,
- "altitudeM": 1297,
- "altitudeAccuracyM": 17,
- "course": 299.6,
- "courseAccuracy": 15.6,
- "groundSpeedMS": 36,
- "groundSpeedAccuracyMS": 11
}
}Response samples
- 200
- 400
- 402
- 403
- 429
- 503
Content type
application/json
{- "state": "geoposition_located",
- "statusCode": 200,
- "location": {
- "latitude": 52.953096,
- "longitude": 87.235007,
- "accuracy": 19
}
}