# Stock

## GET /stock/base

> Product Query

```json
{"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Stock"}],"servers":[{"url":"https://api.itick.org","description":"正式环境"}],"security":[],"paths":{"/stock/base":{"get":{"summary":"Product Query","deprecated":false,"description":"","tags":["Stock"],"parameters":[{"name":"region","in":"query","description":"Market","required":true,"schema":{"type":"string"}},{"name":"code","in":"query","description":"Code","required":true,"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"]}}},"headers":{}}}}}},"components":{"schemas":{"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"]}}}}
```

## GET /stock/tick

> Real-time Transaction

```json
{"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Stock"}],"servers":[{"url":"https://api.itick.org","description":"正式环境"}],"security":[],"paths":{"/stock/tick":{"get":{"summary":"Real-time Transaction","deprecated":false,"description":"","tags":["Stock"],"parameters":[{"name":"region","in":"query","description":"Market Code","required":true,"schema":{"type":"string"}},{"name":"code","in":"query","description":"Product Code","required":true,"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"]}}},"headers":{}}}}}},"components":{"schemas":{"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"}}}}
```

## GET /stock/depth

> Real-time Order Book

```json
{"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Stock"}],"servers":[{"url":"https://api.itick.org","description":"正式环境"}],"security":[],"paths":{"/stock/depth":{"get":{"summary":"Real-time Order Book","deprecated":false,"description":"","tags":["Stock"],"parameters":[{"name":"region","in":"query","description":"Market Code","required":true,"schema":{"type":"string"}},{"name":"code","in":"query","description":"Product Code","required":true,"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"]}}},"headers":{}}}}}},"components":{"schemas":{"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"]}}}}
```

## GET /stock/kline

> Candlestick Query

```json
{"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Stock"}],"servers":[{"url":"https://api.itick.org","description":"正式环境"}],"security":[],"paths":{"/stock/kline":{"get":{"summary":"Candlestick Query","deprecated":false,"description":"","tags":["Stock"],"parameters":[{"name":"region","in":"query","description":"Market Code","required":true,"schema":{"type":"string"}},{"name":"code","in":"query","description":"Product Code","required":true,"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,"schema":{"type":"string"}},{"name":"et","in":"query","description":"Query deadline","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Query number","required":false,"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"]}}},"headers":{}}}}}},"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"}}}}}}
```

## GET /stock/quote

> Real-time Quotation

```json
{"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Stock"}],"servers":[{"url":"https://api.itick.org","description":"正式环境"}],"security":[],"paths":{"/stock/quote":{"get":{"summary":"Real-time Quotation","deprecated":false,"description":"","tags":["Stock"],"parameters":[{"name":"region","in":"query","description":"Market Code","required":true,"schema":{"type":"string"}},{"name":"code","in":"query","description":"Product Code","required":true,"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"]}}},"headers":{}}}}}},"components":{"schemas":{"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"}}}}
```

## GET /stock/klines

> Batch Candlestick Query

```json
{"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Stock"}],"servers":[{"url":"https://api.itick.org","description":"正式环境"}],"security":[],"paths":{"/stock/klines":{"get":{"summary":"Batch Candlestick Query","deprecated":false,"description":"","tags":["Stock"],"parameters":[{"name":"region","in":"query","description":"Market Code","required":true,"schema":{"type":"string"}},{"name":"codes","in":"query","description":"Product Code","required":true,"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,"schema":{"type":"string"}},{"name":"et","in":"query","description":"Query deadline","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Query number","required":false,"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"}}},"headers":{}}}}}},"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"}}}}}}
```

## GET /stock/ticks

> Batch Real-time Transactions

```json
{"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Stock"}],"servers":[{"url":"https://api.itick.org","description":"正式环境"}],"security":[],"paths":{"/stock/ticks":{"get":{"summary":"Batch Real-time Transactions","deprecated":false,"description":"","tags":["Stock"],"parameters":[{"name":"region","in":"query","description":"Market Code","required":true,"schema":{"type":"string"}},{"name":"codes","in":"query","description":"Product Code","required":true,"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"}}},"headers":{}}}}}}}
```

## GET /stock/quotes

> Batch Real-time Quotation

```json
{"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Stock"}],"servers":[{"url":"https://api.itick.org","description":"正式环境"}],"security":[],"paths":{"/stock/quotes":{"get":{"summary":"Batch Real-time Quotation","deprecated":false,"description":"","tags":["Stock"],"parameters":[{"name":"region","in":"query","description":"Market Code","required":true,"schema":{"type":"string"}},{"name":"codes","in":"query","description":"Product Code","required":true,"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"}}},"headers":{}}}}}}}
```

## GET /stock/depths

> Batch Real-time Order Book

```json
{"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Stock"}],"servers":[{"url":"https://api.itick.org","description":"正式环境"}],"security":[],"paths":{"/stock/depths":{"get":{"summary":"Batch Real-time Order Book","deprecated":false,"description":"","tags":["Stock"],"parameters":[{"name":"region","in":"query","description":"Market Code","required":true,"schema":{"type":"string"}},{"name":"codes","in":"query","description":"Product Code","required":true,"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"]}}},"headers":{}}}}}},"components":{"schemas":{"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"]}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.itick.org/apis/stock.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
