Perpetuals
One perpetual contract observation, with funding, open interest and market price.
One row is
One perpetual contract observation, with funding, open interest and market price
Example response
Trimmed real output. No key needed.
GET /v1/datasets/perps/sample
Dates reflect the example, not current coverage.
{
"data": {
"rows": [
{
"marketId": "hyperliquid:default:ETH",
"venue": "hyperliquid",
"dex": "default",
"symbol": "ETH",
"baseAsset": "ETH",
"displayName": "ETH",
"assetClass": "crypto",
"underlyingSymbol": null,
"underlyingCurrency": null,
"priceMultiplier": 1,
"qualityFlags": [],
"quoteCurrency": "USDC",
"marginCurrency": "USDC",
"contractType": "linear",
"markPrice": 2685.5,
"oraclePrice": 2686.4,
"lastPrice": null,
"previousDayPrice": 2666.5,
"priceChange24h": 0.007125445340333769,
"premium": -0.00033502084574155155,
"venuePremium": -0.0002977963,
"fundingRate": 0.0000125,
"fundingIntervalHours": 1,
"fundingKind": "current",
"fundingRate8h": 0.0001,
"fundingApr": 0.1095,
"predictedFundingRate": null,
"predictedFundingIntervalHours": null,
"nextFundingAt": null,
"openInterestBase": 1200726.5714,
"openInterestUsd": 3224551207.4947,
"volume24hUsd": 246085707.18839985,
"maxLeverage": 25,
"isolatedOnly": false,
"delisted": false,
"observedAt": "2026-10-03T21:30:00.000Z",
"sourceAsOf": null,
"sourceUrl": "https://api.hyperliquid.xyz/info",
"confidence": "high",
"stale": false,
"oiChange1h": null,
"oiChange24h": null,
"oiUsdChange1h": null,
"oiUsdChange24h": null,
"underlying": null,
"underlyingPremium": null,
"closedMarketPremium": null
},
{
"marketId": "hyperliquid:default:BTC",
"venue": "hyperliquid",
"dex": "default",
"symbol": "BTC",
"baseAsset": "BTC",
"displayName": "BTC",
"assetClass": "crypto",
"underlyingSymbol": null,
"underlyingCurrency": null,
"priceMultiplier": 1,
"qualityFlags": [],
"quoteCurrency": "USDC",
"marginCurrency": "USDC",
"contractType": "linear",
"markPrice": 84724,
"oraclePrice": 84760,
"lastPrice": null,
"previousDayPrice": 84450,
"priceChange24h": 0.0032445233866194023,
"premium": -0.0004247286455875132,
"venuePremium": -0.0004129306,
"fundingRate": 0.0000082984,
"fundingIntervalHours": 1,
"fundingKind": "current",
"fundingRate8h": 0.0000663872,
"fundingApr": 0.07269398399999999,
"predictedFundingRate": null,
"predictedFundingIntervalHours": null,
"nextFundingAt": null,
"openInterestBase": 36935.97822,
"openInterestUsd": 3129363818.71128,
"volume24hUsd": 472844757.1903594,
"maxLeverage": 40,
"isolatedOnly": false,
"delisted": false,
"observedAt": "2026-10-03T21:30:00.000Z",
"sourceAsOf": null,
"sourceUrl": "https://api.hyperliquid.xyz/info",
"confidence": "high",
"stale": false,
"oiChange1h": null,
"oiChange24h": null,
"oiUsdChange1h": null,
"oiUsdChange24h": null,
"underlying": null,
"underlyingPremium": null,
"closedMarketPremium": null
},
{
"marketId": "hyperliquid:xyz:TSLA",
"venue": "hyperliquid",
"dex": "xyz",
"symbol": "xyz:TSLA",
"baseAsset": "TSLA",
"displayName": "TSLA",
"assetClass": "stocks",
"underlyingSymbol": "TSLA",
"underlyingCurrency": "USD",
"priceMultiplier": 1,
"qualityFlags": [],
"quoteCurrency": "USDC",
"marginCurrency": "USDC",
"contractType": "linear",
"markPrice": 371.2,
"oraclePrice": 371.12,
"lastPrice": null,
"previousDayPrice": 371.17,
"priceChange24h": 0.00008082549775023651,
"premium": 0.0002155636990730514,
"venuePremium": 0.000379931,
"fundingRate": 0.00000625,
"fundingIntervalHours": 1,
"fundingKind": "current",
"fundingRate8h": 0.00005,
"fundingApr": 0.05475000000000001,
"predictedFundingRate": null,
"predictedFundingIntervalHours": null,
"nextFundingAt": null,
"openInterestBase": 134594.084,
"openInterestUsd": 49961323.9808,
"volume24hUsd": 1278317.5990699998,
"maxLeverage": 20,
"isolatedOnly": false,
"delisted": false,
"observedAt": "2026-10-03T21:30:00.000Z",
"sourceAsOf": null,
"sourceUrl": "https://api.hyperliquid.xyz/info",
"confidence": "high",
"stale": false,
"oiChange1h": null,
"oiChange24h": null,
"oiUsdChange1h": null,
"oiUsdChange24h": null,
"underlying": null,
"underlyingPremium": null,
"closedMarketPremium": null
},
{
"marketId": "hyperliquid:default:kPEPE",
"venue": "hyperliquid",
"dex": "default",
"symbol": "kPEPE",
"baseAsset": "PEPE",
"displayName": "kPEPE",
"assetClass": "crypto",
"underlyingSymbol": null,
"underlyingCurrency": null,
"priceMultiplier": 1000,
"qualityFlags": [],
"quoteCurrency": "USDC",
"marginCurrency": "USDC",
"contractType": "linear",
"markPrice": 0.004302,
"oraclePrice": 0.004304,
"lastPrice": null,
"previousDayPrice": 0.004219,
"priceChange24h": 0.01967290827210255,
"premium": -0.000464684014869765,
"venuePremium": -0.000232342,
"fundingRate": 0.0000125,
"fundingIntervalHours": 1,
"fundingKind": "current",
"fundingRate8h": 0.0001,
"fundingApr": 0.1095,
"predictedFundingRate": null,
"predictedFundingIntervalHours": null,
"nextFundingAt": null,
"openInterestBase": 7267769894000,
"openInterestUsd": 31265946.083988003,
"volume24hUsd": 5480253.711302002,
"maxLeverage": 10,
"isolatedOnly": false,
"delisted": false,
"observedAt": "2026-10-03T21:30:00.000Z",
"sourceAsOf": null,
"sourceUrl": "https://api.hyperliquid.xyz/info",
"confidence": "high",
"stale": false,
"oiChange1h": null,
"oiChange24h": null,
"oiUsdChange1h": null,
"oiUsdChange24h": null,
"underlying": null,
"underlyingPremium": null,
"closedMarketPremium": null
},
{
"marketId": "hyperliquid:default:PURR",
"venue": "hyperliquid",
"dex": "default",
"symbol": "PURR",
"baseAsset": "PURR",
"displayName": "PURR",
"assetClass": "crypto",
"underlyingSymbol": null,
"underlyingCurrency": null,
"priceMultiplier": 1,
"qualityFlags": [],
"quoteCurrency": "USDC",
"marginCurrency": "USDC",
"contractType": "linear",
"markPrice": 0.17178,
"oraclePrice": 0.17127,
"lastPrice": null,
"previousDayPrice": 0.15552,
"priceChange24h": 0.1045524691358024,
"premium": 0.0029777544228410946,
"venuePremium": 0,
"fundingRate": 0.0000125,
"fundingIntervalHours": 1,
"fundingKind": "current",
"fundingRate8h": 0.0001,
"fundingApr": 0.1095,
"predictedFundingRate": null,
"predictedFundingIntervalHours": null,
"nextFundingAt": null,
"openInterestBase": 122574616,
"openInterestUsd": 21055867.53648,
"volume24hUsd": 2221264.7745500007,
"maxLeverage": 3,
"isolatedOnly": false,
"delisted": false,
"observedAt": "2026-10-03T21:30:00.000Z",
"sourceAsOf": null,
"sourceUrl": "https://api.hyperliquid.xyz/info",
"confidence": "high",
"stale": false,
"oiChange1h": null,
"oiChange24h": null,
"oiUsdChange1h": null,
"oiUsdChange24h": null,
"underlying": null,
"underlyingPremium": null,
"closedMarketPremium": null
}
],
"sources": [],
"status": "ok",
"asOf": "2026-10-03T21:30:00.000Z",
"total": 5,
"locked": 0,
"access": "pro"
},
"meta": {
"dataset": "perps",
"asOf": "2026-10-03T21:30:00.000Z",
"source": [
{
"id": "market-data",
"attribution": "Exchange and market data providers",
"licence": "Use subject to Gloom Datasets terms"
},
{
"id": "exchange-feeds",
"attribution": "Exchange and market data providers",
"licence": "Use subject to Gloom Datasets terms"
},
{
"id": "derivatives-exchanges",
"attribution": "Public derivatives exchange data",
"licence": "Use subject to Gloom Datasets terms"
}
],
"historyStarts": null,
"coverage": {
"total": 5
},
"lastUpdated": "2026-10-03T21:30:00.000Z",
"disclaimer": "Perpetual contracts are derivatives, not ownership of the underlying asset. Funding and premiums can diverge."
}
}Routes
Base URL https://api.gloom.sh. Send a key with each call; the key's account needs a plan.
GET /v1/perps/board1 credits
Perpetual contract prices, funding and open interest. Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.
- Parameter
search- In
query
- Type
string
- Parameter
limit- In
query
- Type
integer 1 to 200
- Parameter
offset- In
query
- Type
integer 0 to 500000
- Parameter
assetClass- In
query
- Type
stocks,indices,energy,metals,fx,crypto,other
- Parameter
sort- In
query
- Type
oi,funding,oi-change,premium
- Parameter
includeDelisted- In
query
- Type
boolean
| Parameter | In | Type | Notes |
|---|---|---|---|
| query | string | |
| query | integer 1 to 200 | |
| query | integer 0 to 500000 | |
| query |
| |
| query |
| |
| query | boolean |
- Credits: 1 (lookup x1)
- Plans: Basic, Desk, Enterprise
GET /v1/perps/history2 credits
Stored perpetual prices, funding and candle history. Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.
- Parameter
from- In
query
- Type
string
^\d{4}-\d{2}-\d{2}T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d{1,6})?(?:Z|[+-](?:[01]\d|2[0-3]):[0-5]\d)$
- Parameter
to- In
query
- Type
string
^\d{4}-\d{2}-\d{2}T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d{1,6})?(?:Z|[+-](?:[01]\d|2[0-3]):[0-5]\d)$
- Parameter
limit- In
query
- Type
integer 1 to 200
- Parameter
marketId- In
query, required
- Type
string
- Parameter
resolution- In
query
- Type
auto,minute,hour,day
| Parameter | In | Type | Notes |
|---|---|---|---|
| query | string | |
| query | string | |
| query | integer 1 to 200 | |
| query, required | string | |
| query |
|
- Credits: 2 (history x1)
- Plans: Basic, Desk, Enterprise
GET /v1/perps/rankings1 credits
Funding, open-interest and premium dislocations. Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.
Parameters: none.
- Credits: 1 (lookup x1)
- Plans: Basic, Desk, Enterprise
GET /v1/perps/compare1 credits
Compare perpetual venues for one underlying asset. Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.
- Parameter
limit- In
query
- Type
integer 1 to 200
- Parameter
offset- In
query
- Type
integer 0 to 500000
- Parameter
baseAsset- In
query, required
- Type
string
| Parameter | In | Type | Notes |
|---|---|---|---|
| query | integer 1 to 200 | |
| query | integer 0 to 500000 | |
| query, required | string |
- Credits: 1 (lookup x1)
- Plans: Basic, Desk, Enterprise
GET /v1/perps/market5 credits
One perpetual market with retained source evidence. Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.
- Parameter
marketId- In
query, required
- Type
string
| Parameter | In | Type | Notes |
|---|---|---|---|
| query, required | string |
- Credits: 5 (evidence x1)
- Plans: Basic, Desk, Enterprise
GET /v1/perps/equity/{symbol}1 credits
Equity-linked perpetuals and stored underlying references. Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.
- Parameter
symbol- In
path, required
- Type
string
^[A-Za-z0-9.:-]{1,32}$- Notes
Company symbol; normalized to uppercase.
- Parameter
exchange- In
query
- Type
string
- Parameter
limit- In
query
- Type
integer 1 to 200
- Parameter
offset- In
query
- Type
integer 0 to 500000
- Parameter
identity- In
query
- Type
listing
| Parameter | In | Type | Notes |
|---|---|---|---|
| path, required | string | Company symbol; normalized to uppercase. |
| query | string | |
| query | integer 1 to 200 | |
| query | integer 0 to 500000 | |
| query |
|
- Credits: 1 (lookup x1)
- Plans: Basic, Desk, Enterprise
Meta fields
- Field
dataset- Here
The dataset id
- In the example
"perps"
- Field
asOf- Here
The observation date established by the service; otherwise null
- In the example
"2026-10-03T21:30:00.000Z"
- Field
source- Here
Attribution and usage terms of each source
- In the example
3 sources
- Field
historyStarts- Here
Earliest stored history when established by the service; otherwise null.
- In the example
null, not stated yet
- Field
coverage- Here
Service-established coverage; null when unavailable.
- In the example
{"total":5}
- Field
lastUpdated- Here
The source update time established by the service; otherwise null
- In the example
"2026-10-03T21:30:00.000Z"
| Field | Here | In the example |
|---|---|---|
| The dataset id |
|
| The observation date established by the service; otherwise null |
|
| Attribution and usage terms of each source | 3 sources |
| Earliest stored history when established by the service; otherwise null. | null, not stated yet |
| Service-established coverage; null when unavailable. |
|
| The source update time established by the service; otherwise null |
|
Sources
- Source
Exchange and market data providers
- Usage terms
Use subject to Gloom Datasets terms
- Source
Exchange and market data providers
- Usage terms
Use subject to Gloom Datasets terms
- Source
Public derivatives exchange data
- Usage terms
Use subject to Gloom Datasets terms
| Source | Usage terms |
|---|---|
Exchange and market data providers | Use subject to Gloom Datasets terms |
Exchange and market data providers | Use subject to Gloom Datasets terms |
Public derivatives exchange data | Use subject to Gloom Datasets terms |
Errors
These routes can answer 400, 401, 402, 403, 404, 429, 503. See Errors for the codes.
Gloom Datasets reads stored data only: a call never starts a collection.