openapi: 3.1.0
info:
  title: FinMind 台股資料 API
  version: 1.0.0
  description: 使用 FinMind API 查詢台灣股票歷史價格與財經資料。
servers:
  - url: <https://api.finmindtrade.com/api/v4>
paths:
  /data:
    get:
      operationId: getStockData
      summary: 查詢台股歷史股價資料
      description: 根據股票代號與日期範圍查詢台灣股票的歷史價格,例如查詢 2330 台積電的日線股價。
      parameters:
        - name: dataset
          in: query
          required: true
          description: 資料集名稱,例如 TaiwanStockPrice
          schema:
            type: string
        - name: data_id
          in: query
          required: true
          description: 股票代碼,例如 2330
          schema:
            type: string
        - name: start_date
          in: query
          required: true
          description: 查詢起始日期,格式為 YYYY-MM-DD
          schema:
            type: string
        - name: end_date
          in: query
          required: false
          description: 查詢結束日期(可省略表示查詢到今天),格式為 YYYY-MM-DD
          schema:
            type: string
      responses:
        '200':
          description: 查詢結果,回傳包含日期、開盤、收盤、最高、最低、成交量等資料的列表
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        date:
                          type: string
                          format: date
                        open:
                          type: number
                        max:
                          type: number
                        min:
                          type: number
                        close:
                          type: number
                        volume:
                          type: number
                additionalProperties: false