Skip to content

Commit

Permalink
Add region and time format doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
huacnlee authored Mar 19, 2024
1 parent 35d043e commit a00cae3
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 2 deletions.
6 changes: 5 additions & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,13 @@ import TabItem from '@theme/TabItem';
:::info
中国大陆地区访问,建议采用 `openapi.longportapp.cn`, `openapi-quote.longportapp.cn`, `openapi-trade.longportapp.cn` 以提升访问速度。

如果使用我们的 SDK,可以通过设置环境变量 `LONGPORT_REGION=cn` 来使用中国大陆的接入点
如果使用我们的 SDK,可以通过设置环境变量 `LONGPORT_REGION=cn` 来使用中国大陆的接入点,当前我们仅有 `hk``cn` 两个地区可选。
:::

## 时间格式

所有 API 返回有关时间的字段,我们都采用 [Unix Timestamp](https://en.wikipedia.org/wiki/Unix_time) 时区为 UTC。

## 环境需求

<Tabs groupId="programming-language">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,14 @@ LongPort OpenAPI SDK is implemented based on Rust we have released SDK for Pytho

:::tip
For access in mainland China, it is recommended to use `openapi.longportapp.cn`, `openapi-quote.longportapp.cn`, `openapi-trade.longportapp.cn` to improve access speed.

If you are use our SDK, the `LONGPORT_REGION=cn` env variable can to use to setup the API region (Current only support: `cn`, `hk`).
:::

## Time Format

All API response are used [Unix Timestamp](https://en.wikipedia.org/wiki/Unix_time), timezone is UTC.

## Environment Requirements

<Tabs groupId="programming-language">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,13 @@ LongPort OpenAPI SDK 基於 Rust 底層提供標準實現,目前我們已經
:::tip
中國大陸地區訪問,建議採用 `openapi.longportapp.cn`, `openapi-quote.longportapp.cn`, `openapi-trade.longportapp.cn` 以提升訪問速度。

如果您使用我們的 SDK,可以通過設置環境變量 LONGPORT_REGION=cn 來使用位於中國大陸的接入點。
如果您使用我們的 SDK,可以通過設置環境變量 LONGPORT_REGION=cn 來使用位於中國大陸的接入點,目前我們只有 `hk``cn` 兩個地區可選
:::

## 時間格式

所有 API 傳回有關時間的字段,我們都採用 [Unix Timestamp](https://en.wikipedia.org/wiki/Unix_time) 時區為 UTC。

## 環境需求

<Tabs groupId="programming-language">
Expand Down

0 comments on commit a00cae3

Please sign in to comment.