{ "openapi": "3.0.1", "info": { "title": "Default module", "description": "", "version": "1.0.0" }, "tags": [ { "name": "Base" }, { "name": "Stock" }, { "name": "Forex" }, { "name": "Indices" }, { "name": "Crypto" } ], "paths": { "/symbol/list": { "get": { "summary": "Product List", "deprecated": false, "description": "", "tags": [ "Base" ], "parameters": [ { "name": "type", "in": "query", "description": "Product Categories: stock, forex, indices, crypto", "required": true, "example": "stock", "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "Regions: Stocks include (HK, SZ, SH, US, SG), Forex (gb), Indices (gb), Digital currencies (ba)", "required": true, "example": "hk", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "", "required": false, "example": "700", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "description": "Response Data", "type": "object", "properties": { "c": { "type": "string", "description": "Product Code" }, "t": { "type": "string", "description": "Product Category" }, "e": { "type": "string", "description": "Exchange" }, "n": { "type": "string", "description": "Product Name" } }, "required": [ "c", "t", "e", "n" ] } }, "required": [ "code", "msg", "data" ] }, "example": { "code": 200, "status": "ok", "data": [ { "c": "700", "n": "TENCENT HOLDINGS LIMITED", "t": "stock", "e": "HKEX" } ] } } }, "headers": {} } }, "security": [] } }, "/symbol/info": { "get": { "summary": "Product Information", "deprecated": false, "description": "", "tags": [ "Base" ], "parameters": [ { "name": "type", "in": "query", "description": "Product Category", "required": true, "example": "stock", "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "Belongs to Region HK, SZ, SH, US", "required": true, "example": "hk", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "", "required": false, "example": "700", "schema": { "type": "string" } }, { "name": "exchange", "in": "query", "description": "", "required": false, "example": "HKEX", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "description": "Response Data", "type": "object", "properties": { "c": { "type": "string", "description": "Product Code" }, "t": { "type": "string", "description": "Product Category" }, "e": { "type": "string", "description": "Exchange" }, "n": { "type": "string", "description": "Product Name" } }, "required": [ "c", "t", "e", "n" ] } }, "required": [ "code", "msg", "data" ] }, "example": { "code": 200, "status": "ok", "data": [ { "c": "700", "n": "TENCENT HOLDINGS LIMITED", "t": "stock", "e": "HKEX" } ] } } }, "headers": {} } }, "security": [] } }, "/symbol/holidays": { "get": { "summary": "Market Holidays", "deprecated": false, "description": "", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response code, 0: success" }, "msg": { "type": "string", "description": "Exception information, exists when not 0" }, "data": { "type": "array", "items": { "type": "object", "properties": { "c": { "type": "string", "description": "Market code" }, "r": { "type": "string", "description": "Market country name" }, "tz": { "type": "integer", "description": "Market time zone" }, "et": { "type": "string", "description": "Intraday trading hours" }, "v": { "type": "string", "description": "Holiday dates within the year" }, "ey": { "type": "string", "description": "Year" } } }, "description": "Response data" } }, "required": [ "code", "data" ] }, "example": { "code": 200, "status": "ok", "data": [ { "c": "AU", "r": "Australia", "v": "[\"2025-01-01\", \"2025-01-27\", \"2025-04-18\", \"2025-04-21\", \"2025-04-25\", \"2025-06-09\", \"2025-12-25\", \"2025-12-26\"]", "et": "09:30 - 16:00", "ey": "2025", "vr": null, "tz": 10 } ] } } }, "headers": {} } }, "security": [] } }, "/stock/base": { "get": { "summary": "Product Query", "deprecated": false, "description": "", "tags": [ "Stock" ], "parameters": [ { "name": "region", "in": "query", "description": "Market", "required": true, "example": "HK", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Code", "required": true, "example": "700", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "$ref": "#/components/schemas/Base", "description": "Response Data" } }, "required": [ "code", "msg", "data" ] }, "example": { "code": 0, "msg": null, "data": { "s": "839.HK", "nc": "Zhongjiao Holdings", "ne": "CHINA EDU GROUP", "nh": "Zhongjiao Holdings", "e": "SEHK", "c": "HKD", "l": 1000, "t": 2713791221, "cs": 2713791221, "hs": 2713791221, "ep": 0.5555219630532146, "ept": 0.5984943570767414, "bps": 6.618762900073513, "dy": 0.3387696962454725, "b": "HKEquity" } } } }, "headers": {} } }, "security": [] } }, "/stock/tick": { "get": { "summary": "Real-time Transaction", "deprecated": false, "description": "", "tags": [ "Stock" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "HK", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Product Code", "required": true, "example": "700", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "description": "Response Data", "$ref": "#/components/schemas/Tick" } }, "required": [ "code", "msg", "data" ] }, "example": { "code": 0, "msg": null, "data": { "s": "BA_BTC_USDT", "ld": 67600, "t": 1729087440311, "v": 0.02989, "tu": 2020.564, "ts": 0 } } } }, "headers": {} } }, "security": [] } }, "/stock/depth": { "get": { "summary": "Real-time Order Book", "deprecated": false, "description": "", "tags": [ "Stock" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "HK", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Product Code", "required": true, "example": "700", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "description": "Response Data", "$ref": "#/components/schemas/Depth" } }, "required": [ "code", "msg", "data" ] }, "example": { "code": 0, "msg": null, "data": { "s": "BA_BTC_USDT", "a": [ { "po": 1, "p": 67800, "v": 0.36339, "o": 0.36339 }, { "po": 2, "p": 67800.04, "v": 0.00037, "o": 0.00037 }, { "po": 3, "p": 67800.28, "v": 0.00018, "o": 0.00018 }, { "po": 4, "p": 67800.51, "v": 0.00019, "o": 0.00019 }, { "po": 5, "p": 67800.52, "v": 0.0001, "o": 0.0001 } ], "b": [ { "po": 1, "p": 67799.99, "v": 2.49817, "o": 2.49817 }, { "po": 2, "p": 67799.98, "v": 0.06575, "o": 0.06575 }, { "po": 3, "p": 67799.96, "v": 0.09079, "o": 0.09079 }, { "po": 4, "p": 67799.95, "v": 0.1001, "o": 0.1001 }, { "po": 5, "p": 67799.05, "v": 0.0001, "o": 0.0001 } ] } } } }, "headers": {} } }, "security": [] } }, "/stock/kline": { "get": { "summary": "Candlestick Query", "deprecated": false, "description": "", "tags": [ "Stock" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "HK", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Product Code", "required": true, "example": "700", "schema": { "type": "string" } }, { "name": "kType", "in": "query", "description": "Cycle 1 minute, 2 five minutes, 3 ten minutes, 4 thirty minutes, 5 one hour, 6 two hours, 7 four hours, 8 one day, 9 one week, 10 one month", "required": true, "example": "1", "schema": { "type": "string" } }, { "name": "et", "in": "query", "description": "Query deadline", "required": false, "example": "1741239240000", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Query number", "required": false, "example": "100", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Kline" }, "description": "Response Data" } }, "required": [ "code", "msg", "data" ] }, "example": { "code": 0, "msg": null, "data": [ { "tu": 7, "c": 1.568, "t": 1729090560000, "v": 4, "h": 1.568, "l": 1.568, "o": 1.568 } ] } } }, "headers": {} } }, "security": [] } }, "/stock/quote": { "get": { "summary": "Real-time Quotation", "deprecated": false, "description": "", "tags": [ "Stock" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "HK", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Product Code", "required": true, "example": "700", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "description": "Response Data", "$ref": "#/components/schemas/Tick" } }, "required": [ "code", "msg", "data" ] }, "example": { "code": 0, "msg": null, "data": { "s": "BA_BTC_USDT", "ld": 67600, "t": 1729087440311, "v": 0.02989, "tu": 2020.564, "ts": 0 } } } }, "headers": {} } }, "security": [] } }, "/stock/klines": { "get": { "summary": "Batch Candlestick Query", "deprecated": false, "description": "", "tags": [ "Stock" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "HK", "schema": { "type": "string" } }, { "name": "codes", "in": "query", "description": "Product Code", "required": true, "example": "700,9988", "schema": { "type": "string" } }, { "name": "kType", "in": "query", "description": "Cycle 1 minute, 2 five minutes, 3 ten minutes, 4 thirty minutes, 5 one hour, 6 two hours, 7 four hours, 8 one day, 9 one week, 10 one month", "required": true, "example": "1", "schema": { "type": "string" } }, { "name": "et", "in": "query", "description": "Query deadline", "required": false, "example": "1741239240000", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Query number", "required": false, "example": "100", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code 0: Success" }, "msg": { "type": "string", "description": "Exception Information exists when not equal to 0" }, "data": { "type": "object", "properties": { "code": { "type": "array", "items": { "$ref": "#/components/schemas/Kline" } } }, "description": "Response Data", "required": [ "code" ] } }, "required": [ "code", "data", "msg" ], "description": "Return Result" }, "example": { "code": 0, "msg": null, "data": [ { "tu": 7, "c": 1.568, "t": 1729090560000, "v": 4, "h": 1.568, "l": 1.568, "o": 1.568 } ] } } }, "headers": {} } }, "security": [] } }, "/stock/ticks": { "get": { "summary": "Batch Real-time Transactions", "deprecated": false, "description": "", "tags": [ "Stock" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "HK", "schema": { "type": "string" } }, { "name": "codes", "in": "query", "description": "Product Code", "required": true, "example": "700,9988", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "type": "object", "properties": { "s": { "type": "string", "description": "Symbol Code" }, "ld": { "type": "integer", "description": "Latest Price" }, "t": { "type": "integer", "description": "Timestamp of the Latest Transaction" }, "v": { "type": "number", "description": "Transaction Volume" }, "tu": { "type": "number", "description": "Transaction Amount" }, "ts": { "type": "integer", "description": "Trading Status of the Asset" } }, "required": [ "s", "ld", "t", "v", "tu", "ts" ], "description": "Response Data" } }, "required": [ "code", "msg", "data" ], "description": "Return Result" }, "example": { "code": 0, "msg": null, "data": { "s": "BTCUSDT", "ld": 67600, "t": 1729087440311, "v": 0.02989, "tu": 2020.564, "ts": 0 } } } }, "headers": {} } }, "security": [] } }, "/stock/quotes": { "get": { "summary": "Batch Real-time Quotation", "deprecated": false, "description": "", "tags": [ "Stock" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "HK", "schema": { "type": "string" } }, { "name": "codes", "in": "query", "description": "Product Code", "required": true, "example": "700,9988", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "type": "object", "properties": { "s": { "type": "string", "description": "Symbol Code" }, "ld": { "type": "integer", "description": "Latest Price" }, "t": { "type": "integer", "description": "Timestamp of the Latest Transaction" }, "v": { "type": "number", "description": "Transaction Volume" }, "tu": { "type": "number", "description": "Transaction Amount" }, "ts": { "type": "integer", "description": "Trading Status of the Asset" } }, "required": [ "s", "ld", "t", "v", "tu", "ts" ], "description": "Response Data" } }, "required": [ "code", "msg", "data" ], "description": "Return Result" }, "example": { "code": 0, "msg": null, "data": { "s": "BTCUSDT", "ld": 67600, "t": 1729087440311, "v": 0.02989, "tu": 2020.564, "ts": 0 } } } }, "headers": {} } }, "security": [] } }, "/stock/depths": { "get": { "summary": "Batch Real-time Order Book", "deprecated": false, "description": "", "tags": [ "Stock" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "HK", "schema": { "type": "string" } }, { "name": "codes", "in": "query", "description": "Product Code", "required": true, "example": "700,9988", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "description": "Response Data", "$ref": "#/components/schemas/Depth" } }, "required": [ "code", "msg", "data" ] }, "example": { "code": 0, "msg": null, "data": { "s": "BA_BTC_USDT", "a": [ { "po": 1, "p": 67800, "v": 0.36339, "o": 0.36339 }, { "po": 2, "p": 67800.04, "v": 0.00037, "o": 0.00037 }, { "po": 3, "p": 67800.28, "v": 0.00018, "o": 0.00018 }, { "po": 4, "p": 67800.51, "v": 0.00019, "o": 0.00019 }, { "po": 5, "p": 67800.52, "v": 0.0001, "o": 0.0001 } ], "b": [ { "po": 1, "p": 67799.99, "v": 2.49817, "o": 2.49817 }, { "po": 2, "p": 67799.98, "v": 0.06575, "o": 0.06575 }, { "po": 3, "p": 67799.96, "v": 0.09079, "o": 0.09079 }, { "po": 4, "p": 67799.95, "v": 0.1001, "o": 0.1001 }, { "po": 5, "p": 67799.05, "v": 0.0001, "o": 0.0001 } ] } } } }, "headers": {} } }, "security": [] } }, "/forex/base": { "get": { "summary": "Product Query", "deprecated": false, "description": "", "tags": [ "Forex" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "gb", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Product Code", "required": true, "example": "EURUSD", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "title": "Response Code", "description": "0: Success" }, "msg": { "type": "string", "title": "Exception Information", "description": "Exists when not equal to 0" }, "data": { "type": "object", "properties": { "s": { "type": "string", "title": "Product Code" }, "nc": { "type": "string", "title": "Simplified Chinese Underlying Name" }, "ne": { "type": "string", "title": "English Underlying Name" }, "nh": { "type": "string", "title": "Traditional Chinese Underlying Name" }, "e": { "type": "string", "title": "Exchange of the Underlying Asset" }, "c": { "type": "string", "title": "Trading Currency", "description": "CNY:USD；SGD:HKD" }, "l": { "type": "integer", "title": "Shares per Lot" }, "t": { "type": "integer", "title": "Total Share Capital" }, "cs": { "type": "integer", "title": "Circulating Share Capital" }, "hs": { "type": "integer", "title": "Hong Kong Stock Capital (Only Hong Kong Stocks)" }, "ep": { "type": "number", "title": "Earnings Per Share" }, "ept": { "type": "number", "title": "Earnings Per Share (TTM)" }, "bps": { "type": "number", "title": "Net Asset Value Per Share" }, "dy": { "type": "number", "title": "Dividends" }, "b": { "type": "string", "title": "Sector of the Underlying Asset" }, "sd": { "type": "string", "title": "If the underlying asset is an underlying stock, the types of derivative market data available", "description": "1 - Options; 2 - Warrants" } }, "required": [ "s", "nc", "ne", "nh", "e", "c", "l", "t", "cs", "hs", "ep", "ept", "bps", "dy", "b", "sd" ], "title": "Response Data" } }, "required": [ "code", "msg", "data" ] }, "example": { "code": 0, "msg": null, "data": { "s": "839.HK", "nc": "Zhongjiao Holdings", "ne": "CHINA EDU GROUP", "nh": "Zhongjiao Holdings", "e": "SEHK", "c": "HKD", "l": 1000, "t": 2713791221, "cs": 2713791221, "hs": 2713791221, "ep": 0.5555219630532146, "ept": 0.5984943570767414, "bps": 6.618762900073513, "dy": 0.3387696962454725, "b": "HKEquity" } } } }, "headers": {} } }, "security": [] } }, "/forex/tick": { "get": { "summary": "Real-time Transaction", "deprecated": false, "description": "", "tags": [ "Forex" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "gb", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Product Code", "required": true, "example": "EURUSD", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "description": "Response Data", "$ref": "#/components/schemas/Tick" } }, "required": [ "code", "msg", "data" ] }, "example": { "code": 0, "msg": null, "data": { "s": "BA_BTC_USDT", "ld": 67600, "t": 1729087440311, "v": 0.02989, "tu": 2020.564, "ts": 0 } } } }, "headers": {} } }, "security": [] } }, "/forex/depth": { "get": { "summary": "Real-time Order Book", "deprecated": false, "description": "", "tags": [ "Forex" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "gb", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Product Code", "required": true, "example": "EURUSD", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "title": "Response Code", "description": "0: Success" }, "msg": { "type": "string", "title": "Exception Information", "description": "Exists when not equal to 0" }, "data": { "type": "object", "properties": { "s": { "type": "string", "title": "Underlying Code" }, "a": { "type": "array", "items": { "type": "object", "properties": { "po": { "type": "integer", "title": "Level" }, "p": { "type": "integer", "title": "Price" }, "v": { "type": "number", "title": "Order Volume" }, "o": { "type": "number", "title": "Order Quantity" } }, "required": [ "po", "p", "v", "o" ] }, "title": "Sell Side" }, "b": { "type": "array", "items": { "type": "object", "properties": { "po": { "type": "integer", "title": "Level" }, "p": { "type": "number", "title": "Price" }, "v": { "type": "number", "title": "Order Volume" }, "o": { "type": "number", "title": "Order Quantity" } }, "required": [ "po", "p", "v", "o" ] }, "title": "Buy Side" } }, "required": [ "s", "a", "b" ], "title": "Response Data" } }, "required": [ "code", "msg", "data" ] }, "example": { "code": 0, "msg": null, "data": { "s": "BA_BTC_USDT", "a": [ { "po": 1, "p": 67800, "v": 0.36339, "o": 0.36339 }, { "po": 2, "p": 67800.04, "v": 0.00037, "o": 0.00037 }, { "po": 3, "p": 67800.28, "v": 0.00018, "o": 0.00018 }, { "po": 4, "p": 67800.51, "v": 0.00019, "o": 0.00019 }, { "po": 5, "p": 67800.52, "v": 0.0001, "o": 0.0001 } ], "b": [ { "po": 1, "p": 67799.99, "v": 2.49817, "o": 2.49817 }, { "po": 2, "p": 67799.98, "v": 0.06575, "o": 0.06575 }, { "po": 3, "p": 67799.96, "v": 0.09079, "o": 0.09079 }, { "po": 4, "p": 67799.95, "v": 0.1001, "o": 0.1001 }, { "po": 5, "p": 67799.05, "v": 0.0001, "o": 0.0001 } ] } } } }, "headers": {} } }, "security": [] } }, "/forex/kline": { "get": { "summary": "Candlestick Query", "deprecated": false, "description": "", "tags": [ "Forex" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "gb", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Product Code", "required": true, "example": "EURUSD", "schema": { "type": "string" } }, { "name": "kType", "in": "query", "description": "Cycle 1 minute, 2 five minutes, 3 ten minutes, 4 thirty minutes, 5 one hour, 6 two hours, 7 four hours, 8 one day, 9 one week, 10 one month", "required": true, "example": "1", "schema": { "type": "string" } }, { "name": "et", "in": "query", "description": "Query deadline", "required": false, "example": "1741239240000", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Query number", "required": false, "example": "100", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "title": "Response Code", "description": "0: Success" }, "msg": { "type": "string", "title": "Exception Information", "description": "Exists when not equal to 0" }, "data": { "type": "array", "items": { "type": "object", "properties": { "tu": { "type": "number", "description": "Transaction Amount" }, "c": { "type": "number", "description": "Closing Price of the Candlestick" }, "t": { "type": "integer", "description": "Timestamp" }, "v": { "type": "integer", "description": "Transaction Volume" }, "h": { "type": "number", "description": "Highest Price of the Candlestick" }, "l": { "type": "number", "description": "Lowest Price of the Candlestick" }, "o": { "type": "number", "description": "Opening Price of the Candlestick" } } }, "title": "Response Data" } }, "required": [ "code", "msg", "data" ] }, "example": { "code": 0, "msg": null, "data": [ { "tu": 7, "c": 1.568, "t": 1729090560000, "v": 4, "h": 1.568, "l": 1.568, "o": 1.568 } ] } } }, "headers": {} } }, "security": [] } }, "/forex/quote": { "get": { "summary": "Real-time Quotation", "deprecated": false, "description": "", "tags": [ "Forex" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "gb", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Product Code", "required": true, "example": "EURUSD", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "description": "Response Data", "$ref": "#/components/schemas/Tick" } }, "required": [ "code", "msg", "data" ] }, "example": { "code": 0, "msg": null, "data": { "s": "BA_BTC_USDT", "ld": 67600, "t": 1729087440311, "v": 0.02989, "tu": 2020.564, "ts": 0 } } } }, "headers": {} } }, "security": [] } }, "/forex/klines": { "get": { "summary": "Batch Candlestick Query", "deprecated": false, "description": "", "tags": [ "Forex" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "gb", "schema": { "type": "string" } }, { "name": "codes", "in": "query", "description": "Product Code", "required": true, "example": "EURUSD,GBPUSD", "schema": { "type": "string" } }, { "name": "kType", "in": "query", "description": "Cycle 1 minute, 2 five minutes, 3 ten minutes, 4 thirty minutes, 5 one hour, 6 two hours, 7 four hours, 8 one day, 9 one week, 10 one month", "required": true, "example": "1", "schema": { "type": "string" } }, { "name": "et", "in": "query", "description": "Query deadline", "required": false, "example": "1741239240000", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Query number", "required": false, "example": "100", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code 0: Success" }, "msg": { "type": "string", "description": "Exception Information exists when not equal to 0" }, "data": { "type": "object", "properties": { "code": { "type": "array", "items": { "$ref": "#/components/schemas/Kline" } } }, "description": "Response Data", "required": [ "code" ] } }, "required": [ "code", "data", "msg" ], "description": "Return Result" }, "example": { "code": 0, "msg": null, "data": [ { "tu": 7, "c": 1.568, "t": 1729090560000, "v": 4, "h": 1.568, "l": 1.568, "o": 1.568 } ] } } }, "headers": {} } }, "security": [] } }, "/forex/ticks": { "get": { "summary": "Batch Real-time Transactions", "deprecated": false, "description": "", "tags": [ "Forex" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "gb", "schema": { "type": "string" } }, { "name": "codes", "in": "query", "description": "Product Code", "required": true, "example": "EURUSD,GBPUSD", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "type": "object", "properties": { "s": { "type": "string", "description": "Symbol Code" }, "ld": { "type": "integer", "description": "Latest Price" }, "t": { "type": "integer", "description": "Timestamp of the Latest Transaction" }, "v": { "type": "number", "description": "Transaction Volume" }, "tu": { "type": "number", "description": "Transaction Amount" }, "ts": { "type": "integer", "description": "Trading Status of the Asset" } }, "required": [ "s", "ld", "t", "v", "tu", "ts" ], "description": "Response Data" } }, "required": [ "code", "msg", "data" ], "description": "Return Result" }, "example": { "code": 0, "msg": null, "data": { "s": "BTCUSDT", "ld": 67600, "t": 1729087440311, "v": 0.02989, "tu": 2020.564, "ts": 0 } } } }, "headers": {} } }, "security": [] } }, "/forex/quotes": { "get": { "summary": "Batch Real-time Quotation", "deprecated": false, "description": "", "tags": [ "Forex" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "gb", "schema": { "type": "string" } }, { "name": "codes", "in": "query", "description": "Product Code", "required": true, "example": "EURUSD,GBPUSD", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "type": "object", "properties": { "s": { "type": "string", "description": "Symbol Code" }, "ld": { "type": "integer", "description": "Latest Price" }, "t": { "type": "integer", "description": "Timestamp of the Latest Transaction" }, "v": { "type": "number", "description": "Transaction Volume" }, "tu": { "type": "number", "description": "Transaction Amount" }, "ts": { "type": "integer", "description": "Trading Status of the Asset" } }, "required": [ "s", "ld", "t", "v", "tu", "ts" ], "description": "Response Data" } }, "required": [ "code", "msg", "data" ], "description": "Return Result" }, "example": { "code": 0, "msg": null, "data": { "s": "BTCUSDT", "ld": 67600, "t": 1729087440311, "v": 0.02989, "tu": 2020.564, "ts": 0 } } } }, "headers": {} } }, "security": [] } }, "/forex/depths": { "get": { "summary": "Batch Real-time Order Book", "deprecated": false, "description": "", "tags": [ "Forex" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "gb", "schema": { "type": "string" } }, { "name": "codes", "in": "query", "description": "Product Code", "required": true, "example": "EURUSD,GBPUSD", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "description": "Response Data", "$ref": "#/components/schemas/Depth" } }, "required": [ "code", "msg", "data" ] }, "example": { "code": 0, "msg": null, "data": { "s": "BA_BTC_USDT", "a": [ { "po": 1, "p": 67800, "v": 0.36339, "o": 0.36339 }, { "po": 2, "p": 67800.04, "v": 0.00037, "o": 0.00037 }, { "po": 3, "p": 67800.28, "v": 0.00018, "o": 0.00018 }, { "po": 4, "p": 67800.51, "v": 0.00019, "o": 0.00019 }, { "po": 5, "p": 67800.52, "v": 0.0001, "o": 0.0001 } ], "b": [ { "po": 1, "p": 67799.99, "v": 2.49817, "o": 2.49817 }, { "po": 2, "p": 67799.98, "v": 0.06575, "o": 0.06575 }, { "po": 3, "p": 67799.96, "v": 0.09079, "o": 0.09079 }, { "po": 4, "p": 67799.95, "v": 0.1001, "o": 0.1001 }, { "po": 5, "p": 67799.05, "v": 0.0001, "o": 0.0001 } ] } } } }, "headers": {} } }, "security": [] } }, "/indices/base": { "get": { "summary": "Product Query", "deprecated": false, "description": "", "tags": [ "Indices" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "gb", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Product Code", "required": true, "example": "SPX", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "title": "Response Code", "description": "0: Success" }, "msg": { "type": "string", "title": "Exception Information", "description": "Exists when not equal to 0" }, "data": { "type": "object", "properties": { "s": { "type": "string", "title": "Product Code" }, "nc": { "type": "string", "title": "Simplified Chinese Underlying Name" }, "ne": { "type": "string", "title": "English Underlying Name" }, "nh": { "type": "string", "title": "Traditional Chinese Underlying Name" }, "e": { "type": "string", "title": "Exchange of the Underlying Asset" }, "c": { "type": "string", "title": "Trading Currency", "description": "CNY:USD；SGD:HKD" }, "l": { "type": "integer", "title": "Shares per Lot" }, "t": { "type": "integer", "title": "Total Share Capital" }, "cs": { "type": "integer", "title": "Circulating Share Capital" }, "hs": { "type": "integer", "title": "Hong Kong Stock Capital (Only Hong Kong Stocks)" }, "ep": { "type": "number", "title": "Earnings Per Share" }, "ept": { "type": "number", "title": "Earnings Per Share (TTM)" }, "bps": { "type": "number", "title": "Net Asset Value Per Share" }, "dy": { "type": "number", "title": "Dividends" }, "b": { "type": "string", "title": "Sector of the Underlying Asset" }, "sd": { "type": "string", "title": "If the underlying asset is an underlying stock, the types of derivative market data available", "description": "1 - Options; 2 - Warrants" } }, "required": [ "s", "nc", "ne", "nh", "e", "c", "l", "t", "cs", "hs", "ep", "ept", "bps", "dy", "b", "sd" ], "title": "Response Data" } }, "required": [ "code", "msg", "data" ] }, "example": { "code": 0, "msg": null, "data": { "s": "839.HK", "nc": "Zhongjiao Holdings", "ne": "CHINA EDU GROUP", "nh": "Zhongjiao Holdings", "e": "SEHK", "c": "HKD", "l": 1000, "t": 2713791221, "cs": 2713791221, "hs": 2713791221, "ep": 0.5555219630532146, "ept": 0.5984943570767414, "bps": 6.618762900073513, "dy": 0.3387696962454725, "b": "HKEquity" } } } }, "headers": {} } }, "security": [] } }, "/indices/tick": { "get": { "summary": "Real-time Transaction", "deprecated": false, "description": "", "tags": [ "Indices" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "gb", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Product Code", "required": true, "example": "SPX", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "description": "Response Data", "$ref": "#/components/schemas/Tick" } }, "required": [ "code", "msg", "data" ] }, "example": { "code": 0, "msg": null, "data": { "s": "BA_BTC_USDT", "ld": 67600, "t": 1729087440311, "v": 0.02989, "tu": 2020.564, "ts": 0 } } } }, "headers": {} } }, "security": [] } }, "/indices/depth": { "get": { "summary": "Real-time Order Book", "deprecated": false, "description": "", "tags": [ "Indices" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": false, "example": "gb", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Product Code", "required": false, "example": "SPX", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "title": "Response Code", "description": "0: Success" }, "msg": { "type": "string", "title": "Exception Information", "description": "Exists when not equal to 0" }, "data": { "type": "object", "properties": { "s": { "type": "string", "title": "Underlying Code" }, "a": { "type": "array", "items": { "type": "object", "properties": { "po": { "type": "integer", "title": "Level" }, "p": { "type": "integer", "title": "Price" }, "v": { "type": "number", "title": "Order Volume" }, "o": { "type": "number", "title": "Order Quantity" } }, "required": [ "po", "p", "v", "o" ] }, "title": "Sell Side" }, "b": { "type": "array", "items": { "type": "object", "properties": { "po": { "type": "integer", "title": "Level" }, "p": { "type": "number", "title": "Price" }, "v": { "type": "number", "title": "Order Volume" }, "o": { "type": "number", "title": "Order Quantity" } }, "required": [ "po", "p", "v", "o" ] }, "title": "Buy Side" } }, "required": [ "s", "a", "b" ], "title": "Response Data" } }, "required": [ "code", "msg", "data" ] }, "example": { "code": 0, "msg": null, "data": { "s": "BA_BTC_USDT", "a": [ { "po": 1, "p": 67800, "v": 0.36339, "o": 0.36339 }, { "po": 2, "p": 67800.04, "v": 0.00037, "o": 0.00037 }, { "po": 3, "p": 67800.28, "v": 0.00018, "o": 0.00018 }, { "po": 4, "p": 67800.51, "v": 0.00019, "o": 0.00019 }, { "po": 5, "p": 67800.52, "v": 0.0001, "o": 0.0001 } ], "b": [ { "po": 1, "p": 67799.99, "v": 2.49817, "o": 2.49817 }, { "po": 2, "p": 67799.98, "v": 0.06575, "o": 0.06575 }, { "po": 3, "p": 67799.96, "v": 0.09079, "o": 0.09079 }, { "po": 4, "p": 67799.95, "v": 0.1001, "o": 0.1001 }, { "po": 5, "p": 67799.05, "v": 0.0001, "o": 0.0001 } ] } } } }, "headers": {} } }, "security": [] } }, "/indices/kline": { "get": { "summary": "Candlestick Query", "deprecated": false, "description": "", "tags": [ "Indices" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "gb", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Product Code", "required": true, "example": "SPX", "schema": { "type": "string" } }, { "name": "kType", "in": "query", "description": "Cycle 1 minute, 2 five minutes, 3 ten minutes, 4 thirty minutes, 5 one hour, 6 two hours, 7 four hours, 8 one day, 9 one week, 10 one month", "required": true, "example": "1", "schema": { "type": "string" } }, { "name": "et", "in": "query", "description": "Query deadline", "required": false, "example": "1741239240000", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Query number", "required": false, "example": "100", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "title": "Response Code", "description": "0: Success" }, "msg": { "type": "string", "title": "Exception Information", "description": "Exists when not equal to 0" }, "data": { "type": "array", "items": { "type": "object", "properties": { "tu": { "type": "number", "description": "Transaction Amount" }, "c": { "type": "number", "description": "Closing Price of the Candlestick" }, "t": { "type": "integer", "description": "Timestamp" }, "v": { "type": "integer", "description": "Transaction Volume" }, "h": { "type": "number", "description": "Highest Price of the Candlestick" }, "l": { "type": "number", "description": "Lowest Price of the Candlestick" }, "o": { "type": "number", "description": "Opening Price of the Candlestick" } } }, "title": "Response Data" } }, "required": [ "code", "msg", "data" ] }, "example": { "code": 0, "msg": null, "data": [ { "tu": 7, "c": 1.568, "t": 1729090560000, "v": 4, "h": 1.568, "l": 1.568, "o": 1.568 } ] } } }, "headers": {} } }, "security": [] } }, "/indices/quote": { "get": { "summary": "Real-time Quotation", "deprecated": false, "description": "", "tags": [ "Indices" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "gb", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Product Code", "required": true, "example": "SPX", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "description": "Response Data", "$ref": "#/components/schemas/Tick" } }, "required": [ "code", "msg", "data" ] }, "example": { "code": 0, "msg": null, "data": { "s": "BA_BTC_USDT", "ld": 67600, "t": 1729087440311, "v": 0.02989, "tu": 2020.564, "ts": 0 } } } }, "headers": {} } }, "security": [] } }, "/indices/ticks": { "get": { "summary": "Batch Real-time Transactions", "deprecated": false, "description": "", "tags": [ "Indices" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "gb", "schema": { "type": "string" } }, { "name": "codes", "in": "query", "description": "Product Code", "required": true, "example": "SPX,DJI", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "type": "object", "properties": { "s": { "type": "string", "description": "Symbol Code" }, "ld": { "type": "integer", "description": "Latest Price" }, "t": { "type": "integer", "description": "Timestamp of the Latest Transaction" }, "v": { "type": "number", "description": "Transaction Volume" }, "tu": { "type": "number", "description": "Transaction Amount" }, "ts": { "type": "integer", "description": "Trading Status of the Asset" } }, "required": [ "s", "ld", "t", "v", "tu", "ts" ], "description": "Response Data" } }, "required": [ "code", "msg", "data" ], "description": "Return Result" }, "example": { "code": 0, "msg": null, "data": { "s": "BTCUSDT", "ld": 67600, "t": 1729087440311, "v": 0.02989, "tu": 2020.564, "ts": 0 } } } }, "headers": {} } }, "security": [] } }, "/indices/quotes": { "get": { "summary": "Batch Real-time Quotation", "deprecated": false, "description": "", "tags": [ "Indices" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "gb", "schema": { "type": "string" } }, { "name": "codes", "in": "query", "description": "Product Code", "required": true, "example": "SPX,DJI", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "type": "object", "properties": { "s": { "type": "string", "description": "Symbol Code" }, "ld": { "type": "integer", "description": "Latest Price" }, "t": { "type": "integer", "description": "Timestamp of the Latest Transaction" }, "v": { "type": "number", "description": "Transaction Volume" }, "tu": { "type": "number", "description": "Transaction Amount" }, "ts": { "type": "integer", "description": "Trading Status of the Asset" } }, "required": [ "s", "ld", "t", "v", "tu", "ts" ], "description": "Response Data" } }, "required": [ "code", "msg", "data" ], "description": "Return Result" }, "example": { "code": 0, "msg": null, "data": { "s": "BTCUSDT", "ld": 67600, "t": 1729087440311, "v": 0.02989, "tu": 2020.564, "ts": 0 } } } }, "headers": {} } }, "security": [] } }, "/indices/depths": { "get": { "summary": "Batch Real-time Order Book", "deprecated": false, "description": "", "tags": [ "Indices" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "gb", "schema": { "type": "string" } }, { "name": "codes", "in": "query", "description": "Product Code", "required": true, "example": "SPX,DJI", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "description": "Response Data", "$ref": "#/components/schemas/Depth" } }, "required": [ "code", "msg", "data" ] }, "example": { "code": 0, "msg": null, "data": { "s": "BA_BTC_USDT", "a": [ { "po": 1, "p": 67800, "v": 0.36339, "o": 0.36339 }, { "po": 2, "p": 67800.04, "v": 0.00037, "o": 0.00037 }, { "po": 3, "p": 67800.28, "v": 0.00018, "o": 0.00018 }, { "po": 4, "p": 67800.51, "v": 0.00019, "o": 0.00019 }, { "po": 5, "p": 67800.52, "v": 0.0001, "o": 0.0001 } ], "b": [ { "po": 1, "p": 67799.99, "v": 2.49817, "o": 2.49817 }, { "po": 2, "p": 67799.98, "v": 0.06575, "o": 0.06575 }, { "po": 3, "p": 67799.96, "v": 0.09079, "o": 0.09079 }, { "po": 4, "p": 67799.95, "v": 0.1001, "o": 0.1001 }, { "po": 5, "p": 67799.05, "v": 0.0001, "o": 0.0001 } ] } } } }, "headers": {} } }, "security": [] } }, "/crypto/base": { "get": { "summary": "Product Query", "deprecated": false, "description": "", "tags": [ "Crypto" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "ba", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Product Code", "required": true, "example": "BTCUSDT", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "type": "object", "properties": { "s": { "type": "string", "description": "Product Code" }, "nc": { "type": "string", "description": "Simplified Chinese Underlying Name" }, "ne": { "type": "string", "description": "English Underlying Name" }, "nh": { "type": "string", "description": "Traditional Chinese Underlying Name" }, "e": { "type": "string", "description": "Exchange of the Underlying Asset" }, "c": { "type": "string", "description": "Trading Currency, CNY:USD; SGD:HKD" }, "l": { "type": "integer", "description": "Shares per Lot" }, "t": { "type": "integer", "description": "Total Share Capital" }, "cs": { "type": "integer", "description": "Circulating Share Capital" }, "hs": { "type": "integer", "description": "Hong Kong Stock Capital (Only Hong Kong Stocks)" }, "ep": { "type": "number", "description": "Earnings Per Share" }, "ept": { "type": "number", "description": "Earnings Per Share (TTM)" }, "bps": { "type": "number", "description": "Net Asset Value Per Share" }, "dy": { "type": "number", "description": "Dividends" }, "b": { "type": "string", "description": "Sector of the Underlying Asset" }, "sd": { "type": "string", "description": "If the underlying asset is a stock, the available types of derivative market data are: 1 - Options; 2 - Warrants" } }, "required": [ "s", "nc", "ne", "nh", "e", "c", "l", "t", "cs", "hs", "ep", "ept", "bps", "dy", "b", "sd" ], "description": "Response Data" } }, "required": [ "code", "msg", "data" ], "description": "Return Result" }, "example": { "code": 0, "msg": null, "data": { "s": "839.HK", "nc": "Zhongjiao Holdings", "ne": "CHINA EDU GROUP", "nh": "Zhongjiao Holdings", "e": "SEHK", "c": "HKD", "l": 1000, "t": 2713791221, "cs": 2713791221, "hs": 2713791221, "ep": 0.5555219630532146, "ept": 0.5984943570767414, "bps": 6.618762900073513, "dy": 0.3387696962454725, "b": "HKEquity" } } } }, "headers": {} } }, "security": [] } }, "/crypto/tick": { "get": { "summary": "Real-time Transaction", "deprecated": false, "description": "", "tags": [ "Crypto" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "ba", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Product Code", "required": true, "example": "BTCUSDT", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "type": "object", "properties": { "s": { "type": "string", "description": "Symbol Code" }, "ld": { "type": "integer", "description": "Latest Price" }, "t": { "type": "integer", "description": "Timestamp of the Latest Transaction" }, "v": { "type": "number", "description": "Transaction Volume" }, "tu": { "type": "number", "description": "Transaction Amount" }, "ts": { "type": "integer", "description": "Trading Status of the Asset" } }, "required": [ "s", "ld", "t", "v", "tu", "ts" ], "description": "Response Data" } }, "required": [ "code", "msg", "data" ], "description": "Return Result" }, "example": { "code": 0, "msg": null, "data": { "s": "BA_BTC_USDT", "ld": 67600, "t": 1729087440311, "v": 0.02989, "tu": 2020.564, "ts": 0 } } } }, "headers": {} } }, "security": [] } }, "/crypto/depth": { "get": { "summary": "Real-time Order Book", "deprecated": false, "description": "", "tags": [ "Crypto" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "ba", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Product Code", "required": true, "example": "BTCUSDT", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "description": "Response Data", "$ref": "#/components/schemas/Depth" } }, "required": [ "code", "msg", "data" ] }, "example": { "code": 0, "msg": null, "data": { "s": "BTCUSDT", "a": [ { "po": 1, "p": 67800, "v": 0.36339, "o": 0.36339 }, { "po": 2, "p": 67800.04, "v": 0.00037, "o": 0.00037 }, { "po": 3, "p": 67800.28, "v": 0.00018, "o": 0.00018 }, { "po": 4, "p": 67800.51, "v": 0.00019, "o": 0.00019 }, { "po": 5, "p": 67800.52, "v": 0.0001, "o": 0.0001 } ], "b": [ { "po": 1, "p": 67799.99, "v": 2.49817, "o": 2.49817 }, { "po": 2, "p": 67799.98, "v": 0.06575, "o": 0.06575 }, { "po": 3, "p": 67799.96, "v": 0.09079, "o": 0.09079 }, { "po": 4, "p": 67799.95, "v": 0.1001, "o": 0.1001 }, { "po": 5, "p": 67799.05, "v": 0.0001, "o": 0.0001 } ] } } } }, "headers": {} } }, "security": [] } }, "/crypto/kline": { "get": { "summary": "Candlestick Query", "deprecated": false, "description": "", "tags": [ "Crypto" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "ba", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Product Code", "required": true, "example": "BTCUSDT", "schema": { "type": "string" } }, { "name": "kType", "in": "query", "description": "Cycle 1 minute, 2 five minutes, 3 ten minutes, 4 thirty minutes, 5 one hour, 6 two hours, 7 four hours, 8 one day, 9 one week, 10 one month", "required": true, "example": "1", "schema": { "type": "string" } }, { "name": "et", "in": "query", "description": "Query deadline", "required": false, "example": "1741239240000", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Query number", "required": false, "example": "100", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code 0: Success" }, "msg": { "type": "string", "description": "Exception Information exists when not equal to 0" }, "data": { "type": "array", "items": { "type": "object", "properties": { "tu": { "type": "number", "description": "Transaction Amount" }, "c": { "type": "number", "description": "Closing Price of the Candlestick" }, "t": { "type": "integer", "description": "Timestamp" }, "v": { "type": "integer", "description": "Transaction Volume" }, "h": { "type": "number", "description": "Highest Price of the Candlestick" }, "l": { "type": "number", "description": "Lowest Price of the Candlestick" }, "o": { "type": "number", "description": "Opening Price of the Candlestick" } } }, "description": "Response Data" } }, "required": [ "code", "msg", "data" ], "description": "Return Result" }, "example": { "code": 0, "msg": null, "data": [ { "tu": 7, "c": 1.568, "t": 1729090560000, "v": 4, "h": 1.568, "l": 1.568, "o": 1.568 } ] } } }, "headers": {} } }, "security": [] } }, "/crypto/quote": { "get": { "summary": "Real-time Quotation", "deprecated": false, "description": "", "tags": [ "Crypto" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "ba", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Product Code", "required": true, "example": "BTCUSDT", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "type": "object", "properties": { "s": { "type": "string", "description": "Symbol Code" }, "ld": { "type": "integer", "description": "Latest Price" }, "t": { "type": "integer", "description": "Timestamp of the Latest Transaction" }, "v": { "type": "number", "description": "Transaction Volume" }, "tu": { "type": "number", "description": "Transaction Amount" }, "ts": { "type": "integer", "description": "Trading Status of the Asset" } }, "required": [ "s", "ld", "t", "v", "tu", "ts" ], "description": "Response Data" } }, "required": [ "code", "msg", "data" ], "description": "Return Result" }, "example": { "code": 0, "msg": null, "data": { "s": "BTCUSDT", "ld": 67600, "t": 1729087440311, "v": 0.02989, "tu": 2020.564, "ts": 0 } } } }, "headers": {} } }, "security": [] } }, "/crypto/klines": { "get": { "summary": "Batch Candlestick Query", "deprecated": false, "description": "", "tags": [ "Crypto" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "ba", "schema": { "type": "string" } }, { "name": "codes", "in": "query", "description": "Product Code", "required": true, "example": "BTCUSDT,ETHUSDT", "schema": { "type": "string" } }, { "name": "kType", "in": "query", "description": "Cycle 1 minute, 2 five minutes, 3 ten minutes, 4 thirty minutes, 5 one hour, 6 two hours, 7 four hours, 8 one day, 9 one week, 10 one month", "required": true, "example": "1", "schema": { "type": "string" } }, { "name": "et", "in": "query", "description": "Query deadline", "required": false, "example": "1741239240000", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Query number", "required": false, "example": "100", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code 0: Success" }, "msg": { "type": "string", "description": "Exception Information exists when not equal to 0" }, "data": { "type": "object", "properties": { "code": { "type": "array", "items": { "$ref": "#/components/schemas/Kline" } } }, "description": "Response Data", "required": [ "code" ] } }, "required": [ "code", "data", "msg" ], "description": "Return Result" }, "example": { "code": 0, "msg": null, "data": [ { "tu": 7, "c": 1.568, "t": 1729090560000, "v": 4, "h": 1.568, "l": 1.568, "o": 1.568 } ] } } }, "headers": {} } }, "security": [] } }, "/crypto/ticks": { "get": { "summary": "Batch Real-time Transactions", "deprecated": false, "description": "", "tags": [ "Crypto" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "ba", "schema": { "type": "string" } }, { "name": "codes", "in": "query", "description": "Product Code", "required": true, "example": "BTCUSDT,ETHUSDT", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "type": "object", "properties": { "s": { "type": "string", "description": "Symbol Code" }, "ld": { "type": "integer", "description": "Latest Price" }, "t": { "type": "integer", "description": "Timestamp of the Latest Transaction" }, "v": { "type": "number", "description": "Transaction Volume" }, "tu": { "type": "number", "description": "Transaction Amount" }, "ts": { "type": "integer", "description": "Trading Status of the Asset" } }, "required": [ "s", "ld", "t", "v", "tu", "ts" ], "description": "Response Data" } }, "required": [ "code", "msg", "data" ], "description": "Return Result" }, "example": { "code": 0, "msg": null, "data": { "s": "BA_BTC_USDT", "ld": 67600, "t": 1729087440311, "v": 0.02989, "tu": 2020.564, "ts": 0 } } } }, "headers": {} } }, "security": [] } }, "/crypto/quotes": { "get": { "summary": "Batch Real-time Quotation", "deprecated": false, "description": "", "tags": [ "Crypto" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "ba", "schema": { "type": "string" } }, { "name": "codes", "in": "query", "description": "Product Code", "required": true, "example": "BTCUSDT,ETHUSDT", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "type": "object", "properties": { "s": { "type": "string", "description": "Symbol Code" }, "ld": { "type": "integer", "description": "Latest Price" }, "t": { "type": "integer", "description": "Timestamp of the Latest Transaction" }, "v": { "type": "number", "description": "Transaction Volume" }, "tu": { "type": "number", "description": "Transaction Amount" }, "ts": { "type": "integer", "description": "Trading Status of the Asset" } }, "required": [ "s", "ld", "t", "v", "tu", "ts" ], "description": "Response Data" } }, "required": [ "code", "msg", "data" ], "description": "Return Result" }, "example": { "code": 0, "msg": null, "data": { "s": "BA_BTC_USDT", "ld": 67600, "t": 1729087440311, "v": 0.02989, "tu": 2020.564, "ts": 0 } } } }, "headers": {} } }, "security": [] } }, "/crypto/depths": { "get": { "summary": "Batch Real-time Order Book", "deprecated": false, "description": "", "tags": [ "Crypto" ], "parameters": [ { "name": "region", "in": "query", "description": "Market Code", "required": true, "example": "ba", "schema": { "type": "string" } }, { "name": "codes", "in": "query", "description": "Product Code", "required": true, "example": "BTCUSDT", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "Response Code, 0: Success" }, "msg": { "type": "string", "description": "Exception Information, exists when not equal to 0" }, "data": { "description": "Response Data", "$ref": "#/components/schemas/Depth" } }, "required": [ "code", "msg", "data" ] }, "example": { "code": 0, "msg": null, "data": { "s": "BA_BTC_USDT", "a": [ { "po": 1, "p": 67800, "v": 0.36339, "o": 0.36339 }, { "po": 2, "p": 67800.04, "v": 0.00037, "o": 0.00037 }, { "po": 3, "p": 67800.28, "v": 0.00018, "o": 0.00018 }, { "po": 4, "p": 67800.51, "v": 0.00019, "o": 0.00019 }, { "po": 5, "p": 67800.52, "v": 0.0001, "o": 0.0001 } ], "b": [ { "po": 1, "p": 67799.99, "v": 2.49817, "o": 2.49817 }, { "po": 2, "p": 67799.98, "v": 0.06575, "o": 0.06575 }, { "po": 3, "p": 67799.96, "v": 0.09079, "o": 0.09079 }, { "po": 4, "p": 67799.95, "v": 0.1001, "o": 0.1001 }, { "po": 5, "p": 67799.05, "v": 0.0001, "o": 0.0001 } ] } } } }, "headers": {} } }, "security": [] } } }, "components": { "schemas": { "Kline": { "type": "object", "properties": { "tu": { "type": "number", "description": "Transaction Amount" }, "c": { "type": "number", "description": "Closing Price of the Candlestick" }, "t": { "type": "integer", "description": "Timestamp" }, "v": { "type": "integer", "description": "Transaction Volume" }, "h": { "type": "number", "description": "Highest Price of the Candlestick" }, "l": { "type": "number", "description": "Lowest Price of the Candlestick" }, "o": { "type": "number", "description": "Opening Price of the Candlestick" } } }, "Base": { "type": "object", "properties": { "s": { "type": "string", "description": "Product Code" }, "nc": { "type": "string", "description": "Simplified Chinese Underlying Name" }, "ne": { "type": "string", "description": "English Underlying Name" }, "nh": { "type": "string", "description": "Traditional Chinese Underlying Name" }, "e": { "type": "string", "description": "Exchange of the Underlying Asset" }, "c": { "type": "string", "description": "Trading Currency" }, "l": { "type": "integer", "description": "Shares per Lot" }, "t": { "type": "integer", "description": "Total Share Capital" }, "cs": { "type": "integer", "description": "Circulating Share Capital" }, "hs": { "type": "integer", "description": "Hong Kong Stock Capital (Only Hong Kong Stocks)" }, "ep": { "type": "integer", "description": "Earnings Per Share" }, "ept": { "type": "integer", "description": "Earnings Per Share (TTM)" }, "bps": { "type": "integer", "description": "Net Asset Value Per Share" }, "dy": { "type": "integer", "description": "Dividends" }, "b": { "type": "string", "description": "Sector of the Underlying Asset" }, "sd": { "type": "string", "description": "If the underlying asset is a stock, the available types of derivative market data are: 1 - Options; 2 - Warrants" } }, "required": [ "s", "nc", "ne", "nh", "e", "c", "l", "t", "cs", "hs", "ep", "ept", "bps", "dy", "b", "sd" ] }, "Tick": { "type": "object", "properties": { "s": { "type": "string", "description": "Symbol Code" }, "ld": { "type": "integer", "description": "Latest Price" }, "t": { "type": "integer", "description": "Timestamp of the Latest Transaction" }, "v": { "type": "number", "description": "Transaction Volume" }, "tu": { "type": "number", "description": "Transaction Amount" }, "ts": { "type": "integer", "description": "Trading Status of the Asset" } }, "required": [ "s", "ld", "t", "v", "tu", "ts" ], "description": "Tick" }, "Depth": { "type": "object", "properties": { "s": { "type": "string", "description": "Underlying Code" }, "a": { "type": "array", "items": { "type": "object", "properties": { "po": { "type": "integer", "description": "Level" }, "p": { "type": "number", "description": "Price" }, "v": { "type": "number", "description": "Order Volume" }, "o": { "type": "number", "description": "Order Quantity" } }, "required": [ "po", "p", "v", "o" ] }, "description": "Sell Side" }, "b": { "type": "array", "items": { "type": "object", "properties": { "po": { "type": "integer", "description": "Level" }, "p": { "type": "number", "description": "Price" }, "v": { "type": "number", "description": "Order Volume" }, "o": { "type": "number", "description": "Order Quantity" } }, "required": [ "po", "p", "v", "o" ] }, "description": "Buy Side" } }, "required": [ "s", "a", "b" ] } }, "responses": {}, "securitySchemes": {} }, "servers": [ { "url": "https://api.itick.org", "description": "正式环境" } ], "security": [] }