Skip to main content

Location

Golioth Location API definitions.

Interface

MethodDescriptionPathContent Format
POSTResolve location using network-based positioning./.l/v1/netJSON/CBOR

Network Positioning Request Format

Network-based positioning requests may include both cell tower and Wi-Fi access point information. At least one cell tower or Wi-Fi access point is required for successful resolution.

AttributeDescription
cellArray of cell tower objects.
wifiArray of Wi-Fi access point objects.

An example request with both cellular and Wi-Fi network data is provided below.

{
"cell": [
{
"type": "ltecatm",
"mcc": 260,
"mnc": 3,
"id": 25115045,
"strength": -113
},
{
"type": "ltecatm",
"mcc": 260,
"mnc": 3,
"id": 25115046,
"strength": -89
}
],
"wifi": [
{
"mac": "b0:5b:99:d8:0f:f4",
"rssi": -83
},
{
"mac": "ac:f8:cc:09:b3:16",
"rssi": -90
}
]
}

Cell Tower Format

AttributeDescriptionRequired
typeString indicating type of cellular network (ltecatm or nbiotX
mccInteger indicating Mobile Country Code.X
mncInteger indicating Mobile Network Code.X
idInteger indicating EUCID (LTE Cat-M) or Cell ID (NB-Iot).X
strengthInteger indicating RSRP (LTE Cat-M) or NRSRP (NB-Iot). (dBm)
lacInteger indicating Tracking Area Code (TAC)
ageInteger indicating age of measurement. (ms)
channelInteger indicating EARFCN.
servingBoolean indicate whether device is currently served by the cell. (default: false)
lidInteger indicating PCI (LTE Cat-M) or NCID (NB-Iot)

Wi-Fi Access Point Format

AttributeDescriptionRequired
macString indicating access point MAC address.X
ssidString indicating access point Service Set Identifier.
strengthInteger indicating signal strength of access point (dBm).
ageInteger indicating age of measurement. (ms)
frequencyInteger indicating frequency of access point. (MHz)
channelInteger indicating channel number of access point.
ConnectedBoolean indicating whether device is currently connected to the access point. (default: false)

Network Positioning Response Format

AttributeDescription
latInteger indicating latitude of device. (nanodegrees)
lonInteger indicating longitude of device. (nanodegrees)
accInteger horizontal positioning accuracy (HPE). (meters)

An example response is provided below.

{
"lat": 50664189000,
"lon": 17942112000,
"acc": 65
}