Skip to main content

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.

Hit WebSockets use Socket.IO.
NamespaceAuthUse
/PublicOrder book snapshots, price changes, event updates
/userAPI key HMACUser orders, trades, positions, balances, transactions
Base URL:
wss://markets.hit.com

Feed Examples

The market feed uses the public / namespace. Subscribe to order books by outcome token ID, and subscribe to event updates by event UUID.
import { io } from "socket.io-client";

const tokenIds = [process.env.HIT_TOKEN_ID!];
const eventId = process.env.HIT_EVENT_ID;

const socket = io("wss://markets.hit.com/", {
  transports: ["websocket"],
});

socket.on("connect", () => {
  socket.emit("orderbook-market-connect", tokenIds);

  if (eventId) {
    socket.emit("event-connect", eventId);
  }
});

socket.on("orderbook", (data: unknown) => {
  console.log("snapshot", data);
});

socket.on("orderbook-price-change", (data: unknown) => {
  console.log("delta", data);
});

socket.on("orderbook-error", (data: unknown) => {
  console.error("order book error", data);
});

socket.on("event-onchain-update", (data: unknown) => {
  console.log("event update", data);
});

function unsubscribe() {
  socket.emit("orderbook-market-disconnect", tokenIds);

  if (eventId) {
    socket.emit("event-disconnect", eventId);
  }
}

Events

Public events:
EventDirectionPayload
pingClient to server{}
pongServer to client{}
orderbook-market-connectClient to serverArray of token IDs
orderbook-market-disconnectClient to serverArray of token IDs
orderbookServer to clientOrder book snapshot
orderbook-price-changeServer to clientPrice level changes
orderbook-errorServer to clientSnapshot or stream error
event-connectClient to serverEvent UUID
event-disconnectClient to serverEvent UUID
event-onchain-updateServer to clientMarket or event status update
tick-size-changeServer to clientTick size update
User events:
EventDirectionPayload
user-connectClient to serverAPI key auth payload
user-authenticatedServer to client{ "success": boolean, "error"?: string }
user-disconnectClient to serverNo payload
initial-dataClient to serverNo payload
initial-shares-by-marketClient to serverMarket UUID
shares-by-market-disconnectClient to serverNo payload
user-orderServer to clientUser order update
user-tradeServer to clientUser trade update
user-positions-updateServer to clientPosition update
collateral-balanceServer to clientProxy wallet collateral balance
collateral-balance-eoaServer to clientEOA collateral balance
transactionServer to clientTransaction update
user-mp-updateServer to clientRewards update
user-mp-claim-updateServer to clientRewards claim update
order-speed-bump-pendingServer to clientOrder delayed before matching