Datastreams
We deliver data via Kafka streams that:
- Offer the lowest possible latency
- Are as close to the datasource as possible
Topic Name | Description |
---|---|
blocks | Block metadata |
transactions | Block Transaction data |
trades | Includes both the seller and the buyer in the same record. Missing some fields when compared to fills. |
fills | One record for the seller and one record for the buyer. When you have both, you have the trade. It includes extra fields when compared to the trade topic. |
trade_fills | It is essentially the trade record with the fills, as extra fields. However it might not always includes all the fills, due to it being on an old system which is subject to rate limits from Hyperliquid. |
orders | Real-time order data with status changes. Complete visibility as orders progress through their lifecycle. |
misc_events | User events in hyperliquid, including - Funding fees - Backstop liquidations by the HLP Vault - Vault deposits and withdrawals - Transfers - Validator actions and rewards |
Example connecting to a Kafka Topic
Example Data for each Topic
Blocks
Transactions
Here is a list of the available transaction types.
This list could change as Hyperliquid adds more types.
”CSignerAction" |
---|
"CValidatorAction" |
"NetChildVaultPositionsAction" |
"PerpDexClassTransfer" |
"SetGlobalAction" |
"SystemSpotSendAction" |
"ValidatorSignWithdrawalAction" |
"VoteEthDepositAction" |
"VoteEthFinalizedWithdrawalAction" |
"VoteGlobalAction" |
"approveAgent" |
"approveBuilderFee" |
"batchModify" |
"cDeposit" |
"cWithdraw" |
"cancel" |
"cancelByCloid" |
"claimRewards" |
"convertToMultiSigUser" |
"createSubAccount" |
"createVault" |
"evmRawTx" |
"evmUserModify" |
"finalizeEvmContract" |
"linkStakingUser" |
"liquidate" |
"modify" |
"order" |
"registerReferrer" |
"reserveRequestWeight" |
"scheduleCancel" |
"setDisplayName" |
"setReferrer" |
"spotDeploy" |
"spotSend" |
"spotUser" |
"subAccountModify" |
"subAccountSpotTransfer" |
"subAccountTransfer" |
"tokenDelegate" |
"topUpIsolatedOnlyMargin" |
"twapCancel" |
"twapOrder" |
"updateIsolatedMargin" |
"updateLeverage" |
"usdClassTransfer" |
"usdSend" |
"vaultDistribute" |
"vaultModify" |
"vaultTransfer" |
"voteAppHash" |
"withdraw3” |
Cancel Order
a
is an index to an asset that is traded on Hyperliquid. Click through for more information on assets.
Trades
Contains data from both sides of a trade
Fills
Contains only one side of a trade, but with a lot more information than what is contained in the trades.
Fill
Liquidation Fill
Trade Fills
Trade fills is the trades topic enhanced with the fills.
However currently we are unable to always get all the fills for a trade.
If you absolutely require the fill, then it is better to use the fills topic which will always be complete.
Orders
Misc Events
Event Types
Type | Description | Where Clause |
---|---|---|
accountActivationGas | event:LedgerUpdate:delta:type = ‘accountActivationGas’ | |
accountClassTransfer | Moving from Perpetuals balance to Spot balance and vice versa | event:LedgerUpdate:delta:type = ‘accountClassTransfer’ |
deployGasAuction | event:LedgerUpdate:delta:type = ‘deployGasAuction’ | |
deposit | event:LedgerUpdate:delta:type = ‘deposit’ | |
internalTransfer | event:LedgerUpdate:delta:type = ‘internalTransfer’ | |
liquidation | event:LedgerUpdate:delta:type = ‘liquidation’ | |
rewardsClaim | event:LedgerUpdate:delta:type = ‘rewardsClaim’ | |
spotGenesis | event:LedgerUpdate:delta:type = ‘spotGenesis’ | |
spotTransfer | event:LedgerUpdate:delta:type = ‘spotTransfer’ | |
subAccountTransfer | event:LedgerUpdate:delta:type = ‘subAccountTransfer’ | |
vaultCreate | event:LedgerUpdate:delta:type = ‘vaultCreate’ | |
vaultDeposit | event:LedgerUpdate:delta:type = ‘vaultDeposit’ | |
vaultDistribution | event:LedgerUpdate:delta:type = ‘vaultDistribution’ | |
vaultLeaderCommission | event:LedgerUpdate:delta:type = ‘vaultLeaderCommission’ | |
vaultWithdraw | event:LedgerUpdate:delta:type = ‘vaultWithdraw’ | |
withdraw | event:LedgerUpdate:delta:type = ‘withdraw’ | |
CDeposit | Staking Deposit | event:CDeposit IS NOT NULL |
CWithdrawal | Staking Withdrawal | event:CWithdrawal IS NOT NULL |
Delegation | event:Delegation IS NOT NULL | |
Funding | Funding fee | event:Funding IS NOT NULL |
ValidatorRewards | event:ValidatorRewards IS NOT NULL |
AccountClassTransfer
Moving USDC from the Perpetuals balance to the Spot balance and the Spot balance to the Perpetuals balance.
VaultWithdraw
Funding
HLP Vault Liquidation