Positioning API Developer's Guide

/locate

Summary:


      {POST} 
      https://pos.cit.api.here.com/positioning/v1/locate?{parameters}
     

Method: POST

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

Consumes:
application/json
Produces:
application/json

Parameters

[Required:]

app_code

A 20-byte Base64 URL-safe encoded string used for the authentication of the client application.

Parameter definition fields:

in : query
required : True
type : string
app_id

A 20-byte Base64 URL-safe encoded string used for the authentication of the client application.

Parameter definition fields:

in : query
required : True
type : string
locationRequest

Request body containing cell and/or WiFi measurement data

Parameter definition fields:

in : body
required : True
schema : see location_request

[Optional:]

confidence

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.

Parameter definition fields:

in : query
required : False
type : integer [min: 50, max: 99]
desired

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'.

Parameter definition fields:

in : query
required : False
type : string
fallback

Acceptable fallback level for cell based positioning. Use the default setting to accept cell tower level location estimates only. If you allow a WGS-84 compliant geocoordinate location estimate based on LAC, RNC, TAC, NID, or RZ areas, use the fallback=area setting. If you use the fallback=any setting, the service uses all available fallback methods and therefore the location estimate in the response may be at the MNC, SID, or MCC level. This parameter has no effect on WiFi based positioning. If the request contains both cell and WiFi measurements, this parameter has effect only in case no WiFi based position is found.

Parameter definition fields:

in : query
type : string
required

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'.

Parameter definition fields:

in : query
required : False
type : string

Responses

200

Request processed successfully and a WGS-84 compliant geocoordinate location estimate was included in the response.

Body

Body definition, see location_response

400

The request is malformed. Check the message in the response for additional troubleshooting information. The URL query parameters or the JSON POST body in the request is invalid.

Body

Body definition, see error_response

401

Authentication has failed due to incorrect credentials. Check your app_id and app_code.

Body

Body definition, see error_response

403

Authorization has failed. Access is not allowed with the app_id and app_code you provided.

Body

Body definition, see error_response

404

The values provided in the request cannot produce any content for the response. The location of the WLANs and cells in the request is unknown or the locations of the radio measurements are so widely scattered that the location cannot be determined. Make sure that the network measurements are correct and consistent. Try allowing fallbacks (area or any) for cell positioning.

Body

Body definition, see error_response

500

An unexpected server error has occurred, try again later.

Body

Body definition, see error_response

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on selfservesupport@here.com.