HERE Location API is one of 139 APIs that HERE publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Location. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
1 operation
across 1 path,
and defines 90 schemas.
It is described by OpenAPI 3.2.0, at version 2.9.0.
Requests are made against a single base URL, https://positioning.hereapi.com/v2.
The identity and technical contract details declared by the specification.
Uarfcn
integer
UTRAN Absolute Radio Frequency (U-ARFCN)
EutranCid
integer
E-UTRA Cell Identifier (UC-Id), 28 bits (20 bits eNodeB and 8 bits Cell ID). See 3GPP TS 36.331 (V18.2.0), Section 6.3.4 for details.
ClientInfo
object
Information about the client
7 properties
4 required
LteCatMNmr
object
LTE Cat-M network measurement
5 properties
2 required
Latitude
number
Latitude in WGS-84 format, decimal representation ranging from -90 to 90.
Channel
integer
CDMA channel frequency
Lac
integer
Location Area Code (LAC). Note, value 65534 is invalid.
Lte
object
LTE measurement
11 properties
3 required
WcdmaNmr
object
WCDMA network measurement
5 properties
2 required
LteCatM
object
LTE Cat-M measurement
9 properties
3 required
Pathloss
integer
UTRAN pathloss (dBm)
GsmLocalId
object
Local identification parameters of GSM serving cell
2 properties
2 required
Pci
integer
Physical Cell Identity (PCI)
NrArfcn
integer
NR Absolute Radio Frequency Channel Number (NRARFCN)
ErrorDetail
object
Detail about an error
5 properties
Gsm
object
GSM measurement
8 properties
4 required
Rsrq
number
Reference Signal Received Quality (RSRQ) in dB. Values less than -34dB should be clamped to -34. Values greater than +3dB should be clamped to +3. For referenc…
BaseLat
number
Base station latitude
RegistrationZone
integer
CDMA Registration Zone (RZ)
WcdmaLocalId
object
Local identification parameters of WCDMA serving cell
2 properties
2 required
TdscdmaTimingAdvance
integer
Timing advance (TA). Round-Trip distance presented in the units of 4 c / 7.68e6, which corresponds to ~ 156 meters. That is, the scaling factor is 4 times the…
NbIotNmrArray
array
NB-IoT network measurements
Psc
integer
Primary Scrambling Code (PSC, Primary CPICH, Primary Control Pilot Channel).
Rss
integer
Received signal level (dBm) at the terminal
WcdmaCid
integer
WCDMA Cell Identifier (UTRAN CID, UC-Id), 28 bits (12 bits RNC and 16 bits Cell ID). See 3GPP TS 25.331 (V18.0.0), Section 10.3.2.2 for details.
Wcdma
object
WCDMA measurement
8 properties
3 required
Mcc
Mobile Country Code (MCC). The value may be either a string (recommended) or an integer (deprecated). Note: 0xx is for test networks, 1xx and 8xx are not used.
GsmNmr
object
GSM network measurements.
4 properties
2 required
MncString
string
Mobile Network Code (MNC)
Rscp
integer
Received Signal Code Power (RSCP) in dBm. Values less than -120dBm should be clamped to -120. Values greater than -25dBm should be clamped to -25.
WlanLocate
object
WLAN measurement
2 properties
1 required
Tdscdma
object
TD-SCDMA measurement.
9 properties
3 required
NrSyncSignal
object
Synchronization Signal measurement. May include one or more of SS-RSRQ, SS-RSRP and SS-SINR reports.
2 properties
TdscdmaNmrArray
array
TD-SCDMA network measurements. Maximum of 8 distinct uarfcn frequencies.
PnOffset
integer
Pseudonoise offset. This field and CDMA channel frequency together allow for the locally unique identification of the cell.
NbIotLocalId
object
Local identification parameters for NB-IoT cell measurement
2 properties
2 required
NrNmr
object
NR network measurement
4 properties
2 required
PositionLocate
object
Object containing information on a location where a measurement was taken.
5 properties
3 required
CdmaNmr
object
CDMA network measurement
4 properties
2 required
Nci
integer
NR Cell Identifier (NCI). See 3GPP TS 38.331 (V18.2.0), Section 6.3.2 for details.
Sid
integer
System ID (SID)
Cdma
object
CDMA measurement
9 properties
3 required
Bsic
integer
Base Station Identity Code (BSIC, for instance, color code)
NrLocalId
object
Local identification parameters of NR serving cell
2 properties
2 required
MccInteger
integer
Mobile Country Code (MCC) as integer. Note: this format is deprecated, use string format instead. Note: 0xx is for test networks, 1xx and 8xx are not used.
CellParams
integer
Cell Parameters ID (CDMA Spreading Code ID)
MncInteger
integer
Mobile Network Code (MNC) as integer. Note: this format is deprecated, use string format instead.
Earfcn
integer
Evolved Absolute Radio Frequency Channel Number (E-ARFCN)
CdmaNmrArray
array
CDMA network measurements
Mnc
Mobile Network Code (MNC). The value may be either a string (recommended) or an integer (deprecated).
GsmNmrGlobalId
object
The lac and cid parameters of global ID for GSM neighbor measurement. They should be from the same PLMN (MCC+MNC) as the serving cell.
2 properties
2 required
NbIotNmr
object
NB-IoT network measurement
5 properties
2 required
Locate
object
Object wrapping the location data submitted in a request for a position. At least one of gsm, wcdma, tdscdma, lte, lteCatM, nbIot, nr, cdma, or wlan elements i…
10 properties
Nid
integer
Network ID (NID)
Tac
integer
Tracking Area Code (TAC)
Nrsrq
number
Narrowband Reference Signal Received Quality (NRSRQ) in dB. Value range is [-34, 2.5], for reference see 3GPP TS 36.133, Rel. 17, Section 9.1.22.14. Values les…
Uarfcndl
integer
UTRAN Absolute Radio Frequency Downlink (UARFCN-DL)
Rsrp
integer
Reference Signal Received Power (RSRP) in dBm. Values less than -156dBm should be clamped to -156. Values greater than -44dBm should be clamped to -44. For ref…
TdscdmaLocalId
object
Local identification parameters of TD-SCDMA serving cell
2 properties
2 required
LteCatMLocalId
object
Local identification parameters of LTE Cat-M serving cell
2 properties
2 required
RxLevel
integer
Received Signal power (dBm). Values less than -110dBm should be clamped to -110. Values greater than -25dBm should be clamped to -25.
LteNmrArray
array
LTE network measurements
GsmCid
integer
GSM Cell Identifier (GERAN CID). See 3GPP TS 23.003 (V18.6.0), Section 4.3.1 for details.
AuthError
object
Error object reported in case of authentication or authorization errors.
2 properties
LteLocalId
object
Local identification parameters of LTE serving cell
2 properties
2 required
NrRsrp
integer
NR Reference Signal Received Power (SS-RSRP or CSI-RSRP) in dBm. For reference see 3GPP TS 38.215 and 3GPP TS 38.133, version 16.8.0, section 10.1.6. Value ran…
GsmNmrArray
array
GSM network measurements
TdscdmaNmr
object
TD-SCDMA network measurement
5 properties
2 required
PilotPower
integer
Pilot Power (dBm). If Pilot Power is not available directly, it needs to be calculated from Total Power in the band and Pilot Strength with respect to the Tota…
LteCatMNmrArray
array
LTE Cat-M network measurements
LteTimingAdvance
integer
Timing Advance. Expressed in the units of 16 Ts (16 Basic time units) = 16 / (15000 2048) seconds, which corresponds to ~ 156 meters. For reference see 3GPP TS…
TdscdmaCid
integer
TD-SCDMA Cell Identifier (UTRAN CID, UC-Id), 28 bits (12 bits RNC and 16 bits Cell ID). See 3GPP TS 25.331 (V18.0.0), Section 10.3.2.2 for details.
GsmTimingAdvance
integer
Timing advance (TA). Expressed in the units of GSM bits equaling to 48/13 μs ~ 1107 meters.
BaseLng
number
Base station longitude
Nr
object
NR (5G) standalone (NR SA) cell measurement
7 properties
3 required
Nrsrp
integer
Narrowband Reference Signal Received Power (NRSRP) in dBm. For reference see 3GPP TS 36.214 version 14.2.0 Rel. 14, section 5.1.26. Value range is [-156, -44],…
NrNmrArray
array
NR network measurements
NrPci
integer
NR Physical Cell Identity (NR PCI)
CdmaLocalId
object
Local identification parameters of CDMA serving cell
2 properties
2 required
Error
object
Object wrapper for the error response to a request.
7 properties
6 required
NrRsrq
integer
NR Reference Signal Received Quality (SS-RSRQ or CSI-RSRQ) in dB. For reference see 3GPP TS 38.133, version 16.8.0, section 10.1.11.1. Value range is [-43, 20]…
WcdmaNmrArray
array
WCDMA network measurements. Maximum of 8 distinct uarfcndl frequencies.
Bsid
integer
Base Station ID (CDMA BSID, BID)
Bcch
integer
Broadcast Control Channel (BCCH, synonymous to ARFCN = Absolute Radio Frequency Channel)
NbIot
object
NB-IoT cell measurement
9 properties
3 required
MccString
string
Mobile Country Code (MCC). Note: '0xx' is for test networks, '1xx' and '8xx' are not used.
LteNmr
object
LTE network measurement
5 properties
2 required
Longitude
number
Longitude in WGS-84 format, decimal representation ranging from -180 to 180.
NrTac
integer
NR Tracking Area Code (NR TAC)
The full machine-readable OpenAPI contract behind this narrative.
Other APIs HERE publishes across the network.
