Documentation Index
Fetch the complete documentation index at: https://docs.hit.com/llms.txt
Use this file to discover all available pages before exploring further.
The API Reference is organized by endpoint family. It lists bot-facing paths, parameters, request bodies, response schemas, and WebSocket payloads. For workflow explanations and code examples, use the Developers guides.
Base URLs
| Surface | Type | Base URL |
|---|
| REST API | HTTPS | https://hit.com/api/v1 |
| WebSocket | Socket.IO | wss://markets.hit.com |
Auth Labels
| Label | Type | Description |
|---|
| Public | unauthenticated | No credentials are required. |
| API key HMAC | signed headers | Trading API key headers: hit-api-key, hit-signature, hit-timestamp, and hit-passphrase. |
Sections
| Section | Type | Contents |
|---|
| Authentication | REST and Socket.IO | API key headers and WebSocket auth payload |
| Events | REST | Event discovery and event volume |
| Markets | REST | Market lookup, market volume, and public activity |
| Prices | REST | Order books, last trade price, price history, and spreads |
| Orders | REST | Create, list, and cancel orders |
| Portfolio | REST | User positions, portfolio value, and account activity |
| Resolution | REST | Market resolution status |
| WebSockets | Socket.IO | Namespaces, client messages, and server events |
Pagination<T>.
| Field | Type | Required | Description |
|---|
first | integer | Yes | One-based index of the first item on the current page. |
last | integer | Yes | One-based index of the last item on the current page. |
limit | integer | Yes | Maximum items returned on the current page. |
total | integer or null | Yes | Total item count when requested with total=true; otherwise null on endpoints that support skipping totals. |
data | T[] | Yes | Page items. |
| Field | Type | Required | Description |
|---|
page | integer | Yes | Current page number. |
limit | integer | Yes | Maximum items returned on the current page. |
total | integer or null | Yes | Total item count when requested. |
pageCount | integer or null | Yes | Total page count when total is available. |
data | T[] | Yes | Page items. |
Errors
Errors use standard HTTP status codes with a JSON body when a message is available.
| Field | Type | Required | Description |
|---|
statusCode | integer | No | HTTP status code. |
message | string or string[] | Yes | Error message or validation messages. |
error | string | No | HTTP error label. |
