Common APIs

These API endpoints cover APIs which might be used both with the Modem Service and Gelolocation Service API.

Full Almanac Image

GET /api/v1/almanac/full

LoRa Edge™ devices require a list of coarse orbital parameters for GNSS constellations: the Almanac. The quality of the orbital parameters degrades over time. Therefore, updates of the Almanac image inside the device are necessary. The update period depends on the application’s requirements with respect to downlink capacity and energy efficiency.

This API serves full Almanac images on a bi-weekly basis.

Query Parameters

• toa (integer) – Optional. TOA (time of almanac) in GPST. If present, returns the almanac that was served at the specified time. Warning: The use of old almanacs is not recommended except for testing purposes. The TOA parameter is an experimental feature without any guarantees. When in doubt, don’t use it.

Request Headers

• Accept – application/json

• Authorization – Required. Access token

Response:

Status Codes

• 200 OK – OK

• 401 Unauthorized – Authentication failed :statuscode 429: Rate limit exceeded

Response Headers

• Content-Type – ‘application/json’

Response JSON:

{
  "almanac_image": STRING,  // Required. Base64-encoded string containing current Almanac image
  "this_gpst":     INT,     // Required. Time at which the Almanac parameters are valid in GPST
  "backoff":       INT,     // Required. Backoff in seconds until the next update of the Almanac image can be expected
}

• almanac_image: Required. Base64-encoded string containing current Almanac image. The device-level SPI API expects this binary image in the Almanac load command payload.

• this_gpst: Required. Time at which the Almanac parameters are valid in GPST

• backoff: Required. Backoff, in seconds, until the next update of the Almanac image can be expected.