Authentication

To ensure secure access to the Companion API, authentication is required. This is accomplished through the use of API keys. To obtain an API key, please visit our Discord server and request one. All requests must include a valid X-Api-Key header.
It is important to note that the API keys for the Companion API are separate and distinct from those used for the Websocket API.

Base URL

All API requests should be made to:
https://api.blazemonitors.com

Status Codes

200 -> Successful Request 400 -> Bad Request 401 -> Unauthorized 403 -> Forbidden 404 -> Resource Not Found 429 -> Rate Limited Please note that invalid paths will return a 404 error, and incorrect X-Api-Key headers will result in a 401 or 403 error.

Rate Limit

All endpoints are rate-limited at 10 requests per second. Additional requests will receive a 429 status code until the limit is reset.

API Version

This documentation covers Companion API v2.0.0, which includes enhanced item management, affiliate link support, and configurable price/stock alerts.