跳轉到主要內容
TQX 提供港股與美股的行情、參考、財務與市場因子資料。港股代碼使用 .HK 後綴，例如 0700.HK。美股代碼格式視乎介面而定：部分 Qube 方法使用 .NB 後綴，例如 AAPL.NB；本機套件文件則使用 AAPL。

安裝 tqx_data

你可以從 PyPI 下載 tqx-data 套件：
API Key 版本的 tqx-data 需要 Python 3.10 或以上。請以已安裝套件內附的 tqx_data.md 為準，確認實際依賴限制。
本機數據套件使用具備數據存取權限的 API Key。它與 Qube 研究客戶端及交易 API 分開。請聯絡 Audrey（audrey@tqx.ai）申請數據存取權限。

使用 API Key 初始化

呼叫數據方法前，先傳入 API Key 與網關根地址：
也可以設定 TQX_API_KEY 與 TQX_API_BASE_URL，再呼叫 tqx_data.init()。明確傳入的 api_key 優先於環境變數。請勿把 Key 寫進原始碼或程式碼倉庫。

透過編程助手使用 tqx-data

把以下提示詞複製給你的編程助手：
助手只會在尚未保存 Key 時向你索取 API Key，並且不會在輸出中重複它。

Qube 與 PyPI 套件的差異

本文件中的方法以 Qube 內建的 tqx_data 為準。本機 API Key 套件有以下差異：
  • 標示為僅限 Qube 的頁面與方法不在本機套件中：分鐘線、即時分鐘線、 最新 Tick 快照、指標計算、因子與指數成分股。
  • 本機套件文件列出的方法包括： get_hk_daily、get_us_daily、get_stock_detail、 get_trading_calendar、get_currency、get_event_devidend、 get_event_capital_market、get_event_corporate_actions、 get_event_fina_disclosure、get_event_investor_relation_activities、 get_company_concentration、get_company_top_concentration、 get_company_investor、get_company_insider_transaction、 get_company_shareholder_report、get_company_price_vol、 get_company_oper_metrics、get_company_current、get_company_imed、 get_consensus_nonperiod、get_consensus_recommend 及 get_financial_statement。
  • 本機套件也文件化 TickStreamClient，用於接收即時 Tick 推送。 方法名稱、參數與欄位以套件內的 tqx_data.md 白名單為準。
  • 源碼中可能存在未寫入 tqx_data.md 的 reader；這些 reader 不屬於已支援的使用者介面。

在回測中使用數據

  • 日線數據未做除權除息調整，alt_close 與 close 相同。如需復權或總回報序列，請自行套用 get_event_devidend 回傳的事件。
  • 標示為僅提供最新數據的資料沒有歷史版本。請勿在回測中把它當作歷史訊號，否則會把未來資訊帶入較早的日期。
  • 事件只能從其公告日期起使用。