Device Location APIs

NOTE: There are new documentation pages that contains updated dynamic code generation & SDK downloads. You can access the new documents here.  

The Device Location API lets you find the location of IoT devices in an account. You can use a device’s location for many purposes, such as:

  • Verify that fixed assets are where they are supposed to be
  • Periodically track mobile assets, such as monitoring a fleet of moving trucks on an hourly basis
  • Plan efficient truck routes between devices that need service
  • Estimate the arrival time of a delivery

A device’s current location can be requested or the previous location of the device (from the cache). You can compare the current and cached locations to verify that a device has not moved or to see how far it has moved. Precise location can determine if the device is currently in motion.

You can exclude or include any devices in an account that you want to be located by the Device Location Service by granting or revoking consent. The default level of consent is “Coarse only allowed”. Precise location needs to be enabled and there is an option to enable both coarse and precise location (Using whichever one is available). Consent at the account level will be passed to subsequent devices onboarded. You can use the API with Open Development certified IoT devices (i.e routers, modems, vending machines with embedded modules, etc.) These APIs cannot be used with non-IoT devices such as Smartphones, Feature Phones, Tablets, Laptops and Netbooks. Some of the APIs require the devices to be certified to use the location service by the Verizon Open Development program.

If you are interested in using the Device Location API and want to learn about pricing and eligibility, please contact your organization’s Verizon Wireless account representative. If you do not have an account representative or are not sure who your representative is, please fill out the form located here (at the bottom of the page). It is very important that only a certified device is used with precise location. Your account representative or your support contact can help you with what devices have been certified to work with precise location.

Table of Contents

What’s new in the Device Location API

Getting Started

Introduction to the Device Location API
Get credentials to use the API
About the Location Information Format
About the Device Location Callback Service
About Aggregated Billing Service
About Current and Cached Data

Try the API

API Reference

Obtain device location
Update Device Location Consent
Obtain Current/Cached IoT Device Locations - synchronous (Coarse only)
Obtain Current/Cached IoT Device Locations - asynchronous
Create an IoT Device Location Report (Coarse only)
Retrieve a Device Location Report (Coarse only)
Get the Status of a Device Location Report (Coarse only)
Cancel a Device Location Report (Coarse only)
Periodic Device Location

Exclude devices from location services
Exclude Devices from Location Services
Get a List of Excluded Devices
Remove Devices from the Exclusion List

Manage subscription status and usage
Get Location Service subscription status
Get Location Service usage
Create a usage trigger
Get usage triggers
Change an existing usage trigger
Delete a usage trigger

Receive callback messages
Register a Callback Listener
Get Registered Callback Listeners
Deregister a Callback Listener

Aggregated billing services
Add Managed Billing Accounts
Activate Managed Service
Get Managed Account List
Cancel Managed Service

Your use of these APIs is governed by the ThingSpace terms and conditions. Please read them carefully.