Sign in
GNSS

GetAssistanceData

<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/agnss</code></p> <p><b>Device-to-cloud — authorize with a JSON Web Token.</b><br><code>https://api.location.nrfcloud.com/v1/location/agnss</code></p> </div>

Provides assistance data to the device. Enables a faster time-to-first-fix (TTFF) for the GNSS modem. Returns the modem parameters for the nRF GNSS modem in a chunk. The chunk size is determined by the request Range header. See GetAssistanceDataSize endpoint for details.

Basic Request:

curl -X POST "$API_HOST/v1/location/agnss" -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" -H "Accept: application/octet-stream" -H "Range: bytes=0-2200" --output assistance.bin

Custom Request:

curl -X POST "$API_HOST/v1/location/agnss" -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" -H "Accept: application/octet-stream" -H "Range: bytes=0-2200" --output assistance.bin -d "{\"types\": [8], \"mcc\": 244, \"mnc\": 91, \"tac\": 4099, \"eci\": 36078631}"

Type definitions:

  • 1 = GPS UTC
  • 2 = GPS Ephemerides
  • 3 = GPS Almanac
  • 4 = Klobuchar Ionospheric Correction
  • 5 = Nequick Ionospheric Correction
  • 6 = GPS Time of Week
  • 7 = GPS System Clock
  • 8 = Location (lat/lon of cell)
  • 9 = GPS Integrity
  • 11 = QZSS Almanac
  • 12 = QZSS Ephemerides
  • 13 = QZSS Integrity
post/location/agnss

Headers

rangestring
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

Request body

typesNrfMessageType[]

Type of assistance data (see description above). Defaults to [1, 2, 3, 4, 6, 7, 9]

mccinteger

Mobile Country Code. As defined in <a href="https://www.itu.int/dms_pub/itu-t/opb/sp/T-SP-E.212B-2018-PDF-E.pdf" target="_blank">ITU-T E.212</a>.

tacinteger

Tracking Area Code (TAC). Identifies a group of LTE cells in a certain region (Tracking Area). See <a href="https://www.etsi.org/deliver/etsi_ts/123000_123099/123003/17.09.00_60/ts_123003v170900p.pdf" target="_blank">ETSI TS 123 003, section 19.4.2.3</a> for more details.

eciinteger

E-UTRA Cell Identifier (ECI), 28 bits (20 bits eNodeB and 8 bits Cell ID). Calculated using "(eNodeB-ID * 256) + Sector-ID". Range 0 .. 268435455. See <a href="https://www.etsi.org/deliver/etsi_ts/123000_123099/123003/17.09.00_60/ts_123003v170900p.pdf" target="_blank">ETSI TS 123 003, section 19.6</a> for more details.

rsrpnumber double

Reference Signal Received Power. Measured in dBm. See <a href="https://www.rfwireless-world.com/Terminology/LTE-RSRP-vs-RSRQ.html" target="_blank">this page</a> for more details. Range -157..-44

filteredboolean

Send this flag if you want to receive ephemeris for only satellites in view. nRF Cloud will return ephemeris for up to 16 satellites. Cell data (eci, mcc, mnc, tac) is required. Defaults to false.

masknumber double

Filtered ephemeris mask angle. Only works in conjunction with the filtered flag. Controls the mask angle for which the satellites are filtered. Range 0..90 Defaults to 5

Example request

{
  "mcc": 310,
  "tac": 13601,
  "eci": 167899669,
  "rsrp": -90,
  "filtered": true,
  "mask": 5
}

Response

Contains chunk of file defined by the Range header.

string byte required

Chunk of the file according to the request Range header.

Example response

"<Buffer>"

Changes

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