Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.0xarchive.io/llms.txt

Use this file to discover all available pages before exploring further.

Source OpenAPI: 0xArchive API 1.5.0; 116 paths; 90 component schemas. Get per-minute order flow aggregation for a HIP-4 outcome side. Shows order placement and cancellation rates over time. Requires Pro tier or higher.

​
Route Metadata

FieldValue
MethodGET
Path/v1/hyperliquid/hip4/orders/{symbol}/flow
operationIdgetHip4OrderFlow
TagHIP-4 Outcomes - Orders
FamilyHIP-4
Deprecated or legacyno

​
Request Parameters

​
Path Parameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip4OrderFlow path parameters",
  "type": "object",
  "required": [
    "symbol"
  ],
  "properties": {
    "symbol": {
      "description": "HIP-4 coin id (e.g., `0` for outcome 0 Yes side, `1` for No side). The `#`-prefixed form (`#0`, `#1`) is also accepted.",
      "type": "string",
      "example": "0",
      "x-parameter-location": "path"
    }
  }
}

​
Query Parameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip4OrderFlow query parameters",
  "type": "object",
  "properties": {
    "start": {
      "description": "Start timestamp (ISO 8601 format, e.g., 2026-05-02T00:00:00Z)",
      "type": "string",
      "format": "date-time",
      "x-parameter-location": "query"
    },
    "end": {
      "description": "End timestamp (ISO 8601 format, e.g., 2026-05-03T00:00:00Z)",
      "type": "string",
      "format": "date-time",
      "x-parameter-location": "query"
    },
    "cursor": {
      "description": "Cursor for pagination (use the value from previous response's `next_cursor`)",
      "type": "string",
      "x-parameter-location": "query"
    },
    "limit": {
      "description": "Maximum number of results (default: 1000, max: 10000)",
      "type": "integer",
      "default": 1000,
      "maximum": 10000,
      "x-parameter-location": "query"
    },
    "granularity": {
      "description": "Aggregation granularity",
      "type": "string",
      "enum": [
        "1m",
        "5m",
        "15m",
        "1h"
      ],
      "x-parameter-location": "query"
    }
  }
}

​
Response Contracts

​
Status 200

Order flow aggregation data

​
application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip4OrderFlow response 200",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "count": {
          "type": "integer"
        },
        "next_cursor": {
          "type": "string"
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    },
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}

​
Status 400

Invalid request

​
application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip4OrderFlow response 400",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}
OpenAPI example
{
  "code": 400,
  "error": "Invalid request parameters"
}

​
Status 401

Authentication required

​
application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip4OrderFlow response 401",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}
OpenAPI example
{
  "code": 401,
  "error": "Missing or invalid API key. Provide X-API-Key header."
}

​
Status 429

Rate limit exceeded

​
application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip4OrderFlow response 429",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}
OpenAPI example
{
  "code": 429,
  "error": "Rate limit exceeded"
}
Last modified on May 18, 2026