Messages
{
"method": "<string>",
"params": {
"item": "<string>"
},
"id": 123
}{
"method": "<string>",
"params": {
"item": "<string>"
},
"id": 123
}{
"method": "<string>",
"id": 123
}{
"e": "<string>",
"E": 123,
"s": "<string>",
"a": 123,
"p": "<string>",
"q": "<string>",
"f": 123,
"l": 123,
"T": 123,
"m": true
}No examples found{
"e": "<string>",
"E": 123,
"s": "<string>",
"c": "<string>",
"o": "<string>",
"h": "<string>",
"l": "<string>",
"v": "<string>",
"q": "<string>"
}{
"e": "<string>",
"E": 123,
"s": "<string>",
"p": "<string>",
"P": "<string>",
"w": "<string>",
"c": "<string>",
"Q": "<string>",
"o": "<string>",
"h": "<string>",
"l": "<string>",
"v": "<string>",
"q": "<string>",
"O": 123,
"C": 123,
"F": 123,
"L": 123,
"n": 123
}{
"e": "<string>",
"u": 123,
"s": "<string>",
"b": "<string>",
"B": "<string>",
"a": "<string>",
"A": "<string>",
"T": 123,
"E": 123
}{
"e": "<string>",
"E": 123,
"s": "<string>",
"p": "<string>",
"i": "<string>",
"P": "<string>",
"r": "<string>",
"T": 123
}{}{
"e": "<string>",
"E": 123,
"s": "<string>",
"k": {
"t": 123,
"T": 123,
"s": "<string>",
"i": "<string>",
"f": 123,
"L": 123,
"o": "<string>",
"c": "<string>",
"h": "<string>",
"l": "<string>",
"v": "<string>",
"n": 123,
"x": true,
"q": "<string>",
"V": "<string>",
"Q": "<string>",
"B": "<string>"
}
}{
"e": "<string>",
"E": 123,
"o": {
"s": "<string>",
"S": "<string>",
"o": "<string>",
"f": "<string>",
"q": "<string>",
"p": "<string>",
"ap": "<string>",
"X": "<string>",
"l": "<string>",
"z": "<string>",
"T": 123
}
}{}{}{
"e": "<string>",
"u": 123,
"s": "<string>",
"b": "<string>",
"B": "<string>",
"a": "<string>",
"A": "<string>",
"T": 123,
"E": 123
}{
"e": "<string>",
"E": 123,
"o": {
"s": "<string>",
"S": "<string>",
"o": "<string>",
"f": "<string>",
"q": "<string>",
"p": "<string>",
"ap": "<string>",
"X": "<string>",
"l": "<string>",
"z": "<string>",
"T": 123
}
}No examples foundWebsockets
Market data
Market data streams with subscription management via SUBSCRIBE/UNSUBSCRIBE commands.
To use:
- Send SUBSCRIBE commands (publish) with stream names
- Receive stream data messages (subscribe)
Supported stream patterns for SUBSCRIBE:
- @aggTrade - Aggregate trades
- @depth - Order book updates
- @miniTicker - 24hr mini ticker
- @ticker - 24hr full ticker
- @bookTicker - Best bid/offer
- @markPrice - Mark price updates
- @kline_ - Candlestick data
- @forceOrder - Liquidation orders
- !miniTicker@arr - All mini tickers
- !ticker@arr - All tickers
- !bookTicker - All book tickers
- !markPrice@arr - All mark prices
- !forceOrder@arr - All liquidations
WSS
Documentation Index
Fetch the complete documentation index at: https://docs.hypereth.io/llms.txt
Use this file to discover all available pages before exploring further.
Messages
{
"method": "<string>",
"params": {
"item": "<string>"
},
"id": 123
}{
"method": "<string>",
"params": {
"item": "<string>"
},
"id": 123
}{
"method": "<string>",
"id": 123
}{
"e": "<string>",
"E": 123,
"s": "<string>",
"a": 123,
"p": "<string>",
"q": "<string>",
"f": 123,
"l": 123,
"T": 123,
"m": true
}No examples found{
"e": "<string>",
"E": 123,
"s": "<string>",
"c": "<string>",
"o": "<string>",
"h": "<string>",
"l": "<string>",
"v": "<string>",
"q": "<string>"
}{
"e": "<string>",
"E": 123,
"s": "<string>",
"p": "<string>",
"P": "<string>",
"w": "<string>",
"c": "<string>",
"Q": "<string>",
"o": "<string>",
"h": "<string>",
"l": "<string>",
"v": "<string>",
"q": "<string>",
"O": 123,
"C": 123,
"F": 123,
"L": 123,
"n": 123
}{
"e": "<string>",
"u": 123,
"s": "<string>",
"b": "<string>",
"B": "<string>",
"a": "<string>",
"A": "<string>",
"T": 123,
"E": 123
}{
"e": "<string>",
"E": 123,
"s": "<string>",
"p": "<string>",
"i": "<string>",
"P": "<string>",
"r": "<string>",
"T": 123
}{}{
"e": "<string>",
"E": 123,
"s": "<string>",
"k": {
"t": 123,
"T": 123,
"s": "<string>",
"i": "<string>",
"f": 123,
"L": 123,
"o": "<string>",
"c": "<string>",
"h": "<string>",
"l": "<string>",
"v": "<string>",
"n": 123,
"x": true,
"q": "<string>",
"V": "<string>",
"Q": "<string>",
"B": "<string>"
}
}{
"e": "<string>",
"E": 123,
"o": {
"s": "<string>",
"S": "<string>",
"o": "<string>",
"f": "<string>",
"q": "<string>",
"p": "<string>",
"ap": "<string>",
"X": "<string>",
"l": "<string>",
"z": "<string>",
"T": 123
}
}{}{}{
"e": "<string>",
"u": 123,
"s": "<string>",
"b": "<string>",
"B": "<string>",
"a": "<string>",
"A": "<string>",
"T": 123,
"E": 123
}{
"e": "<string>",
"E": 123,
"o": {
"s": "<string>",
"S": "<string>",
"o": "<string>",
"f": "<string>",
"q": "<string>",
"p": "<string>",
"ap": "<string>",
"X": "<string>",
"l": "<string>",
"z": "<string>",
"T": 123
}
}No examples foundSubscribe Request
type:object
Subscribe to one or more streams
Unsubscribe Request
type:object
Unsubscribe from one or more streams
List Subscriptions Request
type:object
Get list of current subscriptions
Aggregate Trade Stream Message
type:object
Real-time aggregate trade information received from stream
Order Book Depth Update Stream Message
type:object
Real-time order book depth updates received from stream
24hr Mini Ticker Stream Message
type:object
24hr rolling window mini ticker statistics received from stream
24hr Ticker Statistics Stream Message
type:object
24hr rolling window ticker statistics received from stream
Individual Symbol Book Ticker Stream Message
type:object
Best bid/ask price and quantity received from stream
Mark Price Stream Message
type:object
Mark price and funding rate updates received from stream
All Market Mark Price Stream Message
type:array
Mark price updates for all symbols received from stream
Kline/Candlestick Stream Message
type:object
Kline/candlestick bars for a symbol received from stream
Liquidation Order Stream Message
type:object
Liquidation order information received from stream
All Market Mini Tickers Stream Message
type:array
24hr rolling window mini ticker statistics for all symbols received from stream
All Market Tickers Stream Message
type:array
24hr rolling window ticker statistics for all symbols received from stream
All Book Tickers Stream Message
type:object
Best bid/ask price and quantity for all symbols received from stream
All Market Liquidation Orders Stream Message
type:object
Liquidation order information for all symbols received from stream
Partial Book Depth Stream Message
type:object
Top bids and asks received from stream
⌘I