--- updatedAt: 2026-06-02T20:06:00.000Z agentTools: projectIndex: https://docs.zerohash.com/llms.txt --- # List symbol data Retrieves a list of symbols and their market data. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "zerohash API", "description": "\n### Authentication\n\nzerohash Uses HMAC SHA-256 verification to ensure the authenticity of API requests, follow instructions by link [https://docs.zerohash.com/reference/api-authentication](https://docs.zerohash.com/reference/api-authentication)\n\nDownload zerohash OpenAPI Schema as JSON\n", "version": "1.7.0" }, "servers": [ { "url": "https://api.cert.zerohash.com", "description": "Certification API server" } ], "x-readme": { "proxy-enabled": false }, "tags": [ { "name": "Market Data", "description": "Market Data Services" } ], "paths": { "/market_data/symbol_data": { "get": { "tags": [ "Market Data" ], "summary": "List symbol data", "description": "Retrieves a list of symbols and their market data.", "parameters": [ { "$ref": "#/components/parameters/Signature" }, { "$ref": "#/components/parameters/Timestamp" }, { "name": "underlying", "in": "query", "description": "The underlying asset symbol for the requested market data. For example, `BTC` or `ETH`.", "required": true, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/LiquidityEnabledUnderlyingCurrency" } }, { "name": "quoted_currency", "in": "query", "description": "Quoted currency symbol. For example, `USD` or `EUR`. This is the currency in which the price is quoted.", "required": true, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/LiquidityEnabledQuotedCurrency" } } ], "responses": { "200": { "description": "Market data for the requested underlying/quoted pairs. Structured as an array of `[underlyingSymbol, { marketDataMap: [[quotedSymbol, SymbolData], ...] }]` tuples.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSymbolDataResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Code400" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Code403" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Code404" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Code500" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Code503" } } } } } } } }, "security": [ { "apiKey": [], "apiPassphrase": [] } ], "components": { "securitySchemes": { "apiKey": { "type": "apiKey", "description": "Your API public key. See the [Authentication guide](https://docs.zerohash.com/reference/api-authentication) for how to obtain keys.", "in": "header", "name": "X-SCX-API-KEY" }, "apiPassphrase": { "type": "apiKey", "description": "The passphrase associated with your API key, set when the key was created.", "in": "header", "name": "X-SCX-PASSPHRASE" } }, "parameters": { "Signature": { "name": "X-SCX-SIGNED", "in": "header", "description": "HMAC-SHA256 signature of the request, base64-encoded. See the [Authentication guide](https://docs.zerohash.com/reference/api-authentication) for the exact signing formula.", "required": true, "schema": { "type": "string" } }, "Timestamp": { "name": "X-SCX-TIMESTAMP", "in": "header", "description": "Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.", "required": true, "schema": { "type": "string", "example": "1678901234" } } }, "schemas": { "Code400": { "type": "object", "description": "Request was rejected by validation or a downstream service. `errors` is an array of human-readable messages; each entry describes a single validation failure or business-rule violation.", "required": [ "errors" ], "properties": { "errors": { "type": "array", "items": { "type": "string" }, "example": [ "body/amount must be >= 0", "body/asset is required" ] } } }, "Code403": { "type": "object", "description": "Authentication or authorization failed. `error` is always `true`; `message` explains which check failed (missing API key, bad signature, insufficient permission, etc.).", "required": [ "error", "message" ], "properties": { "error": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "This api key does not have write permission to this endpoint" } } }, "Code404": { "type": "object", "description": "The requested resource does not exist or is not visible to the caller.", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "Not Found" } } }, "Code500": { "type": "object", "description": "An unexpected error occurred on the server. The request can be retried after a short delay, but the same inputs may reproduce the error.", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "Internal Server Error" } } }, "Code503": { "type": "object", "description": "A downstream dependency was unavailable, timed out, or returned a retryable error. Safe to retry; the response carries a `zh-allow-retry: true` header.", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "Service Unavailable" } } }, "LiquidityEnabledUnderlyingCurrency": { "type": "string", "description": "The underlying asset in the trading pair. E.g. `BTC` in the pair `BTC/USD`.", "example": "BTC", "enum": [ "USDC.OPTIMISM", "USDC.SUI", "DOT", "FIL", "PYUSD.ETH", "TRX", "ZRX", "DAI.ETH", "USDC.WORLDCHAIN", "USDP", "USDT.BSC", "USDT.CELO", "PEPE.ETH", "SAND", "USDC.DOTHUB", "USDC.SEI", "USDC.SOL", "USDC.ZKSYNC", "ENA.ETH", "MANA.ETH", "PYTH.SOL", "SOL", "USDC.BASE", "USDC.CELO", "USDT", "ADA", "INJ.ETH", "MATIC.POLYGON", "PAXG", "USD", "AAVE.ETH", "ALGO", "EURC.XLM", "KNC.ETH", "PNUT.SOL", "SHIB", "BCH", "DOGE", "EGLD", "JTO.SOL", "UNI.ETH", "USDC", "USDC.ARBITRUM", "ONDO.ETH", "PENGU.SOL", "USD", "WLFI.ETH", "XLM", "APT", "CC", "ETH.OPTIMISM", "ETH.WORLDCHAIN", "LDO.ETH", "MORPHO.ETH", "SEI", "ETH.ZKSYNC", "USDC.AVAX", "USDC.XLM", "USDT.DOTHUB", "USDT.SOL", "MANA", "USDC.ALGO", "MATIC.ETH", "NEAR", "UNI", "USDT.ARBITRUM", "USDT.AVAX", "OMG", "ARB.ARBITRUM", "COMP.ETH", "GRT.ETH", "USDC.POLYGON", "AVAX", "AAVE", "CELO", "PYUSD.SOL", "PAXG.ETH", "USDC.MONAD", "BAT", "COMP", "ETH.ARBITRUM", "ETH.BASE", "OP.OPTIMISM", "TRUMP.SOL", "ENJ.ETH", "SUI", "USDT.ETH", "USDT.OPTIMISM", "USDT.TRX", "USDT.XPL", "OMG.ETH", "XRP", "HBAR", "USDC.APT", "USDC.ETH", "BNB", "ATOM", "BAT.ETH", "GRT", "LINK.ETH", "USDP.SOL", "ZK.ZKSYNC", "BONK.SOL", "KNC", "TIA", "ZRO.ETH", "ZRX.ETH", "PUMP.SOL", "USD", "XTZ", "CRV.ETH", "GALA.ETH", "TON", "USDT.POLYGON", "WBTC.ETH", "XPL", "BTC", "MON", "SHIB.ETH", "USDC.BSC", "WLD.WORLDCHAIN", "W.SOL", "LTC", "RLUSD.ETH", "WBTC", "LINK", "USDCX.CANTON", "ETH", "WIF.SOL", "APE.ETH", "EURC", "MKR.ETH", "RLUSD.XRP" ] }, "LiquidityEnabledQuotedCurrency": { "type": "string", "description": "The quoted currency in the trading pair. E.g. `USD` in the pair `BTC/USD`.", "example": "USD", "enum": [ "USD", "EUR", "USDC.ETH" ] }, "GetSymbolData": { "type": "object", "properties": { "underlyingSymbol": { "type": "string", "example": "BTC", "description": "Underlying symbol in the pair." }, "quotedSymbol": { "type": "string", "example": "USD", "description": "Quoted symbol in the pair." }, "price": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Most recent symbol price." }, "lastTimestamp": { "description": "Order book last update timestamp. Protobuf Timestamp split into `seconds` and `nanos`.", "type": "object", "properties": { "seconds": { "type": "number", "example": 1684928 }, "nanos": { "type": "number", "example": 819000000 } } }, "median": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Median price." }, "lastVolume": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Most recent trade volume stated in the quoted currency." }, "lastUnderlyingVolume": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Most recent trade volume stated in the underlying." }, "lastTradeId": { "type": "string", "example": "286032218", "description": "Most recent trade ID" }, "dayUnderlyingVolume": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Day volume stated in the underlying." }, "dayQuotedVolume": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Day volume stated in the quoted currency." }, "h24UnderlyingVolume": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Rolling 24h volume stated in the underlying." }, "h24QuotedVolume": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Rolling 24h volume stated in the quoted currency." }, "dayOpen": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Open price for the day." }, "dayHigh": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "High price for the day." }, "dayLow": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Low price for the day." }, "h24Open": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Rolling 24h opening price." }, "h24High": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Rolling 24h high price." }, "h24Low": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Rolling 24h low price." }, "hourUnderlyingVolume": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Hour volume stated in the underlying." }, "hourQuotedVolume": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Hour volume stated in the quoted currency." }, "hourOpen": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Hour opening price." }, "hourHigh": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Hour high price." }, "hourLow": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Hour low price." }, "h24Change": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Rolling 24h price change." }, "h24PctChange": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Rolling 24h percent change." }, "dayChange": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Daily price change." }, "dayPctChange": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Daily percent change." }, "hourChange": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Hour price change." }, "hourPctChange": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Hour percent change." }, "supply": { "type": "number", "example": 19382375, "description": "Total supply for the underlying." }, "mktcap": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Total market capitalization stated in the quoted currency." }, "circulatingSupply": { "type": "number", "example": 19382375, "description": "The current supply of coins available to the public." }, "circulatingSupplyMktcap": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Market cap based on circulating supply, stated in the quoted currency." }, "h24UnderlyingTotalVolume": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Rolling 24h total volume stated in the underlying." }, "h24QuotedTotalVolume": { "allOf": [ { "$ref": "#/components/schemas/DecimalValue" } ], "description": "Rolling 24h total volume stated in the quoted currency." }, "imageUrl": { "type": "string", "example": "//media/37746251/btc.png", "description": "Image URL for the underlying asset." } } }, "GetSymbolDataResponse": { "type": "array", "description": "Array of tuples keyed by underlying symbol. Each tuple is `[underlyingSymbol, { marketDataMap: [[quotedSymbol, GetSymbolData], ...] }]`.", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": [ { "type": "string", "description": "Underlying asset symbol (e.g. `BTC`).", "example": "BTC" }, { "type": "object", "required": [ "marketDataMap" ], "properties": { "marketDataMap": { "type": "array", "description": "Array of `[quotedSymbol, GetSymbolData]` tuples for the given underlying.", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": [ { "type": "string", "description": "Quoted currency symbol (e.g. `USD`).", "example": "USD" }, { "$ref": "#/components/schemas/GetSymbolData" } ] } } } } ] }, "example": [ [ "BTC", { "marketDataMap": [ [ "USD", { "underlyingSymbol": "BTC", "quotedSymbol": "USD", "price": { "value": "63523.1267818274" }, "lastTimestamp": { "seconds": 1780942, "nanos": 100000000 }, "median": { "value": "63523.1267818274" }, "lastVolume": { "value": "0.00000017" }, "lastUnderlyingVolume": { "value": "0.0107958126" }, "lastTradeId": "1204043756", "dayUnderlyingVolume": { "value": "23877.59071385" }, "dayQuotedVolume": { "value": "1513703665.67374" }, "h24UnderlyingVolume": { "value": "33691.54917206" }, "h24QuotedVolume": { "value": "2126242561.78843" }, "dayOpen": { "value": "63315.1065321782" }, "dayHigh": { "value": "64199.9776710545" }, "dayLow": { "value": "62393.1022759814" }, "h24Open": { "value": "62014.926566741" }, "h24High": { "value": "64199.9776710545" }, "h24Low": { "value": "61166.479991137" }, "hourUnderlyingVolume": { "value": "105.6514879" }, "hourQuotedVolume": { "value": "6717810.00305892" }, "hourOpen": { "value": "63534.1678453974" }, "hourHigh": { "value": "63624.8539896268" }, "hourLow": { "value": "63519.9494427626" }, "h24Change": { "value": "1508.200215086399" }, "h24PctChange": { "value": "2.431995486543487" }, "dayChange": { "value": "208.02024964919838" }, "dayPctChange": { "value": "0.3285475789944027" }, "hourChange": { "value": "-11.041063570002734" }, "hourPctChange": { "value": "-0.017378150913804062" }, "supply": 20039087, "mktcap": { "value": "1272945464093.0693" }, "circulatingSupply": 20039087, "circulatingSupplyMktcap": { "value": "1272945464093.0693" }, "h24UnderlyingTotalVolume": { "value": "326752.617229663" }, "h24QuotedTotalVolume": { "value": "20742397942.829296" }, "imageUrl": "//media/37746251/btc.png" } ] ] } ] ] }, "DecimalValue": { "type": "object", "description": "Decimal value represented as a stringified number.", "properties": { "value": { "type": "string", "example": "24774.07" } } } } } } ```