Getting Started With The Atrius APIs


To get started using Atrius APIs, please follow this step-by-step guide.

Step 1 – Get a subscription key

All Atrius APIs require an approved subscription key to a specific API product. API Product subscription keys can be obtained from your licensed Atrius partner. Each subscription contains a Primary key and a Secondary key. You can use either key as the key value for the atr-subscription-key request header in calls to the API.

Step 2 – View the API Documentation

Now, you are ready to explore the APIs available to you! The Atrius API Portal provides both documentation that describes how to use the APIs and includes code samples in multiple languages. Additionally, the API Console allows you to directly interact with the API right here in the developer portal.


1.     Open the API Documentation, select a Product and then an API.

2.     Select an endpoint from the list.

3.     Review the information in the reference, including the:

·       Request URL

·       Request parameters

·       Request headers

·       Request body

·       Response codes

·       Sample JSON data

·       Code samples

Step 3 – Try it!

1.     From any operation in the endpoint reference, click Try it.

2.     Follow the prompts and enter values for the query parameters and headers

a.      Note: The Request URL and HTTP request change based on the values for the parameter and request header fields.

3.     Click Send to submit the request. The response includes a response status, latency, and content including JSON data for the requested endpoint.