{ "cells": [ { "cell_type": "markdown", "id": "7be70890", "metadata": {}, "source": [ "# TejToolAPI\n", "\n", "幫助使用者快速取得且整理 TEJ 資料庫所提供的資訊。" ] }, { "cell_type": "code", "execution_count": 2, "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 \n", "import numpy as np" ] }, { "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": 5, "id": "4ce03529", "metadata": {}, "outputs": [ { "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", "
股票代碼日期母公司每股盈餘_A母公司每股盈餘_Q母公司每股盈餘_TTM
023302021-08-13NaNNaNNaN
123302021-08-16NaNNaNNaN
223302021-08-17NaNNaNNaN
323302021-08-18NaNNaNNaN
423302021-08-19NaNNaNNaN
..................
4537112021-12-027.663.299.83
4537112021-09-287.663.299.83
4537112022-04-2614.847.189.83
4537112021-07-2214.847.189.83
4537112022-07-013.013.0115.68
\n", "

735 rows × 5 columns

\n", "
" ], "text/plain": [ " 股票代碼 日期 母公司每股盈餘_A 母公司每股盈餘_Q 母公司每股盈餘_TTM\n", "0 2330 2021-08-13 NaN NaN NaN\n", "1 2330 2021-08-16 NaN NaN NaN\n", "2 2330 2021-08-17 NaN NaN NaN\n", "3 2330 2021-08-18 NaN NaN NaN\n", "4 2330 2021-08-19 NaN NaN NaN\n", ".. ... ... ... ... ...\n", "45 3711 2021-12-02 7.66 3.29 9.83\n", "45 3711 2021-09-28 7.66 3.29 9.83\n", "45 3711 2022-04-26 14.84 7.18 9.83\n", "45 3711 2021-07-22 14.84 7.18 9.83\n", "45 3711 2022-07-01 3.01 3.01 15.68\n", "\n", "[735 rows x 5 columns]" ] }, "execution_count": 5, "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", ")" ] }, { "cell_type": "code", "execution_count": null, "id": "0ff831ab", "metadata": {}, "outputs": [], "source": [] } ], "metadata": { "kernelspec": { "display_name": "Python [conda env:zipline-tej] *", "language": "python", "name": "conda-env-zipline-tej-py" }, "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.8.13" } }, "nbformat": 4, "nbformat_minor": 5 }