Welcome to the Alpine IQ REST API
To get started developing on the AIQ system you will need to obtain an API key and authorize your first request.
- Login to the AIQ customer portal
- Navigate to "Settings" in the left nav bar
- Click on "API" in the tab options on the top of the settings page
- Copy your API key via the input field
Unhide your key by clicking the "EYE" icon within the input field
Warning related to regenerating keys
Your key needs to be regenerated if the user that created it resets their password, as it will also invalidate the API key.
If you would like a sandbox account, please reach out to our support team for approval. Once you have your API key you will be ready to call our endpoints.
API limits: 2 – second, 20 – minute, 200 – hour
It is required to pass your "Unique user ID" to each endpoint. In the screenshot above you will see "Your UID for requests is: 1". Your user ID will be listed here:
It is required to to pass your API key as header "X-APIKEY" for all requests