hyper_ methods
Params are a JSON object (or an array whose first item is that object). Every answer has the same envelope:
{ "data": { ... }, "hypercoreTime": 1793379658284, "servedAt": 1793379658517, "cached": false,
"proof": { "alg": "ed25519", "digest": "<sha256 hex>", "signer": "<base58>", "signature": "<base58>" } }hypercoreTime is the time HyperCore put on the data (the book time, the vault's last point) or, when the info API gives none, the HTTP date of HyperCore's answer. Answers are cached for 0.5 s (books) to 60 s (dex list).
hyper_getBook
Order book (L2) of a HyperCore perp or spot market, up to 20 levels a side.
| Param | Type | Notes |
|---|---|---|
coin (required) | string | Market, for example BTC, ETH, or a HIP-3 market like xyz:AAPL |
depth | number | Levels a side, 1 to 20 |
nSigFigs | number | Price aggregation, 2 to 5 |
{"jsonrpc":"2.0","id":1,"method":"hyper_getBook","params":{"coin":"BTC","depth":5}}hyper_getMarkPrice
Mark, oracle and mid price of one or more HyperCore perps.
| Param | Type | Notes |
|---|---|---|
coin | string | Market; omit for every market |
dex | string | HIP-3 dex name; omit for the main perp dex |
{"jsonrpc":"2.0","id":1,"method":"hyper_getMarkPrice","params":{"coin":"ETH"}}hyper_getFunding
Current hourly funding, premium, open interest and the funding history of a perp.
| Param | Type | Notes |
|---|---|---|
coin (required) | string | |
hours | number | History length, 1 to 168 |
dex | string |
{"jsonrpc":"2.0","id":1,"method":"hyper_getFunding","params":{"coin":"SOL","hours":24}}hyper_getPosition
Account value, margin and open positions of a HyperCore address.
| Param | Type | Notes |
|---|---|---|
user (required) | string | 0x address on HyperCore |
dex | string |
{"jsonrpc":"2.0","id":1,"method":"hyper_getPosition","params":{"user":"0xdfc24b077bc1425ad1dea75bcb6f8158e10df303"}}hyper_getLiquidations
Liquidation fills: the backstop liquidations taken by the HLP liquidator, or the liquidations of one address.
| Param | Type | Notes |
|---|---|---|
user | string | 0x address; omit for backstop liquidations |
limit | number |
{"jsonrpc":"2.0","id":1,"method":"hyper_getLiquidations","params":{"limit":5}}hyper_getOutcome
HIP-4 outcome markets: the outcome list, one outcome by id, or a text search.
| Param | Type | Notes |
|---|---|---|
outcome | number | |
query | string | |
limit | number |
{"jsonrpc":"2.0","id":1,"method":"hyper_getOutcome","params":{"query":"BTC","limit":5}}hyper_getVault
A HyperCore vault: account value, APR, day PnL, followers. Defaults to HLP.
| Param | Type | Notes |
|---|---|---|
vault | string | 0x vault address |
{"jsonrpc":"2.0","id":1,"method":"hyper_getVault","params":{"vault":"0xdfc24b077bc1425ad1dea75bcb6f8158e10df303"}}hyper_getHip3Dexs
Every HIP-3 builder-deployed perp dex: name, deployer, fee recipient, market count.
{"jsonrpc":"2.0","id":1,"method":"hyper_getHip3Dexs","params":{}}hyper_getLiquidations without a user reads the fills of the HLP liquidator, which takes backstop liquidations only; liquidations that clear on the book show up per address with user.