Getting Started

The Geo Suite REST APIs provide a variety of location based services supporting a wide range of devices and applications. The APIs are designed for multiple platforms including web, mobile, and low-power/low-bandwidth IoT devices. Each API has documentation and a test page.

All APIs return a standard HTTP status code to indicate success or error. The Status Codes are documented below. The APIs return results in JSON format.

All APIs require an API Key parameter (APIKEY) as part of the request. The APIKEY identifies your application to our system. For developer accounts, each APIKEY is limited to a certain number of transactions per month depending on the API being called. You can request your own APIKEY by completing and submitting the Request API Key form.

Status Codes

Code Description

200

OK

204

The request was processed but there was not any data available.

400

Bad Request. Please check your request with the associated documentation and try again.

401

Access denied. Please use a valid api_key.

403

Access forbidden. Please speak with your administrator about availability of the resource for which you received this error.

404

The requested resource does not exist.

500

Internal Server Error. Please contact your administrator with the complete error message so that our team can investigate.

501

Not Implemented. The server does not support the map provider used for the request.

504

Service Timeout.

Getting Started

The Geo Suite REST APIs provide a variety of location based services supporting a wide range of devices and applications. The APIs are designed for multiple platforms including web, mobile, and low-power/low-bandwidth IoT devices. Each API has documentation and a test page.

All APIs return a standard HTTP status code to indicate success or error. The Status Codes are documented below. The APIs return results in JSON format.

All APIs require an API Key parameter (APIKEY) as part of the request. The APIKEY identifies your application to our system. For developer accounts, each APIKEY is limited to a certain number of transactions per month depending on the API being called. You can request your own APIKEY by completing and submitting the Request API Key form.

Status Codes

Code Description

200

OK

204

The request was processed but there was not any data available.

400

Bad Request. Please check your request with the associated documentation and try again.

401

Access denied. Please use a valid api_key.

403

Access forbidden. Please speak with your administrator about availability of the resource for which you received this error.

404

The requested resource does not exist.

500

Internal Server Error. Please contact your administrator with the complete error message so that our team can investigate.

501

Not Implemented. The server does not support the map provider used for the request.

504

Service Timeout.