API reference
Generated from https://api.tideperp.tech/v1/openapi.json at request time, so it cannot drift from the running API. Financial values are decimal strings; timestamps are ISO-8601 UTC.
Reference
Loading
TidePerpGenerated from https://api.tideperp.tech/v1/openapi.json at request time, so it cannot drift from the running API. Financial values are decimal strings; timestamps are ISO-8601 UTC.
get/v1/v1/overview
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| universe | query | string · one of hypercore, elysium, combined · default "combined" | no |
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"universe": {
"type": "string",
"enum": [
"hypercore",
"elysium",
"combined"
]
},
"as_of": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"volume_24h_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_24h_change_pct": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"open_interest_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"open_interest_change_24h_pct": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"markets_active": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"markets_total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"venues_active": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"venues_verified": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"data_health": {
"type": "object",
"properties": {
"feeds_live_pct": {
"type": "number"
},
"feeds_total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"feeds_live": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"source_id": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"CONNECTED",
"DEGRADED",
"DISCONNECTED",
"DISABLED"
]
},
"last_observation_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"lag_seconds": {
"type": [
"number",
"null"
]
},
"environment": {
"type": "string"
},
"details": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"source_id",
"status",
"last_observation_at",
"lag_seconds",
"environment",
"details"
],
"additionalProperties": false
}
},
"timescaledb": {
"type": "boolean"
}
},
"required": [
"feeds_live_pct",
"feeds_total",
"feeds_live",
"sources",
"timescaledb"
],
"additionalProperties": false
},
"trending": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"symbol": {
"type": "string"
},
"canonical_code": {
"type": "string"
},
"display_name": {
"type": [
"string",
"null"
]
},
"base_asset": {
"type": "string"
},
"quote_asset": {
"type": "string"
},
"settlement_asset": {
"type": "string"
},
"venue": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"execution_domain": {
"type": "string",
"enum": [
"HYPERCORE_NATIVE",
"ELYSIUM_NATIVE",
"INTEGRATED_APP",
"EXTERNAL_CONTEXT"
]
}
},
"required": [
"id",
"code",
"name",
"execution_domain"
],
"additionalProperties": false
},
"protocol": {
"anyOf": [
{
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"verification_status": {
"type": "string"
}
},
"required": [
"slug",
"name",
"verification_status"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"execution_domain": {
"type": "string",
"enum": [
"HYPERCORE_NATIVE",
"ELYSIUM_NATIVE",
"INTEGRATED_APP",
"EXTERNAL_CONTEXT"
]
},
"comparability_class": {
"type": "string",
"enum": [
"DIRECT",
"NORMALIZED",
"NON_COMPARABLE"
]
},
"comparison_group": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELISTED",
"HALTED",
"PENDING"
]
},
"max_leverage": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"mark_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oracle_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"mid_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"price_change_24h_pct": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_24h_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_7d_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_30d_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"trade_count_24h": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"open_interest": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"open_interest_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oi_change_24h_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oi_change_24h_pct": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"funding_rate": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"funding_interval_seconds": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"funding_annualized": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"premium": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"spread_bps": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"depth_100bps_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"book_observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"LOCAL",
"TESTNET",
"PRODUCTION"
]
},
"observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"ingested_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"quality_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
}
},
"required": [
"source",
"environment",
"observed_at",
"ingested_at",
"quality_status"
],
"additionalProperties": false
}
},
"required": [
"id",
"symbol",
"canonical_code",
"display_name",
"base_asset",
"quote_asset",
"settlement_asset",
"venue",
"protocol",
"execution_domain",
"comparability_class",
"comparison_group",
"status",
"max_leverage",
"mark_price",
"oracle_price",
"mid_price",
"price_change_24h_pct",
"volume_24h_usd",
"volume_7d_usd",
"volume_30d_usd",
"trade_count_24h",
"open_interest",
"open_interest_usd",
"oi_change_24h_usd",
"oi_change_24h_pct",
"funding_rate",
"funding_interval_seconds",
"funding_annualized",
"premium",
"spread_bps",
"depth_100bps_usd",
"book_observed_at",
"provenance"
],
"additionalProperties": false
}
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"LOCAL",
"TESTNET",
"PRODUCTION"
]
},
"observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"ingested_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"quality_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
}
},
"required": [
"source",
"environment",
"observed_at",
"ingested_at",
"quality_status"
],
"additionalProperties": false
}
},
"required": [
"universe",
"as_of",
"volume_24h_usd",
"volume_24h_change_pct",
"open_interest_usd",
"open_interest_change_24h_pct",
"markets_active",
"markets_total",
"venues_active",
"venues_verified",
"data_health",
"trending",
"provenance"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}protocols
compare
intelligence
chain
methodology
auth
watchlists
alerts
api-keys
admin
get/v1/v1/overview/volume
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| universe | query | string · one of hypercore, elysium, combined · default "combined" | no |
| bucket | query | string · one of 1h, 1d · default "1h" | no |
| limit | query | integer · 1–2000 · default 168 | no |
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"universe": {
"type": "string",
"enum": [
"hypercore",
"elysium",
"combined"
]
},
"metric": {
"type": "string",
"enum": [
"volume",
"open_interest"
]
},
"bucket": {
"type": "string",
"enum": [
"1h",
"1d"
]
},
"points": {
"type": "array",
"items": {
"type": "object",
"properties": {
"bucket_start": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"value_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"markets_covered": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"quality_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
}
},
"required": [
"bucket_start",
"value_usd",
"markets_covered",
"quality_status"
],
"additionalProperties": false
}
},
"methodology": {
"type": "string"
}
},
"required": [
"universe",
"metric",
"bucket",
"points",
"methodology"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/overview/open-interest
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| universe | query | string · one of hypercore, elysium, combined · default "combined" | no |
| bucket | query | string · one of 1h, 1d · default "1h" | no |
| limit | query | integer · 1–2000 · default 168 | no |
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"universe": {
"type": "string",
"enum": [
"hypercore",
"elysium",
"combined"
]
},
"metric": {
"type": "string",
"enum": [
"volume",
"open_interest"
]
},
"bucket": {
"type": "string",
"enum": [
"1h",
"1d"
]
},
"points": {
"type": "array",
"items": {
"type": "object",
"properties": {
"bucket_start": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"value_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"markets_covered": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"quality_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
}
},
"required": [
"bucket_start",
"value_usd",
"markets_covered",
"quality_status"
],
"additionalProperties": false
}
},
"methodology": {
"type": "string"
}
},
"required": [
"universe",
"metric",
"bucket",
"points",
"methodology"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/health
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"ok",
"degraded",
"down"
]
},
"version": {
"type": "string"
},
"environment": {
"type": "string"
},
"uptime_seconds": {
"type": "number"
},
"database": {
"type": "string",
"enum": [
"ok",
"error"
]
},
"event_bus": {
"type": "string"
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"source_id": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"CONNECTED",
"DEGRADED",
"DISCONNECTED",
"DISABLED"
]
},
"last_observation_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"lag_seconds": {
"type": [
"number",
"null"
]
},
"environment": {
"type": "string"
},
"details": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"source_id",
"status",
"last_observation_at",
"lag_seconds",
"environment",
"details"
],
"additionalProperties": false
}
},
"workers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"worker_name": {
"type": "string"
},
"status": {
"type": "string"
},
"last_heartbeat_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"last_run_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"last_error": {
"type": [
"string",
"null"
]
}
},
"required": [
"worker_name",
"status",
"last_heartbeat_at",
"last_run_at",
"last_error"
],
"additionalProperties": false
}
},
"chain": {
"type": "array",
"items": {
"type": "object",
"properties": {
"network_code": {
"type": "string"
},
"chain_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"environment": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"last_indexed_block": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"head_block": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"lag_blocks": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"last_block_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"latest_batch_sequence": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"latest_batch_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
}
},
"required": [
"network_code",
"chain_id",
"environment",
"enabled",
"last_indexed_block",
"head_block",
"lag_blocks",
"last_block_at",
"latest_batch_sequence",
"latest_batch_at"
],
"additionalProperties": false
}
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"status",
"version",
"environment",
"uptime_seconds",
"database",
"event_bus",
"sources",
"workers",
"chain",
"generated_at"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/markets
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| limit | query | integer · 1–500 · default 50 | no |
| cursor | query | string | no |
| domain | query | string · one of HYPERCORE_NATIVE, ELYSIUM_NATIVE, INTEGRATED_APP, EXTERNAL_CONTEXT | no |
| venue_id | query | string · uuid | no |
| venue_code | query | string | no |
| asset | query | string | no |
| quote_asset | query | string | no |
| search | query | string | no |
| status | query | string · one of ACTIVE, DELISTED, HALTED, PENDING, ALL | no |
| comparable_only | query | boolean | no |
| min_volume | query | string | no |
| min_oi | query | string | no |
| funding_direction | query | string · one of positive, negative | no |
| min_abs_funding | query | string | no |
| max_spread_bps | query | string | no |
| min_depth_usd | query | string | no |
| sort_by | query | string · one of volume, open_interest, funding, price_change, spread, depth, symbol, oi_change · default "volume" | no |
| sort_order | query | string · one of asc, desc · default "desc" | no |
200{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"symbol": {
"type": "string"
},
"canonical_code": {
"type": "string"
},
"display_name": {
"type": [
"string",
"null"
]
},
"base_asset": {
"type": "string"
},
"quote_asset": {
"type": "string"
},
"settlement_asset": {
"type": "string"
},
"venue": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"execution_domain": {
"type": "string",
"enum": [
"HYPERCORE_NATIVE",
"ELYSIUM_NATIVE",
"INTEGRATED_APP",
"EXTERNAL_CONTEXT"
]
}
},
"required": [
"id",
"code",
"name",
"execution_domain"
],
"additionalProperties": false
},
"protocol": {
"anyOf": [
{
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"verification_status": {
"type": "string"
}
},
"required": [
"slug",
"name",
"verification_status"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"execution_domain": {
"type": "string",
"enum": [
"HYPERCORE_NATIVE",
"ELYSIUM_NATIVE",
"INTEGRATED_APP",
"EXTERNAL_CONTEXT"
]
},
"comparability_class": {
"type": "string",
"enum": [
"DIRECT",
"NORMALIZED",
"NON_COMPARABLE"
]
},
"comparison_group": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELISTED",
"HALTED",
"PENDING"
]
},
"max_leverage": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"mark_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oracle_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"mid_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"price_change_24h_pct": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_24h_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_7d_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_30d_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"trade_count_24h": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"open_interest": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"open_interest_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oi_change_24h_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oi_change_24h_pct": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"funding_rate": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"funding_interval_seconds": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"funding_annualized": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"premium": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"spread_bps": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"depth_100bps_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"book_observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"LOCAL",
"TESTNET",
"PRODUCTION"
]
},
"observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"ingested_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"quality_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
}
},
"required": [
"source",
"environment",
"observed_at",
"ingested_at",
"quality_status"
],
"additionalProperties": false
}
},
"required": [
"id",
"symbol",
"canonical_code",
"display_name",
"base_asset",
"quote_asset",
"settlement_asset",
"venue",
"protocol",
"execution_domain",
"comparability_class",
"comparison_group",
"status",
"max_leverage",
"mark_price",
"oracle_price",
"mid_price",
"price_change_24h_pct",
"volume_24h_usd",
"volume_7d_usd",
"volume_30d_usd",
"trade_count_24h",
"open_interest",
"open_interest_usd",
"oi_change_24h_usd",
"oi_change_24h_pct",
"funding_rate",
"funding_interval_seconds",
"funding_annualized",
"premium",
"spread_bps",
"depth_100bps_usd",
"book_observed_at",
"provenance"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/search
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| q | query | string | yes |
| limit | query | integer · 1–50 · default 10 | no |
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"markets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"symbol": {
"type": "string"
},
"canonical_code": {
"type": "string"
},
"display_name": {
"type": [
"string",
"null"
]
},
"base_asset": {
"type": "string"
},
"quote_asset": {
"type": "string"
},
"settlement_asset": {
"type": "string"
},
"venue": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"execution_domain": {
"type": "string",
"enum": [
"HYPERCORE_NATIVE",
"ELYSIUM_NATIVE",
"INTEGRATED_APP",
"EXTERNAL_CONTEXT"
]
}
},
"required": [
"id",
"code",
"name",
"execution_domain"
],
"additionalProperties": false
},
"protocol": {
"anyOf": [
{
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"verification_status": {
"type": "string"
}
},
"required": [
"slug",
"name",
"verification_status"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"execution_domain": {
"type": "string",
"enum": [
"HYPERCORE_NATIVE",
"ELYSIUM_NATIVE",
"INTEGRATED_APP",
"EXTERNAL_CONTEXT"
]
},
"comparability_class": {
"type": "string",
"enum": [
"DIRECT",
"NORMALIZED",
"NON_COMPARABLE"
]
},
"comparison_group": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELISTED",
"HALTED",
"PENDING"
]
},
"max_leverage": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"mark_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oracle_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"mid_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"price_change_24h_pct": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_24h_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_7d_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_30d_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"trade_count_24h": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"open_interest": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"open_interest_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oi_change_24h_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oi_change_24h_pct": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"funding_rate": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"funding_interval_seconds": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"funding_annualized": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"premium": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"spread_bps": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"depth_100bps_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"book_observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"LOCAL",
"TESTNET",
"PRODUCTION"
]
},
"observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"ingested_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"quality_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
}
},
"required": [
"source",
"environment",
"observed_at",
"ingested_at",
"quality_status"
],
"additionalProperties": false
}
},
"required": [
"id",
"symbol",
"canonical_code",
"display_name",
"base_asset",
"quote_asset",
"settlement_asset",
"venue",
"protocol",
"execution_domain",
"comparability_class",
"comparison_group",
"status",
"max_leverage",
"mark_price",
"oracle_price",
"mid_price",
"price_change_24h_pct",
"volume_24h_usd",
"volume_7d_usd",
"volume_30d_usd",
"trade_count_24h",
"open_interest",
"open_interest_usd",
"oi_change_24h_usd",
"oi_change_24h_pct",
"funding_rate",
"funding_interval_seconds",
"funding_annualized",
"premium",
"spread_bps",
"depth_100bps_usd",
"book_observed_at",
"provenance"
],
"additionalProperties": false
}
},
"protocols": {
"type": "array",
"items": {
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"venue_code": {
"type": "string"
},
"verification_status": {
"type": "string"
}
},
"required": [
"slug",
"name",
"venue_code",
"verification_status"
],
"additionalProperties": false
}
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"symbol": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"markets": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"symbol",
"name",
"markets"
],
"additionalProperties": false
}
}
},
"required": [
"markets",
"protocols",
"assets"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/markets/{id}
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| id | path | string | yes |
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"symbol": {
"type": "string"
},
"canonical_code": {
"type": "string"
},
"display_name": {
"type": [
"string",
"null"
]
},
"base_asset": {
"type": "string"
},
"quote_asset": {
"type": "string"
},
"settlement_asset": {
"type": "string"
},
"venue": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"execution_domain": {
"type": "string",
"enum": [
"HYPERCORE_NATIVE",
"ELYSIUM_NATIVE",
"INTEGRATED_APP",
"EXTERNAL_CONTEXT"
]
}
},
"required": [
"id",
"code",
"name",
"execution_domain"
],
"additionalProperties": false
},
"protocol": {
"anyOf": [
{
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"verification_status": {
"type": "string"
}
},
"required": [
"slug",
"name",
"verification_status"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"execution_domain": {
"type": "string",
"enum": [
"HYPERCORE_NATIVE",
"ELYSIUM_NATIVE",
"INTEGRATED_APP",
"EXTERNAL_CONTEXT"
]
},
"comparability_class": {
"type": "string",
"enum": [
"DIRECT",
"NORMALIZED",
"NON_COMPARABLE"
]
},
"comparison_group": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELISTED",
"HALTED",
"PENDING"
]
},
"max_leverage": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"mark_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oracle_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"mid_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"price_change_24h_pct": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_24h_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_7d_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_30d_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"trade_count_24h": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"open_interest": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"open_interest_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oi_change_24h_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oi_change_24h_pct": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"funding_rate": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"funding_interval_seconds": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"funding_annualized": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"premium": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"spread_bps": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"depth_100bps_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"book_observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"LOCAL",
"TESTNET",
"PRODUCTION"
]
},
"observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"ingested_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"quality_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
}
},
"required": [
"source",
"environment",
"observed_at",
"ingested_at",
"quality_status"
],
"additionalProperties": false
},
"specification": {
"anyOf": [
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"multiplier": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"tick_size": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"lot_size": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"max_leverage": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"funding_interval_seconds": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"contract_type": {
"type": "string"
},
"contract_style": {
"type": "string"
},
"valid_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"source": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"version",
"multiplier",
"tick_size",
"lot_size",
"max_leverage",
"funding_interval_seconds",
"contract_type",
"contract_style",
"valid_from",
"source"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"source_code": {
"type": "string"
},
"source_market_id": {
"type": "string"
},
"source_venue": {
"type": [
"string",
"null"
]
},
"active": {
"type": "boolean"
},
"first_seen_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"last_seen_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"source_code",
"source_market_id",
"source_venue",
"active",
"first_seen_at",
"last_seen_at"
],
"additionalProperties": false
}
},
"fee_schedule": {
"anyOf": [
{
"type": "object",
"properties": {
"tier_name": {
"type": "string"
},
"maker_fee": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"taker_fee": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"fee_unit": {
"type": "string",
"enum": [
"FRACTION",
"BPS"
]
},
"effective_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"effective_to": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"source_url": {
"type": [
"string",
"null"
]
},
"verification_status": {
"type": "string"
},
"conditions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"tier_name",
"maker_fee",
"taker_fee",
"fee_unit",
"effective_from",
"effective_to",
"source_url",
"verification_status",
"conditions"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"trading_url": {
"type": [
"string",
"null"
]
},
"first_seen_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"delisted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"symbol",
"canonical_code",
"display_name",
"base_asset",
"quote_asset",
"settlement_asset",
"venue",
"protocol",
"execution_domain",
"comparability_class",
"comparison_group",
"status",
"max_leverage",
"mark_price",
"oracle_price",
"mid_price",
"price_change_24h_pct",
"volume_24h_usd",
"volume_7d_usd",
"volume_30d_usd",
"trade_count_24h",
"open_interest",
"open_interest_usd",
"oi_change_24h_usd",
"oi_change_24h_pct",
"funding_rate",
"funding_interval_seconds",
"funding_annualized",
"premium",
"spread_bps",
"depth_100bps_usd",
"book_observed_at",
"provenance",
"specification",
"sources",
"fee_schedule",
"trading_url",
"first_seen_at",
"delisted_at"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/markets/{id}/volume
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| from | query | string · date-time | no |
| to | query | string · date-time | no |
| bucket | query | string · one of 1m, 5m, 15m, 1h, 1d · default "1h" | no |
| limit | query | integer · 1–2000 · default 500 | no |
| id | path | string | yes |
200{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"bucket_start": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"bucket_seconds": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"volume_base": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"notional_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"trade_count": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"vwap": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"buy_notional_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"sell_notional_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"source": {
"type": "string"
}
},
"required": [
"bucket_start",
"bucket_seconds",
"volume_base",
"notional_usd",
"trade_count",
"vwap",
"buy_notional_usd",
"sell_notional_usd",
"source"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/markets/{id}/open-interest
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| from | query | string · date-time | no |
| to | query | string · date-time | no |
| bucket | query | string · one of 1m, 5m, 15m, 1h, 1d · default "1h" | no |
| limit | query | integer · 1–2000 · default 500 | no |
| id | path | string | yes |
200{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"observed_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"open_interest": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"open_interest_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"mark_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"quality_status": {
"type": "string"
}
},
"required": [
"observed_at",
"open_interest",
"open_interest_usd",
"mark_price",
"quality_status"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/markets/{id}/funding
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| limit | query | integer · 1–500 · default 50 | no |
| cursor | query | string | no |
| from | query | string · date-time | no |
| to | query | string · date-time | no |
| id | path | string | yes |
200{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"observed_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"funding_rate": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"funding_interval_seconds": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"annualized_rate": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"premium": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"source": {
"type": "string"
},
"quality_status": {
"type": "string"
}
},
"required": [
"observed_at",
"funding_rate",
"funding_interval_seconds",
"annualized_rate",
"premium",
"source",
"quality_status"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/markets/{id}/orderbook
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| id | path | string | yes |
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"instrument_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"observed_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"sequence_id": {
"type": [
"string",
"null"
]
},
"bids": {
"type": "array",
"items": {
"type": "object",
"properties": {
"price": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"size": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"orders": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"price",
"size",
"orders"
],
"additionalProperties": false
}
},
"asks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"price": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"size": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"orders": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"price",
"size",
"orders"
],
"additionalProperties": false
}
},
"best_bid": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"best_ask": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"mid_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"spread_bps": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"source_depth": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"LOCAL",
"TESTNET",
"PRODUCTION"
]
},
"observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"ingested_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"quality_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
}
},
"required": [
"source",
"environment",
"observed_at",
"ingested_at",
"quality_status"
],
"additionalProperties": false
}
},
"required": [
"instrument_id",
"observed_at",
"sequence_id",
"bids",
"asks",
"best_bid",
"best_ask",
"mid_price",
"spread_bps",
"source_depth",
"provenance"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/markets/{id}/candles
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| interval | query | string · one of 1m, 5m, 15m, 1h, 4h, 1d · default "1h" | no |
| from | query | string · date-time | no |
| to | query | string · date-time | no |
| limit | query | integer · 1–2000 · default 500 | no |
| id | path | string | yes |
200{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"bucket_start": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"bucket_end": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"open": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"high": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"low": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"close": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"volume": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"trade_count": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"source": {
"type": "string"
},
"quality_status": {
"type": "string"
}
},
"required": [
"bucket_start",
"bucket_end",
"open",
"high",
"low",
"close",
"volume",
"trade_count",
"source",
"quality_status"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/markets/{id}/trades
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| limit | query | integer · 1–500 · default 50 | no |
| cursor | query | string | no |
| from | query | string · date-time | no |
| to | query | string · date-time | no |
| id | path | string | yes |
200{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"trade_time": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"price": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"quantity": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"notional": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"side": {
"type": "string",
"enum": [
"BUY",
"SELL"
]
},
"dedup_confidence": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"trade_time",
"price",
"quantity",
"notional",
"side",
"dedup_confidence",
"source"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/markets/{id}/liquidity
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| id | path | string | yes |
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"instrument_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"observed_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"best_bid": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"best_ask": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"mid_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"spread_bps": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"depth": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"properties": {
"bid": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"ask": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"imbalance": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
}
},
"required": [
"bid",
"ask",
"imbalance"
],
"additionalProperties": false
}
},
"book_levels": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"history": {
"type": "array",
"items": {
"type": "object",
"properties": {
"observed_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"spread_bps": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"depth_100bps_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"imbalance_100bps": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
}
},
"required": [
"observed_at",
"spread_bps",
"depth_100bps_usd",
"imbalance_100bps"
],
"additionalProperties": false
}
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"LOCAL",
"TESTNET",
"PRODUCTION"
]
},
"observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"ingested_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"quality_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
}
},
"required": [
"source",
"environment",
"observed_at",
"ingested_at",
"quality_status"
],
"additionalProperties": false
}
},
"required": [
"instrument_id",
"observed_at",
"best_bid",
"best_ask",
"mid_price",
"spread_bps",
"depth",
"book_levels",
"history",
"provenance"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}post/v1/v1/markets/{id}/execution-estimate
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| id | path | string | yes |
application/json{
"type": "object",
"properties": {
"side": {
"type": "string",
"enum": [
"BUY",
"SELL"
]
},
"order_size_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"order_quantity": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"fee_assumption": {
"default": {
"fee_type": "TAKER"
},
"type": "object",
"properties": {
"fee_type": {
"default": "TAKER",
"type": "string",
"enum": [
"TAKER",
"MAKER",
"CUSTOM"
]
},
"rate_bps": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
}
}
},
"max_snapshot_age_ms": {
"default": 5000,
"type": "integer",
"minimum": 100,
"maximum": 3600000
}
},
"required": [
"side"
]
}get/v1/v1/protocols
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| limit | query | integer · 1–500 · default 50 | no |
| cursor | query | string | no |
| domain | query | string · one of HYPERCORE_NATIVE, ELYSIUM_NATIVE, INTEGRATED_APP, EXTERNAL_CONTEXT | no |
| verification_status | query | string · one of DISCOVERED, PROVISIONAL, VERIFIED, INACTIVE | no |
| status | query | string | no |
| min_volume | query | string | no |
| min_oi | query | string | no |
| sort_by | query | string · one of volume, open_interest, markets, share, name · default "volume" | no |
| sort_order | query | string · one of asc, desc · default "desc" | no |
200{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"website": {
"type": [
"string",
"null"
]
},
"documentation_url": {
"type": [
"string",
"null"
]
},
"verification_status": {
"type": "string",
"enum": [
"DISCOVERED",
"PROVISIONAL",
"VERIFIED",
"INACTIVE"
]
},
"venue": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"execution_domain": {
"type": "string",
"enum": [
"HYPERCORE_NATIVE",
"ELYSIUM_NATIVE",
"INTEGRATED_APP",
"EXTERNAL_CONTEXT"
]
},
"execution_model": {
"type": "string"
},
"status": {
"type": "string"
},
"network_code": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"code",
"name",
"execution_domain",
"execution_model",
"status",
"network_code"
],
"additionalProperties": false
},
"markets_active": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"markets_total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"volume_24h_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"open_interest_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"market_share_pct": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"settlement_assets": {
"type": "array",
"items": {
"type": "string"
}
},
"data_quality": {
"type": "object",
"properties": {
"live": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"delayed": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"stale": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"missing": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"live",
"delayed",
"stale",
"missing"
],
"additionalProperties": false
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"LOCAL",
"TESTNET",
"PRODUCTION"
]
},
"observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"ingested_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"quality_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
}
},
"required": [
"source",
"environment",
"observed_at",
"ingested_at",
"quality_status"
],
"additionalProperties": false
}
},
"required": [
"id",
"slug",
"name",
"website",
"documentation_url",
"verification_status",
"venue",
"markets_active",
"markets_total",
"volume_24h_usd",
"open_interest_usd",
"market_share_pct",
"settlement_assets",
"data_quality",
"provenance"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/protocols/{slug}
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| slug | path | string | yes |
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"website": {
"type": [
"string",
"null"
]
},
"documentation_url": {
"type": [
"string",
"null"
]
},
"verification_status": {
"type": "string",
"enum": [
"DISCOVERED",
"PROVISIONAL",
"VERIFIED",
"INACTIVE"
]
},
"venue": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"execution_domain": {
"type": "string",
"enum": [
"HYPERCORE_NATIVE",
"ELYSIUM_NATIVE",
"INTEGRATED_APP",
"EXTERNAL_CONTEXT"
]
},
"execution_model": {
"type": "string"
},
"status": {
"type": "string"
},
"network_code": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"code",
"name",
"execution_domain",
"execution_model",
"status",
"network_code"
],
"additionalProperties": false
},
"markets_active": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"markets_total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"volume_24h_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"open_interest_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"market_share_pct": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"settlement_assets": {
"type": "array",
"items": {
"type": "string"
}
},
"data_quality": {
"type": "object",
"properties": {
"live": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"delayed": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"stale": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"missing": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"live",
"delayed",
"stale",
"missing"
],
"additionalProperties": false
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"LOCAL",
"TESTNET",
"PRODUCTION"
]
},
"observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"ingested_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"quality_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
}
},
"required": [
"source",
"environment",
"observed_at",
"ingested_at",
"quality_status"
],
"additionalProperties": false
},
"metadata": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"fee_schedules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tier_name": {
"type": "string"
},
"maker_fee": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"taker_fee": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"fee_unit": {
"type": "string",
"enum": [
"FRACTION",
"BPS"
]
},
"effective_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"effective_to": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"source_url": {
"type": [
"string",
"null"
]
},
"verification_status": {
"type": "string"
},
"conditions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"tier_name",
"maker_fee",
"taker_fee",
"fee_unit",
"effective_from",
"effective_to",
"source_url",
"verification_status",
"conditions"
],
"additionalProperties": false
}
},
"applications": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"access_type": {
"type": "string"
},
"trading_url": {
"type": [
"string",
"null"
]
},
"verification_status": {
"type": "string"
}
},
"required": [
"id",
"name",
"access_type",
"trading_url",
"verification_status"
],
"additionalProperties": false
}
},
"top_markets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"symbol": {
"type": "string"
},
"canonical_code": {
"type": "string"
},
"display_name": {
"type": [
"string",
"null"
]
},
"base_asset": {
"type": "string"
},
"quote_asset": {
"type": "string"
},
"settlement_asset": {
"type": "string"
},
"venue": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"execution_domain": {
"type": "string",
"enum": [
"HYPERCORE_NATIVE",
"ELYSIUM_NATIVE",
"INTEGRATED_APP",
"EXTERNAL_CONTEXT"
]
}
},
"required": [
"id",
"code",
"name",
"execution_domain"
],
"additionalProperties": false
},
"protocol": {
"anyOf": [
{
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"verification_status": {
"type": "string"
}
},
"required": [
"slug",
"name",
"verification_status"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"execution_domain": {
"type": "string",
"enum": [
"HYPERCORE_NATIVE",
"ELYSIUM_NATIVE",
"INTEGRATED_APP",
"EXTERNAL_CONTEXT"
]
},
"comparability_class": {
"type": "string",
"enum": [
"DIRECT",
"NORMALIZED",
"NON_COMPARABLE"
]
},
"comparison_group": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELISTED",
"HALTED",
"PENDING"
]
},
"max_leverage": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"mark_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oracle_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"mid_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"price_change_24h_pct": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_24h_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_7d_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_30d_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"trade_count_24h": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"open_interest": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"open_interest_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oi_change_24h_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oi_change_24h_pct": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"funding_rate": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"funding_interval_seconds": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"funding_annualized": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"premium": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"spread_bps": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"depth_100bps_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"book_observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"LOCAL",
"TESTNET",
"PRODUCTION"
]
},
"observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"ingested_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"quality_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
}
},
"required": [
"source",
"environment",
"observed_at",
"ingested_at",
"quality_status"
],
"additionalProperties": false
}
},
"required": [
"id",
"symbol",
"canonical_code",
"display_name",
"base_asset",
"quote_asset",
"settlement_asset",
"venue",
"protocol",
"execution_domain",
"comparability_class",
"comparison_group",
"status",
"max_leverage",
"mark_price",
"oracle_price",
"mid_price",
"price_change_24h_pct",
"volume_24h_usd",
"volume_7d_usd",
"volume_30d_usd",
"trade_count_24h",
"open_interest",
"open_interest_usd",
"oi_change_24h_usd",
"oi_change_24h_pct",
"funding_rate",
"funding_interval_seconds",
"funding_annualized",
"premium",
"spread_bps",
"depth_100bps_usd",
"book_observed_at",
"provenance"
],
"additionalProperties": false
}
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"verified_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"slug",
"name",
"website",
"documentation_url",
"verification_status",
"venue",
"markets_active",
"markets_total",
"volume_24h_usd",
"open_interest_usd",
"market_share_pct",
"settlement_assets",
"data_quality",
"provenance",
"metadata",
"fee_schedules",
"applications",
"top_markets",
"created_at",
"verified_at"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/protocols/{slug}/metrics
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| bucket | query | string · one of 1h, 1d · default "1h" | no |
| limit | query | integer · 1–2000 · default 168 | no |
| slug | path | string | yes |
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"protocol_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"bucket": {
"type": "string",
"enum": [
"1h",
"1d"
]
},
"points": {
"type": "array",
"items": {
"type": "object",
"properties": {
"bucket_start": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"volume_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"open_interest_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"markets_covered": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"share_pct": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
}
},
"required": [
"bucket_start",
"volume_usd",
"open_interest_usd",
"markets_covered",
"share_pct"
],
"additionalProperties": false
}
},
"methodology": {
"type": "string"
}
},
"required": [
"protocol_id",
"bucket",
"points",
"methodology"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/protocols/{slug}/markets
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| limit | query | integer · 1–500 · default 100 | no |
| cursor | query | string | no |
| slug | path | string | yes |
200{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"symbol": {
"type": "string"
},
"canonical_code": {
"type": "string"
},
"display_name": {
"type": [
"string",
"null"
]
},
"base_asset": {
"type": "string"
},
"quote_asset": {
"type": "string"
},
"settlement_asset": {
"type": "string"
},
"venue": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"execution_domain": {
"type": "string",
"enum": [
"HYPERCORE_NATIVE",
"ELYSIUM_NATIVE",
"INTEGRATED_APP",
"EXTERNAL_CONTEXT"
]
}
},
"required": [
"id",
"code",
"name",
"execution_domain"
],
"additionalProperties": false
},
"protocol": {
"anyOf": [
{
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"verification_status": {
"type": "string"
}
},
"required": [
"slug",
"name",
"verification_status"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"execution_domain": {
"type": "string",
"enum": [
"HYPERCORE_NATIVE",
"ELYSIUM_NATIVE",
"INTEGRATED_APP",
"EXTERNAL_CONTEXT"
]
},
"comparability_class": {
"type": "string",
"enum": [
"DIRECT",
"NORMALIZED",
"NON_COMPARABLE"
]
},
"comparison_group": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELISTED",
"HALTED",
"PENDING"
]
},
"max_leverage": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"mark_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oracle_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"mid_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"price_change_24h_pct": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_24h_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_7d_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_30d_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"trade_count_24h": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"open_interest": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"open_interest_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oi_change_24h_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oi_change_24h_pct": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"funding_rate": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"funding_interval_seconds": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"funding_annualized": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"premium": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"spread_bps": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"depth_100bps_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"book_observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"LOCAL",
"TESTNET",
"PRODUCTION"
]
},
"observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"ingested_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"quality_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
}
},
"required": [
"source",
"environment",
"observed_at",
"ingested_at",
"quality_status"
],
"additionalProperties": false
}
},
"required": [
"id",
"symbol",
"canonical_code",
"display_name",
"base_asset",
"quote_asset",
"settlement_asset",
"venue",
"protocol",
"execution_domain",
"comparability_class",
"comparison_group",
"status",
"max_leverage",
"mark_price",
"oracle_price",
"mid_price",
"price_change_24h_pct",
"volume_24h_usd",
"volume_7d_usd",
"volume_30d_usd",
"trade_count_24h",
"open_interest",
"open_interest_usd",
"oi_change_24h_usd",
"oi_change_24h_pct",
"funding_rate",
"funding_interval_seconds",
"funding_annualized",
"premium",
"spread_bps",
"depth_100bps_usd",
"book_observed_at",
"provenance"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/protocols/{slug}/fees
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| slug | path | string | yes |
200{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tier_name": {
"type": "string"
},
"maker_fee": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"taker_fee": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"fee_unit": {
"type": "string",
"enum": [
"FRACTION",
"BPS"
]
},
"effective_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"effective_to": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"source_url": {
"type": [
"string",
"null"
]
},
"verification_status": {
"type": "string"
},
"conditions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"tier_name",
"maker_fee",
"taker_fee",
"fee_unit",
"effective_from",
"effective_to",
"source_url",
"verification_status",
"conditions"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}post/v1/v1/compare
application/json{
"type": "object",
"properties": {
"comparison_group": {
"type": "string"
},
"instrument_ids": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"side": {
"default": "BUY",
"type": "string",
"enum": [
"BUY",
"SELL"
]
},
"order_size_usd": {
"default": "50000",
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"fee_type": {
"default": "TAKER",
"type": "string",
"enum": [
"TAKER",
"MAKER"
]
},
"max_snapshot_age_ms": {
"default": 60000,
"type": "integer",
"minimum": 100,
"maximum": 3600000
}
},
"required": [
"instrument_ids"
]
}200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"comparison_group": {
"type": "string"
},
"side": {
"type": "string",
"enum": [
"BUY",
"SELL"
]
},
"order_size_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"fee_type": {
"type": "string"
},
"rows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"instrument_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"symbol": {
"type": "string"
},
"canonical_code": {
"type": "string"
},
"venue": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"code",
"name"
],
"additionalProperties": false
},
"settlement_asset": {
"type": "string"
},
"comparability_class": {
"type": "string",
"enum": [
"DIRECT",
"NORMALIZED",
"NON_COMPARABLE"
]
},
"rankable": {
"type": "boolean"
},
"rank": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"funding_rate": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"funding_interval_seconds": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"funding_hourly_normalized": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"funding_annualized": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"mark_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"spread_bps": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"depth_100bps_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"fee_bps": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"fee_source": {
"type": "string"
},
"execution": {
"anyOf": [
{
"type": "object",
"properties": {
"instrument_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"side": {
"type": "string",
"enum": [
"BUY",
"SELL"
]
},
"status": {
"type": "string",
"enum": [
"FILLED",
"INSUFFICIENT_OBSERVED_DEPTH"
]
},
"requested_notional_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"requested_quantity": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"filled_notional_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"filled_quantity": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"unfilled_notional_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"unfilled_quantity": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"average_execution_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"reference_mid_price": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"best_opposite_price": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"spread_cost_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"price_impact_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"estimated_fee_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"estimated_total_cost_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"slippage_bps": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"levels_consumed": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"book_levels_available": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"fee_assumption": {
"type": "object",
"properties": {
"fee_type": {
"type": "string"
},
"rate_bps": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"source": {
"type": "string"
}
},
"required": [
"fee_type",
"rate_bps",
"source"
],
"additionalProperties": false
},
"snapshot_timestamp": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"snapshot_age_ms": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"methodology": {
"type": "string"
},
"quality_status": {
"type": "string",
"enum": [
"ESTIMATED"
]
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"LOCAL",
"TESTNET",
"PRODUCTION"
]
},
"observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"ingested_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"quality_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
}
},
"required": [
"source",
"environment",
"observed_at",
"ingested_at",
"quality_status"
],
"additionalProperties": false
}
},
"required": [
"instrument_id",
"side",
"status",
"requested_notional_usd",
"requested_quantity",
"filled_notional_usd",
"filled_quantity",
"unfilled_notional_usd",
"unfilled_quantity",
"average_execution_price",
"reference_mid_price",
"best_opposite_price",
"spread_cost_usd",
"price_impact_usd",
"estimated_fee_usd",
"estimated_total_cost_usd",
"slippage_bps",
"levels_consumed",
"book_levels_available",
"fee_assumption",
"snapshot_timestamp",
"snapshot_age_ms",
"methodology",
"quality_status",
"provenance"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"book_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"MISSING"
]
},
"disclosures": {
"type": "array",
"items": {
"type": "string"
}
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"LOCAL",
"TESTNET",
"PRODUCTION"
]
},
"observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"ingested_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"quality_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
}
},
"required": [
"source",
"environment",
"observed_at",
"ingested_at",
"quality_status"
],
"additionalProperties": false
}
},
"required": [
"instrument_id",
"symbol",
"canonical_code",
"venue",
"settlement_asset",
"comparability_class",
"rankable",
"rank",
"funding_rate",
"funding_interval_seconds",
"funding_hourly_normalized",
"funding_annualized",
"mark_price",
"spread_bps",
"depth_100bps_usd",
"fee_bps",
"fee_source",
"execution",
"book_status",
"disclosures",
"provenance"
],
"additionalProperties": false
}
},
"non_comparable": {
"type": "array",
"items": {
"type": "object",
"properties": {
"instrument_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"reason": {
"type": "string"
}
},
"required": [
"instrument_id",
"reason"
],
"additionalProperties": false
}
},
"methodology": {
"type": "string"
},
"as_of": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"comparison_group",
"side",
"order_size_usd",
"fee_type",
"rows",
"non_comparable",
"methodology",
"as_of"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}post/v1/v1/compare/execution
application/json{
"type": "object",
"properties": {
"comparison_group": {
"type": "string"
},
"instrument_ids": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"side": {
"default": "BUY",
"type": "string",
"enum": [
"BUY",
"SELL"
]
},
"order_size_usd": {
"default": "50000",
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"fee_type": {
"default": "TAKER",
"type": "string",
"enum": [
"TAKER",
"MAKER"
]
},
"max_snapshot_age_ms": {
"default": 60000,
"type": "integer",
"minimum": 100,
"maximum": 3600000
}
},
"required": [
"instrument_ids"
]
}get/v1/v1/funding/opportunities
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| min_divergence_hourly | query | string · default "0.00005" | no |
| order_size_usd | query | string · default "50000" | no |
| horizon_hours | query | integer · 1–720 · default 24 | no |
| limit | query | integer · 1–100 · default 25 | no |
200{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"comparison_group": {
"type": "string"
},
"long_leg": {
"type": "object",
"properties": {
"instrument_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"symbol": {
"type": "string"
},
"venue_code": {
"type": "string"
},
"funding_hourly": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"settlement_asset": {
"type": "string"
}
},
"required": [
"instrument_id",
"symbol",
"venue_code",
"funding_hourly",
"settlement_asset"
],
"additionalProperties": false
},
"short_leg": {
"type": "object",
"properties": {
"instrument_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"symbol": {
"type": "string"
},
"venue_code": {
"type": "string"
},
"funding_hourly": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"settlement_asset": {
"type": "string"
}
},
"required": [
"instrument_id",
"symbol",
"venue_code",
"funding_hourly",
"settlement_asset"
],
"additionalProperties": false
},
"divergence_hourly": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"divergence_annualized": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"comparability_class": {
"type": "string",
"enum": [
"DIRECT",
"NORMALIZED",
"NON_COMPARABLE"
]
},
"net_carry": {
"type": "object",
"properties": {
"horizon_hours": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"expected_funding_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"entry_fees_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"exit_fees_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"slippage_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"net_carry_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"net_carry_bps": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"assumptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"horizon_hours",
"expected_funding_usd",
"entry_fees_usd",
"exit_fees_usd",
"slippage_usd",
"net_carry_usd",
"net_carry_bps",
"assumptions"
],
"additionalProperties": false
},
"disclosures": {
"type": "array",
"items": {
"type": "string"
}
},
"as_of": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"comparison_group",
"long_leg",
"short_leg",
"divergence_hourly",
"divergence_annualized",
"comparability_class",
"net_carry",
"disclosures",
"as_of"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/intelligence
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| limit | query | integer · 1–500 · default 50 | no |
| cursor | query | string | no |
| from | query | string · date-time | no |
| to | query | string · date-time | no |
| type | query | string · one of VOLUME_ANOMALY, OI_EXPANSION, OI_CONTRACTION, FUNDING_EXTREME, FUNDING_DIVERGENCE, SPREAD_EXPANSION, LIQUIDITY_DETERIORATION, PRICE_DISLOCATION, MARKET_STRESS, MARKET_LISTED, MARKET_DELISTED | no |
| severity | query | string · one of INFO, LOW, MEDIUM, HIGH, CRITICAL | no |
| instrument_id | query | string · uuid | no |
| venue_id | query | string · uuid | no |
| status | query | string · one of ACTIVE, RESOLVED, ALL · default "ALL" | no |
| domain | query | string · one of HYPERCORE_NATIVE, ELYSIUM_NATIVE | no |
200{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"event_type": {
"type": "string",
"enum": [
"VOLUME_ANOMALY",
"OI_EXPANSION",
"OI_CONTRACTION",
"FUNDING_EXTREME",
"FUNDING_DIVERGENCE",
"SPREAD_EXPANSION",
"LIQUIDITY_DETERIORATION",
"PRICE_DISLOCATION",
"MARKET_STRESS",
"MARKET_LISTED",
"MARKET_DELISTED"
]
},
"severity": {
"type": "string",
"enum": [
"INFO",
"LOW",
"MEDIUM",
"HIGH",
"CRITICAL"
]
},
"status": {
"type": "string"
},
"detected_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"window_start": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"window_end": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"instrument": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"symbol": {
"type": "string"
},
"canonical_code": {
"type": "string"
},
"venue_code": {
"type": "string"
},
"venue_name": {
"type": "string"
}
},
"required": [
"id",
"symbol",
"canonical_code",
"venue_code",
"venue_name"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"baseline": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"current_value": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"evidence": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"score": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"detector": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"parameters": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"code",
"version"
],
"additionalProperties": false
},
"methodology_url": {
"type": "string"
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"LOCAL",
"TESTNET",
"PRODUCTION"
]
},
"observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"ingested_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"quality_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
}
},
"required": [
"source",
"environment",
"observed_at",
"ingested_at",
"quality_status"
],
"additionalProperties": false
}
},
"required": [
"id",
"event_type",
"severity",
"status",
"detected_at",
"window_start",
"window_end",
"instrument",
"baseline",
"current_value",
"evidence",
"score",
"detector",
"methodology_url",
"provenance"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/intelligence/funding
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| limit | query | integer · 1–500 · default 50 | no |
| cursor | query | string | no |
| from | query | string · date-time | no |
| to | query | string · date-time | no |
| type | query | string · one of VOLUME_ANOMALY, OI_EXPANSION, OI_CONTRACTION, FUNDING_EXTREME, FUNDING_DIVERGENCE, SPREAD_EXPANSION, LIQUIDITY_DETERIORATION, PRICE_DISLOCATION, MARKET_STRESS, MARKET_LISTED, MARKET_DELISTED | no |
| severity | query | string · one of INFO, LOW, MEDIUM, HIGH, CRITICAL | no |
| instrument_id | query | string · uuid | no |
| venue_id | query | string · uuid | no |
| status | query | string · one of ACTIVE, RESOLVED, ALL · default "ALL" |
get/v1/v1/intelligence/liquidity
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| limit | query | integer · 1–500 · default 50 | no |
| cursor | query | string | no |
| from | query | string · date-time | no |
| to | query | string · date-time | no |
| type | query | string · one of VOLUME_ANOMALY, OI_EXPANSION, OI_CONTRACTION, FUNDING_EXTREME, FUNDING_DIVERGENCE, SPREAD_EXPANSION, LIQUIDITY_DETERIORATION, PRICE_DISLOCATION, MARKET_STRESS, MARKET_LISTED, MARKET_DELISTED | no |
| severity | query | string · one of INFO, LOW, MEDIUM, HIGH, CRITICAL | no |
| instrument_id | query | string · uuid | no |
| venue_id | query | string · uuid | no |
| status | query | string · one of ACTIVE, RESOLVED, ALL · default "ALL" |
get/v1/v1/intelligence/trending
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| limit | query | integer · 1–100 · default 20 | no |
| universe | query | string · one of hypercore, elysium, combined · default "combined" | no |
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"as_of": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"window": {
"type": "string",
"enum": [
"24h"
]
},
"entries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"market": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"symbol": {
"type": "string"
},
"canonical_code": {
"type": "string"
},
"display_name": {
"type": [
"string",
"null"
]
},
"base_asset": {
"type": "string"
},
"quote_asset": {
"type": "string"
},
"settlement_asset": {
"type": "string"
},
"venue": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"execution_domain": {
"type": "string",
"enum": [
"HYPERCORE_NATIVE",
"ELYSIUM_NATIVE",
"INTEGRATED_APP",
"EXTERNAL_CONTEXT"
]
}
},
"required": [
"id",
"code",
"name",
"execution_domain"
],
"additionalProperties": false
},
"protocol": {
"anyOf": [
{
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"verification_status": {
"type": "string"
}
},
"required": [
"slug",
"name",
"verification_status"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"execution_domain": {
"type": "string",
"enum": [
"HYPERCORE_NATIVE",
"ELYSIUM_NATIVE",
"INTEGRATED_APP",
"EXTERNAL_CONTEXT"
]
},
"comparability_class": {
"type": "string",
"enum": [
"DIRECT",
"NORMALIZED",
"NON_COMPARABLE"
]
},
"comparison_group": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELISTED",
"HALTED",
"PENDING"
]
},
"max_leverage": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"mark_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oracle_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"mid_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"price_change_24h_pct": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_24h_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_7d_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_30d_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"trade_count_24h": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"open_interest": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"open_interest_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oi_change_24h_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oi_change_24h_pct": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"funding_rate": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"funding_interval_seconds": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"funding_annualized": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"premium": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"spread_bps": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"depth_100bps_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"book_observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"LOCAL",
"TESTNET",
"PRODUCTION"
]
},
"observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"ingested_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"quality_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
}
},
"required": [
"source",
"environment",
"observed_at",
"ingested_at",
"quality_status"
],
"additionalProperties": false
}
},
"required": [
"id",
"symbol",
"canonical_code",
"display_name",
"base_asset",
"quote_asset",
"settlement_asset",
"venue",
"protocol",
"execution_domain",
"comparability_class",
"comparison_group",
"status",
"max_leverage",
"mark_price",
"oracle_price",
"mid_price",
"price_change_24h_pct",
"volume_24h_usd",
"volume_7d_usd",
"volume_30d_usd",
"trade_count_24h",
"open_interest",
"open_interest_usd",
"oi_change_24h_usd",
"oi_change_24h_pct",
"funding_rate",
"funding_interval_seconds",
"funding_annualized",
"premium",
"spread_bps",
"depth_100bps_usd",
"book_observed_at",
"provenance"
],
"additionalProperties": false
},
"volume_change_pct": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oi_change_pct": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"activity_score": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"active_signals": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"market",
"volume_change_pct",
"oi_change_pct",
"activity_score",
"active_signals"
],
"additionalProperties": false
}
},
"methodology": {
"type": "string"
}
},
"required": [
"as_of",
"window",
"entries",
"methodology"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/intelligence/{id}
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| id | path | string · uuid | yes |
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"event_type": {
"type": "string",
"enum": [
"VOLUME_ANOMALY",
"OI_EXPANSION",
"OI_CONTRACTION",
"FUNDING_EXTREME",
"FUNDING_DIVERGENCE",
"SPREAD_EXPANSION",
"LIQUIDITY_DETERIORATION",
"PRICE_DISLOCATION",
"MARKET_STRESS",
"MARKET_LISTED",
"MARKET_DELISTED"
]
},
"severity": {
"type": "string",
"enum": [
"INFO",
"LOW",
"MEDIUM",
"HIGH",
"CRITICAL"
]
},
"status": {
"type": "string"
},
"detected_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"window_start": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"window_end": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"instrument": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"symbol": {
"type": "string"
},
"canonical_code": {
"type": "string"
},
"venue_code": {
"type": "string"
},
"venue_name": {
"type": "string"
}
},
"required": [
"id",
"symbol",
"canonical_code",
"venue_code",
"venue_name"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"baseline": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"current_value": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"evidence": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"score": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"detector": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"parameters": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"code",
"version"
],
"additionalProperties": false
},
"methodology_url": {
"type": "string"
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"LOCAL",
"TESTNET",
"PRODUCTION"
]
},
"observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"ingested_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"quality_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
}
},
"required": [
"source",
"environment",
"observed_at",
"ingested_at",
"quality_status"
],
"additionalProperties": false
},
"observations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"observation_table": {
"type": "string"
},
"observation_time": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"observation_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
}
},
"required": [
"observation_table",
"observation_time",
"observation_id"
],
"additionalProperties": false
}
},
"market": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"symbol": {
"type": "string"
},
"canonical_code": {
"type": "string"
},
"display_name": {
"type": [
"string",
"null"
]
},
"base_asset": {
"type": "string"
},
"quote_asset": {
"type": "string"
},
"settlement_asset": {
"type": "string"
},
"venue": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"execution_domain": {
"type": "string",
"enum": [
"HYPERCORE_NATIVE",
"ELYSIUM_NATIVE",
"INTEGRATED_APP",
"EXTERNAL_CONTEXT"
]
}
},
"required": [
"id",
"code",
"name",
"execution_domain"
],
"additionalProperties": false
},
"protocol": {
"anyOf": [
{
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"verification_status": {
"type": "string"
}
},
"required": [
"slug",
"name",
"verification_status"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"execution_domain": {
"type": "string",
"enum": [
"HYPERCORE_NATIVE",
"ELYSIUM_NATIVE",
"INTEGRATED_APP",
"EXTERNAL_CONTEXT"
]
},
"comparability_class": {
"type": "string",
"enum": [
"DIRECT",
"NORMALIZED",
"NON_COMPARABLE"
]
},
"comparison_group": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELISTED",
"HALTED",
"PENDING"
]
},
"max_leverage": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"mark_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oracle_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"mid_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"price_change_24h_pct": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_24h_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_7d_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_30d_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"trade_count_24h": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"open_interest": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"open_interest_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oi_change_24h_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oi_change_24h_pct": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"funding_rate": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"funding_interval_seconds": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"funding_annualized": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"premium": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"spread_bps": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"depth_100bps_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"book_observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"LOCAL",
"TESTNET",
"PRODUCTION"
]
},
"observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"ingested_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"quality_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
}
},
"required": [
"source",
"environment",
"observed_at",
"ingested_at",
"quality_status"
],
"additionalProperties": false
}
},
"required": [
"id",
"symbol",
"canonical_code",
"display_name",
"base_asset",
"quote_asset",
"settlement_asset",
"venue",
"protocol",
"execution_domain",
"comparability_class",
"comparison_group",
"status",
"max_leverage",
"mark_price",
"oracle_price",
"mid_price",
"price_change_24h_pct",
"volume_24h_usd",
"volume_7d_usd",
"volume_30d_usd",
"trade_count_24h",
"open_interest",
"open_interest_usd",
"oi_change_24h_usd",
"oi_change_24h_pct",
"funding_rate",
"funding_interval_seconds",
"funding_annualized",
"premium",
"spread_bps",
"depth_100bps_usd",
"book_observed_at",
"provenance"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"event_type",
"severity",
"status",
"detected_at",
"window_start",
"window_end",
"instrument",
"baseline",
"current_value",
"evidence",
"score",
"detector",
"methodology_url",
"provenance",
"observations",
"market"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/chain/networks
200{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"network_code": {
"type": "string"
},
"network_name": {
"type": "string"
},
"environment": {
"type": "string"
},
"chain_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"chain_type": {
"type": "string"
},
"native_asset": {
"type": [
"string",
"null"
]
},
"explorer_url": {
"type": [
"string",
"null"
]
},
"parent_network_code": {
"type": [
"string",
"null"
]
},
"enabled": {
"type": "boolean"
},
"verified_at": {
"type": [
"string",
"null"
]
},
"verification_note": {
"type": [
"string",
"null"
]
},
"indexer": {
"anyOf": [
{
"type": "object",
"properties": {
"last_processed_block": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"head_block": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"lag_blocks": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"last_block_at": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"blocks_retained": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"contracts_discovered": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"contracts_approved": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"last_processed_block",
"head_block",
"lag_blocks",
"last_block_at",
"status",
"blocks_retained",
"contracts_discovered",
"contracts_approved"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"settlement": {
"anyOf": [
{
"type": "object",
"properties": {
"latest_batch_sequence": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"latest_batch_at": {
"type": [
"string",
"null"
]
},
"batches_observed": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"sequencer_inbox": {
"type": [
"string",
"null"
]
}
},
"required": [
"latest_batch_sequence",
"latest_batch_at",
"batches_observed",
"sequencer_inbox"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"facts": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"contracts": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"network_code",
"network_name",
"environment",
"chain_id",
"chain_type",
"native_asset",
"explorer_url",
"parent_network_code",
"enabled",
"verified_at",
"verification_note",
"indexer",
"settlement"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/chain/{code}/blocks
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| limit | query | integer · 1–200 · default 50 | no |
| code | path | string | yes |
200{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"block_number": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"block_hash": {
"type": "string"
},
"parent_hash": {
"type": "string"
},
"timestamp": {
"type": "string"
},
"tx_count": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"gas_used": {
"type": [
"number",
"null"
]
},
"base_fee_per_gas": {
"type": [
"string",
"null"
]
},
"l1_block_number": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"canonical": {
"type": "boolean"
}
},
"required": [
"block_number",
"block_hash",
"parent_hash",
"timestamp",
"tx_count",
"gas_used",
"base_fee_per_gas",
"l1_block_number",
"canonical"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/chain/{code}/stats
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| hours | query | integer · 1–168 · default 24 | no |
| code | path | string | yes |
200{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"bucket_start": {
"type": "string"
},
"block_count": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"tx_count": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"gas_used": {
"type": "string"
},
"avg_base_fee": {
"type": [
"string",
"null"
]
},
"min_block": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"max_block": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"bucket_start",
"block_count",
"tx_count",
"gas_used",
"avg_base_fee",
"min_block",
"max_block"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/chain/{code}/contracts
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| status | query | string · one of PROVISIONAL, APPROVED, IGNORED | no |
| limit | query | integer · 1–500 · default 100 | no |
| code | path | string | yes |
200{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"address": {
"type": "string"
},
"label": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"discovery_method": {
"type": "string"
},
"creator_address": {
"type": [
"string",
"null"
]
},
"creation_tx_hash": {
"type": [
"string",
"null"
]
},
"creation_block": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"discovered_at": {
"type": "string"
},
"events_indexed": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"id",
"address",
"label",
"status",
"discovery_method",
"creator_address",
"creation_tx_hash",
"creation_block",
"discovered_at",
"events_indexed"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/chain/{code}/settlement
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| limit | query | integer · 1–500 · default 50 | no |
| code | path | string | yes |
200{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"batch_sequence": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"parent_block_number": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"parent_tx_hash": {
"type": "string"
},
"batch_hash": {
"type": [
"string",
"null"
]
},
"after_delayed_messages_read": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"time_bounds": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"data_location": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"availability_type": {
"type": "string"
},
"data_size_bytes": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"observed_at": {
"type": "string"
},
"posting_delay_seconds": {
"type": [
"number",
"null"
]
}
},
"required": [
"batch_sequence",
"parent_block_number",
"parent_tx_hash",
"batch_hash",
"after_delayed_messages_read",
"time_bounds",
"data_location",
"availability_type",
"data_size_bytes",
"observed_at",
"posting_delay_seconds"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/methodology
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"analytics_version": {
"type": "string"
},
"metrics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"metric_code": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"name": {
"type": "string"
},
"formula": {
"type": "string"
},
"units": {
"type": [
"string",
"null"
]
},
"methodology": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"active": {
"type": "boolean"
}
},
"required": [
"metric_code",
"version",
"name",
"formula",
"units",
"methodology",
"active"
],
"additionalProperties": false
}
},
"analytics": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"version": {
"type": "number"
},
"formula": {
"type": "string"
},
"notes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"code",
"version",
"formula",
"notes"
],
"additionalProperties": false
}
},
"detectors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"detector_code": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"name": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"parameters": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"enabled": {
"type": "boolean"
}
},
"required": [
"detector_code",
"version",
"name",
"description",
"parameters",
"enabled"
],
"additionalProperties": false
}
},
"quality_states": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"definition": {
"type": "string"
}
},
"required": [
"status",
"definition"
],
"additionalProperties": false
}
},
"sources": {
"type": "object",
"properties": {
"hypercore": {
"type": "object",
"properties": {
"limits": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"docs_verified_at": {
"type": "string"
},
"networks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"environment": {
"type": "string"
},
"data_environment": {
"type": "string"
}
},
"required": [
"code",
"name",
"environment",
"data_environment"
],
"additionalProperties": false
}
}
},
"required": [
"limits",
"docs_verified_at",
"networks"
],
"additionalProperties": false
},
"elysium": {
"type": "object",
"properties": {
"facts": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"networks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"chain_id": {
"type": [
"number",
"null"
]
},
"environment": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"verified_at": {
"type": [
"string",
"null"
]
},
"note": {
"type": "string"
}
},
"required": [
"code",
"name",
"chain_id",
"environment",
"enabled",
"verified_at",
"note"
],
"additionalProperties": false
}
}
},
"required": [
"facts",
"networks"
],
"additionalProperties": false
}
},
"required": [
"hypercore",
"elysium"
],
"additionalProperties": false
},
"fee_schedules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"venue_code": {
"type": "string"
},
"tier_name": {
"type": "string"
},
"maker_fee": {
"type": "string"
},
"taker_fee": {
"type": "string"
},
"fee_unit": {
"type": "string"
},
"source_url": {
"type": [
"string",
"null"
]
},
"verification_status": {
"type": "string"
},
"effective_from": {
"type": "string"
}
},
"required": [
"venue_code",
"tier_name",
"maker_fee",
"taker_fee",
"fee_unit",
"source_url",
"verification_status",
"effective_from"
],
"additionalProperties": false
}
},
"generated_at": {
"type": "string"
}
},
"required": [
"analytics_version",
"metrics",
"analytics",
"detectors",
"quality_states",
"sources",
"fee_schedules",
"generated_at"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}post/v1/v1/auth/register
application/json{
"type": "object",
"properties": {
"email": {
"type": "string",
"maxLength": 320,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"password": {
"type": "string",
"minLength": 10,
"maxLength": 256
},
"display_name": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
},
"required": [
"email",
"password"
]
}200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"email": {
"type": "string"
},
"email_verified": {
"type": "boolean"
},
"display_name": {
"type": [
"string",
"null"
]
},
"role": {
"type": "string",
"enum": [
"USER",
"ADMIN"
]
},
"plan": {
"type": "string",
"enum": [
"DEVELOPER",
"PROFESSIONAL",
"INSTITUTIONAL"
]
},
"preferences": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"email",
"email_verified",
"display_name",
"role",
"plan",
"preferences",
"created_at"
],
"additionalProperties": false
},
"csrf_token": {
"type": "string"
},
"verification": {
"type": "object",
"properties": {
"required": {
"type": "boolean"
},
"delivery": {
"type": "string",
"enum": [
"email",
"unavailable"
]
},
"token": {
"type": "string"
}
},
"required": [
"required",
"delivery"
],
"additionalProperties": false
}
},
"required": [
"user",
"csrf_token"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}post/v1/v1/auth/login
application/json{
"type": "object",
"properties": {
"email": {
"type": "string",
"maxLength": 320,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"password": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"required": [
"email",
"password"
]
}200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"email": {
"type": "string"
},
"email_verified": {
"type": "boolean"
},
"display_name": {
"type": [
"string",
"null"
]
},
"role": {
"type": "string",
"enum": [
"USER",
"ADMIN"
]
},
"plan": {
"type": "string",
"enum": [
"DEVELOPER",
"PROFESSIONAL",
"INSTITUTIONAL"
]
},
"preferences": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"email",
"email_verified",
"display_name",
"role",
"plan",
"preferences",
"created_at"
],
"additionalProperties": false
},
"csrf_token": {
"type": "string"
},
"verification": {
"type": "object",
"properties": {
"required": {
"type": "boolean"
},
"delivery": {
"type": "string",
"enum": [
"email",
"unavailable"
]
},
"token": {
"type": "string"
}
},
"required": [
"required",
"delivery"
],
"additionalProperties": false
}
},
"required": [
"user",
"csrf_token"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}post/v1/v1/auth/logout
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/auth/csrf
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"csrf_token": {
"type": [
"string",
"null"
]
},
"authenticated": {
"type": "boolean"
}
},
"required": [
"csrf_token",
"authenticated"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}post/v1/v1/auth/verify-email
application/json{
"type": "object",
"properties": {
"token": {
"type": "string",
"minLength": 16
}
},
"required": [
"token"
]
}200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"verified": {
"type": "boolean"
}
},
"required": [
"verified"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}post/v1/v1/auth/request-password-reset
application/json{
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
}
},
"required": [
"email"
]
}200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"accepted": {
"type": "boolean",
"enum": [
true
]
},
"token": {
"type": "string"
}
},
"required": [
"accepted"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}post/v1/v1/auth/reset-password
application/json{
"type": "object",
"properties": {
"token": {
"type": "string",
"minLength": 16
},
"password": {
"type": "string",
"minLength": 10,
"maxLength": 256
}
},
"required": [
"token",
"password"
]
}200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"reset": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"reset"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/users/me
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"email": {
"type": "string"
},
"email_verified": {
"type": "boolean"
},
"display_name": {
"type": [
"string",
"null"
]
},
"role": {
"type": "string",
"enum": [
"USER",
"ADMIN"
]
},
"plan": {
"type": "string",
"enum": [
"DEVELOPER",
"PROFESSIONAL",
"INSTITUTIONAL"
]
},
"preferences": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"email",
"email_verified",
"display_name",
"role",
"plan",
"preferences",
"created_at"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}patch/v1/v1/users/me
application/json{
"type": "object",
"properties": {
"display_name": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"preferences": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
}
}200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"email": {
"type": "string"
},
"email_verified": {
"type": "boolean"
},
"display_name": {
"type": [
"string",
"null"
]
},
"role": {
"type": "string",
"enum": [
"USER",
"ADMIN"
]
},
"plan": {
"type": "string",
"enum": [
"DEVELOPER",
"PROFESSIONAL",
"INSTITUTIONAL"
]
},
"preferences": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"email",
"email_verified",
"display_name",
"role",
"plan",
"preferences",
"created_at"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}delete/v1/v1/users/me
application/json{
"type": "object",
"properties": {
"password": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"required": [
"password"
]
}200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"deleted": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"deleted"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}delete/v1/v1/auth/sessions
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"revoked": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"revoked"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/watchlists
200{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"position": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"filters": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"market_count": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"name",
"position",
"filters",
"market_count",
"created_at",
"updated_at"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}post/v1/v1/watchlists
application/json{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"filters": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"name"
]
}200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"position": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"filters": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"market_count": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"name",
"position",
"filters",
"market_count",
"created_at",
"updated_at"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/watchlists/{id}
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| id | path | string · uuid | yes |
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"position": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"filters": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"market_count": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"markets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"symbol": {
"type": "string"
},
"canonical_code": {
"type": "string"
},
"display_name": {
"type": [
"string",
"null"
]
},
"base_asset": {
"type": "string"
},
"quote_asset": {
"type": "string"
},
"settlement_asset": {
"type": "string"
},
"venue": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"execution_domain": {
"type": "string",
"enum": [
"HYPERCORE_NATIVE",
"ELYSIUM_NATIVE",
"INTEGRATED_APP",
"EXTERNAL_CONTEXT"
]
}
},
"required": [
"id",
"code",
"name",
"execution_domain"
],
"additionalProperties": false
},
"protocol": {
"anyOf": [
{
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"verification_status": {
"type": "string"
}
},
"required": [
"slug",
"name",
"verification_status"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"execution_domain": {
"type": "string",
"enum": [
"HYPERCORE_NATIVE",
"ELYSIUM_NATIVE",
"INTEGRATED_APP",
"EXTERNAL_CONTEXT"
]
},
"comparability_class": {
"type": "string",
"enum": [
"DIRECT",
"NORMALIZED",
"NON_COMPARABLE"
]
},
"comparison_group": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELISTED",
"HALTED",
"PENDING"
]
},
"max_leverage": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"mark_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oracle_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"mid_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"price_change_24h_pct": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_24h_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_7d_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"volume_30d_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"trade_count_24h": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"open_interest": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"open_interest_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oi_change_24h_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"oi_change_24h_pct": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"funding_rate": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"funding_interval_seconds": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"funding_annualized": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"premium": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"spread_bps": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"depth_100bps_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"book_observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"LOCAL",
"TESTNET",
"PRODUCTION"
]
},
"observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"ingested_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"quality_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
}
},
"required": [
"source",
"environment",
"observed_at",
"ingested_at",
"quality_status"
],
"additionalProperties": false
}
},
"required": [
"id",
"symbol",
"canonical_code",
"display_name",
"base_asset",
"quote_asset",
"settlement_asset",
"venue",
"protocol",
"execution_domain",
"comparability_class",
"comparison_group",
"status",
"max_leverage",
"mark_price",
"oracle_price",
"mid_price",
"price_change_24h_pct",
"volume_24h_usd",
"volume_7d_usd",
"volume_30d_usd",
"trade_count_24h",
"open_interest",
"open_interest_usd",
"oi_change_24h_usd",
"oi_change_24h_pct",
"funding_rate",
"funding_interval_seconds",
"funding_annualized",
"premium",
"spread_bps",
"depth_100bps_usd",
"book_observed_at",
"provenance"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"name",
"position",
"filters",
"market_count",
"created_at",
"updated_at",
"markets"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}patch/v1/v1/watchlists/{id}
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| id | path | string · uuid | yes |
application/json{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"position": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"filters": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
}
}
}200delete/v1/v1/watchlists/{id}
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| id | path | string · uuid | yes |
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"deleted": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"deleted"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}post/v1/v1/watchlists/{id}/markets
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| id | path | string · uuid | yes |
application/json{
"type": "object",
"properties": {
"instrument_ids": {
"minItems": 1,
"maxItems": 200,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
}
},
"required": [
"instrument_ids"
]
}200delete/v1/v1/watchlists/{id}/markets
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| id | path | string · uuid | yes |
application/json{
"type": "object",
"properties": {
"instrument_ids": {
"minItems": 1,
"maxItems": 200,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
}
},
"required": [
"instrument_ids"
]
}200put/v1/v1/watchlists/{id}/markets/order
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| id | path | string · uuid | yes |
application/json{
"type": "object",
"properties": {
"instrument_ids": {
"minItems": 1,
"maxItems": 200,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
}
},
"required": [
"instrument_ids"
]
}200get/v1/v1/alerts
200{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": [
"string",
"null"
]
},
"alert_type": {
"type": "string",
"enum": [
"VOLUME_THRESHOLD",
"OI_CHANGE_PCT",
"FUNDING_THRESHOLD",
"FUNDING_DIVERGENCE",
"SPREAD_EXPANSION",
"LIQUIDITY_DETERIORATION",
"MARKET_LISTED",
"MARKET_DELISTED",
"INTELLIGENCE_SEVERITY",
"PRICE_THRESHOLD"
]
},
"instrument": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"symbol": {
"type": "string"
},
"venue_code": {
"type": "string"
}
},
"required": [
"id",
"symbol",
"venue_code"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"venue_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"condition": {
"type": "object",
"properties": {
"operator": {
"type": "string",
"enum": [
"gt",
"lt",
"gte",
"lte",
"abs_gt",
"change_pct_gt",
"change_pct_lt"
]
},
"threshold": {
"type": "string"
},
"window_seconds": {
"type": "integer",
"minimum": 60,
"maximum": 604800
},
"severity": {
"type": "string",
"enum": [
"LOW",
"MEDIUM",
"HIGH",
"CRITICAL"
]
}
},
"required": [
"operator",
"threshold"
],
"additionalProperties": false
},
"channels": {
"type": "array",
"items": {
"type": "string",
"enum": [
"IN_APP",
"EMAIL",
"TELEGRAM",
"DISCORD",
"WEBHOOK"
]
}
},
"cooldown_seconds": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"enabled": {
"type": "boolean"
},
"last_triggered_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"name",
"alert_type",
"instrument",
"venue_id",
"condition",
"channels",
"cooldown_seconds",
"enabled",
"last_triggered_at",
"created_at"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}post/v1/v1/alerts
application/json{
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 128
},
"alert_type": {
"type": "string",
"enum": [
"VOLUME_THRESHOLD",
"OI_CHANGE_PCT",
"FUNDING_THRESHOLD",
"FUNDING_DIVERGENCE",
"SPREAD_EXPANSION",
"LIQUIDITY_DETERIORATION",
"MARKET_LISTED",
"MARKET_DELISTED",
"INTELLIGENCE_SEVERITY",
"PRICE_THRESHOLD"
]
},
"instrument_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"venue_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"type": "object",
"properties": {
"operator": {
"type": "string",
"enum": [
"gt",
"lt",
"gte",
"lte",
"abs_gt",
"change_pct_gt",
"change_pct_lt"
]
},
"threshold": {
"type": "string"
},
"window_seconds": {
"type": "integer",
"minimum": 60,
"maximum": 604800
},
"severity": {
"type": "string",
"enum": [
"LOW",
"MEDIUM",
"HIGH",
"CRITICAL"
]
}
},
"required": [
"operator",
"threshold"
]
},
"channels": {
"default": [
"IN_APP"
],
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"IN_APP",
"EMAIL",
"TELEGRAM",
"DISCORD",
"WEBHOOK"
]
}
},
"cooldown_seconds": {
"default": 3600,
"type": "integer",
"minimum": 60,
"maximum": 604800
},
"enabled": {
"default": true,
"type": "boolean"
}
},
"required": [
"alert_type",
"condition"
]
}patch/v1/v1/alerts/{id}
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| id | path | string · uuid | yes |
application/json{
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 128
},
"alert_type": {
"type": "string",
"enum": [
"VOLUME_THRESHOLD",
"OI_CHANGE_PCT",
"FUNDING_THRESHOLD",
"FUNDING_DIVERGENCE",
"SPREAD_EXPANSION",
"LIQUIDITY_DETERIORATION",
"MARKET_LISTED",
"MARKET_DELISTED",
"INTELLIGENCE_SEVERITY",
"PRICE_THRESHOLD"
]
},
"instrument_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"venue_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"condition": {
"type": "object",
"properties": {
"operator": {
"type": "string",
"enum": [
"gt",
"lt",
"gte",
"lte",
"abs_gt",
"change_pct_gt",
"change_pct_lt"
]
},
"threshold": {
"type": "string"
},
"window_seconds": {
"type": "integer",
"minimum": 60,
"maximum": 604800
},
"severity": {
"type": "string",
"enum": [
"LOW",
"MEDIUM",
"HIGH",
"CRITICAL"
]
}
},
"required": [
"operator",
"threshold"
]
},
"channels": {
"default": [
"IN_APP"
],
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"IN_APP",
"EMAIL",
"TELEGRAM",
"DISCORD",
"WEBHOOK"
]
}
},
"cooldown_seconds": {
"default": 3600,
"type": "integer",
"minimum": 60,
"maximum": 604800
},
"enabled": {
"default": true,
"type": "boolean"
}
}
}delete/v1/v1/alerts/{id}
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| id | path | string · uuid | yes |
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"deleted": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"deleted"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/notifications
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| limit | query | integer · 1–500 · default 50 | no |
| cursor | query | string | no |
| unread_only | query | boolean | no |
200{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"alert_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"channel": {
"type": "string"
},
"title": {
"type": "string"
},
"payload": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"status": {
"type": "string"
},
"delivered_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"read_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"alert_id",
"channel",
"title",
"payload",
"status",
"delivered_at",
"read_at",
"created_at"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}post/v1/v1/notifications/{id}/read
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| id | path | string · uuid | yes |
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"read": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"read"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}post/v1/v1/notifications/read-all
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"updated": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"updated"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/notification-channels
200{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"channel_type": {
"type": "string",
"enum": [
"EMAIL",
"TELEGRAM",
"DISCORD",
"WEBHOOK"
]
},
"label": {
"type": [
"string",
"null"
]
},
"destination": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"channel_type",
"label",
"destination",
"verified",
"enabled",
"created_at"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}post/v1/v1/notification-channels
application/json{
"type": "object",
"properties": {
"channel_type": {
"type": "string",
"enum": [
"EMAIL",
"TELEGRAM",
"DISCORD",
"WEBHOOK"
]
},
"label": {
"type": "string",
"maxLength": 128
},
"config": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"webhook_url": {
"type": "string",
"format": "uri"
},
"bot_token": {
"type": "string"
},
"chat_id": {
"type": "string"
}
}
}
},
"required": [
"channel_type",
"config"
]
}delete/v1/v1/notification-channels/{id}
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| id | path | string · uuid | yes |
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"deleted": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"deleted"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/api-keys
200{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"key_prefix": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"rate_limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"expires_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"revoked_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"last_used_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"name",
"key_prefix",
"scopes",
"rate_limit",
"expires_at",
"revoked_at",
"last_used_at",
"created_at"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}post/v1/v1/api-keys
application/json{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"scopes": {
"default": [
"read"
],
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"read",
"stream"
]
}
},
"expires_in_days": {
"type": "integer",
"minimum": 1,
"maximum": 365
}
},
"required": [
"name"
]
}200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"key_prefix": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"rate_limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"expires_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"revoked_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"last_used_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"key": {
"type": "string"
}
},
"required": [
"id",
"name",
"key_prefix",
"scopes",
"rate_limit",
"expires_at",
"revoked_at",
"last_used_at",
"created_at",
"key"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}delete/v1/v1/api-keys/{id}
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| id | path | string · uuid | yes |
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"key_prefix": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"rate_limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"expires_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"revoked_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"last_used_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"name",
"key_prefix",
"scopes",
"rate_limit",
"expires_at",
"revoked_at",
"last_used_at",
"created_at"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/api-usage
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| window | query | string · one of 24h, 7d, 30d · default "7d" | no |
| api_key_id | query | string · uuid | no |
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"window": {
"type": "string",
"enum": [
"24h",
"7d",
"30d"
]
},
"requests": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"errors": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"by_endpoint": {
"type": "array",
"items": {
"type": "object",
"properties": {
"endpoint": {
"type": "string"
},
"requests": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"avg_ms": {
"type": "number"
}
},
"required": [
"endpoint",
"requests",
"avg_ms"
],
"additionalProperties": false
}
},
"by_day": {
"type": "array",
"items": {
"type": "object",
"properties": {
"day": {
"type": "string"
},
"requests": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"day",
"requests"
],
"additionalProperties": false
}
},
"rate_limit_per_minute": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"window",
"requests",
"errors",
"by_endpoint",
"by_day",
"rate_limit_per_minute"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/admin/overview
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}patch/v1/v1/admin/protocols/{slug}
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| slug | path | string | yes |
application/json{
"type": "object",
"properties": {
"verification_status": {
"type": "string",
"enum": [
"DISCOVERED",
"PROVISIONAL",
"VERIFIED",
"INACTIVE"
]
},
"website": {
"type": "string",
"format": "uri"
},
"documentation_url": {
"type": "string",
"format": "uri"
},
"note": {
"type": "string",
"maxLength": 500
}
},
"required": [
"verification_status"
]
}200patch/v1/v1/admin/contracts/{id}
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| id | path | string · uuid | yes |
application/json{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"PROVISIONAL",
"APPROVED",
"IGNORED"
]
},
"label": {
"type": "string",
"maxLength": 128
},
"abi": {
"type": "array",
"items": {}
},
"protocol_slug": {
"type": "string"
}
}
}200patch/v1/v1/admin/detectors/{code}
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| code | path | string | yes |
application/json{
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"parameters": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
}
}200{
"type": "object",
"properties": {
"data": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}get/v1/v1/admin/quality-events
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| open_only | query | boolean · default true | no |
| limit | query | integer · 1–500 · default 100 | no |
200{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}post/v1/v1/admin/quality-events/{id}/resolve
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| id | path | string · uuid | yes |
200{
"type": "object",
"properties": {
"data": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}post/v1/v1/admin/corrections
application/json{
"type": "object",
"properties": {
"target_table": {
"type": "string",
"maxLength": 64
},
"target_id": {
"type": "string",
"maxLength": 200
},
"old_value": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"new_value": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"reason": {
"type": "string",
"minLength": 5,
"maxLength": 2000
}
},
"required": [
"target_table",
"target_id",
"old_value",
"new_value",
"reason"
]
}200get/v1/v1/admin/audit-log
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| limit | query | integer · 1–500 · default 100 | no |
200{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}post/v1/v1/admin/users/{id}/role
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| id | path | string · uuid | yes |
application/json{
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"USER",
"ADMIN"
]
},
"plan": {
"type": "string",
"enum": [
"DEVELOPER",
"PROFESSIONAL",
"INSTITUTIONAL"
]
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"SUSPENDED"
]
}
}
}200200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"instrument_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"side": {
"type": "string",
"enum": [
"BUY",
"SELL"
]
},
"status": {
"type": "string",
"enum": [
"FILLED",
"INSUFFICIENT_OBSERVED_DEPTH"
]
},
"requested_notional_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"requested_quantity": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"filled_notional_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"filled_quantity": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"unfilled_notional_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"unfilled_quantity": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"average_execution_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"reference_mid_price": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"best_opposite_price": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"spread_cost_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"price_impact_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"estimated_fee_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"estimated_total_cost_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"slippage_bps": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"levels_consumed": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"book_levels_available": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"fee_assumption": {
"type": "object",
"properties": {
"fee_type": {
"type": "string"
},
"rate_bps": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"source": {
"type": "string"
}
},
"required": [
"fee_type",
"rate_bps",
"source"
],
"additionalProperties": false
},
"snapshot_timestamp": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"snapshot_age_ms": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"methodology": {
"type": "string"
},
"quality_status": {
"type": "string",
"enum": [
"ESTIMATED"
]
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"LOCAL",
"TESTNET",
"PRODUCTION"
]
},
"observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"ingested_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"quality_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
}
},
"required": [
"source",
"environment",
"observed_at",
"ingested_at",
"quality_status"
],
"additionalProperties": false
}
},
"required": [
"instrument_id",
"side",
"status",
"requested_notional_usd",
"requested_quantity",
"filled_notional_usd",
"filled_quantity",
"unfilled_notional_usd",
"unfilled_quantity",
"average_execution_price",
"reference_mid_price",
"best_opposite_price",
"spread_cost_usd",
"price_impact_usd",
"estimated_fee_usd",
"estimated_total_cost_usd",
"slippage_bps",
"levels_consumed",
"book_levels_available",
"fee_assumption",
"snapshot_timestamp",
"snapshot_age_ms",
"methodology",
"quality_status",
"provenance"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"comparison_group": {
"type": "string"
},
"side": {
"type": "string",
"enum": [
"BUY",
"SELL"
]
},
"order_size_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"fee_type": {
"type": "string"
},
"rows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"instrument_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"symbol": {
"type": "string"
},
"canonical_code": {
"type": "string"
},
"venue": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"code",
"name"
],
"additionalProperties": false
},
"settlement_asset": {
"type": "string"
},
"comparability_class": {
"type": "string",
"enum": [
"DIRECT",
"NORMALIZED",
"NON_COMPARABLE"
]
},
"rankable": {
"type": "boolean"
},
"rank": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"funding_rate": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"funding_interval_seconds": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"funding_hourly_normalized": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"funding_annualized": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"mark_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"spread_bps": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"depth_100bps_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"fee_bps": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"fee_source": {
"type": "string"
},
"execution": {
"anyOf": [
{
"type": "object",
"properties": {
"instrument_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"side": {
"type": "string",
"enum": [
"BUY",
"SELL"
]
},
"status": {
"type": "string",
"enum": [
"FILLED",
"INSUFFICIENT_OBSERVED_DEPTH"
]
},
"requested_notional_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"requested_quantity": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"filled_notional_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"filled_quantity": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"unfilled_notional_usd": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"unfilled_quantity": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"average_execution_price": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"reference_mid_price": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"best_opposite_price": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"spread_cost_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"price_impact_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"estimated_fee_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"estimated_total_cost_usd": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"slippage_bps": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"levels_consumed": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"book_levels_available": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"fee_assumption": {
"type": "object",
"properties": {
"fee_type": {
"type": "string"
},
"rate_bps": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
"source": {
"type": "string"
}
},
"required": [
"fee_type",
"rate_bps",
"source"
],
"additionalProperties": false
},
"snapshot_timestamp": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"snapshot_age_ms": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"methodology": {
"type": "string"
},
"quality_status": {
"type": "string",
"enum": [
"ESTIMATED"
]
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"LOCAL",
"TESTNET",
"PRODUCTION"
]
},
"observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"ingested_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"quality_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
}
},
"required": [
"source",
"environment",
"observed_at",
"ingested_at",
"quality_status"
],
"additionalProperties": false
}
},
"required": [
"instrument_id",
"side",
"status",
"requested_notional_usd",
"requested_quantity",
"filled_notional_usd",
"filled_quantity",
"unfilled_notional_usd",
"unfilled_quantity",
"average_execution_price",
"reference_mid_price",
"best_opposite_price",
"spread_cost_usd",
"price_impact_usd",
"estimated_fee_usd",
"estimated_total_cost_usd",
"slippage_bps",
"levels_consumed",
"book_levels_available",
"fee_assumption",
"snapshot_timestamp",
"snapshot_age_ms",
"methodology",
"quality_status",
"provenance"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"book_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"MISSING"
]
},
"disclosures": {
"type": "array",
"items": {
"type": "string"
}
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"LOCAL",
"TESTNET",
"PRODUCTION"
]
},
"observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"ingested_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"quality_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
}
},
"required": [
"source",
"environment",
"observed_at",
"ingested_at",
"quality_status"
],
"additionalProperties": false
}
},
"required": [
"instrument_id",
"symbol",
"canonical_code",
"venue",
"settlement_asset",
"comparability_class",
"rankable",
"rank",
"funding_rate",
"funding_interval_seconds",
"funding_hourly_normalized",
"funding_annualized",
"mark_price",
"spread_bps",
"depth_100bps_usd",
"fee_bps",
"fee_source",
"execution",
"book_status",
"disclosures",
"provenance"
],
"additionalProperties": false
}
},
"non_comparable": {
"type": "array",
"items": {
"type": "object",
"properties": {
"instrument_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"reason": {
"type": "string"
}
},
"required": [
"instrument_id",
"reason"
],
"additionalProperties": false
}
},
"methodology": {
"type": "string"
},
"as_of": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"comparison_group",
"side",
"order_size_usd",
"fee_type",
"rows",
"non_comparable",
"methodology",
"as_of"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}| no |
| domain | query | string · one of HYPERCORE_NATIVE, ELYSIUM_NATIVE | no |
200{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"event_type": {
"type": "string",
"enum": [
"VOLUME_ANOMALY",
"OI_EXPANSION",
"OI_CONTRACTION",
"FUNDING_EXTREME",
"FUNDING_DIVERGENCE",
"SPREAD_EXPANSION",
"LIQUIDITY_DETERIORATION",
"PRICE_DISLOCATION",
"MARKET_STRESS",
"MARKET_LISTED",
"MARKET_DELISTED"
]
},
"severity": {
"type": "string",
"enum": [
"INFO",
"LOW",
"MEDIUM",
"HIGH",
"CRITICAL"
]
},
"status": {
"type": "string"
},
"detected_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"window_start": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"window_end": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"instrument": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"symbol": {
"type": "string"
},
"canonical_code": {
"type": "string"
},
"venue_code": {
"type": "string"
},
"venue_name": {
"type": "string"
}
},
"required": [
"id",
"symbol",
"canonical_code",
"venue_code",
"venue_name"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"baseline": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"current_value": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"evidence": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"score": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"detector": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"parameters": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"code",
"version"
],
"additionalProperties": false
},
"methodology_url": {
"type": "string"
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"LOCAL",
"TESTNET",
"PRODUCTION"
]
},
"observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"ingested_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"quality_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
}
},
"required": [
"source",
"environment",
"observed_at",
"ingested_at",
"quality_status"
],
"additionalProperties": false
}
},
"required": [
"id",
"event_type",
"severity",
"status",
"detected_at",
"window_start",
"window_end",
"instrument",
"baseline",
"current_value",
"evidence",
"score",
"detector",
"methodology_url",
"provenance"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}| no |
| domain | query | string · one of HYPERCORE_NATIVE, ELYSIUM_NATIVE | no |
200{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"event_type": {
"type": "string",
"enum": [
"VOLUME_ANOMALY",
"OI_EXPANSION",
"OI_CONTRACTION",
"FUNDING_EXTREME",
"FUNDING_DIVERGENCE",
"SPREAD_EXPANSION",
"LIQUIDITY_DETERIORATION",
"PRICE_DISLOCATION",
"MARKET_STRESS",
"MARKET_LISTED",
"MARKET_DELISTED"
]
},
"severity": {
"type": "string",
"enum": [
"INFO",
"LOW",
"MEDIUM",
"HIGH",
"CRITICAL"
]
},
"status": {
"type": "string"
},
"detected_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"window_start": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"window_end": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"instrument": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"symbol": {
"type": "string"
},
"canonical_code": {
"type": "string"
},
"venue_code": {
"type": "string"
},
"venue_name": {
"type": "string"
}
},
"required": [
"id",
"symbol",
"canonical_code",
"venue_code",
"venue_name"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"baseline": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"current_value": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"evidence": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"score": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$"
},
{
"type": "null"
}
]
},
"detector": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"parameters": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"code",
"version"
],
"additionalProperties": false
},
"methodology_url": {
"type": "string"
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"LOCAL",
"TESTNET",
"PRODUCTION"
]
},
"observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"ingested_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"quality_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
}
},
"required": [
"source",
"environment",
"observed_at",
"ingested_at",
"quality_status"
],
"additionalProperties": false
}
},
"required": [
"id",
"event_type",
"severity",
"status",
"detected_at",
"window_start",
"window_end",
"instrument",
"baseline",
"current_value",
"evidence",
"score",
"detector",
"methodology_url",
"provenance"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"position": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"filters": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"market_count": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"name",
"position",
"filters",
"market_count",
"created_at",
"updated_at"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"position": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"filters": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"market_count": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"name",
"position",
"filters",
"market_count",
"created_at",
"updated_at"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"position": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"filters": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"market_count": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"name",
"position",
"filters",
"market_count",
"created_at",
"updated_at"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"position": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"filters": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"market_count": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"name",
"position",
"filters",
"market_count",
"created_at",
"updated_at"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": [
"string",
"null"
]
},
"alert_type": {
"type": "string",
"enum": [
"VOLUME_THRESHOLD",
"OI_CHANGE_PCT",
"FUNDING_THRESHOLD",
"FUNDING_DIVERGENCE",
"SPREAD_EXPANSION",
"LIQUIDITY_DETERIORATION",
"MARKET_LISTED",
"MARKET_DELISTED",
"INTELLIGENCE_SEVERITY",
"PRICE_THRESHOLD"
]
},
"instrument": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"symbol": {
"type": "string"
},
"venue_code": {
"type": "string"
}
},
"required": [
"id",
"symbol",
"venue_code"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"venue_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"condition": {
"type": "object",
"properties": {
"operator": {
"type": "string",
"enum": [
"gt",
"lt",
"gte",
"lte",
"abs_gt",
"change_pct_gt",
"change_pct_lt"
]
},
"threshold": {
"type": "string"
},
"window_seconds": {
"type": "integer",
"minimum": 60,
"maximum": 604800
},
"severity": {
"type": "string",
"enum": [
"LOW",
"MEDIUM",
"HIGH",
"CRITICAL"
]
}
},
"required": [
"operator",
"threshold"
],
"additionalProperties": false
},
"channels": {
"type": "array",
"items": {
"type": "string",
"enum": [
"IN_APP",
"EMAIL",
"TELEGRAM",
"DISCORD",
"WEBHOOK"
]
}
},
"cooldown_seconds": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"enabled": {
"type": "boolean"
},
"last_triggered_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"name",
"alert_type",
"instrument",
"venue_id",
"condition",
"channels",
"cooldown_seconds",
"enabled",
"last_triggered_at",
"created_at"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": [
"string",
"null"
]
},
"alert_type": {
"type": "string",
"enum": [
"VOLUME_THRESHOLD",
"OI_CHANGE_PCT",
"FUNDING_THRESHOLD",
"FUNDING_DIVERGENCE",
"SPREAD_EXPANSION",
"LIQUIDITY_DETERIORATION",
"MARKET_LISTED",
"MARKET_DELISTED",
"INTELLIGENCE_SEVERITY",
"PRICE_THRESHOLD"
]
},
"instrument": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"symbol": {
"type": "string"
},
"venue_code": {
"type": "string"
}
},
"required": [
"id",
"symbol",
"venue_code"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"venue_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"condition": {
"type": "object",
"properties": {
"operator": {
"type": "string",
"enum": [
"gt",
"lt",
"gte",
"lte",
"abs_gt",
"change_pct_gt",
"change_pct_lt"
]
},
"threshold": {
"type": "string"
},
"window_seconds": {
"type": "integer",
"minimum": 60,
"maximum": 604800
},
"severity": {
"type": "string",
"enum": [
"LOW",
"MEDIUM",
"HIGH",
"CRITICAL"
]
}
},
"required": [
"operator",
"threshold"
],
"additionalProperties": false
},
"channels": {
"type": "array",
"items": {
"type": "string",
"enum": [
"IN_APP",
"EMAIL",
"TELEGRAM",
"DISCORD",
"WEBHOOK"
]
}
},
"cooldown_seconds": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"enabled": {
"type": "boolean"
},
"last_triggered_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"name",
"alert_type",
"instrument",
"venue_id",
"condition",
"channels",
"cooldown_seconds",
"enabled",
"last_triggered_at",
"created_at"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}200{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"channel_type": {
"type": "string",
"enum": [
"EMAIL",
"TELEGRAM",
"DISCORD",
"WEBHOOK"
]
},
"label": {
"type": [
"string",
"null"
]
},
"destination": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"channel_type",
"label",
"destination",
"verified",
"enabled",
"created_at"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}{
"type": "object",
"properties": {
"data": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}{
"type": "object",
"properties": {
"data": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}{
"type": "object",
"properties": {
"data": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}{
"type": "object",
"properties": {
"data": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"meta": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"generated_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"environment": {
"type": "string",
"enum": [
"local",
"testnet",
"production"
]
},
"source_status": {
"type": "string",
"enum": [
"LIVE",
"DELAYED",
"STALE",
"ESTIMATED",
"RECONSTRUCTED",
"MISSING",
"UNAVAILABLE",
"INVALID"
]
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"request_id",
"generated_at",
"environment"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}