API Basics

The API endpoints are based on REST, have standard HTTP response codes, and return JSON-encoded responses.

The following topics cover the fundamentals of using the API and key articles that demonstrate the GET /data method, querying time series data, and more.

Topics:

• API Tokens and Security - Explains how API tokens (keys) work and options for using signed certificates.
• Base URL - Start your REST endpoint calls with this URL.
• Time Series Data - Work with time series data that you can time-window via date indexes.
• Query Parameters - Simple parameter guidelines and some common utility parameters.
• HTTP Response Codes - HTTP codes returned by endpoints.
• Attribution - Requirements for acknowledging viaNexus Data Platform use.
• Disclaimers - Important notes on viaNexus Platform Data and related messages you must display.
• Streaming - Setup guide for streaming data via websockets from supported datasets.