Skip to main content

Outcome Balances REST API Endpoint

Returns a user's quote, yes, and no balances for a HIP-4 prediction market outcome.

Updated on
Jun 29, 2026
info

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

user
string
REQUIRED

User address (0x...) to query balances for

outcome
string
REQUIRED

Outcome identifier to query

Returns

user
string

User address being queried (0x-prefixed hex string)

outcome
integer

Outcome identifier being queried (e.g. 10)

quote
object

Quote token balance for the user

token
string

Quote token symbol (e.g. "USDH")

total
string

Quote token balance as a stringified number (e.g. "0.00388614")

yes
object

Balance of the yes side of the outcome

market
object

Market alias details for the yes side

side
integer

Side index (0 for the yes side)

name
string

Side name (e.g. "Yes")

coin
string

Coin alias for the yes side (e.g. "#100")

token
string

Token alias for the yes side (e.g. "+100")

assetId
integer

Native asset index for the yes side (e.g. 100000100)

encoding
integer

Encoding value for the yes side (e.g. 100)

total
string

Balance of the yes side as a stringified number

no
object

Balance of the no side of the outcome

market
object

Market alias details for the no side

side
integer

Side index (1 for the no side)

name
string

Side name (e.g. "No")

coin
string

Coin alias for the no side (e.g. "#101")

token
string

Token alias for the no side (e.g. "+101")

assetId
integer

Native asset index for the no side (e.g. 100000101)

encoding
integer

Encoding value for the no side (e.g. 101)

total
string

Balance of the no side as a stringified number

actions
object

Outcome action types available for this outcome

split
object

Outcome split action template

type
string

Action type ("outcomeSplit")

outcome
integer

Outcome identifier for the action

amount
string

Amount in USDH as a stringified number

merge
object

Outcome merge action template

type
string

Action type ("outcomeMerge")

outcome
integer

Outcome identifier for the action

amount
string

Amount in USDH as a stringified number. Null or omitted means the maximum available amount.

Request
Don't have an account yet?
Create your Quicknode endpoint in seconds and start building
Get started for free