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 TWAP data scoped to a Hyperliquid user address.

Route Metadata

FieldValue
MethodGET
Path/v1/hyperliquid/spot/twap/user/{user}
operationIdgetHyperliquidSpotUserTwap
TagHyperliquid Spot
FamilyHyperliquid Spot
Deprecated or legacyno

Request Parameters

Path Parameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidSpotUserTwap path parameters",
  "type": "object",
  "required": [
    "user"
  ],
  "properties": {
    "user": {
      "description": "Hyperliquid user address.",
      "type": "string",
      "example": "0x0000000000000000000000000000000000000000",
      "x-parameter-location": "path"
    }
  }
}

Query Parameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidSpotUserTwap query parameters",
  "type": "object",
  "properties": {
    "start": {
      "description": "Start timestamp for bounded historical queries.",
      "oneOf": [
        {
          "type": "integer",
          "format": "int64",
          "example": 1704067200000
        },
        {
          "type": "string",
          "format": "date-time",
          "example": "2026-01-01T00:00:00Z"
        }
      ],
      "x-parameter-location": "query"
    },
    "end": {
      "description": "End timestamp for bounded historical queries.",
      "oneOf": [
        {
          "type": "integer",
          "format": "int64",
          "example": 1704070800000
        },
        {
          "type": "string",
          "format": "date-time",
          "example": "2026-01-01T01:00:00Z"
        }
      ],
      "x-parameter-location": "query"
    },
    "cursor": {
      "description": "Cursor for pagination. Use the value from the previous response metadata.",
      "type": "string",
      "x-parameter-location": "query"
    },
    "limit": {
      "description": "Maximum number of records to return.",
      "type": "integer",
      "default": 100,
      "maximum": 10000,
      "x-parameter-location": "query"
    }
  }
}

Response Contracts

Status 200

Hyperliquid Spot user TWAP data

application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidSpotUserTwap response 200",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "description": "Hyperliquid Spot TWAP record. Fields may expand as TWAP coverage fills in for a pair.",
        "type": "object",
        "additionalProperties": true
      }
    },
    "meta": {
      "description": "Response metadata",
      "type": "object",
      "properties": {
        "count": {
          "description": "Number of records returned",
          "type": "integer"
        },
        "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
        },
        "request_id": {
          "description": "Unique request ID for support",
          "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": "getHyperliquidSpotUserTwap 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": "getHyperliquidSpotUserTwap 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 404

Resource not found

application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidSpotUserTwap response 404",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}
OpenAPI example
{
  "code": 404,
  "error": "Resource not found"
}

Status 429

Rate limit exceeded

application/json

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