{ "cells": [ { "cell_type": "markdown", "id": "7be70890", "metadata": {}, "source": [ "# TejToolAPI\n", "\n", "幫助使用者快速取得且整理 TEJ 資料庫所提供的資訊。" ] }, { "cell_type": "code", "execution_count": null, "id": "b7ff5d0c", "metadata": {}, "outputs": [], "source": [ "import os \n", "os.environ['TEJAPI_BASE'] = \"https://api.tej.com.tw\"\n", "os.environ['TEJAPI_KEY'] = \"your key\"\n", "import TejToolAPI\n", "import pandas as pd " ] }, { "cell_type": "markdown", "id": "edcfe6a1", "metadata": {}, "source": [ "\n", "### TejToolAPI.get_history_data\n", "\n", "取的證券相關或交易相關等歷史資料。\n", "\n", "#### Paramters:\n", "* ticker: _iterable[str]_\n", " 欲查詢的資料的證券代碼。\n", "* columns: _iterable[str]_\n", " \n", " 欲查詢資料的欄位名稱，欄位名稱請見 https://api.tej.com.tw/。\n", "* transfer_to_chinese: _boolean_\n", " 是否將欄位轉換為英文。\n", "* start: _pd.Timestamp_ or _str_\n", " 資料起始時間。\n", "* end: _pd.Timestamp_ or _str_\n", " 資料結束時間。\n", "* fin_type = _iterable[str]_\n", " 決定資料型態。\n", " A: 累績資料\n", " F: 單季資料\n", " TTM: 移動四季資料\n", "* include_self_acc: _str_\n", " 投資用財務包含自結和董事會決議數(include_self_acc = 'Y')\n", " 僅投資用財務(include_self_acc = 'N')\n", " \n", "#### Returns:\n", "\n", "pd.DataFrame" ] }, { "cell_type": "code", "execution_count": 2, "id": "4ce03529", "metadata": {}, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "Currently used TEJ API key call quota 803/100000 (0.8%)\n", "Currently used TEJ API key data quota 90316132/10000000 (903.16%)\n" ] }, { "data": { "text/html": [ "
\n", "\n", "\n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", "
股票代碼日期母公司每股盈餘_Q母公司每股盈餘_TTM母公司每股盈餘_A
011012021-07-020.57NaN0.57
111012021-07-050.57NaN0.57
211012021-07-060.57NaN0.57
311012021-07-070.57NaN0.57
411012021-07-080.57NaN0.57
..................
73637112022-06-273.0115.943.01
73737112022-06-283.0115.943.01
73837112022-06-293.0115.943.01
73937112022-06-303.0115.943.01
74037112022-07-013.0115.943.01
\n", "

741 rows × 5 columns

\n", "
" ], "text/plain": [ " 股票代碼 日期 母公司每股盈餘_Q 母公司每股盈餘_TTM 母公司每股盈餘_A\n", "0 1101 2021-07-02 0.57 NaN 0.57\n", "1 1101 2021-07-05 0.57 NaN 0.57\n", "2 1101 2021-07-06 0.57 NaN 0.57\n", "3 1101 2021-07-07 0.57 NaN 0.57\n", "4 1101 2021-07-08 0.57 NaN 0.57\n", ".. ... ... ... ... ...\n", "736 3711 2022-06-27 3.01 15.94 3.01\n", "737 3711 2022-06-28 3.01 15.94 3.01\n", "738 3711 2022-06-29 3.01 15.94 3.01\n", "739 3711 2022-06-30 3.01 15.94 3.01\n", "740 3711 2022-07-01 3.01 15.94 3.01\n", "\n", "[741 rows x 5 columns]" ] }, "execution_count": 2, "metadata": {}, "output_type": "execute_result" } ], "source": [ "ticker = [\"2330\", \"1101\", \"3711\"]\n", "columns = [\"eps\"]\n", "TejToolAPI.get_history_data(\n", " ticker = ticker,\n", " columns = columns,\n", " transfer_to_chinese = True,\n", " start = pd.Timestamp(\"2021-07-02\"),\n", " end = pd.Timestamp(\"2022-07-02\"),\n", " fin_type = [\"A\", \"Q\", \"TTM\"],\n", " include_self_acc = \"Y\"\n", ")" ] } ], "metadata": { "kernelspec": { "display_name": "FactorLib", "language": "python", "name": "factorlib" }, "language_info": { "codemirror_mode": { "name": "ipython", "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", "version": "3.11.5" } }, "nbformat": 4, "nbformat_minor": 5 }