Source OpenAPI: 0xArchive API 1.5.0; 116 paths; 90 component schemas. Use the JSON Schema block below for field-level types, required fields, nested objects, and enum values.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.
Required Fields
No required fields are declared on this component schema.JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "ApiResponseOrderBookArray",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"description": "L2 order book snapshot",
"type": "object",
"required": [
"asks",
"bids",
"coin",
"symbol",
"timestamp"
],
"properties": {
"asks": {
"description": "Ask price levels (best ask first)",
"type": "array",
"items": {
"description": "Single price level in the order book",
"type": "object",
"required": [
"n",
"px",
"sz"
],
"properties": {
"n": {
"description": "Number of orders at this level",
"type": "integer",
"example": 15
},
"px": {
"description": "Price",
"type": "string",
"example": "42150.00"
},
"sz": {
"description": "Total size at this price level",
"type": "string",
"example": "1.5"
}
}
}
},
"bids": {
"description": "Bid price levels (best bid first)",
"type": "array",
"items": {
"description": "Single price level in the order book",
"type": "object",
"required": [
"n",
"px",
"sz"
],
"properties": {
"n": {
"description": "Number of orders at this level",
"type": "integer",
"example": 15
},
"px": {
"description": "Price",
"type": "string",
"example": "42150.00"
},
"sz": {
"description": "Total size at this price level",
"type": "string",
"example": "1.5"
}
}
}
},
"coin": {
"description": "Trading pair symbol (deprecated, use symbol instead)",
"type": "string",
"deprecated": true,
"example": "BTC"
},
"mid_price": {
"description": "Mid price (best bid + best ask) / 2",
"type": "string",
"example": "42150.50"
},
"spread": {
"description": "Spread in absolute terms (best ask - best bid)",
"type": "string",
"example": "1.00"
},
"spread_bps": {
"description": "Spread in basis points",
"type": "string",
"example": "2.37"
},
"symbol": {
"description": "Trading pair symbol",
"type": "string",
"example": "BTC"
},
"timestamp": {
"description": "Snapshot timestamp (UTC)",
"type": "string",
"format": "date-time",
"example": "2025-01-21T10:30:45.123Z"
}
}
}
},
"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
}
}
}