Get HIP-3 open interest history JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3OpenInterest path parameters",
  "type": "object",
  "required": [
    "symbol"
  ],
  "properties": {
    "symbol": {
      "description": "Trading pair symbol (e.g., km:US500, xyz:XYZ100). HIP-3 symbols are case-sensitive.",
      "type": "string",
      "example": "xyz:XYZ100",
      "x-parameter-location": "path"
    }
  }
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3OpenInterest query parameters",
  "type": "object",
  "properties": {
    "start": {
      "description": "Start timestamp in Unix milliseconds. Defaults to 24h ago.",
      "type": "integer",
      "format": "int64",
      "x-parameter-location": "query"
    },
    "end": {
      "description": "End timestamp in Unix milliseconds. Defaults to now.",
      "type": "integer",
      "format": "int64",
      "x-parameter-location": "query"
    },
    "cursor": {
      "description": "Cursor for pagination",
      "type": "integer",
      "format": "int64",
      "x-parameter-location": "query"
    },
    "limit": {
      "description": "Maximum number of results (default: 100, max: 1000)",
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "x-parameter-location": "query"
    },
    "interval": {
      "description": "Aggregation interval. When omitted, returns raw ~10 sec updates.",
      "type": "string",
      "enum": [
        "5m",
        "15m",
        "30m",
        "1h",
        "4h",
        "1d"
      ],
      "x-parameter-location": "query"
    }
  }
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3OpenInterest response 200",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "description": "Open interest snapshot with market context",
        "type": "object",
        "required": [
          "coin",
          "open_interest",
          "symbol",
          "timestamp"
        ],
        "properties": {
          "coin": {
            "description": "Trading pair symbol (deprecated, use symbol instead)",
            "type": "string",
            "deprecated": true,
            "example": "BTC"
          },
          "day_ntl_volume": {
            "description": "24-hour notional volume",
            "type": "string",
            "nullable": true,
            "example": "10000000.00"
          },
          "impact_ask_price": {
            "description": "Impact ask price for liquidations",
            "type": "string",
            "nullable": true
          },
          "impact_bid_price": {
            "description": "Impact bid price for liquidations",
            "type": "string",
            "nullable": true
          },
          "mark_price": {
            "description": "Mark price used for liquidations",
            "type": "string",
            "nullable": true,
            "example": "42500.50"
          },
          "mid_price": {
            "description": "Current mid price",
            "type": "string",
            "nullable": true,
            "example": "42500.75"
          },
          "open_interest": {
            "description": "Total open interest in contracts",
            "type": "string",
            "example": "500000.00"
          },
          "oracle_price": {
            "description": "Oracle price from external feed",
            "type": "string",
            "nullable": true,
            "example": "42498.25"
          },
          "prev_day_price": {
            "description": "Price 24 hours ago",
            "type": "string",
            "nullable": true,
            "example": "42000.00"
          },
          "symbol": {
            "description": "Trading pair symbol",
            "type": "string",
            "example": "BTC"
          },
          "timestamp": {
            "description": "Snapshot timestamp (UTC)",
            "type": "string",
            "format": "date-time",
            "example": "2025-01-21T10:30:00.000Z"
          }
        }
      }
    },
    "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
    }
  }
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3OpenInterest 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"
    }
  }
}

{
  "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"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3OpenInterest 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"
    }
  }
}

{
  "code": 401,
  "error": "Missing or invalid API key. Provide X-API-Key header."
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3OpenInterest 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"
    }
  }
}

{
  "code": 429,
  "error": "Rate limit exceeded"
}