Skip to main content
Skip table of contents

NSnappy 3rd party REST API

1. Overview

NSnappy offers a 3rd party REST API for our clients to integrate at a system level. Currently, this API can be used to retrieve data from the measurement devices and gateways connected to NSnappy. New capabilities can be added to this API in future.

Please, ask your NSnappy representative for a quote on 3rd party REST API access.

2. Getting started

  1. Create a new user account that will be used to access the REST API.

  2. Set the access privileges of this API user as required.

  3. Ask Nokeval to create an API access key for this user.

  4. Nokeval will securely send the API access key.

  5. Study the API documentation.

  6. Plan, implement and test your integration.

3. API documentation

Ask your NSnappy representative to send you the API documentation package as a ZIP file. When you receive the package, extract it to a folder on your computer. Open the extracted index.html file in your browser to read the documentation.

4. API usage

API usage is limited by a user specific usage plan. Default usage plan has the following usage limits:

  • Throttle: 10 queries per second

  • Burst: 2 queries

There is also a fixed upper limit for the API response size, which is 10 MB.

Response size limitation should be taken into account when planning the API query strategy. When planning the integration and queries, also note that the responses are in JSON format. Example of a JSON response from the API:

{"value":-1.79,"measured_at":"2026-03-12T07:31:38.000Z"},

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.