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.
Get Markets by ID
Authentication: Public
Query parameters:
| Query | Type | Required | Description |
|---|
ids | string | No | Comma-separated market UUIDs. If omitted, returns an empty array. |
Market[].
Get Market
GET /api/v1/markets/{id_or_slug}
Public
Path parameters:
| Parameter | Type | Required | Description |
|---|
id_or_slug | UUID string or string | Yes | Market UUID or slug. |
Market.
Get Market Volume
GET /api/v1/markets/{marketId}/volume
Public
Path parameters:
| Parameter | Type | Required | Description |
|---|
marketId | UUID string | Yes | Market UUID. |
MarketVolume.
| Field | Type | Required | Description |
|---|
marketId | UUID string | Yes | Market UUID. |
eventId | UUID string | Yes | Parent event UUID. |
tradeVolumeUsd | string | Yes | All-time trade volume in USD. |
tradeVolumeUsd24h | string | No | 24-hour trade volume in USD. |
Get Market Users
GET /api/v1/markets/{id_or_slug}/users
Public
Path parameters:
| Parameter | Type | Required | Description |
|---|
id_or_slug | UUID string or string | Yes | Market UUID or slug. |
MarketUser[].
| Field | Type | Required | Description |
|---|
proxy_address | address string | Yes | User proxy wallet address. |
token_id_1 | string or null | No | First held token ID. |
amount_1 | string or number or null | No | Balance for token_id_1. |
token_id_2 | string or null | No | Second held token ID. |
amount_2 | string or number or null | No | Balance for token_id_2. |
Get Public Market Activity
GET /api/v1/markets/activity
Public
Query parameters:
| Query | Type | Required | Description |
|---|
type | enum string | No | BUY or SELL. |
name | string | No | Case-insensitive partial name filter. |
page | integer | No | Page number. Default 1. |
limit | integer | No | Results per page. Default 5. |
total | boolean | No | Include total count. Default true. |
sortBy | string | No | Sort field. Default usersactivityview.timestamp. |
order | enum string | No | ASC or DESC. Default DESC. |
Pagination<Activity>.
Get Public Activity for a Market
GET /api/v1/markets/activity/{marketId}
Public
Path parameters:
| Parameter | Type | Required | Description |
|---|
marketId | UUID string | Yes | Market UUID. |
| Query | Type | Required | Description |
|---|
proxyAddress | address string | No | Proxy wallet address filter. |
type | enum string | No | SPLIT, MERGE, or REDEEM. |
page | integer | No | Page number. Default 1. |
limit | integer | No | Results per page. Default 10. |
total | boolean | No | Include total count. Default true. |
sortBy | string | No | Sort field. Default usersactivityview.timestamp. |
order | enum string | No | ASC or DESC. Default DESC. |
Pagination<Activity>.
Market
| Field | Type | Required | Description |
|---|
id | UUID string | Yes | Market UUID. |
name | string | Yes | Market name. |
createdAt | string (date-time) | Yes | Creation timestamp. |
updatedAt | string (date-time) | Yes | Last update timestamp. |
chance | number | Yes | Current market chance. |
status | enum string | Yes | DRAFT, ACTIVE, or RESOLVED. |
icon | string | Yes | Market icon URL. |
tokenId1 | string | Yes | Outcome 1 token ID. |
tokenId2 | string | Yes | Outcome 2 token ID. |
ancillaryData | string | Yes | UMA ancillary data. |
isInitialized | boolean | Yes | Whether the market has been initialized. |
conditionId | string | Yes | Conditional Tokens condition ID. |
questionId | string | Yes | UMA question ID. |
outcome1 | string | Yes | Outcome 1 label. |
outcome2 | string | Yes | Outcome 2 label. |
orderFeeRateBps | integer | Yes | Active order fee rate in basis points. |
passiveOrderFeeRateBps | integer | Yes | Passive order fee rate in basis points. |
tickSize | string | Yes | Minimum price increment. |
speedBumpDelayMs | integer | Yes | Taker-order matching delay in milliseconds. |
firstPriceDataAt | string (date-time) or null | No | First price-history timestamp. |
hasProposedPrice | boolean | Yes | Whether a UMA price has been proposed. |
isDisputed | boolean | Yes | Whether the proposed price is disputed. |
isSettled | boolean | Yes | Whether the UMA request is settled. |
resolvedOnAdapterTimestamp | integer | Yes | Adapter resolution timestamp. |
isResolved | boolean | Yes | Whether the market is resolved. |
isRegistered | boolean | Yes | Whether the market is registered on chain. |
isPaused | boolean | Yes | Whether the market is paused. |
marketResolvedTo | string | Yes | Raw resolved outcome value. |
marketId | string | Yes | On-chain market ID. |
negRisk | boolean | Yes | Whether the market uses negative-risk resolution. |
questionFlaggedTimestamp | integer | Yes | Question-flagged timestamp. |
transactionHash | string | Yes | Creation or registration transaction hash. |
eventId | UUID string | Yes | Parent event UUID. |
questionIndex | integer or null | No | Question index for multi-market events. |
tradeVolumeUsd | string | No | All-time trade volume in USD. |
tradeVolumeUsd24h | string | No | 24-hour trade volume in USD. |
Activity
| Field | Type | Required | Description |
|---|
id | UUID string | Yes | Activity row UUID. |
name | string | Yes | Market or event name. |
slug | string | Yes | Event slug. |
description | string | Yes | Event description. |
createdAt | string (date-time) | Yes | Event creation timestamp. |
createdBy | UUID string | Yes | Event creator user ID. |
updatedAt | string (date-time) | Yes | Event update timestamp. |
startDate | string (date-time) | Yes | Event start timestamp. |
endDate | string (date-time) | Yes | Event end timestamp. |
protected | boolean | Yes | Whether the event is protected. |
icon | string | Yes | Icon URL. |
tokenId1 | string | Yes | Outcome 1 token ID. |
tokenId2 | string | Yes | Outcome 2 token ID. |
conditionId | string | Yes | Conditional Tokens condition ID. |
proxy_address | address string | Yes | User proxy wallet address. |
outcome1 | string | Yes | Outcome 1 label. |
outcome2 | string | Yes | Outcome 2 label. |
type | enum string | Yes | BUY, SELL, SPLIT, MERGE, or REDEEM. |
timestamp | integer | Yes | Activity timestamp in seconds. |
hash | string | Yes | Transaction hash. |
amount | number | Yes | Activity amount. |
parent_collection_id | string | Yes | Conditional Tokens parent collection ID. |
partition | integer[] | Yes | Conditional Tokens partition. |
isResolved | boolean | Yes | Whether the market is resolved. |
price | string | Yes | Activity price. |
fee | number | Yes | Fee amount. |
