Exchange API calls do not consume Quicknode API credits. If you are on a free trial plan, see hyperliquidapi.com for your URL and fee schedule. To white-label with your own builder code, contact us.
Query Parameters
- userstringREQUIRED
User address (0x...) to query balances for
- outcomestringREQUIRED
Outcome identifier to query
Returns
- userstring
User address being queried (0x-prefixed hex string)
- outcomeinteger
Outcome identifier being queried (e.g. 10)
- quoteobject
Quote token balance for the user
- tokenstring
Quote token symbol (e.g. "USDH")
- totalstring
Quote token balance as a stringified number (e.g. "0.00388614")
- yesobject
Balance of the yes side of the outcome
- marketobject
Market alias details for the yes side
- sideinteger
Side index (0 for the yes side)
- namestring
Side name (e.g. "Yes")
- coinstring
Coin alias for the yes side (e.g. "#100")
- tokenstring
Token alias for the yes side (e.g. "+100")
- assetIdinteger
Native asset index for the yes side (e.g. 100000100)
- encodinginteger
Encoding value for the yes side (e.g. 100)
- totalstring
Balance of the yes side as a stringified number
- noobject
Balance of the no side of the outcome
- marketobject
Market alias details for the no side
- sideinteger
Side index (1 for the no side)
- namestring
Side name (e.g. "No")
- coinstring
Coin alias for the no side (e.g. "#101")
- tokenstring
Token alias for the no side (e.g. "+101")
- assetIdinteger
Native asset index for the no side (e.g. 100000101)
- encodinginteger
Encoding value for the no side (e.g. 101)
- totalstring
Balance of the no side as a stringified number
- actionsobject
Outcome action types available for this outcome
- splitobject
Outcome split action template
- typestring
Action type ("outcomeSplit")
- outcomeinteger
Outcome identifier for the action
- amountstring
Amount in USDH as a stringified number
- mergeobject
Outcome merge action template
- typestring
Action type ("outcomeMerge")
- outcomeinteger
Outcome identifier for the action
- amountstring
Amount in USDH as a stringified number. Null or omitted means the maximum available amount.