> For the complete documentation index, see [llms.txt](https://doc.itick.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.itick.org/apis/forex.md).

# Forex

## GET /forex/base

> Product Query

```json
{"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Forex"}],"servers":[{"url":"https://api.itick.org","description":"正式环境"}],"security":[],"paths":{"/forex/base":{"get":{"summary":"Product Query","deprecated":false,"description":"","tags":["Forex"],"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","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"]}}},"headers":{}}}}}}}
```

## GET /forex/tick

> Real-time Transaction

```json
{"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Forex"}],"servers":[{"url":"https://api.itick.org","description":"正式环境"}],"security":[],"paths":{"/forex/tick":{"get":{"summary":"Real-time Transaction","deprecated":false,"description":"","tags":["Forex"],"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 /forex/depth

> Real-time Order Book

```json
{"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Forex"}],"servers":[{"url":"https://api.itick.org","description":"正式环境"}],"security":[],"paths":{"/forex/depth":{"get":{"summary":"Real-time Order Book","deprecated":false,"description":"","tags":["Forex"],"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","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"]}}},"headers":{}}}}}}}
```

## GET /forex/kline

> Candlestick Query

```json
{"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Forex"}],"servers":[{"url":"https://api.itick.org","description":"正式环境"}],"security":[],"paths":{"/forex/kline":{"get":{"summary":"Candlestick Query","deprecated":false,"description":"","tags":["Forex"],"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","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"]}}},"headers":{}}}}}}}
```

## GET /forex/quote

> Real-time Quotation

```json
{"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Forex"}],"servers":[{"url":"https://api.itick.org","description":"正式环境"}],"security":[],"paths":{"/forex/quote":{"get":{"summary":"Real-time Quotation","deprecated":false,"description":"","tags":["Forex"],"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 /forex/klines

> Batch Candlestick Query

```json
{"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Forex"}],"servers":[{"url":"https://api.itick.org","description":"正式环境"}],"security":[],"paths":{"/forex/klines":{"get":{"summary":"Batch Candlestick Query","deprecated":false,"description":"","tags":["Forex"],"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 /forex/ticks

> Batch Real-time Transactions

```json
{"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Forex"}],"servers":[{"url":"https://api.itick.org","description":"正式环境"}],"security":[],"paths":{"/forex/ticks":{"get":{"summary":"Batch Real-time Transactions","deprecated":false,"description":"","tags":["Forex"],"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 /forex/quotes

> Batch Real-time Quotation

```json
{"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Forex"}],"servers":[{"url":"https://api.itick.org","description":"正式环境"}],"security":[],"paths":{"/forex/quotes":{"get":{"summary":"Batch Real-time Quotation","deprecated":false,"description":"","tags":["Forex"],"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 /forex/depths

> Batch Real-time Order Book

```json
{"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Forex"}],"servers":[{"url":"https://api.itick.org","description":"正式环境"}],"security":[],"paths":{"/forex/depths":{"get":{"summary":"Batch Real-time Order Book","deprecated":false,"description":"","tags":["Forex"],"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"]}}}}
```