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.

​
List Orders

GET /api/v1/orders
Authentication: API key HMAC Query parameters:
QueryTypeRequiredDescription
marketUUID stringNoMarket UUID.
statusenum stringNoPENDING, EXECUTING, EXECUTED, CANCELLED, or REJECTED.
makeraddress stringNoMaker address.
marketNamestringNoCase-insensitive partial market name.
sortByenum stringNocreated_at, total, amount, or filled. Default created_at.
orderenum stringNoASC or DESC. Default DESC.
Response type: Order[].

​
List Orders Paginated

GET /api/v1/orders/paginated
Authentication: API key HMAC Query parameters:
QueryTypeRequiredDescription
marketUUID stringNoMarket UUID.
statusenum stringNoPENDING, EXECUTING, EXECUTED, CANCELLED, or REJECTED.
makeraddress stringNoMaker address.
marketNamestringNoCase-insensitive partial market name.
pageintegerNoPage number. Default 1.
limitintegerNoResults per page. Default 30.
sortByenum stringNocreated_at, total, amount, or filled. Default created_at.
orderenum stringNoASC or DESC. Default DESC.
Response type: Pagination<Order>.

​
Get Order

GET /api/v1/orders/{id}
Authentication: API key HMAC Path parameters:
ParameterTypeRequiredDescription
idUUID stringYesOrder UUID.
Response type: Order.

​
Create Order

POST /api/v1/orders
Authentication: API key HMAC Request body type: CreateOrder.
FieldTypeRequiredDescription
saltstringYesUnique uint256 numeric string. Max 78 characters.
takeraddress stringYesTaker address. Use the zero address for open GTC maker orders.
tokenIdstringYesOutcome token ID as a numeric string. Max 78 characters.
makerAmountstringYesPositive integer string in base units. Max 78 characters.
takerAmountstringYesPositive integer string in base units. Max 78 characters.
expirationintegerYesUnix timestamp in seconds, or 0.
feeRateBpsintegerNoFee rate in basis points. Range 0 to 10000.
sideintegerYes0 buy, 1 sell.
signaturestringNoClient-side EIP-712 order signature.
orderTypeenum stringYesGTC, FOK, or FAK.
priceUintstringNoServer-compatible price integer.
Response type: Order.

​
Create Batch Orders

POST /api/v1/orders/batch
Authentication: API key HMAC Request body:
FieldTypeRequiredDescription
ordersCreateOrder[]YesOrders to create. Minimum 1, maximum 50.
Response type: CreateBatchOrdersResponse.
FieldTypeRequiredDescription
resultsBatchOrderResult[]YesPer-order results in request order.
BatchOrderResult:
FieldTypeRequiredDescription
indexintegerYesIndex of the order in the submitted batch.
successbooleanYesWhether that order was created.
orderIdUUID stringNoCreated order UUID when successful.
errorstringNoError message when unsuccessful.

​
Cancel Order

POST /api/v1/orders/{id}/cancel
Authentication: API key HMAC Path parameters:
ParameterTypeRequiredDescription
idUUID stringYesOrder UUID.
Response type: Order.

​
Delete Order

DELETE /api/v1/orders/{id}
Authentication: API key HMAC Path parameters:
ParameterTypeRequiredDescription
idUUID stringYesOrder UUID.
Response type: DeleteOrderResponse.
FieldTypeRequiredDescription
successbooleanYesWhether the order was deleted.

​
Cancel Batch Orders

POST /api/v1/orders/batch-cancel
Authentication: API key HMAC Request body:
FieldTypeRequiredDescription
orderIdsUUID string[]YesOrder UUIDs to cancel. Minimum 1, maximum 50.
Response type: BatchCancelOrdersResponse.
FieldTypeRequiredDescription
resultsBatchCancelOrderResult[]YesPer-order cancellation results.
BatchCancelOrderResult:
FieldTypeRequiredDescription
orderIdUUID stringYesOrder UUID.
successbooleanYesWhether the order was cancelled.
errorstringNoError message when unsuccessful.

​
Cancel Market Orders

POST /api/v1/orders/cancel
Authentication: API key HMAC Request body:
FieldTypeRequiredDescription
marketUUID stringYesMarket UUID.
Response type: Order[].

​
Cancel All Orders

POST /api/v1/orders/cancel-all
Authentication: API key HMAC Response type: CancelAllOrdersResponse.
FieldTypeRequiredDescription
clearedMarketsUUID string[]YesMarket UUIDs with orders successfully cancelled.
failedMarketsUUID string[]NoMarket UUIDs that failed cancellation. Retry these.

​
Get Order Book Events

GET /api/v1/orders/events
Authentication: API key HMAC Query parameters:
QueryTypeRequiredDescription
pageintegerNoPage number. Default 1.
limitintegerNoResults per page. Default 30.
totalbooleanNoInclude total count. Default true.
Response type: Pagination<OrderbookEvent>.

​
Order

FieldTypeRequiredDescription
idUUID stringYesOrder UUID.
saltstringYesOrder salt.
makeraddress stringYesMaker address.
signeraddress stringYesSigner address.
takeraddress stringYesTaker address.
tokenIdstringYesOutcome token ID.
makerAmountnumberYesMaker amount in base units.
takerAmountnumberYesTaker amount in base units.
expirationintegerYesUnix timestamp in seconds, or 0.
nonceintegerYesMaker nonce.
feeRateBpsintegerYesFee rate in basis points.
sideintegerYes0 buy, 1 sell.
signatureTypeintegerYesSignature type.
signaturestringYesEIP-712 signature.
marketUUID stringYesMarket UUID.
orderTypeenum stringYesGTC, FOK, or FAK.
ownerUUID stringYesHit user ID that owns the order.
outcomestringYesOutcome label.
statusenum stringYesPENDING, EXECUTING, EXECUTED, CANCELLED, or REJECTED.
createdAtstring (date-time)YesCreation timestamp.
amountnumberYesOrder size in display units.
pricenumberYesLimit price.
matchedAmountnumberYesFilled amount in display units.
hashstringYesOrder hash.
priceUintstringYesInteger price representation.
metadataobjectNoAdditional order metadata.

​
OrderbookEvent

FieldTypeRequiredDescription
idUUID stringNoEvent UUID.
namestringNoEvent name.
slugstringNoEvent slug.
createdAtstring (date-time)NoCreation timestamp.
startDatestring (date-time)NoEvent start timestamp.
endDatestring (date-time)NoEvent end timestamp.
singlebooleanNoWhether the event has one market.
marketsViewOrderbookEventMarket[]NoActive orderbook markets for the event.
OrderbookEventMarket:
FieldTypeRequiredDescription
idUUID stringNoMarket UUID.
namestringYesMarket name.
tokenId1stringYesOutcome 1 token ID.
tokenId2stringYesOutcome 2 token ID.
outcome1stringYesOutcome 1 label.
outcome2stringYesOutcome 2 label.
orderFeeRateBpsintegerYesActive order fee rate in basis points.
passiveOrderFeeRateBpsintegerYesPassive order fee rate in basis points.