GuidesAPI Reference
API Reference

Location query

Request WGS-84 compliant geographical coordinates for a location based on 2G/3G/4G cell and/or WLAN measurements.

Query Params
string
length between 4 and 101

A list of up to six billing tags, separated by the + sign. This parameter provides a way to track your platform usage. For details, refer to the Cost Management Developer Guide section on Billing Tags.

integer
50 to 99
Defaults to 68

Confidence level in percent for the accuracy/uncertainty in the location estimate response. If not specified, the default is 68 (this corresponds to a 68% probability that the true position is within the accuracy/uncertainty radius of the location estimate: the higher the number, the greater the confidence level).

fallback
array of strings

Acceptable fallback options for cell and WLAN positioning. Values area and any apply to cell based positioning only in case none of the models of the cells serving the target device are currently available. Value singleWifi applies to WLAN based positioning in case only one of the provided WLAN APs can be used for position calculation.

By default, cell based positioning returns only cell level location estimates. In LTE and LTE Cat-M, use the fallback=area setting if you permit location estimate to be based on a combination of cells of a single tower, or more precisely, on an eNodeB area. Also use this setting if you allow location estimate to be based on an area of a group of cells defined by the network (LAC, RNC, TAC, NID, or RZ). If you use the fallback=any setting, the service can use all aforementioned cell fallback methods and additionally fallback to the MNC, SID, or MCC level. If both area and any are specified, then area is ignored.

For privacy reasons, the precise positioning based on a single WLAN AP is not possible. You can use the fallback=singleWifi setting to allow less accurate positioning based on a single WLAN AP. In that case, the center location of the position estimate will be deviated and the reported accuracy radius will be larger. If you choose to make use of this parameter, it is recommended to use it in all requests, not only those which contain just single WLAN AP measurement. This will help to avoid error responses with status 400 in cases when all APs except one have either multicast MAC address (which are excluded from positioning) or are otherwise unusable for position calculation.

fallback
desired
array of strings

Comma-separated list of additional data fields that the service should include in the response if data is available. The query parameter supports the value altitude.

desired
required
array of strings

Comma-separated list of additional data fields that the service should include in the response. If the data is not available, the response contains an error message. The query parameter supports the value altitude.

required
Body Params

Request body containing cell and/or WLAN measurement data. Cellular measurements are given in terms defined in 3GPP and 3GGP2 specifications, see the corresponding documentation at http://www.3gpp.org.

client
object

Information about the client

wlan
array of objects
length between 1 and 256

WLAN access points. For privacy reasons positioning based on a single WLAN AP is not possible; there has to be at least one other matching WLAN AP or cell. Alternatively, you can allow fallbacks to less accurate single WLAN AP location estimates by using the setting fallback=singleWifi.

wlan
gsm
array of objects
length between 1 and 16

GSM cells (GERAN)

gsm
wcdma
array of objects
length between 1 and 16

WCDMA cells (UTRA-FDD, 3G UMTS)

wcdma
tdscdma
array of objects
length between 1 and 16

TD-SCDMA cells (UTRA-TDD, 3G UMTS TDD)

tdscdma
lte
array of objects
length between 1 and 16

LTE cells (E-UTRA, 4G)

lte
lteCatM
array of objects
length between 1 and 16

LTE Cat-M cells

lteCatM
nbIot
array of objects
length between 1 and 16

NB-IoT cells

nbIot
cdma
array of objects
length between 1 and 16

CDMA cells (CDMA2000)

cdma
Headers
string

Indicates that the data in the body has been compressed. Supported codings are: 'gzip', 'deflate', 'br'.

string

User-provided token that can be used to trace a request or a group of requests sent to the service. Can be any string, but UUID is recommended. It will be echoed in the response.

Responses

Language
Credentials
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json