Route Metadata
| Field | Value |
|---|---|
| Method | GET |
| Path | /v1/hyperliquid/hip3/oracle/discovery-bounds/{symbol} |
| operationId | getHip3OracleDiscoveryBounds |
| Tag | HIP-3 Builder Perps - Oracle |
| Family | HIP-3 |
| Deprecated or legacy | no |
Request Parameters
Path Parameters
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getHip3OracleDiscoveryBounds path parameters",
"type": "object",
"required": [
"symbol"
],
"properties": {
"symbol": {
"description": "HIP-3 symbol with builder prefix. Case-sensitive.",
"type": "string",
"example": "km:US500",
"x-parameter-location": "path"
}
}
}
Response Contracts
Status 200
HIP-3 oracle discovery boundsapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getHip3OracleDiscoveryBounds response 200",
"description": "API response containing HIP-3 oracle discovery bounds.",
"type": "object",
"properties": {
"data": {
"description": "Instantaneous HIP-3 discovery bounds derived from the current reference price and max leverage.",
"type": "object",
"required": [
"block_number",
"bound_fraction",
"lower_bound",
"max_leverage",
"reference_price",
"reference_source",
"symbol",
"timestamp",
"upper_bound"
],
"properties": {
"block_number": {
"description": "Source block number.",
"type": "integer",
"format": "int64",
"example": 1038634032
},
"bound_fraction": {
"description": "Fraction applied on each side of reference_price.",
"type": "number",
"example": 0.05
},
"lower_bound": {
"description": "Instantaneous lower discovery bound.",
"type": "number",
"example": 714.628
},
"max_leverage": {
"description": "Market max leverage used for the bound fraction.",
"type": "integer",
"example": 20
},
"reference_price": {
"description": "External price when available, otherwise mark price.",
"type": "number",
"example": 752.24
},
"reference_source": {
"description": "Price source used for the bounds.",
"type": "string",
"enum": [
"external",
"mark"
],
"example": "external"
},
"symbol": {
"description": "HIP-3 symbol.",
"type": "string",
"example": "km:US500"
},
"timestamp": {
"description": "Source timestamp in Unix milliseconds.",
"type": "integer",
"format": "int64",
"example": 1781678086894
},
"upper_bound": {
"description": "Instantaneous upper discovery bound.",
"type": "number",
"example": 789.852
}
}
},
"meta": {
"description": "Response metadata",
"type": "object",
"properties": {
"count": {
"description": "Number of records returned",
"type": "integer"
},
"coverage_from": {
"description": "Earliest coverage for the requested symbol and data type. Present only when the requested window ends before coverage begins.",
"type": "string",
"format": "date-time"
},
"next_cursor": {
"description": "Cursor for pagination (timestamp). Use this value as the `cursor` parameter to fetch the next page of results.",
"type": "string",
"nullable": true
},
"notice": {
"description": "Human-readable advisory about the response. Currently used when the requested window ends before coverage begins for the symbol; may carry other advisories in future.",
"type": "string"
},
"request_id": {
"description": "Unique request ID for support",
"type": "string",
"format": "uuid"
}
}
},
"success": {
"type": "boolean",
"example": true
}
}
}
Status 400
Invalid requestapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getHip3OracleDiscoveryBounds response 400",
"description": "Error response",
"type": "object",
"properties": {
"code": {
"description": "HTTP status code",
"type": "integer"
},
"error": {
"description": "Error message",
"type": "string"
},
"error_code": {
"description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
"type": "string"
},
"request_id": {
"description": "Unique request ID for support",
"type": "string",
"format": "uuid"
}
}
}
OpenAPI example
{
"code": 400,
"error": "Failed to deserialize query string: limit: invalid digit found in string",
"error_code": "invalid_query_params",
"request_id": "3f2a9c71-5b0e-4d68-9a4c-7e1d2b6f8a05"
}
Status 401
Authentication requiredapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getHip3OracleDiscoveryBounds response 401",
"description": "Error response",
"type": "object",
"properties": {
"code": {
"description": "HTTP status code",
"type": "integer"
},
"error": {
"description": "Error message",
"type": "string"
},
"error_code": {
"description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
"type": "string"
},
"request_id": {
"description": "Unique request ID for support",
"type": "string",
"format": "uuid"
}
}
}
OpenAPI example
{
"code": 401,
"error": "Missing or invalid API key. Provide X-API-Key header."
}
Status 429
Rate limit exceededapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getHip3OracleDiscoveryBounds response 429",
"description": "Error response",
"type": "object",
"properties": {
"code": {
"description": "HTTP status code",
"type": "integer"
},
"error": {
"description": "Error message",
"type": "string"
},
"error_code": {
"description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
"type": "string"
},
"request_id": {
"description": "Unique request ID for support",
"type": "string",
"format": "uuid"
}
}
}
OpenAPI example
{
"code": 429,
"error": "Rate limit exceeded"
}