{ "openapi": "3.1.1", "info": { "title": "Hendrix Public API", "description": "Versioned market microstructure intelligence. Descriptive analytics only; no directional trading advice.", "version": "v1" }, "servers": [ { "url": "https://api.hendrix.systems", "description": "Production" } ], "paths": { "/healthz": { "get": { "tags": [ "Operations" ], "summary": "Confirm that the API process is healthy.", "operationId": "GetHealth", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiServiceHealthResponse" } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/livez": { "get": { "tags": [ "Operations" ], "summary": "Confirm that the API process is live.", "operationId": "GetLiveness", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiServiceHealthResponse" } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/readyz": { "get": { "tags": [ "Operations" ], "summary": "Check whether required API dependencies are ready.", "operationId": "GetReadiness", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiReadinessResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiReadinessResponse" } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/markets": { "get": { "tags": [ "Public" ], "summary": "List active markets and route capabilities.", "operationId": "ListMarkets", "parameters": [ { "name": "market_type", "in": "query", "schema": { "type": "string" } }, { "name": "is_hip3", "in": "query", "schema": { "type": "string" } }, { "name": "family", "in": "query", "schema": { "type": "string" } }, { "name": "projection", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarketResponse" } } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/markets/overview": { "get": { "tags": [ "Public" ], "summary": "Get current market microstructure overview rows.", "operationId": "GetMarketsOverview", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarketOverviewResponse" } } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/markets/{market}/metrics": { "get": { "tags": [ "Public" ], "summary": "Get a precomputed market metric series.", "operationId": "GetMarketMetrics", "parameters": [ { "name": "market", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "metric", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "venue", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricSeriesResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/markets/{market}/open-interest": { "get": { "tags": [ "Public" ], "summary": "Get open-interest posture and source series for a market.", "operationId": "GetMarketOpenInterest", "parameters": [ { "name": "market", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "venue", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenInterestSnapshotResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/markets/{market}/liquidity-posture": { "get": { "tags": [ "Public" ], "summary": "Get the evaluated liquidity posture for a market.", "operationId": "GetMarketLiquidityPosture", "parameters": [ { "name": "market", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "venue", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiquidityPostureResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/markets/{market}/liquidations": { "get": { "tags": [ "Public" ], "summary": "Get liquidation activity and pressure for a market.", "operationId": "GetMarketLiquidations", "parameters": [ { "name": "market", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "venue", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiquidationSnapshotResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/markets/{market}/ohlc": { "get": { "tags": [ "Public" ], "summary": "Get OHLC candles for a market.", "operationId": "GetMarketOhlc", "parameters": [ { "name": "market", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "venue", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OhlcSeriesResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/markets/{market}/depth": { "get": { "tags": [ "Public" ], "summary": "Get the current order-book depth profile for a market.", "operationId": "GetMarketDepth", "parameters": [ { "name": "market", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "venue", "in": "query", "schema": { "type": "string" } }, { "name": "levels", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DepthResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/markets/{market}/funding": { "get": { "tags": [ "Public" ], "summary": "Get the latest funding state or a bounded funding series for a market.", "operationId": "GetMarketFunding", "parameters": [ { "name": "market", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "required": [ "market", "decision_time", "rates" ], "type": "object", "properties": { "market": { "type": "string" }, "decision_time": { "type": "string", "format": "date-time" }, "rates": { "type": "array", "items": { "required": [ "venue", "rate", "ts", "observed_at", "freshness", "interval", "annualization", "index_price", "mark_price", "oracle_price", "open_interest", "basis_bps", "latest_settlement_event_time", "latest_settlement_observed_at", "latest_settlement_rate", "premium", "source_lineage", "null_reason_codes", "quality_flags" ], "type": "object", "properties": { "venue": { "type": "string" }, "rate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "ts": { "type": "string", "format": "date-time" }, "observed_at": { "type": "string", "format": "date-time" }, "freshness": { "required": [ "decision_time", "observed_at", "age_seconds", "status", "reason_code", "max_age_seconds", "grace_seconds", "next_expected_observation_seconds" ], "type": "object", "properties": { "decision_time": { "type": "string", "format": "date-time" }, "observed_at": { "type": [ "null", "string" ], "format": "date-time" }, "age_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "status": { "type": "string" }, "reason_code": { "type": "string" }, "max_age_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "grace_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "next_expected_observation_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "interval": { "required": [ "kind", "seconds", "hours" ], "type": "object", "properties": { "kind": { "type": "string" }, "seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "hours": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "annualization": { "required": [ "method", "annualized_rate", "eight_hour_equivalent_rate", "interval_count_per_year" ], "type": "object", "properties": { "method": { "type": "string" }, "annualized_rate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "eight_hour_equivalent_rate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "interval_count_per_year": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "index_price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "mark_price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "oracle_price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "open_interest": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "basis_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "latest_settlement_event_time": { "type": [ "null", "string" ], "format": "date-time" }, "latest_settlement_observed_at": { "type": [ "null", "string" ], "format": "date-time" }, "latest_settlement_rate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "premium": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "source_lineage": { "type": "array", "items": { "required": [ "role", "source", "source_version", "observed_at", "event_time", "timestamp_policy", "parser_version" ], "type": "object", "properties": { "role": { "type": "string" }, "source": { "type": "string" }, "source_version": { "type": [ "null", "string" ] }, "observed_at": { "type": [ "null", "string" ], "format": "date-time" }, "event_time": { "type": [ "null", "string" ], "format": "date-time" }, "timestamp_policy": { "type": [ "null", "string" ] }, "parser_version": { "type": [ "null", "string" ] } } } }, "null_reason_codes": { "type": "array", "items": { "type": "string" } }, "quality_flags": { "type": "array", "items": { "type": "string" } } } } } } }, { "required": [ "market", "venues" ], "type": "object", "properties": { "market": { "type": "string" }, "venues": { "type": "object", "additionalProperties": { "type": "array", "items": { "required": [ "ts", "value" ], "type": "object", "properties": { "ts": { "type": "string", "format": "date-time" }, "value": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } } } } } } ] } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false }, "x-hendrix-data-rights": { "posture": "context_redacted_when_disabled", "raw_licensed_payloads_exposed": false } } }, "/v1/funding/overview": { "get": { "tags": [ "Public" ], "summary": "Get latest funding posture across active markets.", "operationId": "GetFundingOverview", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FundingOverviewResponse" } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false }, "x-hendrix-data-rights": { "posture": "context_redacted_when_disabled", "raw_licensed_payloads_exposed": false } } }, "/v1/scoreboard": { "get": { "tags": [ "Public" ], "summary": "Get the price-discovery scoreboard for the requested window.", "operationId": "GetPriceDiscoveryScoreboard", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScoreboardResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } }, "451": { "description": "CEX-derived public/API surfaces are disabled pending commercial data-rights review.", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false }, "x-hendrix-data-rights": { "posture": "required", "raw_licensed_payloads_exposed": false } } }, "/v1/coinbase/premium": { "get": { "tags": [ "Public" ], "summary": "Get the bounded Coinbase premium series.", "operationId": "GetCoinbasePremium", "parameters": [ { "name": "market", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoinbasePremiumSeriesResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } }, "451": { "description": "CEX-derived public/API surfaces are disabled pending commercial data-rights review.", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false }, "x-hendrix-data-rights": { "posture": "required", "raw_licensed_payloads_exposed": false } } }, "/v1/perp/basis": { "get": { "tags": [ "Public" ], "summary": "Get the bounded cross-venue perpetual basis series.", "operationId": "GetPerpBasis", "parameters": [ { "name": "market", "in": "query", "schema": { "type": "string" } }, { "name": "venue", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerpBasisSeriesResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } }, "451": { "description": "CEX-derived public/API surfaces are disabled pending commercial data-rights review.", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false }, "x-hendrix-data-rights": { "posture": "required", "raw_licensed_payloads_exposed": false } } }, "/v1/coinbase/arbitrage-friction": { "get": { "tags": [ "Public" ], "summary": "Get the bounded Coinbase arbitrage-friction series.", "operationId": "GetCoinbaseArbitrageFriction", "parameters": [ { "name": "market", "in": "query", "schema": { "type": "string" } }, { "name": "venue", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoinbaseArbitrageFrictionSeriesResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } }, "451": { "description": "CEX-derived public/API surfaces are disabled pending commercial data-rights review.", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false }, "x-hendrix-data-rights": { "posture": "required", "raw_licensed_payloads_exposed": false } } }, "/v1/coinbase/spot-stress": { "get": { "tags": [ "Public" ], "summary": "Get the bounded Coinbase spot-stress series.", "operationId": "GetCoinbaseSpotStress", "parameters": [ { "name": "market", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoinbaseSpotStressSeriesResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } }, "451": { "description": "CEX-derived public/API surfaces are disabled pending commercial data-rights review.", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false }, "x-hendrix-data-rights": { "posture": "required", "raw_licensed_payloads_exposed": false } } }, "/v1/coinbase/spot-impulse": { "get": { "tags": [ "Public" ], "summary": "Get the bounded US spot-impulse series.", "operationId": "GetUsSpotImpulse", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsSpotImpulseSeriesResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } }, "451": { "description": "CEX-derived public/API surfaces are disabled pending commercial data-rights review.", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false }, "x-hendrix-data-rights": { "posture": "required", "raw_licensed_payloads_exposed": false } } }, "/v1/markets/{market}/eth-oracle-context": { "get": { "tags": [ "Public" ], "summary": "Get ETH oracle and DeFi context for a market.", "operationId": "GetMarketEthOracleContext", "parameters": [ { "name": "market", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "lookback_minutes", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EthOracleContextResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/flyout-contexts/prefetch": { "post": { "tags": [ "Public" ], "summary": "Batch-prefetch bounded analytical flyout context payloads.", "operationId": "PrefetchAnalyticalFlyoutContexts", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticalFlyoutContextPrefetchRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticalFlyoutContextPrefetchResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/launch-access/requests": { "post": { "tags": [ "Public" ], "summary": "Submit an idempotent launch-access request.", "operationId": "RequestLaunchAccess", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LaunchAccessRequestBody" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LaunchAccessRequestResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/hip3/markets": { "get": { "tags": [ "HIP-3" ], "summary": "List HIP-3 market intelligence at an optional source-time boundary.", "operationId": "ListHip3Markets", "parameters": [ { "name": "market", "in": "query", "schema": { "type": "string" } }, { "name": "dex_name", "in": "query", "schema": { "type": "string" } }, { "name": "deployer", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "include_inactive", "in": "query", "schema": { "type": "boolean" } }, { "name": "as_source_at", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hip3MarketIntelligenceResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/hip3/adoption/current": { "get": { "tags": [ "HIP-3" ], "summary": "Get the current HIP-3 adoption snapshot.", "operationId": "GetCurrentHip3Adoption", "parameters": [ { "name": "as_source_at", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hip3AdoptionSnapshotResponse" } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/hip3/adoption/history": { "get": { "tags": [ "HIP-3" ], "summary": "Get bounded HIP-3 adoption history.", "operationId": "GetHip3AdoptionHistory", "parameters": [ { "name": "since", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "include_details", "in": "query", "schema": { "type": "boolean" } }, { "name": "as_source_at", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hip3AdoptionHistoryResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/hip3/deployer-action-contract": { "get": { "tags": [ "HIP-3" ], "summary": "Get the public deployer-action source contract.", "operationId": "GetHip3DeployerActionContract", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hip3DeployerActionSourceContractResponse" } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/hip3/deployer-actions": { "get": { "tags": [ "HIP-3" ], "summary": "Get bounded HIP-3 deployer-action history.", "operationId": "GetHip3DeployerActions", "parameters": [ { "name": "market", "in": "query", "schema": { "type": "string" } }, { "name": "dex_name", "in": "query", "schema": { "type": "string" } }, { "name": "deployer", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "promotable_only", "in": "query", "schema": { "type": "boolean" } }, { "name": "as_source_at", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hip3DeployerActionHistoryResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/hip3/deployer-reliability": { "get": { "tags": [ "HIP-3" ], "summary": "Get HIP-3 deployer reliability diagnostics.", "operationId": "GetHip3DeployerReliability", "parameters": [ { "name": "market", "in": "query", "schema": { "type": "string" } }, { "name": "dex_name", "in": "query", "schema": { "type": "string" } }, { "name": "deployer", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "include_inactive", "in": "query", "schema": { "type": "boolean" } }, { "name": "as_source_at", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hip3DeployerReliabilityResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/rwa/markets/{market}/registry": { "get": { "tags": [ "RWA" ], "summary": "Get registry and lineage context for an RWA-like market.", "operationId": "GetRwaMarketRegistry", "parameters": [ { "name": "market", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "venue", "in": "query", "schema": { "type": "string" } }, { "name": "asset_class", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RwaMarketRegistryResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/rwa/markets/{market}/quality": { "get": { "tags": [ "RWA" ], "summary": "Get the RWA market-quality series for a bounded window.", "operationId": "GetRwaMarketQuality", "parameters": [ { "name": "market", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "venue", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RwaMarketQualitySeriesResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/rwa/comparables/{comparableMarketKey}/snapshot": { "get": { "tags": [ "RWA" ], "summary": "Get a current external comparable snapshot.", "operationId": "GetRwaComparableSnapshot", "parameters": [ { "name": "comparableMarketKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "venue", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RwaComparableSnapshotResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/hip4/source-status": { "get": { "tags": [ "HIP-4" ], "summary": "Get current HIP-4 registry source status.", "operationId": "GetHip4SourceStatus", "parameters": [ { "name": "as_observed_at", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hip4OutcomeMetaSourceStatusResponse" } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/hip4/outcomes": { "get": { "tags": [ "HIP-4" ], "summary": "List a stable page of HIP-4 outcomes.", "operationId": "ListHip4Outcomes", "parameters": [ { "name": "as_observed_at", "in": "query", "schema": { "type": "string" } }, { "name": "description_class", "in": "query", "schema": { "type": "string" } }, { "name": "binary_type", "in": "query", "schema": { "type": "string" } }, { "name": "reviewable_only", "in": "query", "schema": { "type": "boolean" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hip4OutcomeMarketListResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/hip4/outcomes/{outcomeId}": { "get": { "tags": [ "HIP-4" ], "summary": "Get HIP-4 outcome metadata.", "operationId": "GetHip4Outcome", "parameters": [ { "name": "outcomeId", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } }, { "name": "as_observed_at", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hip4OutcomeMarketResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/hip4/outcomes/{outcomeId}/sides/{sideIndex}": { "get": { "tags": [ "HIP-4" ], "summary": "Get HIP-4 outcome-side identity metadata.", "operationId": "GetHip4OutcomeSide", "parameters": [ { "name": "outcomeId", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } }, { "name": "sideIndex", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } }, { "name": "as_observed_at", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hip4OutcomeSideIdentityResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/hip4/outcomes/{outcomeId}/sides/{sideIndex}/book": { "get": { "tags": [ "HIP-4" ], "summary": "Get current HIP-4 outcome-side order-book state.", "operationId": "GetHip4OutcomeSideBook", "parameters": [ { "name": "outcomeId", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } }, { "name": "sideIndex", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } }, { "name": "as_observed_at", "in": "query", "schema": { "type": "string" } }, { "name": "as_source_at", "in": "query", "schema": { "type": "string" } }, { "name": "levels", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hip4OutcomeSideBookResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/hip4/outcomes/{outcomeId}/sides/{sideIndex}/state": { "get": { "tags": [ "HIP-4" ], "summary": "Get consolidated HIP-4 outcome-side market state.", "operationId": "GetHip4OutcomeSideState", "parameters": [ { "name": "outcomeId", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } }, { "name": "sideIndex", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } }, { "name": "as_observed_at", "in": "query", "schema": { "type": "string" } }, { "name": "as_source_at", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hip4OutcomeSideStateResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/hip4/outcomes/{outcomeId}/sides/{sideIndex}/trades": { "get": { "tags": [ "HIP-4" ], "summary": "Get bounded HIP-4 outcome-side trades.", "operationId": "GetHip4OutcomeSideTrades", "parameters": [ { "name": "outcomeId", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } }, { "name": "sideIndex", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hip4OutcomeSideTradesResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/hip4/outcomes/{outcomeId}/sides/{sideIndex}/mids": { "get": { "tags": [ "HIP-4" ], "summary": "Get bounded HIP-4 outcome-side midpoint history.", "operationId": "GetHip4OutcomeSideMids", "parameters": [ { "name": "outcomeId", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } }, { "name": "sideIndex", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hip4OutcomeSideMidSeriesResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/hip4/outcomes/{outcomeId}/probability": { "get": { "tags": [ "HIP-4" ], "summary": "Get descriptive HIP-4 probability microstructure.", "operationId": "GetHip4OutcomeProbability", "parameters": [ { "name": "outcomeId", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } }, { "name": "as_observed_at", "in": "query", "schema": { "type": "string" } }, { "name": "as_source_at", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hip4OutcomeProbabilityResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/hip4/outcomes/{outcomeId}/boundary-risk": { "get": { "tags": [ "HIP-4" ], "summary": "Get HIP-4 boundary-risk diagnostics.", "operationId": "GetHip4BoundaryRisk", "parameters": [ { "name": "outcomeId", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } }, { "name": "as_observed_at", "in": "query", "schema": { "type": "string" } }, { "name": "as_source_at", "in": "query", "schema": { "type": "string" } }, { "name": "annualized_volatility", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hip4BoundaryRiskResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/hip4/outcomes/{outcomeId}/opportunity-cost": { "get": { "tags": [ "HIP-4" ], "summary": "Get descriptive HIP-4 opportunity-cost comparisons.", "operationId": "GetHip4OpportunityCost", "parameters": [ { "name": "outcomeId", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } }, { "name": "as_observed_at", "in": "query", "schema": { "type": "string" } }, { "name": "as_source_at", "in": "query", "schema": { "type": "string" } }, { "name": "side_index", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "capital_usd", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } }, { "name": "cash_apy", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } }, { "name": "funding_apy", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } }, { "name": "hedge_carry_apy", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } }, { "name": "vault_apy", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } }, { "name": "same_expiry_return_usd", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hip4OpportunityCostResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/hip4/outcomes/{outcomeId}/quality": { "get": { "tags": [ "HIP-4" ], "summary": "Get HIP-4 outcome quality components and explanations.", "operationId": "GetHip4OutcomeQuality", "parameters": [ { "name": "outcomeId", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } }, { "name": "as_observed_at", "in": "query", "schema": { "type": "string" } }, { "name": "as_source_at", "in": "query", "schema": { "type": "string" } }, { "name": "annualized_volatility", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hip4OutcomeMarketQualityResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/hip4/outcomes/{outcomeId}/truth-labels": { "get": { "tags": [ "HIP-4" ], "summary": "Get settlement truth-label history for a HIP-4 outcome.", "operationId": "GetHip4OutcomeTruthLabels", "parameters": [ { "name": "outcomeId", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } }, { "name": "as_observed_at", "in": "query", "schema": { "type": "string" } }, { "name": "include_corrections", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hip4OutcomeTruthLabelsResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/hip4/outcomes/{outcomeId}/calibration": { "get": { "tags": [ "HIP-4" ], "summary": "Get calibration history for a HIP-4 outcome.", "operationId": "GetHip4OutcomeCalibration", "parameters": [ { "name": "outcomeId", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "include_excluded", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hip4CalibrationSummaryResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/hip4/calibration/metrics": { "get": { "tags": [ "HIP-4" ], "summary": "Get aggregate HIP-4 calibration metrics.", "operationId": "GetHip4CalibrationMetrics", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "evaluation_time", "in": "query", "schema": { "type": "string" } }, { "name": "event_class_name", "in": "query", "schema": { "type": "string" } }, { "name": "probability_buckets", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hip4CalibrationMetricsResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/hip4/outcomes/{outcomeId}/calibration/metrics": { "get": { "tags": [ "HIP-4" ], "summary": "Get calibration metrics for a HIP-4 outcome.", "operationId": "GetHip4OutcomeCalibrationMetrics", "parameters": [ { "name": "outcomeId", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "evaluation_time", "in": "query", "schema": { "type": "string" } }, { "name": "event_class_name", "in": "query", "schema": { "type": "string" } }, { "name": "probability_buckets", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hip4CalibrationMetricsResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "The anonymous public API rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "x-hendrix-access": { "minimum_tier": "free", "wallet_specific": false, "high_volume_export": false } } }, "/v1/pro/execution": { "get": { "tags": [ "Pro" ], "summary": "Get wallet-specific execution-quality analytics.", "operationId": "GetProExecutionQuality", "parameters": [ { "name": "wallet", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProExecutionReportResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "401": { "description": "Pro entitlement or API key is required.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } } }, "403": { "description": "The caller does not have access to this Pro surface.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } } }, "429": { "description": "The Pro API-key rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "security": [ { "HendrixApiKey": [ ] }, { "HendrixBearer": [ ] } ], "x-hendrix-access": { "minimum_tier": "pro", "wallet_specific": true, "high_volume_export": false } } }, "/v1/pro/vpin": { "get": { "tags": [ "Pro" ], "summary": "Get a bounded VPIN series and toxicity regimes.", "operationId": "GetProVpin", "parameters": [ { "name": "market", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "venue", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProVpinSeriesResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "401": { "description": "Pro entitlement or API key is required.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } } }, "403": { "description": "The caller does not have access to this Pro surface.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } } }, "429": { "description": "The Pro API-key rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "security": [ { "HendrixApiKey": [ ] }, { "HendrixBearer": [ ] } ], "x-hendrix-access": { "minimum_tier": "pro", "wallet_specific": false, "high_volume_export": false } } }, "/v1/pro/replay": { "get": { "tags": [ "Pro" ], "summary": "Get a bounded historical order-book replay.", "operationId": "GetProBookReplay", "parameters": [ { "name": "market", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "venue", "in": "query", "schema": { "type": "string" } }, { "name": "sample_interval_seconds", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "levels", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProBookReplayResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "401": { "description": "Pro entitlement or API key is required.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } } }, "403": { "description": "The caller does not have access to this Pro surface.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } } }, "429": { "description": "The Pro API-key rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "security": [ { "HendrixApiKey": [ ] }, { "HendrixBearer": [ ] } ], "x-hendrix-access": { "minimum_tier": "pro", "wallet_specific": false, "high_volume_export": true } } }, "/v1/pro/cascades": { "get": { "tags": [ "Pro" ], "summary": "Get detected liquidation cascades for a bounded market window.", "operationId": "GetProLiquidationCascades", "parameters": [ { "name": "market", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "min_notional_usd", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProLiquidationCascadeSeriesResponse" } } } }, "400": { "description": "Request validation failed. Framework query-binding failures can return an empty body.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "401": { "description": "Pro entitlement or API key is required.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } } }, "403": { "description": "The caller does not have access to this Pro surface.", "content": { "application/json": { "schema": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } } }, "429": { "description": "The Pro API-key rate limit was exceeded.", "content": { "application/json": { "schema": { "required": [ "error", "retry_after_seconds" ], "type": "object", "properties": { "error": { "type": "string" }, "retry_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } } } } }, "security": [ { "HendrixApiKey": [ ] }, { "HendrixBearer": [ ] } ], "x-hendrix-access": { "minimum_tier": "pro", "wallet_specific": false, "high_volume_export": false } } } }, "components": { "schemas": { "AnalyticalFlyoutConfidence": { "required": [ "score", "sample_count", "sample_window", "source_version" ], "type": "object", "properties": { "score": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "sample_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "sample_window": { "$ref": "#/components/schemas/AnalyticalFlyoutTimeRange" }, "source_version": { "type": "string" } } }, "AnalyticalFlyoutContextDescriptor": { "required": [ "context_key", "context_type", "market", "time_window", "bucket", "freshness", "expected_payload_bytes", "pro_tier_required" ], "type": "object", "properties": { "context_key": { "type": "string" }, "context_type": { "type": "string" }, "market": { "type": "string" }, "time_window": { "$ref": "#/components/schemas/AnalyticalFlyoutTimeRange" }, "bucket": { "$ref": "#/components/schemas/AnalyticalFlyoutTimeBucket" }, "freshness": { "$ref": "#/components/schemas/AnalyticalFlyoutFreshness" }, "expected_payload_bytes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "pro_tier_required": { "type": "boolean" } } }, "AnalyticalFlyoutContextPayload": { "required": [ "context_key", "context_type", "status", "title", "summary", "freshness" ], "type": "object", "properties": { "context_key": { "type": "string" }, "context_type": { "type": "string" }, "status": { "type": "string" }, "title": { "type": "string" }, "summary": { "type": "string" }, "freshness": { "$ref": "#/components/schemas/AnalyticalFlyoutFreshness" }, "primary_metrics": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyticalFlyoutPrimaryMetric" } }, "confidence": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AnalyticalFlyoutConfidence" } ] }, "observations": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyticalFlyoutObservation" } }, "caveats": { "type": "array", "items": { "type": "string" } }, "quality_flags": { "type": "array", "items": { "type": "string" } }, "mini_series": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AnalyticalFlyoutMiniSeries" } ] }, "payload_budget_bytes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "AnalyticalFlyoutContextPrefetchItem": { "required": [ "context_key", "status", "cache_hit", "payload_bytes", "payload" ], "type": "object", "properties": { "context_key": { "type": "string" }, "status": { "type": "string" }, "cache_hit": { "type": "boolean" }, "payload_bytes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "payload": { "$ref": "#/components/schemas/AnalyticalFlyoutContextPayload" } } }, "AnalyticalFlyoutContextPrefetchRequest": { "required": [ "contexts" ], "type": "object", "properties": { "contexts": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyticalFlyoutContextDescriptor" } } } }, "AnalyticalFlyoutContextPrefetchResponse": { "required": [ "requested", "unavailable", "cache_hits", "repository_fan_out", "results" ], "type": "object", "properties": { "requested": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "unavailable": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "cache_hits": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "repository_fan_out": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyticalFlyoutContextPrefetchItem" } } } }, "AnalyticalFlyoutFreshness": { "required": [ "status", "observed_at", "max_age_seconds", "age_seconds" ], "type": "object", "properties": { "status": { "type": "string" }, "observed_at": { "type": "string", "format": "date-time" }, "max_age_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "age_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "AnalyticalFlyoutMiniSeries": { "required": [ "unit", "max_points", "points" ], "type": "object", "properties": { "unit": { "type": "string" }, "max_points": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "points": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyticalFlyoutSeriesPoint" } } } }, "AnalyticalFlyoutObservation": { "required": [ "code", "severity", "message" ], "type": "object", "properties": { "code": { "type": "string" }, "severity": { "type": "string" }, "message": { "type": "string" } } }, "AnalyticalFlyoutPrimaryMetric": { "required": [ "label", "unit", "precision" ], "type": "object", "properties": { "label": { "type": "string" }, "value": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "unit": { "type": "string" }, "precision": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "display_value": { "type": [ "null", "string" ] } } }, "AnalyticalFlyoutSeriesPoint": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "value": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "AnalyticalFlyoutTimeBucket": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "granularity": { "type": "string" } } }, "AnalyticalFlyoutTimeRange": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } }, "ApiError": { "required": [ "error", "message" ], "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "details": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "ApiReadinessCheckResponse": { "required": [ "name", "status", "duration_ms" ], "type": "object", "properties": { "name": { "type": "string" }, "status": { "type": "string" }, "duration_ms": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "description": { "type": [ "null", "string" ] }, "data": { "type": [ "null", "object" ] } } }, "ApiReadinessResponse": { "required": [ "status", "service", "total_duration_ms", "checks" ], "type": "object", "properties": { "status": { "type": "string" }, "service": { "type": "string" }, "total_duration_ms": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "checks": { "type": "array", "items": { "$ref": "#/components/schemas/ApiReadinessCheckResponse" } } } }, "ApiServiceHealthResponse": { "required": [ "status", "service" ], "type": "object", "properties": { "status": { "type": "string" }, "service": { "type": "string" } } }, "BookLevel": { "type": "object", "properties": { "price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "size": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "BookLevelResponse": { "required": [ "price", "size" ], "type": "object", "properties": { "price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "size": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "CoinbaseArbitrageFrictionPointResponse": { "required": [ "ts", "market", "venue", "friction_score", "state", "confidence", "residual_abs_bps", "residual_z_score", "persistence_score", "spot_basis_bps", "observation_count", "quality_flags" ], "type": "object", "properties": { "ts": { "type": "string", "format": "date-time" }, "market": { "type": "string" }, "venue": { "type": "string" }, "friction_score": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "state": { "type": "string" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "residual_abs_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "residual_z_score": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "persistence_score": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "half_life_minutes": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "funding_adjusted_basis_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "spot_basis_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "source_lag_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "observation_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "quality_flags": { "type": "array", "items": { "type": "string" } } } }, "CoinbaseArbitrageFrictionSeriesResponse": { "required": [ "period", "access_tier", "truncated", "result_limit", "data", "caveats" ], "type": "object", "properties": { "period": { "$ref": "#/components/schemas/RwaTimeRangeResponse" }, "market": { "type": [ "null", "string" ] }, "venue": { "type": [ "null", "string" ] }, "access_tier": { "type": "string" }, "truncated": { "type": "boolean" }, "result_limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "latest": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CoinbaseArbitrageFrictionPointResponse" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CoinbaseArbitrageFrictionPointResponse" } }, "caveats": { "type": "array", "items": { "type": "string" } } } }, "CoinbasePremiumPointResponse": { "required": [ "ts", "market", "coinbase_mid_price", "coinbase_source_timestamp", "coinbase_observation_count", "binance_observation_count", "hyperliquid_observation_count", "direction", "direction_basis", "quality_flags" ], "type": "object", "properties": { "ts": { "type": "string", "format": "date-time" }, "market": { "type": "string" }, "coinbase_mid_price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "binance_mid_price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "hyperliquid_mid_price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "coinbase_minus_binance_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "coinbase_minus_hyperliquid_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "coinbase_source_timestamp": { "type": "string", "format": "date-time" }, "binance_source_timestamp": { "type": [ "null", "string" ], "format": "date-time" }, "hyperliquid_source_timestamp": { "type": [ "null", "string" ], "format": "date-time" }, "coinbase_observation_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "binance_observation_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "hyperliquid_observation_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "max_source_lag_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "direction": { "type": "string" }, "direction_basis": { "type": "string" }, "quality_flags": { "type": "array", "items": { "type": "string" } } } }, "CoinbasePremiumSeriesResponse": { "required": [ "period", "access_tier", "truncated", "result_limit", "data", "caveats" ], "type": "object", "properties": { "period": { "$ref": "#/components/schemas/RwaTimeRangeResponse" }, "market": { "type": [ "null", "string" ] }, "access_tier": { "type": "string" }, "truncated": { "type": "boolean" }, "result_limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CoinbasePremiumPointResponse" } }, "caveats": { "type": "array", "items": { "type": "string" } } } }, "CoinbaseSpotStressPointResponse": { "required": [ "ts", "market", "stress_score", "state", "confidence", "coinbase_spread_bps", "spread_z_score", "premium_abs_bps", "coinbase_observation_count", "quality_flags" ], "type": "object", "properties": { "ts": { "type": "string", "format": "date-time" }, "market": { "type": "string" }, "stress_score": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "state": { "type": "string" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "coinbase_spread_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "spread_z_score": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "premium_abs_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "cross_venue_dispersion_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "source_lag_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "coinbase_observation_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "quality_flags": { "type": "array", "items": { "type": "string" } } } }, "CoinbaseSpotStressSeriesResponse": { "required": [ "period", "access_tier", "truncated", "result_limit", "data", "caveats" ], "type": "object", "properties": { "period": { "$ref": "#/components/schemas/RwaTimeRangeResponse" }, "market": { "type": [ "null", "string" ] }, "access_tier": { "type": "string" }, "truncated": { "type": "boolean" }, "result_limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "latest": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CoinbaseSpotStressPointResponse" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CoinbaseSpotStressPointResponse" } }, "caveats": { "type": "array", "items": { "type": "string" } } } }, "DepthResponse": { "required": [ "market", "timestamp", "mid_price", "spread_bps", "bids", "asks" ], "type": "object", "properties": { "market": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "mid_price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "spread_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "bids": { "type": "array", "items": { "$ref": "#/components/schemas/BookLevelResponse" } }, "asks": { "type": "array", "items": { "$ref": "#/components/schemas/BookLevelResponse" } } } }, "EthOracleContextCoverageResponse": { "required": [ "has_hyperliquid_context", "external_oracle_count", "has_mev_context", "feature_count" ], "type": "object", "properties": { "has_hyperliquid_context": { "type": "boolean" }, "external_oracle_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "has_mev_context": { "type": "boolean" }, "feature_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "EthOracleContextFeatureResponse": { "required": [ "kind", "source", "source_version", "event_timestamp", "observed_timestamp", "source_lag_seconds", "freshness", "confidence", "quality_flags" ], "type": "object", "properties": { "kind": { "type": "string" }, "source": { "type": "string" }, "source_version": { "type": "string" }, "event_timestamp": { "type": "string", "format": "date-time" }, "observed_timestamp": { "type": "string", "format": "date-time" }, "source_lag_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "freshness": { "type": "string" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "quality_flags": { "type": "array", "items": { "type": "string" } }, "provider": { "type": [ "null", "string" ] }, "feed_id": { "type": [ "null", "string" ] }, "base_asset": { "type": [ "null", "string" ] }, "quote_asset": { "type": [ "null", "string" ] }, "mark_price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "oracle_price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "index_price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "external_oracle_price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "mark_oracle_gap_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "mark_index_gap_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "oracle_index_gap_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "mark_external_oracle_gap_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "oracle_update_lag_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "block_number": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "slot": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "builder_pubkey": { "type": [ "null", "string" ] }, "proposer_pubkey": { "type": [ "null", "string" ] }, "relay": { "type": [ "null", "string" ] }, "mev_reward_eth": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "private_tx_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "bundle_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "EthOracleContextResponse": { "required": [ "market", "decision_time", "lookback_minutes", "confidence", "coverage", "features" ], "type": "object", "properties": { "market": { "type": "string" }, "decision_time": { "type": "string", "format": "date-time" }, "lookback_minutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "coverage": { "$ref": "#/components/schemas/EthOracleContextCoverageResponse" }, "features": { "type": "array", "items": { "$ref": "#/components/schemas/EthOracleContextFeatureResponse" } } } }, "FreshnessEnvelopeResponse": { "required": [ "decision_time", "observed_at", "age_seconds", "status", "reason_code", "max_age_seconds", "grace_seconds", "next_expected_observation_seconds" ], "type": "object", "properties": { "decision_time": { "type": "string", "format": "date-time" }, "observed_at": { "type": [ "null", "string" ], "format": "date-time" }, "age_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "status": { "type": "string" }, "reason_code": { "type": "string" }, "max_age_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "grace_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "next_expected_observation_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "FundingAnnualizationResponse": { "required": [ "method", "annualized_rate", "eight_hour_equivalent_rate", "interval_count_per_year" ], "type": "object", "properties": { "method": { "type": "string" }, "annualized_rate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "eight_hour_equivalent_rate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "interval_count_per_year": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "FundingFamilySummaryResponse": { "required": [ "market_family", "total_markets", "live_markets", "delayed_markets", "stale_markets", "unavailable_markets", "longs_pay_markets", "shorts_pay_markets", "flat_markets", "included_market_count", "excluded_live_markets", "included_notional_usd", "oracle_notional_weighted_annualized_rate", "strongest_annualized_market", "strongest_annualized_rate" ], "type": "object", "properties": { "market_family": { "type": "string" }, "total_markets": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "live_markets": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "delayed_markets": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "stale_markets": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "unavailable_markets": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "longs_pay_markets": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "shorts_pay_markets": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "flat_markets": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "included_market_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "excluded_live_markets": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "included_notional_usd": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "oracle_notional_weighted_annualized_rate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "strongest_annualized_market": { "type": [ "null", "string" ] }, "strongest_annualized_rate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "FundingIntervalResponse": { "required": [ "kind", "seconds", "hours" ], "type": "object", "properties": { "kind": { "type": "string" }, "seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "hours": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "FundingOverviewMarketResponse": { "required": [ "market", "market_family", "rates" ], "type": "object", "properties": { "market": { "type": "string" }, "market_family": { "type": "string" }, "rates": { "type": "array", "items": { "$ref": "#/components/schemas/FundingRateResponse" } } } }, "FundingOverviewResponse": { "required": [ "decision_time", "formula_key", "summaries", "markets" ], "type": "object", "properties": { "decision_time": { "type": "string", "format": "date-time" }, "formula_key": { "type": "string" }, "summaries": { "type": "array", "items": { "$ref": "#/components/schemas/FundingFamilySummaryResponse" } }, "markets": { "type": "array", "items": { "$ref": "#/components/schemas/FundingOverviewMarketResponse" } } } }, "FundingRateResponse": { "required": [ "venue", "rate", "ts", "observed_at", "freshness", "interval", "annualization", "index_price", "mark_price", "oracle_price", "open_interest", "basis_bps", "latest_settlement_event_time", "latest_settlement_observed_at", "latest_settlement_rate", "premium", "source_lineage", "null_reason_codes", "quality_flags" ], "type": "object", "properties": { "venue": { "type": "string" }, "rate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "ts": { "type": "string", "format": "date-time" }, "observed_at": { "type": "string", "format": "date-time" }, "freshness": { "$ref": "#/components/schemas/FreshnessEnvelopeResponse" }, "interval": { "$ref": "#/components/schemas/FundingIntervalResponse" }, "annualization": { "$ref": "#/components/schemas/FundingAnnualizationResponse" }, "index_price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "mark_price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "oracle_price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "open_interest": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "basis_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "latest_settlement_event_time": { "type": [ "null", "string" ], "format": "date-time" }, "latest_settlement_observed_at": { "type": [ "null", "string" ], "format": "date-time" }, "latest_settlement_rate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "premium": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "source_lineage": { "type": "array", "items": { "$ref": "#/components/schemas/FundingSourceLineageResponse" } }, "null_reason_codes": { "type": "array", "items": { "type": "string" } }, "quality_flags": { "type": "array", "items": { "type": "string" } } } }, "FundingSourceLineageResponse": { "required": [ "role", "source", "source_version", "observed_at", "event_time", "timestamp_policy", "parser_version" ], "type": "object", "properties": { "role": { "type": "string" }, "source": { "type": "string" }, "source_version": { "type": [ "null", "string" ] }, "observed_at": { "type": [ "null", "string" ], "format": "date-time" }, "event_time": { "type": [ "null", "string" ], "format": "date-time" }, "timestamp_policy": { "type": [ "null", "string" ] }, "parser_version": { "type": [ "null", "string" ] } } }, "Hip3AdoptionContributionResponse": { "required": [ "kind", "dex_name", "core_notional_usd_24h", "hip3_notional_usd_24h", "rwa_cash_notional_usd_24h", "hip3_other_notional_usd_24h", "unclassified_notional_usd_24h", "classified_notional_usd_24h", "classified_share", "unclassified_share", "active_market_count", "included_market_count" ], "type": "object", "properties": { "kind": { "type": "string" }, "dex_name": { "type": "string" }, "core_notional_usd_24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "hip3_notional_usd_24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "rwa_cash_notional_usd_24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "hip3_other_notional_usd_24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "unclassified_notional_usd_24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "classified_notional_usd_24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "classified_share": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "unclassified_share": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "active_market_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "included_market_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "Hip3AdoptionHistoryResponse": { "required": [ "decision_time", "since", "data" ], "type": "object", "properties": { "decision_time": { "type": "string", "format": "date-time" }, "since": { "type": "string", "format": "date-time" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Hip3AdoptionObservationResponse" } } } }, "Hip3AdoptionLineageResponse": { "required": [ "formula_key", "source_version", "taxonomy_source_versions" ], "type": "object", "properties": { "formula_key": { "type": "string" }, "source_version": { "type": "string" }, "taxonomy_source_versions": { "type": "array", "items": { "type": "string" } } } }, "Hip3AdoptionObservationResponse": { "required": [ "observed_at", "source_window_start", "trailing_window_seconds", "adoption_coverage", "market_mix_coverage", "core_notional_usd_24h", "hip3_notional_usd_24h", "total_notional_usd_24h", "hip3_share", "rwa_cash_notional_usd_24h", "hip3_other_notional_usd_24h", "unclassified_notional_usd_24h", "classified_notional_usd_24h", "classified_share", "unclassified_share", "rwa_cash_share_lower_bound", "rwa_cash_share_upper_bound", "hip3_other_share_lower_bound", "hip3_other_share_upper_bound", "source_count", "complete_source_count", "active_market_count", "included_market_count", "diagnostic_flags", "freshness", "lineage", "sources", "contributions" ], "type": "object", "properties": { "observed_at": { "type": "string", "format": "date-time" }, "source_window_start": { "type": "string", "format": "date-time" }, "trailing_window_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "adoption_coverage": { "type": "string" }, "market_mix_coverage": { "type": "string" }, "core_notional_usd_24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "hip3_notional_usd_24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "total_notional_usd_24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "hip3_share": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "rwa_cash_notional_usd_24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "hip3_other_notional_usd_24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "unclassified_notional_usd_24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "classified_notional_usd_24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "classified_share": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "unclassified_share": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "rwa_cash_share_lower_bound": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "rwa_cash_share_upper_bound": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "hip3_other_share_lower_bound": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "hip3_other_share_upper_bound": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "source_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "complete_source_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "active_market_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "included_market_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "diagnostic_flags": { "type": "array", "items": { "type": "string" } }, "freshness": { "$ref": "#/components/schemas/FreshnessEnvelopeResponse" }, "lineage": { "$ref": "#/components/schemas/Hip3AdoptionLineageResponse" }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/Hip3AdoptionSourceResponse" } }, "contributions": { "type": "array", "items": { "$ref": "#/components/schemas/Hip3AdoptionContributionResponse" } } } }, "Hip3AdoptionSnapshotResponse": { "required": [ "decision_time", "observation" ], "type": "object", "properties": { "decision_time": { "type": "string", "format": "date-time" }, "observation": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Hip3AdoptionObservationResponse" } ] } } }, "Hip3AdoptionSourceResponse": { "required": [ "kind", "dex_name", "status", "observed_at", "source_version", "response_sha256", "universe_count", "context_count", "diagnostic_flags" ], "type": "object", "properties": { "kind": { "type": "string" }, "dex_name": { "type": "string" }, "status": { "type": "string" }, "observed_at": { "type": [ "null", "string" ], "format": "date-time" }, "source_version": { "type": [ "null", "string" ] }, "response_sha256": { "type": [ "null", "string" ] }, "universe_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "context_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "diagnostic_flags": { "type": "array", "items": { "type": "string" } } } }, "Hip3AssetMembershipResponse": { "required": [ "status", "transition_reason", "source", "source_version", "observed_timestamp", "missing_confirmation_count" ], "type": "object", "properties": { "status": { "type": "string" }, "transition_reason": { "type": "string" }, "source": { "type": [ "null", "string" ] }, "source_version": { "type": [ "null", "string" ] }, "observed_timestamp": { "type": [ "null", "string" ], "format": "date-time" }, "missing_confirmation_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "Hip3DeployerActionCoverageResponse": { "required": [ "status", "known_action_count", "latest_observed_timestamp", "source_lineage", "reason_codes" ], "type": "object", "properties": { "status": { "type": "string" }, "known_action_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "latest_observed_timestamp": { "type": [ "null", "string" ], "format": "date-time" }, "source_lineage": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Hip3SourceLineageResponse" } ] }, "reason_codes": { "type": "array", "items": { "type": "string" } } } }, "Hip3DeployerActionEffectResponse": { "required": [ "kind", "reason_code", "dex_name", "asset_name", "market", "parameter_name", "text_value", "decimal_value", "integer_value", "boolean_value" ], "type": "object", "properties": { "kind": { "type": "string" }, "reason_code": { "type": "string" }, "dex_name": { "type": [ "null", "string" ] }, "asset_name": { "type": [ "null", "string" ] }, "market": { "type": [ "null", "string" ] }, "parameter_name": { "type": [ "null", "string" ] }, "text_value": { "type": [ "null", "string" ] }, "decimal_value": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "integer_value": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "boolean_value": { "type": [ "null", "boolean" ] } } }, "Hip3DeployerActionEventResponse": { "required": [ "action_id", "kind", "variant", "deployer", "dex_name", "asset_name", "market", "source_lineage", "event_timestamp_policy", "parser_version", "raw_payload_sha256", "diagnostic_flags", "is_promotable", "effects" ], "type": "object", "properties": { "action_id": { "type": "string" }, "kind": { "type": "string" }, "variant": { "type": "string" }, "deployer": { "type": [ "null", "string" ] }, "dex_name": { "type": [ "null", "string" ] }, "asset_name": { "type": [ "null", "string" ] }, "market": { "type": [ "null", "string" ] }, "source_lineage": { "$ref": "#/components/schemas/Hip3SourceLineageResponse" }, "event_timestamp_policy": { "type": [ "null", "string" ] }, "parser_version": { "type": "string" }, "raw_payload_sha256": { "type": "string" }, "diagnostic_flags": { "type": "array", "items": { "type": "string" } }, "is_promotable": { "type": "boolean" }, "effects": { "type": "array", "items": { "$ref": "#/components/schemas/Hip3DeployerActionEffectResponse" } } } }, "Hip3DeployerActionHistoryResponse": { "required": [ "decision_time", "source", "parser_version", "actions", "data_limitations" ], "type": "object", "properties": { "decision_time": { "type": "string", "format": "date-time" }, "source": { "type": "string" }, "parser_version": { "type": "string" }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/Hip3DeployerActionEventResponse" } }, "data_limitations": { "type": "array", "items": { "type": "string" } } } }, "Hip3DeployerActionSourceContractResponse": { "required": [ "source", "parser_version", "official_docs_reviewed_date", "variants", "diagnostic_flags", "data_limitations" ], "type": "object", "properties": { "source": { "type": "string" }, "parser_version": { "type": "string" }, "official_docs_reviewed_date": { "type": "string" }, "variants": { "type": "array", "items": { "$ref": "#/components/schemas/Hip3DeployerActionVariantContractResponse" } }, "diagnostic_flags": { "type": "array", "items": { "type": "string" } }, "data_limitations": { "type": "array", "items": { "type": "string" } } } }, "Hip3DeployerActionVariantContractResponse": { "required": [ "kind", "variant", "effect_kinds", "reason_codes", "required_fields", "constraint_codes" ], "type": "object", "properties": { "kind": { "type": "string" }, "variant": { "type": "string" }, "effect_kinds": { "type": "array", "items": { "type": "string" } }, "reason_codes": { "type": "array", "items": { "type": "string" } }, "required_fields": { "type": "array", "items": { "type": "string" } }, "constraint_codes": { "type": "array", "items": { "type": "string" } } } }, "Hip3DeployerReliabilityComponentResponse": { "required": [ "kind", "status", "score", "reason_codes", "source_lineage" ], "type": "object", "properties": { "kind": { "type": "string" }, "status": { "type": "string" }, "score": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "reason_codes": { "type": "array", "items": { "type": "string" } }, "source_lineage": { "$ref": "#/components/schemas/Hip3SourceLineageResponse" } } }, "Hip3DeployerReliabilityReportResponse": { "required": [ "market", "base_asset", "dex_name", "deployer", "status", "score", "confidence", "risk_flags", "components", "timeline" ], "type": "object", "properties": { "market": { "type": "string" }, "base_asset": { "type": "string" }, "dex_name": { "type": [ "null", "string" ] }, "deployer": { "type": [ "null", "string" ] }, "status": { "type": "string" }, "score": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "risk_flags": { "type": "array", "items": { "type": "string" } }, "components": { "type": "array", "items": { "$ref": "#/components/schemas/Hip3DeployerReliabilityComponentResponse" } }, "timeline": { "type": "array", "items": { "$ref": "#/components/schemas/Hip3DeployerReliabilityTimelineEventResponse" } } } }, "Hip3DeployerReliabilityResponse": { "required": [ "decision_time", "summary", "reports", "data_limitations" ], "type": "object", "properties": { "decision_time": { "type": "string", "format": "date-time" }, "summary": { "$ref": "#/components/schemas/Hip3DeployerReliabilityResponseSummary" }, "reports": { "type": "array", "items": { "$ref": "#/components/schemas/Hip3DeployerReliabilityReportResponse" } }, "data_limitations": { "type": "array", "items": { "type": "string" } } } }, "Hip3DeployerReliabilityResponseSummary": { "required": [ "total", "stable", "watch", "degraded", "unavailable" ], "type": "object", "properties": { "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "stable": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "watch": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "degraded": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "unavailable": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "Hip3DeployerReliabilitySummaryResponse": { "required": [ "status", "score", "confidence", "reason_codes", "risk_flags" ], "type": "object", "properties": { "status": { "type": "string" }, "score": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "reason_codes": { "type": "array", "items": { "type": "string" } }, "risk_flags": { "type": "array", "items": { "type": "string" } } } }, "Hip3DeployerReliabilityTimelineEventResponse": { "required": [ "observed_timestamp", "kind", "reason_code", "severity", "action_id", "variant", "market", "dex_name", "parameter_name", "text_value", "decimal_value", "integer_value", "boolean_value", "source_lineage" ], "type": "object", "properties": { "observed_timestamp": { "type": [ "null", "string" ], "format": "date-time" }, "kind": { "type": "string" }, "reason_code": { "type": "string" }, "severity": { "type": "string" }, "action_id": { "type": [ "null", "string" ] }, "variant": { "type": [ "null", "string" ] }, "market": { "type": [ "null", "string" ] }, "dex_name": { "type": [ "null", "string" ] }, "parameter_name": { "type": [ "null", "string" ] }, "text_value": { "type": [ "null", "string" ] }, "decimal_value": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "integer_value": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "boolean_value": { "type": [ "null", "boolean" ] }, "source_lineage": { "$ref": "#/components/schemas/Hip3SourceLineageResponse" } } }, "Hip3FreshnessStateResponse": { "required": [ "status", "freshness" ], "type": "object", "properties": { "status": { "type": "string" }, "freshness": { "$ref": "#/components/schemas/FreshnessEnvelopeResponse" } } }, "Hip3LiquidityStateResponse": { "required": [ "status", "freshness", "spread_bps", "depth_50bps" ], "type": "object", "properties": { "status": { "type": "string" }, "freshness": { "$ref": "#/components/schemas/FreshnessEnvelopeResponse" }, "spread_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "depth_50bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "Hip3MarginStateResponse": { "required": [ "status", "freshness", "collateral_token_index", "collateral_token_name", "collateral_token_full_name", "margin_table_id", "margin_table_description", "margin_tiers", "max_leverage", "only_isolated", "margin_mode", "growth_mode", "last_growth_mode_change_time", "is_delisted", "source_lineage", "reason_codes" ], "type": "object", "properties": { "status": { "type": "string" }, "freshness": { "$ref": "#/components/schemas/FreshnessEnvelopeResponse" }, "collateral_token_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "collateral_token_name": { "type": [ "null", "string" ] }, "collateral_token_full_name": { "type": [ "null", "string" ] }, "margin_table_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "margin_table_description": { "type": [ "null", "string" ] }, "margin_tiers": { "type": "array", "items": { "$ref": "#/components/schemas/Hip3MarginTierResponse" } }, "max_leverage": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "only_isolated": { "type": [ "null", "boolean" ] }, "margin_mode": { "type": [ "null", "string" ] }, "growth_mode": { "type": [ "null", "string" ] }, "last_growth_mode_change_time": { "type": [ "null", "string" ] }, "is_delisted": { "type": [ "null", "boolean" ] }, "source_lineage": { "$ref": "#/components/schemas/Hip3SourceLineageResponse" }, "reason_codes": { "type": "array", "items": { "type": "string" } } } }, "Hip3MarginTierResponse": { "required": [ "lower_bound", "max_leverage" ], "type": "object", "properties": { "lower_bound": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "max_leverage": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "Hip3MarketIntelligenceMarketResponse": { "required": [ "market", "base_asset", "market_type", "market_family", "listing_state", "external_reference", "external_reference_null_reason", "membership", "dex_name", "asset_name", "full_name", "taxonomy", "margin_state", "source_lineage", "participants", "parameters", "metadata", "market_state", "open_interest_capacity", "deployer_action_history", "deployer_reliability", "liquidity", "quality", "risk_flags", "explanations", "data_limitations" ], "type": "object", "properties": { "market": { "type": "string" }, "base_asset": { "type": "string" }, "market_type": { "type": "string" }, "market_family": { "type": "string" }, "listing_state": { "type": "string" }, "external_reference": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MarketExternalReferenceResponse" } ] }, "external_reference_null_reason": { "type": [ "null", "string" ] }, "membership": { "$ref": "#/components/schemas/Hip3AssetMembershipResponse" }, "dex_name": { "type": [ "null", "string" ] }, "asset_name": { "type": [ "null", "string" ] }, "full_name": { "type": [ "null", "string" ] }, "taxonomy": { "$ref": "#/components/schemas/Hip3TaxonomyStateResponse" }, "margin_state": { "$ref": "#/components/schemas/Hip3MarginStateResponse" }, "source_lineage": { "$ref": "#/components/schemas/Hip3SourceLineageResponse" }, "participants": { "$ref": "#/components/schemas/Hip3ParticipantLineageResponse" }, "parameters": { "$ref": "#/components/schemas/Hip3ParameterStateResponse" }, "metadata": { "$ref": "#/components/schemas/Hip3FreshnessStateResponse" }, "market_state": { "$ref": "#/components/schemas/Hip3MarketStateResponse" }, "open_interest_capacity": { "$ref": "#/components/schemas/Hip3OpenInterestCapacityResponse" }, "deployer_action_history": { "$ref": "#/components/schemas/Hip3DeployerActionCoverageResponse" }, "deployer_reliability": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Hip3DeployerReliabilitySummaryResponse" } ] }, "liquidity": { "$ref": "#/components/schemas/Hip3LiquidityStateResponse" }, "quality": { "$ref": "#/components/schemas/Hip3QualityStateResponse" }, "risk_flags": { "type": "array", "items": { "type": "string" } }, "explanations": { "type": "array", "items": { "$ref": "#/components/schemas/Hip3ReasonResponse" } }, "data_limitations": { "type": "array", "items": { "type": "string" } } } }, "Hip3MarketIntelligenceResponse": { "required": [ "decision_time", "summary", "markets" ], "type": "object", "properties": { "decision_time": { "type": "string", "format": "date-time" }, "summary": { "$ref": "#/components/schemas/Hip3MarketIntelligenceSummaryResponse" }, "markets": { "type": "array", "items": { "$ref": "#/components/schemas/Hip3MarketIntelligenceMarketResponse" } } } }, "Hip3MarketIntelligenceSummaryResponse": { "required": [ "total", "active", "watch", "degraded", "unavailable" ], "type": "object", "properties": { "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "active": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "watch": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "degraded": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "unavailable": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "Hip3MarketStateResponse": { "required": [ "status", "freshness", "last_price", "open_interest", "funding_rate", "volume_24h", "volume_usd_24h", "trade_count_24h" ], "type": "object", "properties": { "status": { "type": "string" }, "freshness": { "$ref": "#/components/schemas/FreshnessEnvelopeResponse" }, "last_price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "open_interest": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "funding_rate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "volume_24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "volume_usd_24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "trade_count_24h": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "Hip3OpenInterestCapacityResponse": { "required": [ "status", "freshness", "open_interest_cap_notional", "scope", "utilization", "is_at_cap", "source_lineage" ], "type": "object", "properties": { "status": { "type": "string" }, "freshness": { "$ref": "#/components/schemas/FreshnessEnvelopeResponse" }, "open_interest_cap_notional": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "scope": { "type": [ "null", "string" ] }, "utilization": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "is_at_cap": { "type": [ "null", "boolean" ] }, "source_lineage": { "$ref": "#/components/schemas/Hip3SourceLineageResponse" } } }, "Hip3ParameterStateResponse": { "required": [ "deployer_fee_scale", "last_deployer_fee_scale_change_time", "streaming_open_interest_cap", "funding_multiplier", "funding_interest_rate" ], "type": "object", "properties": { "deployer_fee_scale": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "last_deployer_fee_scale_change_time": { "type": [ "null", "string" ] }, "streaming_open_interest_cap": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "funding_multiplier": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "funding_interest_rate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "Hip3ParticipantLineageResponse": { "required": [ "deployer", "oracle_updater", "fee_recipient" ], "type": "object", "properties": { "deployer": { "type": [ "null", "string" ] }, "oracle_updater": { "type": [ "null", "string" ] }, "fee_recipient": { "type": [ "null", "string" ] } } }, "Hip3QualityStateResponse": { "required": [ "status", "confidence" ], "type": "object", "properties": { "status": { "type": "string" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "Hip3ReasonResponse": { "required": [ "code", "severity", "message" ], "type": "object", "properties": { "code": { "type": "string" }, "severity": { "type": "string" }, "message": { "type": "string" } } }, "Hip3SourceLineageResponse": { "required": [ "source", "source_version", "observed_timestamp" ], "type": "object", "properties": { "source": { "type": [ "null", "string" ] }, "source_version": { "type": [ "null", "string" ] }, "observed_timestamp": { "type": [ "null", "string" ], "format": "date-time" } } }, "Hip3TaxonomyStateResponse": { "required": [ "status", "category_key", "raw_category", "display_name", "keywords", "category_source_lineage", "annotation_source_lineage", "reason_codes" ], "type": "object", "properties": { "status": { "type": "string" }, "category_key": { "type": [ "null", "string" ] }, "raw_category": { "type": [ "null", "string" ] }, "display_name": { "type": [ "null", "string" ] }, "keywords": { "type": "array", "items": { "type": "string" } }, "category_source_lineage": { "$ref": "#/components/schemas/Hip3SourceLineageResponse" }, "annotation_source_lineage": { "$ref": "#/components/schemas/Hip3SourceLineageResponse" }, "reason_codes": { "type": "array", "items": { "type": "string" } } } }, "Hip4BoundaryRiskResponse": { "required": [ "outcome_id", "outcome_name", "decision_time", "is_high_gamma_state", "quality_flags" ], "type": "object", "properties": { "outcome_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "outcome_name": { "type": "string" }, "decision_time": { "type": "string", "format": "date-time" }, "underlying": { "type": [ "null", "string" ] }, "expiry": { "type": [ "null", "string" ], "format": "date-time" }, "target_price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "underlying_price": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Hip4UnderlyingPriceResponse" } ] }, "annualized_volatility": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "time_to_expiry_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "time_to_expiry_years": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "distance_to_target": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "distance_to_target_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "log_moneyness": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "standardized_boundary_distance": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "model_probability": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "event_gamma_per_dollar": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "probability_mid": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "probability_model_gap": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "boundary_liquidity_depth": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "buy_impact_probability_points": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "sell_impact_probability_points": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "is_high_gamma_state": { "type": "boolean" }, "quality_flags": { "type": "array", "items": { "type": "string" } } } }, "Hip4CalibrationLineageResponse": { "required": [ "metadata_source", "metadata_source_version", "metadata_observed_timestamp", "snapshot_source_timestamp", "snapshot_observed_timestamp" ], "type": "object", "properties": { "metadata_source": { "type": "string" }, "metadata_source_version": { "type": "string" }, "metadata_observed_timestamp": { "type": "string", "format": "date-time" }, "snapshot_source_timestamp": { "type": "string", "format": "date-time" }, "snapshot_observed_timestamp": { "type": "string", "format": "date-time" }, "resolution_label_id": { "type": [ "null", "string" ] }, "resolution_source": { "type": [ "null", "string" ] }, "resolution_source_version": { "type": [ "null", "string" ] }, "resolution_observed_timestamp": { "type": [ "null", "string" ], "format": "date-time" } } }, "Hip4CalibrationMetricGroupResponse": { "required": [ "market_quality_bucket", "sample_size", "confidence" ], "type": "object", "properties": { "event_class_name": { "type": [ "null", "string" ] }, "time_to_expiry_bucket": { "type": [ "null", "string" ] }, "market_quality_bucket": { "type": "string" }, "sample_size": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "brier_score": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "log_loss": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "mean_probability": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "observed_frequency": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "Hip4CalibrationMetricsResponse": { "required": [ "evaluation_time", "range", "settings", "total_rows", "included_rows", "scored_rows", "excluded_rows", "invalid_probability_rows", "confidence", "exclusion_reasons", "groups", "reliability" ], "type": "object", "properties": { "outcome_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "evaluation_time": { "type": "string", "format": "date-time" }, "range": { "$ref": "#/components/schemas/RwaTimeRangeResponse" }, "settings": { "$ref": "#/components/schemas/Hip4CalibrationMetricsSettingsResponse" }, "total_rows": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "included_rows": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "scored_rows": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "excluded_rows": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "invalid_probability_rows": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "brier_score": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "log_loss": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "mean_probability": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "observed_frequency": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "exclusion_reasons": { "type": "object", "additionalProperties": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/Hip4CalibrationMetricGroupResponse" } }, "reliability": { "type": "array", "items": { "$ref": "#/components/schemas/Hip4CalibrationReliabilityBucketResponse" } } } }, "Hip4CalibrationMetricsSettingsResponse": { "required": [ "probability_bucket_count", "log_loss_epsilon", "full_confidence_sample_size", "quality_filters" ], "type": "object", "properties": { "probability_bucket_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "log_loss_epsilon": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "full_confidence_sample_size": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "quality_filters": { "$ref": "#/components/schemas/Hip4CalibrationQualityFilterResponse" } } }, "Hip4CalibrationQualityFilterResponse": { "type": "object", "properties": { "max_snapshot_observation_lag_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "max_spread_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "min_depth100_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "Hip4CalibrationReliabilityBucketResponse": { "required": [ "bucket_index", "lower_inclusive", "upper_exclusive", "sample_size", "confidence" ], "type": "object", "properties": { "bucket_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "lower_inclusive": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "upper_exclusive": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "sample_size": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "brier_score": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "log_loss": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "mean_probability": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "observed_frequency": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "Hip4CalibrationRowResponse": { "required": [ "source_timestamp", "decision_timestamp", "side_index", "probability", "included", "exclusion_reasons", "lineage" ], "type": "object", "properties": { "source_timestamp": { "type": "string", "format": "date-time" }, "decision_timestamp": { "type": "string", "format": "date-time" }, "side_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "probability": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "outcome_value": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "result_side_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "time_to_expiry_bucket": { "type": [ "null", "string" ] }, "included": { "type": "boolean" }, "exclusion_reasons": { "type": "array", "items": { "type": "string" } }, "lineage": { "$ref": "#/components/schemas/Hip4CalibrationLineageResponse" } } }, "Hip4CalibrationSummaryResponse": { "required": [ "outcome_id", "evaluation_time", "range", "total", "included", "excluded", "exclusion_reasons", "rows" ], "type": "object", "properties": { "outcome_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "evaluation_time": { "type": "string", "format": "date-time" }, "range": { "$ref": "#/components/schemas/RwaTimeRangeResponse" }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "included": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "excluded": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "exclusion_reasons": { "type": "object", "additionalProperties": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/Hip4CalibrationRowResponse" } } } }, "Hip4ComplementParityResponse": { "required": [ "status", "confidence", "decision_time", "mid_parity_gap", "ask_parity_cost", "bid_parity_value", "friction_adjusted_gap", "tolerance_probability_points", "reason_codes", "risk_flags", "source_tables" ], "type": "object", "properties": { "status": { "type": "string" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "decision_time": { "type": "string", "format": "date-time" }, "mid_parity_gap": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "ask_parity_cost": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "bid_parity_value": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "friction_adjusted_gap": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "tolerance_probability_points": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "reason_codes": { "type": "array", "items": { "type": "string" } }, "risk_flags": { "type": "array", "items": { "type": "string" } }, "source_tables": { "type": "array", "items": { "type": "string" } } } }, "Hip4FreshnessResponse": { "required": [ "decision_time", "observation_age_seconds", "status" ], "type": "object", "properties": { "decision_time": { "type": "string", "format": "date-time" }, "observation_age_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "status": { "type": "string" } } }, "Hip4MetadataQualityReasonResponse": { "required": [ "code", "severity", "message", "side_index" ], "type": "object", "properties": { "code": { "type": "string" }, "severity": { "type": "string" }, "message": { "type": "string" }, "side_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "Hip4MetadataQualityResponse": { "required": [ "status", "confidence", "flags", "reasons" ], "type": "object", "properties": { "status": { "type": "string" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "flags": { "type": "array", "items": { "type": "string" } }, "reasons": { "type": "array", "items": { "$ref": "#/components/schemas/Hip4MetadataQualityReasonResponse" } } } }, "Hip4OpportunityCostComparisonResponse": { "required": [ "kind", "label", "requires_wallet_context", "confidence", "quality_flags" ], "type": "object", "properties": { "kind": { "type": "string" }, "label": { "type": "string" }, "requires_wallet_context": { "type": "boolean" }, "annualized_return_rate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "expected_return_usd": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "expected_final_value_usd": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "value_gap_usd": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "value_gap_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "quality_flags": { "type": "array", "items": { "type": "string" } } } }, "Hip4OpportunityCostResponse": { "required": [ "outcome_id", "outcome_name", "decision_time", "scope", "capital_usd", "side_index", "quality_flags", "comparisons", "explanations" ], "type": "object", "properties": { "outcome_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "outcome_name": { "type": "string" }, "decision_time": { "type": "string", "format": "date-time" }, "expiry": { "type": [ "null", "string" ], "format": "date-time" }, "horizon_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "horizon_years": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "scope": { "type": "string" }, "capital_usd": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "side_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "side_name": { "type": [ "null", "string" ] }, "entry_probability": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "exit_probability": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "market_probability": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "terminal_payoff_probability": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "claim_units": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "expected_terminal_value_usd": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "entry_friction_usd": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "immediate_exit_value_usd": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "immediate_exit_friction_usd": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "quality_flags": { "type": "array", "items": { "type": "string" } }, "comparisons": { "type": "array", "items": { "$ref": "#/components/schemas/Hip4OpportunityCostComparisonResponse" } }, "explanations": { "type": "array", "items": { "$ref": "#/components/schemas/Hip4QualityExplanationResponse" } } } }, "Hip4OutcomeIdentityResponse": { "required": [ "outcome_id", "outcome_key", "context_key", "question_id", "display_label", "lifecycle_status", "approval_state", "source_lineage", "metadata_quality" ], "type": "object", "properties": { "outcome_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "outcome_key": { "type": "string" }, "context_key": { "type": "string" }, "question_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "display_label": { "type": "string" }, "lifecycle_status": { "type": "string" }, "approval_state": { "type": "string" }, "source_lineage": { "$ref": "#/components/schemas/Hip4SourceLineageResponse" }, "metadata_quality": { "$ref": "#/components/schemas/Hip4MetadataQualityResponse" } } }, "Hip4OutcomeMarketListPageResponse": { "required": [ "limit", "has_more", "next_cursor" ], "type": "object", "properties": { "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "has_more": { "type": "boolean" }, "next_cursor": { "type": [ "null", "string" ] } } }, "Hip4OutcomeMarketListResponse": { "required": [ "decision_time", "access_tier", "source_status", "page", "outcomes" ], "type": "object", "properties": { "decision_time": { "type": "string", "format": "date-time" }, "access_tier": { "type": "string" }, "source_status": { "$ref": "#/components/schemas/Hip4OutcomeMetaSourceStatusResponse" }, "page": { "$ref": "#/components/schemas/Hip4OutcomeMarketListPageResponse" }, "outcomes": { "type": "array", "items": { "$ref": "#/components/schemas/Hip4OutcomeMarketResponse" } } } }, "Hip4OutcomeMarketQualityActivityResponse": { "required": [ "range", "trade_count", "total_size", "total_notional_probability" ], "type": "object", "properties": { "range": { "$ref": "#/components/schemas/RwaTimeRangeResponse" }, "trade_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "total_size": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "total_notional_probability": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "latest_source_timestamp": { "type": [ "null", "string" ], "format": "date-time" } } }, "Hip4OutcomeMarketQualityComponentResponse": { "required": [ "code", "weight", "status" ], "type": "object", "properties": { "code": { "type": "string" }, "weight": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "score": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "status": { "type": "string" } } }, "Hip4OutcomeMarketQualityResponse": { "required": [ "outcome_id", "identity", "decision_time", "score_version", "status", "confidence", "quality_flags", "components", "explanations" ], "type": "object", "properties": { "outcome_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "identity": { "$ref": "#/components/schemas/Hip4OutcomeIdentityResponse" }, "decision_time": { "type": "string", "format": "date-time" }, "score_version": { "type": "string" }, "status": { "type": "string" }, "score": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "quality_flags": { "type": "array", "items": { "type": "string" } }, "components": { "type": "array", "items": { "$ref": "#/components/schemas/Hip4OutcomeMarketQualityComponentResponse" } }, "explanations": { "type": "array", "items": { "$ref": "#/components/schemas/Hip4QualityExplanationResponse" } }, "recent_activity": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Hip4OutcomeMarketQualityActivityResponse" } ] } } }, "Hip4OutcomeMarketResponse": { "required": [ "outcome_id", "identity", "name", "description_raw", "description_class", "binary_type", "status", "confidence", "diagnostic_flags", "quality_flags", "price_thresholds", "source_lineage", "freshness", "sides" ], "type": "object", "properties": { "outcome_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "identity": { "$ref": "#/components/schemas/Hip4OutcomeIdentityResponse" }, "name": { "type": "string" }, "description_raw": { "type": "string" }, "description_class": { "type": "string" }, "description_class_name": { "type": [ "null", "string" ] }, "binary_type": { "type": "string" }, "quote_asset": { "type": [ "null", "string" ] }, "status": { "type": "string" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "diagnostic_flags": { "type": "array", "items": { "type": "string" } }, "quality_flags": { "type": "array", "items": { "type": "string" } }, "underlying": { "type": [ "null", "string" ] }, "expiry": { "type": [ "null", "string" ], "format": "date-time" }, "target_price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "price_thresholds": { "type": "array", "items": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } }, "period": { "type": [ "null", "string" ] }, "question": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Hip4OutcomeQuestionResponse" } ] }, "source_lineage": { "$ref": "#/components/schemas/Hip4SourceLineageResponse" }, "freshness": { "$ref": "#/components/schemas/Hip4FreshnessResponse" }, "sides": { "type": "array", "items": { "$ref": "#/components/schemas/Hip4OutcomeSideAssetResponse" } } } }, "Hip4OutcomeMetaCorpusResponse": { "required": [ "outcome_count", "question_count" ], "type": "object", "properties": { "outcome_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "question_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "Hip4OutcomeMetaEnvironmentStatusResponse": { "required": [ "environment", "source_status", "availability_status", "endpoint", "official_docs_status", "reason_codes", "risk_flags" ], "type": "object", "properties": { "environment": { "type": "string" }, "source_status": { "type": "string" }, "availability_status": { "type": "string" }, "endpoint": { "type": "string" }, "official_docs_status": { "type": "string" }, "reason_codes": { "type": "array", "items": { "type": "string" } }, "risk_flags": { "type": "array", "items": { "type": "string" } } } }, "Hip4OutcomeMetaSnapshotStatusResponse": { "required": [ "source_version", "observed_timestamp", "parser_version", "outcome_count", "question_count", "freshness_status", "observation_age_seconds", "stale_after_seconds" ], "type": "object", "properties": { "source_version": { "type": "string" }, "observed_timestamp": { "type": "string", "format": "date-time" }, "parser_version": { "type": "string" }, "outcome_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "question_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "freshness_status": { "type": "string" }, "observation_age_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "stale_after_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "Hip4OutcomeMetaSourceStatusResponse": { "required": [ "decision_time", "source", "source_version", "observed_timestamp", "outcome_count", "question_count", "current_snapshot", "corpus", "gate", "environments" ], "type": "object", "properties": { "decision_time": { "type": "string", "format": "date-time" }, "source": { "type": "string" }, "source_version": { "type": "string" }, "observed_timestamp": { "type": [ "null", "string" ], "format": "date-time" }, "outcome_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "question_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "current_snapshot": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Hip4OutcomeMetaSnapshotStatusResponse" } ] }, "corpus": { "$ref": "#/components/schemas/Hip4OutcomeMetaCorpusResponse" }, "gate": { "$ref": "#/components/schemas/Hip4SourceContractGateResponse" }, "environments": { "type": "array", "items": { "$ref": "#/components/schemas/Hip4OutcomeMetaEnvironmentStatusResponse" } } } }, "Hip4OutcomeProbabilityResponse": { "required": [ "outcome_id", "decision_time", "quality_flags", "probability_drift", "complement_parity" ], "type": "object", "properties": { "outcome_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "decision_time": { "type": "string", "format": "date-time" }, "source_timestamp": { "type": [ "null", "string" ], "format": "date-time" }, "observed_timestamp": { "type": [ "null", "string" ], "format": "date-time" }, "mid_parity_gap": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "ask_parity_cost": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "bid_parity_value": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "quality_flags": { "type": "array", "items": { "type": "string" } }, "probability_drift": { "type": "array", "items": { "$ref": "#/components/schemas/Hip4ProbabilityDriftResponse" } }, "complement_parity": { "$ref": "#/components/schemas/Hip4ComplementParityResponse" }, "yes_side": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Hip4OutcomeSideMicrostructureResponse" } ] }, "no_side": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Hip4OutcomeSideMicrostructureResponse" } ] } } }, "Hip4OutcomeQuestionResponse": { "required": [ "question_id", "name", "description_raw", "description_class", "diagnostic_flags", "price_thresholds", "named_outcome_ids", "settled_named_outcome_ids", "is_fallback_outcome", "source_lineage" ], "type": "object", "properties": { "question_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "name": { "type": "string" }, "description_raw": { "type": "string" }, "description_class": { "type": "string" }, "description_class_name": { "type": [ "null", "string" ] }, "diagnostic_flags": { "type": "array", "items": { "type": "string" } }, "underlying": { "type": [ "null", "string" ] }, "expiry": { "type": [ "null", "string" ], "format": "date-time" }, "price_thresholds": { "type": "array", "items": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } }, "period": { "type": [ "null", "string" ] }, "fallback_outcome_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "named_outcome_ids": { "type": "array", "items": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "settled_named_outcome_ids": { "type": "array", "items": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "is_fallback_outcome": { "type": "boolean" }, "named_outcome_ordinal": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "source_lineage": { "$ref": "#/components/schemas/Hip4SourceLineageResponse" } } }, "Hip4OutcomeSideAssetResponse": { "required": [ "side_index", "identity", "side_name", "encoding", "coin", "token_name", "asset_id", "source_lineage" ], "type": "object", "properties": { "side_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "identity": { "$ref": "#/components/schemas/Hip4OutcomeSideIdentityResponse" }, "side_name": { "type": "string" }, "encoding": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "coin": { "type": "string" }, "token_name": { "type": "string" }, "asset_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "source_lineage": { "$ref": "#/components/schemas/Hip4SourceLineageResponse" } } }, "Hip4OutcomeSideBookResponse": { "required": [ "outcome_id", "side_index", "coin", "asset_id", "source_timestamp", "observed_timestamp", "mid_probability", "spread_probability_points", "spread_bps", "depth_10bps", "depth_25bps", "depth_50bps", "depth_100bps", "metadata_lineage", "bids", "asks" ], "type": "object", "properties": { "outcome_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "side_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "coin": { "type": "string" }, "asset_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "source_timestamp": { "type": "string", "format": "date-time" }, "observed_timestamp": { "type": "string", "format": "date-time" }, "mid_probability": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "spread_probability_points": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "spread_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "depth_10bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "depth_25bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "depth_50bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "depth_100bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "metadata_lineage": { "$ref": "#/components/schemas/Hip4SourceLineageResponse" }, "bids": { "type": "array", "items": { "$ref": "#/components/schemas/BookLevelResponse" } }, "asks": { "type": "array", "items": { "$ref": "#/components/schemas/BookLevelResponse" } } } }, "Hip4OutcomeSideBookStateResponse": { "required": [ "source_timestamp", "observed_timestamp", "best_bid_probability", "best_ask_probability", "mid_probability", "spread_probability_points", "spread_bps", "depth_10bps", "depth_10bps_bid", "depth_10bps_ask", "depth_25bps", "depth_50bps", "depth_100bps" ], "type": "object", "properties": { "source_timestamp": { "type": "string", "format": "date-time" }, "observed_timestamp": { "type": "string", "format": "date-time" }, "best_bid_probability": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "best_ask_probability": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "mid_probability": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "spread_probability_points": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "spread_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "depth_10bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "depth_10bps_bid": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "depth_10bps_ask": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "depth_25bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "depth_50bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "depth_100bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "Hip4OutcomeSideIdentityResponse": { "required": [ "outcome_id", "side_index", "outcome_key", "context_key", "question_id", "side_key", "display_label", "lifecycle_status", "approval_state", "source_lineage", "metadata_quality" ], "type": "object", "properties": { "outcome_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "side_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "outcome_key": { "type": "string" }, "context_key": { "type": "string" }, "question_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "side_key": { "type": "string" }, "display_label": { "type": "string" }, "lifecycle_status": { "type": "string" }, "approval_state": { "type": "string" }, "source_lineage": { "$ref": "#/components/schemas/Hip4SourceLineageResponse" }, "metadata_quality": { "$ref": "#/components/schemas/Hip4MetadataQualityResponse" } } }, "Hip4OutcomeSideMicrostructureResponse": { "required": [ "side_index", "source_timestamp", "observed_timestamp", "depth_bands", "buy_impacts", "sell_impacts", "quality_flags" ], "type": "object", "properties": { "side_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "source_timestamp": { "type": "string", "format": "date-time" }, "observed_timestamp": { "type": "string", "format": "date-time" }, "best_bid_probability": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "best_ask_probability": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "mid_probability": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "spread_probability_points": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "spread_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "depth_bands": { "type": "array", "items": { "$ref": "#/components/schemas/Hip4ProbabilityDepthBandResponse" } }, "buy_impacts": { "type": "array", "items": { "$ref": "#/components/schemas/Hip4ProbabilityImpactResponse" } }, "sell_impacts": { "type": "array", "items": { "$ref": "#/components/schemas/Hip4ProbabilityImpactResponse" } }, "quality_flags": { "type": "array", "items": { "type": "string" } } } }, "Hip4OutcomeSideMidPointResponse": { "required": [ "source_timestamp", "observed_timestamp", "coin", "asset_id", "mid_probability", "metadata_lineage" ], "type": "object", "properties": { "source_timestamp": { "type": "string", "format": "date-time" }, "observed_timestamp": { "type": "string", "format": "date-time" }, "coin": { "type": "string" }, "asset_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "mid_probability": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "metadata_lineage": { "$ref": "#/components/schemas/Hip4SourceLineageResponse" } } }, "Hip4OutcomeSideMidSeriesResponse": { "required": [ "outcome_id", "side_index", "range", "data" ], "type": "object", "properties": { "outcome_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "side_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "range": { "$ref": "#/components/schemas/RwaTimeRangeResponse" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Hip4OutcomeSideMidPointResponse" } } } }, "Hip4OutcomeSideMidStateResponse": { "required": [ "source_timestamp", "observed_timestamp", "mid_probability" ], "type": "object", "properties": { "source_timestamp": { "type": "string", "format": "date-time" }, "observed_timestamp": { "type": "string", "format": "date-time" }, "mid_probability": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "Hip4OutcomeSideStateResponse": { "required": [ "outcome_id", "side_index", "coin", "asset_id", "decision_time", "liquidity", "metadata_lineage" ], "type": "object", "properties": { "outcome_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "side_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "coin": { "type": "string" }, "asset_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "decision_time": { "type": "string", "format": "date-time" }, "liquidity": { "$ref": "#/components/schemas/Hip4SideLiquidityResponse" }, "latest_book": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Hip4OutcomeSideBookStateResponse" } ] }, "latest_mid": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Hip4OutcomeSideMidStateResponse" } ] }, "latest_trade": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Hip4OutcomeSideTradeStateResponse" } ] }, "metadata_lineage": { "$ref": "#/components/schemas/Hip4SourceLineageResponse" } } }, "Hip4OutcomeSideTradeResponse": { "required": [ "source_timestamp", "observed_timestamp", "coin", "asset_id", "price", "size", "side", "metadata_lineage" ], "type": "object", "properties": { "source_timestamp": { "type": "string", "format": "date-time" }, "observed_timestamp": { "type": "string", "format": "date-time" }, "coin": { "type": "string" }, "asset_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "size": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "side": { "type": "string" }, "trade_id": { "type": [ "null", "string" ] }, "metadata_lineage": { "$ref": "#/components/schemas/Hip4SourceLineageResponse" } } }, "Hip4OutcomeSideTradesResponse": { "required": [ "outcome_id", "side_index", "range", "trades" ], "type": "object", "properties": { "outcome_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "side_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "range": { "$ref": "#/components/schemas/RwaTimeRangeResponse" }, "trades": { "type": "array", "items": { "$ref": "#/components/schemas/Hip4OutcomeSideTradeResponse" } } } }, "Hip4OutcomeSideTradeStateResponse": { "required": [ "source_timestamp", "observed_timestamp", "price", "size", "side" ], "type": "object", "properties": { "source_timestamp": { "type": "string", "format": "date-time" }, "observed_timestamp": { "type": "string", "format": "date-time" }, "price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "size": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "side": { "type": "string" } } }, "Hip4OutcomeTruthLabelResponse": { "required": [ "label_id", "label_type", "family", "event_timestamp", "observed_timestamp", "confidence", "mechanism_tags", "summary", "source_lineage", "source_ids", "source_uris" ], "type": "object", "properties": { "label_id": { "type": "string" }, "label_type": { "type": "string" }, "family": { "type": "string" }, "result_side_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "event_timestamp": { "type": "string", "format": "date-time" }, "observed_timestamp": { "type": "string", "format": "date-time" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "mechanism_tags": { "type": "array", "items": { "type": "string" } }, "summary": { "type": "string" }, "corrected_label_id": { "type": [ "null", "string" ] }, "source_lineage": { "$ref": "#/components/schemas/Hip4SourceLineageResponse" }, "source_ids": { "type": "array", "items": { "type": "string" } }, "source_uris": { "type": "array", "items": { "type": "string" } } } }, "Hip4OutcomeTruthLabelsResponse": { "required": [ "outcome_id", "decision_time", "labels" ], "type": "object", "properties": { "outcome_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "decision_time": { "type": "string", "format": "date-time" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/Hip4OutcomeTruthLabelResponse" } } } }, "Hip4ProbabilityDepthBandResponse": { "required": [ "band_probability_points", "bid_size", "ask_size", "total_size" ], "type": "object", "properties": { "band_probability_points": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "bid_size": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "ask_size": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "total_size": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "Hip4ProbabilityDriftResponse": { "required": [ "side_index", "status", "confidence", "decision_time", "latest_source_timestamp", "previous_source_timestamp", "latest_mid_probability", "previous_mid_probability", "delta_probability_points", "velocity_probability_points_per_hour", "window_seconds", "jump_size_probability_points", "reason_codes", "risk_flags", "source_tables" ], "type": "object", "properties": { "side_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "status": { "type": "string" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "decision_time": { "type": "string", "format": "date-time" }, "latest_source_timestamp": { "type": [ "null", "string" ], "format": "date-time" }, "previous_source_timestamp": { "type": [ "null", "string" ], "format": "date-time" }, "latest_mid_probability": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "previous_mid_probability": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "delta_probability_points": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "velocity_probability_points_per_hour": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "window_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "jump_size_probability_points": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "reason_codes": { "type": "array", "items": { "type": "string" } }, "risk_flags": { "type": "array", "items": { "type": "string" } }, "source_tables": { "type": "array", "items": { "type": "string" } } } }, "Hip4ProbabilityImpactResponse": { "required": [ "side", "target_size", "filled_size", "unfilled_size", "quality_flags" ], "type": "object", "properties": { "side": { "type": "string" }, "target_size": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "filled_size": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "vwap_probability": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "probability_impact": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "unfilled_size": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "quality_flags": { "type": "array", "items": { "type": "string" } } } }, "Hip4QualityExplanationResponse": { "required": [ "code", "severity", "message" ], "type": "object", "properties": { "code": { "type": "string" }, "severity": { "type": "string" }, "message": { "type": "string" } } }, "Hip4SideLiquidityResponse": { "required": [ "status", "confidence", "freshness", "book_freshness", "mid_freshness", "trade_freshness", "primary_source", "best_bid_probability", "best_ask_probability", "mid_probability", "spread_probability_points", "spread_bps", "depth_10bps", "depth_25bps", "depth_50bps", "depth_100bps", "imbalance", "reason_codes", "risk_flags", "source_tables" ], "type": "object", "properties": { "status": { "type": "string" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "freshness": { "$ref": "#/components/schemas/FreshnessEnvelopeResponse" }, "book_freshness": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/FreshnessEnvelopeResponse" } ] }, "mid_freshness": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/FreshnessEnvelopeResponse" } ] }, "trade_freshness": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/FreshnessEnvelopeResponse" } ] }, "primary_source": { "type": [ "null", "string" ] }, "best_bid_probability": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "best_ask_probability": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "mid_probability": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "spread_probability_points": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "spread_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "depth_10bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "depth_25bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "depth_50bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "depth_100bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "imbalance": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "reason_codes": { "type": "array", "items": { "type": "string" } }, "risk_flags": { "type": "array", "items": { "type": "string" } }, "source_tables": { "type": "array", "items": { "type": "string" } } } }, "Hip4SourceContractGateResponse": { "required": [ "surface", "tier", "status", "missing_capabilities" ], "type": "object", "properties": { "surface": { "type": "string" }, "tier": { "type": "string" }, "status": { "type": "string" }, "missing_capabilities": { "type": "array", "items": { "type": "string" } } } }, "Hip4SourceLineageResponse": { "required": [ "source", "source_version", "observed_timestamp" ], "type": "object", "properties": { "source": { "type": "string" }, "source_version": { "type": "string" }, "observed_timestamp": { "type": "string", "format": "date-time" } } }, "Hip4UnderlyingPriceResponse": { "required": [ "market", "venue", "source_timestamp", "observed_timestamp", "price", "source" ], "type": "object", "properties": { "market": { "type": "string" }, "venue": { "type": "string" }, "source_timestamp": { "type": "string", "format": "date-time" }, "observed_timestamp": { "type": "string", "format": "date-time" }, "price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "source": { "type": "string" } } }, "LaunchAccessRequestBody": { "type": "object", "properties": { "email": { "type": [ "null", "string" ] }, "source_path": { "type": [ "null", "string" ] }, "referrer": { "type": [ "null", "string" ] }, "utm_source": { "type": [ "null", "string" ] }, "utm_medium": { "type": [ "null", "string" ] }, "utm_campaign": { "type": [ "null", "string" ] } } }, "LaunchAccessRequestResponse": { "required": [ "status", "request_id", "decision_time" ], "type": "object", "properties": { "status": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "decision_time": { "type": "string", "format": "date-time" } } }, "LiquidationClusterResponse": { "required": [ "cluster_id", "side", "start_time", "end_time", "duration_milliseconds", "count", "notional_usd", "notional_density_usd_per_second", "price_impact_bps" ], "type": "object", "properties": { "cluster_id": { "type": "string" }, "side": { "type": "string" }, "start_time": { "type": "string", "format": "date-time" }, "end_time": { "type": "string", "format": "date-time" }, "duration_milliseconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "notional_usd": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "notional_density_usd_per_second": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "price_impact_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "LiquidationExplanationResponse": { "required": [ "code", "severity", "message" ], "type": "object", "properties": { "code": { "type": "string" }, "severity": { "type": "string" }, "message": { "type": "string" } } }, "LiquidationPressureResponse": { "required": [ "bid_depth_50bps_usd", "ask_depth_50bps_usd", "max_side_pressure_ratio", "status", "reason_code" ], "type": "object", "properties": { "bid_depth_50bps_usd": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "ask_depth_50bps_usd": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "max_side_pressure_ratio": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "status": { "type": "string" }, "reason_code": { "type": "string" } } }, "LiquidationSnapshotResponse": { "required": [ "market", "venue", "decision_time", "window", "source_status", "summary", "pressure", "freshness", "clusters", "source_tables", "derived_from_tables", "formula_key", "risk_flags", "null_reason", "explanations" ], "type": "object", "properties": { "market": { "type": "string" }, "venue": { "type": "string" }, "decision_time": { "type": "string", "format": "date-time" }, "window": { "$ref": "#/components/schemas/OpenInterestWindowResponse" }, "source_status": { "type": "string" }, "summary": { "$ref": "#/components/schemas/LiquidationSummaryResponse" }, "pressure": { "$ref": "#/components/schemas/LiquidationPressureResponse" }, "freshness": { "$ref": "#/components/schemas/FreshnessEnvelopeResponse" }, "clusters": { "type": "array", "items": { "$ref": "#/components/schemas/LiquidationClusterResponse" } }, "source_tables": { "type": "array", "items": { "type": "string" } }, "derived_from_tables": { "type": "array", "items": { "type": "string" } }, "formula_key": { "type": "string" }, "risk_flags": { "type": "array", "items": { "type": "string" } }, "null_reason": { "type": [ "null", "string" ] }, "explanations": { "type": "array", "items": { "$ref": "#/components/schemas/LiquidationExplanationResponse" } } } }, "LiquidationSummaryResponse": { "required": [ "count", "notional_usd", "buy_count", "sell_count", "buy_notional_usd", "sell_notional_usd", "side_skew", "latest_event_timestamp" ], "type": "object", "properties": { "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "notional_usd": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "buy_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "sell_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "buy_notional_usd": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "sell_notional_usd": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "side_skew": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "latest_event_timestamp": { "type": [ "null", "string" ], "format": "date-time" } } }, "LiquidityPostureComponentResponse": { "required": [ "key", "value", "unit", "status", "severity", "reason_code", "message" ], "type": "object", "properties": { "key": { "type": "string" }, "value": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "unit": { "type": "string" }, "status": { "type": "string" }, "severity": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "reason_code": { "type": "string" }, "message": { "type": "string" } } }, "LiquidityPostureExplanationResponse": { "required": [ "code", "severity", "message" ], "type": "object", "properties": { "code": { "type": "string" }, "severity": { "type": "string" }, "message": { "type": "string" } } }, "LiquidityPostureResponse": { "required": [ "market", "venue", "decision_time", "posture", "score", "score_version", "confidence", "freshness", "components", "reason_codes", "risk_flags", "null_reason", "source_tables", "derived_from_tables", "formula_key", "explanations" ], "type": "object", "properties": { "market": { "type": "string" }, "venue": { "type": "string" }, "decision_time": { "type": "string", "format": "date-time" }, "posture": { "type": "string" }, "score": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "score_version": { "type": "string" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "freshness": { "$ref": "#/components/schemas/FreshnessEnvelopeResponse" }, "components": { "type": "array", "items": { "$ref": "#/components/schemas/LiquidityPostureComponentResponse" } }, "reason_codes": { "type": "array", "items": { "type": "string" } }, "risk_flags": { "type": "array", "items": { "type": "string" } }, "null_reason": { "type": [ "null", "string" ] }, "source_tables": { "type": "array", "items": { "type": "string" } }, "derived_from_tables": { "type": "array", "items": { "type": "string" } }, "formula_key": { "type": "string" }, "explanations": { "type": "array", "items": { "$ref": "#/components/schemas/LiquidityPostureExplanationResponse" } } } }, "MarketExternalReferenceResponse": { "required": [ "provider", "coverage_status", "mapping_version", "exchange", "provider_symbol", "url" ], "type": "object", "properties": { "provider": { "type": "string" }, "coverage_status": { "type": "string" }, "mapping_version": { "type": "string" }, "exchange": { "type": "string" }, "provider_symbol": { "type": "string" }, "url": { "type": "string" } } }, "MarketOverviewResponse": { "required": [ "market", "market_family", "listing_state", "data_source", "external_reference", "external_reference_null_reason", "freshness", "volume_24h", "volume_usd_24h", "trade_count_24h", "open_interest", "spread_bps", "last_price", "price_change_24h_pct" ], "type": "object", "properties": { "market": { "type": "string" }, "market_family": { "type": "string" }, "listing_state": { "type": "string" }, "data_source": { "type": "string" }, "external_reference": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MarketExternalReferenceResponse" } ] }, "external_reference_null_reason": { "type": [ "null", "string" ] }, "latest_observation_timestamp": { "type": [ "null", "string" ], "format": "date-time" }, "observation_age_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "freshness": { "$ref": "#/components/schemas/FreshnessEnvelopeResponse" }, "volume_24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "volume_usd_24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "trade_count_24h": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "open_interest": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "funding_rate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "spread_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "vpin": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "last_price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "price_change_24h_pct": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "MarketResponse": { "required": [ "market", "base_asset", "market_type", "is_hip3", "market_family", "listing_state", "route_capabilities", "external_reference", "external_reference_null_reason" ], "type": "object", "properties": { "market": { "type": "string" }, "base_asset": { "type": "string" }, "market_type": { "type": "string" }, "is_hip3": { "type": "boolean" }, "market_family": { "type": "string" }, "listing_state": { "type": "string" }, "route_capabilities": { "$ref": "#/components/schemas/MarketRouteCapabilitiesResponse" }, "external_reference": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MarketExternalReferenceResponse" } ] }, "external_reference_null_reason": { "type": [ "null", "string" ] }, "tick_size": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "lot_size": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "max_leverage": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "MarketRouteCapabilitiesResponse": { "required": [ "supports_metrics", "supports_depth", "supports_funding", "supports_liquidations", "supports_hip3_context", "supports_hip4_context" ], "type": "object", "properties": { "supports_metrics": { "type": "boolean" }, "supports_depth": { "type": "boolean" }, "supports_funding": { "type": "boolean" }, "supports_liquidations": { "type": "boolean" }, "supports_hip3_context": { "type": "boolean" }, "supports_hip4_context": { "type": "boolean" } } }, "MetricComputationWindowResponse": { "required": [ "start", "end", "granularity" ], "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "granularity": { "type": "string" } } }, "MetricIntelligenceResponse": { "required": [ "metric", "value", "unit", "source_tables", "computation_window", "freshness", "confidence", "null_reason", "formula_key", "risk_flags" ], "type": "object", "properties": { "metric": { "type": "string" }, "value": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "unit": { "type": "string" }, "source_tables": { "type": "array", "items": { "type": "string" } }, "computation_window": { "$ref": "#/components/schemas/MetricComputationWindowResponse" }, "freshness": { "$ref": "#/components/schemas/FreshnessEnvelopeResponse" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "null_reason": { "type": [ "null", "string" ] }, "formula_key": { "type": "string" }, "risk_flags": { "type": "array", "items": { "type": "string" } } } }, "MetricPointResponse": { "required": [ "ts", "value" ], "type": "object", "properties": { "ts": { "type": "string", "format": "date-time" }, "value": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "MetricSeriesResponse": { "required": [ "market", "metric", "granularity", "intelligence", "data" ], "type": "object", "properties": { "market": { "type": "string" }, "metric": { "type": "string" }, "granularity": { "type": "string" }, "intelligence": { "$ref": "#/components/schemas/MetricIntelligenceResponse" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MetricPointResponse" } } } }, "OhlcPointResponse": { "required": [ "ts", "open", "high", "low", "close", "volume" ], "type": "object", "properties": { "ts": { "type": "string", "format": "date-time" }, "open": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "high": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "low": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "close": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "volume": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "OhlcSeriesResponse": { "required": [ "market", "data" ], "type": "object", "properties": { "market": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OhlcPointResponse" } } } }, "OpenInterestFundingAlignmentResponse": { "required": [ "status", "reason_code", "funding_rate", "funding_timestamp" ], "type": "object", "properties": { "status": { "type": "string" }, "reason_code": { "type": "string" }, "funding_rate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "funding_timestamp": { "type": [ "null", "string" ], "format": "date-time" } } }, "OpenInterestSnapshotResponse": { "required": [ "market", "venue", "granularity", "decision_time", "window", "open_interest", "open_interest_timestamp", "open_interest_delta", "open_interest_delta_pct", "open_interest_velocity_per_hour", "open_interest_to_volume", "volume_window", "funding_alignment", "intelligence", "data", "source_tables", "risk_flags", "null_reason" ], "type": "object", "properties": { "market": { "type": "string" }, "venue": { "type": "string" }, "granularity": { "type": "string" }, "decision_time": { "type": "string", "format": "date-time" }, "window": { "$ref": "#/components/schemas/OpenInterestWindowResponse" }, "open_interest": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "open_interest_timestamp": { "type": [ "null", "string" ], "format": "date-time" }, "open_interest_delta": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "open_interest_delta_pct": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "open_interest_velocity_per_hour": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "open_interest_to_volume": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "volume_window": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "funding_alignment": { "$ref": "#/components/schemas/OpenInterestFundingAlignmentResponse" }, "intelligence": { "$ref": "#/components/schemas/MetricIntelligenceResponse" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MetricPointResponse" } }, "source_tables": { "type": "array", "items": { "type": "string" } }, "risk_flags": { "type": "array", "items": { "type": "string" } }, "null_reason": { "type": [ "null", "string" ] } } }, "OpenInterestWindowResponse": { "required": [ "start", "end" ], "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } }, "PerpBasisPointResponse": { "required": [ "ts", "market", "venue", "coinbase_spot_mid_price", "perp_mid_price", "spot_basis_bps", "coinbase_source_timestamp", "perp_source_timestamp", "coinbase_observation_count", "perp_observation_count", "source_lag_seconds", "basis_state", "funding_context", "quality_flags" ], "type": "object", "properties": { "ts": { "type": "string", "format": "date-time" }, "market": { "type": "string" }, "venue": { "type": "string" }, "coinbase_spot_mid_price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "perp_mid_price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "spot_basis_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "funding_rate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "funding_rate_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "funding_adjusted_basis_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "funding_timestamp": { "type": [ "null", "string" ], "format": "date-time" }, "funding_basis_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "cross_venue_basis_divergence_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "coinbase_source_timestamp": { "type": "string", "format": "date-time" }, "perp_source_timestamp": { "type": "string", "format": "date-time" }, "coinbase_observation_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "perp_observation_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "source_lag_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "basis_state": { "type": "string" }, "funding_context": { "type": "string" }, "quality_flags": { "type": "array", "items": { "type": "string" } } } }, "PerpBasisSeriesResponse": { "required": [ "period", "access_tier", "truncated", "result_limit", "data", "caveats" ], "type": "object", "properties": { "period": { "$ref": "#/components/schemas/RwaTimeRangeResponse" }, "market": { "type": [ "null", "string" ] }, "venue": { "type": [ "null", "string" ] }, "access_tier": { "type": "string" }, "truncated": { "type": "boolean" }, "result_limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PerpBasisPointResponse" } }, "caveats": { "type": "array", "items": { "type": "string" } } } }, "ProBookReplayFrameResponse": { "required": [ "bucket_start", "timestamp", "source_lag_milliseconds", "mid_price", "spread_bps", "bids", "asks" ], "type": "object", "properties": { "bucket_start": { "type": "string", "format": "date-time" }, "timestamp": { "type": "string", "format": "date-time" }, "source_lag_milliseconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "mid_price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "spread_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "bids": { "type": "array", "items": { "$ref": "#/components/schemas/BookLevel" } }, "asks": { "type": "array", "items": { "$ref": "#/components/schemas/BookLevel" } } } }, "ProBookReplayResponse": { "required": [ "market", "venue", "period", "sample_interval_seconds", "levels", "truncated", "truncation_flags", "quality_flags", "data" ], "type": "object", "properties": { "market": { "type": "string" }, "venue": { "type": "string" }, "period": { "$ref": "#/components/schemas/TimeRange" }, "sample_interval_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "levels": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "truncated": { "type": "boolean" }, "truncation_flags": { "type": "array", "items": { "type": "string" } }, "max_source_lag_milliseconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "quality_flags": { "type": "array", "items": { "type": "string" } }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProBookReplayFrameResponse" } } } }, "ProExecutionReportResponse": { "required": [ "wallet", "period", "total_trades", "total_volume_usd", "total_slippage_usd", "avg_slippage_bps", "median_slippage_bps", "p99_slippage_bps", "by_market" ], "type": "object", "properties": { "wallet": { "type": "string" }, "period": { "$ref": "#/components/schemas/TimeRange" }, "total_trades": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "total_volume_usd": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "total_slippage_usd": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "avg_slippage_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "median_slippage_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "p99_slippage_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "by_market": { "type": "array", "items": { "$ref": "#/components/schemas/ProMarketExecutionSummaryResponse" } } } }, "ProLiquidationCascadeResponse": { "required": [ "cascade_id", "market", "side", "start_time", "end_time", "duration_milliseconds", "liquidation_count", "total_notional_usd", "price_impact_bps" ], "type": "object", "properties": { "cascade_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "market": { "type": "string" }, "side": { "type": "string" }, "start_time": { "type": "string", "format": "date-time" }, "end_time": { "type": "string", "format": "date-time" }, "duration_milliseconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "liquidation_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "total_notional_usd": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "notional_density_usd_per_second": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "price_impact_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "ProLiquidationCascadeSeriesResponse": { "required": [ "market", "period", "data", "caveats" ], "type": "object", "properties": { "market": { "type": "string" }, "period": { "$ref": "#/components/schemas/TimeRange" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProLiquidationCascadeResponse" } }, "caveats": { "type": "array", "items": { "type": "string" } } } }, "ProMarketExecutionSummaryResponse": { "required": [ "market", "trade_count", "volume_usd", "avg_slippage_bps", "total_slippage_usd", "estimated_savings_usd" ], "type": "object", "properties": { "market": { "type": "string" }, "trade_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "volume_usd": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "avg_slippage_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "total_slippage_usd": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "estimated_savings_usd": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "ProVpinPointResponse": { "required": [ "timestamp", "vpin", "regime" ], "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "vpin": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "regime": { "type": "string" } } }, "ProVpinSeriesResponse": { "required": [ "market", "period", "data" ], "type": "object", "properties": { "market": { "type": "string" }, "period": { "$ref": "#/components/schemas/TimeRange" }, "venue": { "type": [ "null", "string" ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProVpinPointResponse" } } } }, "RwaComparableSnapshotResponse": { "required": [ "comparable_market_key", "decision_time", "summary", "markets" ], "type": "object", "properties": { "comparable_market_key": { "type": "string" }, "venue": { "type": [ "null", "string" ] }, "decision_time": { "type": "string", "format": "date-time" }, "summary": { "$ref": "#/components/schemas/RwaMarketQualitySummaryResponse" }, "markets": { "type": "array", "items": { "$ref": "#/components/schemas/RwaMarketQualityBucketResponse" } } } }, "RwaComparisonExplanationResponse": { "required": [ "code", "severity", "message" ], "type": "object", "properties": { "code": { "type": "string" }, "severity": { "type": "string" }, "message": { "type": "string" } } }, "RwaMarketQualityBucketResponse": { "required": [ "timestamp", "venue", "market", "instrument_key", "comparable_market_key", "status", "confidence", "is_comparable", "reference_session_state", "diagnostics", "quality_flags", "explanations", "total_volume", "funding_annualization_method" ], "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "venue": { "type": "string" }, "market": { "type": "string" }, "instrument_key": { "type": "string" }, "comparable_market_key": { "type": "string" }, "status": { "type": "string" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "is_comparable": { "type": "boolean" }, "reference_session_state": { "type": "string" }, "diagnostics": { "type": "array", "items": { "type": "string" } }, "quality_flags": { "type": "array", "items": { "type": "string" } }, "explanations": { "type": "array", "items": { "$ref": "#/components/schemas/RwaComparisonExplanationResponse" } }, "venue_price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "reference_price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "reference_gap_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "session_gap_bps": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "reference_event_lag_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "reference_observation_lag_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "effective_spread_mean": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "depth10_bps_mean": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "open_interest": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "total_volume": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "funding_rate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "funding_annualized_rate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "funding_annualization_method": { "type": "string" }, "contract_multiplier": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "RwaMarketQualitySeriesResponse": { "required": [ "market", "range", "summary", "data" ], "type": "object", "properties": { "market": { "type": "string" }, "comparable_market_key": { "type": [ "null", "string" ] }, "venue": { "type": [ "null", "string" ] }, "range": { "$ref": "#/components/schemas/RwaTimeRangeResponse" }, "summary": { "$ref": "#/components/schemas/RwaMarketQualitySummaryResponse" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RwaMarketQualityBucketResponse" } } } }, "RwaMarketQualitySummaryResponse": { "required": [ "total", "valid", "degraded", "rejected" ], "type": "object", "properties": { "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "valid": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "degraded": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "rejected": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "RwaMarketRegistryMappingResponse": { "required": [ "instrument_key", "display_symbol", "asset_class", "mapping_kind", "comparable_market_key", "mapping_lifecycle_status", "mapping_approval_state", "instrument_lifecycle_status", "instrument_approval_state", "mapping_source", "instrument_source" ], "type": "object", "properties": { "instrument_key": { "type": "string" }, "display_symbol": { "type": "string" }, "display_name": { "type": [ "null", "string" ] }, "asset_class": { "type": "string" }, "mapping_kind": { "type": "string" }, "comparable_market_key": { "type": "string" }, "contract_multiplier": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "reference_source": { "type": [ "null", "string" ] }, "oracle_source": { "type": [ "null", "string" ] }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "mapping_lifecycle_status": { "type": "string" }, "mapping_approval_state": { "type": "string" }, "instrument_lifecycle_status": { "type": "string" }, "instrument_approval_state": { "type": "string" }, "mapping_source": { "$ref": "#/components/schemas/RwaSourceLineageResponse" }, "instrument_source": { "$ref": "#/components/schemas/RwaSourceLineageResponse" } } }, "RwaMarketRegistryResponse": { "required": [ "market", "venue", "decision_time", "mappings" ], "type": "object", "properties": { "market": { "type": "string" }, "venue": { "type": "string" }, "decision_time": { "type": "string", "format": "date-time" }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/RwaMarketRegistryMappingResponse" } } } }, "RwaSourceLineageResponse": { "required": [ "source", "source_kind", "source_version", "observed_timestamp" ], "type": "object", "properties": { "source": { "type": "string" }, "source_kind": { "type": "string" }, "source_version": { "type": "string" }, "observed_timestamp": { "type": "string", "format": "date-time" } } }, "RwaTimeRangeResponse": { "required": [ "from", "to" ], "type": "object", "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" } } }, "ScoreboardMarketResponse": { "required": [ "market", "latest_timestamp", "comparison_venue", "is_cointegrated", "observations", "readiness", "diagnostic" ], "type": "object", "properties": { "market": { "type": "string" }, "latest_timestamp": { "type": "string", "format": "date-time" }, "hl_share": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "comparison_venue": { "type": "string" }, "comparison_share": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "is_cointegrated": { "type": "boolean" }, "observations": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "readiness": { "type": "string" }, "diagnostic": { "type": "string" } } }, "ScoreboardResponse": { "required": [ "period", "markets" ], "type": "object", "properties": { "period": { "$ref": "#/components/schemas/RwaTimeRangeResponse" }, "markets": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreboardMarketResponse" } } } }, "TimeRange": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "duration": { "pattern": "^-?(\\d+\\.)?\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?$", "type": "string" }, "recommended_table": { "type": [ "null", "string" ] } } }, "UsSpotImpulsePointResponse": { "required": [ "ts", "score", "state", "confidence", "market_count", "positive_market_count", "negative_market_count", "positive_breadth", "negative_breadth", "average_premium_z_score", "persistence_score", "session_weight", "quality_flags" ], "type": "object", "properties": { "ts": { "type": "string", "format": "date-time" }, "score": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "state": { "type": "string" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "market_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "positive_market_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "negative_market_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "positive_breadth": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "negative_breadth": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "average_premium_z_score": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "persistence_score": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "session_weight": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "max_source_lag_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "quality_flags": { "type": "array", "items": { "type": "string" } } } }, "UsSpotImpulseSeriesResponse": { "required": [ "period", "access_tier", "truncated", "result_limit", "data", "caveats" ], "type": "object", "properties": { "period": { "$ref": "#/components/schemas/RwaTimeRangeResponse" }, "access_tier": { "type": "string" }, "truncated": { "type": "boolean" }, "result_limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "latest": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UsSpotImpulsePointResponse" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/UsSpotImpulsePointResponse" } }, "caveats": { "type": "array", "items": { "type": "string" } } } } }, "securitySchemes": { "HendrixApiKey": { "type": "apiKey", "description": "Hendrix Pro API key. Keys and hashes are never included in this contract.", "name": "X-Hendrix-Api-Key", "in": "header" }, "HendrixBearer": { "type": "http", "description": "Bearer form of a Hendrix Pro API key.", "scheme": "bearer", "bearerFormat": "Hendrix API key" } } }, "tags": [ { "name": "Operations" }, { "name": "Public" }, { "name": "HIP-3" }, { "name": "RWA" }, { "name": "HIP-4" }, { "name": "Pro" } ], "x-hendrix-contract-source": "docs/api-spec.md", "x-hendrix-contract-path": "/v1/openapi.json" }