Introduction
How to get started with HTS API
Base URL
The HTS API is built on REST principles. We enforce HTTPS in every request to improve data security, integrity, and privacy. The API does not support HTTP.
All requests should contain the following base URL (v1):
You’ll need an account and API key to get started. From your account dashboard, you can monitor usage and setup integrations.
Authentication
To authenticate you need to add an Authorization header with the contents of the header being Bearer ABC123
where ABC123
is your API Key.
Response Codes
HTS API uses standard HTTP codes to indicate the success or failure of your requests.
In general, 2xx
HTTP codes correspond to success, 4xx
codes are for user-related failures, and 5xx
codes are for infrastructure issues.
Rate limit
The response headers describe your current rate limit following every request. Contact our team to adjust rate limits based on your usage.