Location API (1.0)

Download OpenAPI specification:Download

Overview

Submit device locations to Localz.

URLs

The base URL will differ depending on the region you are connecting to:

Region Host
Australia https://api-au.localz.io
Europe https://api-eu.localz.io
United States https://api-us.localz.io

Authentication

All API endpoints require apikey HTTP header, that gives you access to your Localz project.

ApiKeyAuth

Security Scheme Type API Key
Header parameter name: apikey

Submit Location

Submit Location

Submit a single device location

Authorizations:
path Parameters
projectId
required
string

Project ID

Request Body schema: application/json

Location

deviceId
required
string

Some identifier for the device - can be GUID/UUID etc.

eventDateTime
required
string

Timestamp for the device location in ISO 8601 format

required
object (request.geoJSON)

Responses

Request samples

Content type
application/json
{
  • "deviceId": "string",
  • "eventDateTime": "2020-10-04T23:45:01+00:00",
  • "geoJson": {
    }
}

Response samples

Content type
application/json
{ }

Submit Location Batch

Submit a batch of locations for different devices

Authorizations:
path Parameters
projectId
required
string

Project ID

Request Body schema: application/json

Locations

required
Array of objects (request.Location)

Responses

Request samples

Content type
application/json
{
  • "locations": [
    ]
}

Response samples

Content type
application/json
{ }