Sign in
Predicted GPS

GetPredictedAssistanceData

<div class="nrf-note"> <p><b>Cloud-to-cloud — authorize with an Organization Auth Token.</b><br><code>https://api.location.nrfcloud.com/v1/organizations/{organizationSlug}/projects/{projectSlug}/location/pgps</code></p> <p><b>Device-to-cloud — authorize with a JSON Web Token.</b><br><code>https://api.location.nrfcloud.com/v1/location/pgps</code></p> </div> <div style="background-color: #f8d7da; color: #721c24; text-align: center; border: 1px solid #f5c6cb; border-radius: .25rem; padding: .75rem 1.25rem">This endpoint has been deprecated. Please use the <a href="#tag/GNSS/operation/GetPredictedAssistanceData">GNSS GetPredictionData endpoint</a> instead.</div>

Generates up to one week of gps predictions. The predictions are used by the nRF91 GPS modem to enable a faster time-to-first-fix (TTFF) and provide offline navigation when out of range of an LTE cell.

Returns a link for easy download of the predictions file.

Basic Request:

curl -G $API_HOST/v1/location/pgps -H "Authorization: Bearer $JWT" -H "Content-Type: application/json"

Custom Request:

curl -G $API_HOST/v1/location/pgps  -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" -d "predictionCount=42" -d "predictionIntervalMinutes=240" -d "startGpsDay=15131" -d "startGpsTimeOfDaySeconds=0"
get/location/pgps

Query parameters

predictionCountnumber double

The number of predictions requested. Default is 42 (7 days, 6 predictions per day). Valid range 1..42 The number of possible predictions depends on StartGpsDay and PredictionInterval

predictionIntervalMinutesnumber double

The time between predictions (in minutes). Defaults to 240 (4 hours). Valid value is: 240

startGpsDaynumber double

The start day of the prediction set as GPS Day (days since the GPS epoch). Defaults to current GPS day. Valid range currentGpsDay..currentGpsDay + 6.

Example:15131
startGpsTimeOfDaySecondsnumber double

The start time of the prediction set as seconds in day. Defaults to 0. Valid range 0..86399

Headers

x-custom-device-idstring

User-defined device ID, used to identify requests when using a cloud-to-cloud integration. Ignored if using a device token.

Example:my-device-12345

Response

Link to the P-GPS binary payload file for download.

pathstring required

The path to the file that contains PGNSS prediction data.

hoststring required

The protocol-agnostic URL for accessing PGNSS prediction files.

Example response

{
  "path": "public/15131-0_15135-72000.bin",
  "host": "pgnss.nrfcloud.com"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.