iT邦幫忙

2021 iThome 鐵人賽

DAY 6
0
永豐金融APIs

深入解析 Shioaji API系列 第 6

Day 06 - Snapshots

本篇重點

  • Snapshots 介紹與屬性說明
  • VS Code 查看Function參數內容

Snapshots

官方說明文件:https://sinotrade.github.io/tutor/snapshot/
Snapshots,中文翻譯為「快照」,也就是用來抓取金融商品當下的資訊,這個資訊,就相當於平常看盤時的這個畫面
https://ithelp.ithome.com.tw/upload/images/20210920/20140827hkSH5pWU8g.png
也因為是抓取當下的資訊,所以Snapshots呼叫時無法給定特定的時間點,只須傳入Contract的List,而回傳的資料為shioaji.data.Snapshot物件的List。而Snapshots除了可以拿來抓取個股當下的交易資訊,也可以抓取期貨、選擇權或指數當下的交易資訊,只要把對應的Contract加入List即可。
程式碼範例如下:

contracts = [api.Contracts.Stocks['2330'], api.Contracts.Stocks['2890']]
snapshots = api.snapshots(contracts)

屬性說明:

屬性 說明
code '2330' 股票代碼
exchange 'TSE' 掛牌交易所
high 610.0 最高價
low 599.0 最低價
open 600.0 開盤價
close 600.0 收盤價
volume 57 成交量
amount 34200000 成交金額
average_price 601.91 均價
change_price 0.0 變動價格
change_rate 0.0 變動幅度(單位:%)
change_type <ChangeType.Unchanged: 'Unchanged'> 變動類型
buy_price 600.0 委買價
buy_volume 1107.0 委買量
sell_price 601.0 委賣價
sell_volume 3 委賣量
tick_type <TickType.Sell: 'Sell'> tick類型
total_amount 24508038290 總成交金額
total_volume 40717 總成交量
ts 1631889000000000000 時間戳
volume_ratio 1.81 成交量比率(今日總成交量/昨日總成交量)
yesterday_volume 22539.0 昨日成交量(張數)

VS Code 查看Function參數內容

有時在查看官方說明文件時,會發現文件上沒有特別說明Function的參數內容,這時可以透過VS Code的功能,來查看Function的參數內容。查看方式有下列三種

  1. 在編寫程式碼時,VS Code會自動顯示
    https://ithelp.ithome.com.tw/upload/images/20210920/20140827pUC9qyambn.png
  2. 在VS Code中,將滑鼠指標停留在該Function上方,VS Code就會自動顯示該Funciton的參數內容說明
    https://ithelp.ithome.com.tw/upload/images/20210920/20140827uAw5V52Eyq.png
  3. 跟第二個方式相同,只是在滑鼠指標停得在該Function上方時,按住Ctrl鍵,此時滑鼠指標就會變成手套
    https://ithelp.ithome.com.tw/upload/images/20210920/20140827ZGVYi0OyAU.png
    接著,按下滑鼠左鍵,VS Code就會自動開啟該Function所在的python程式檔案並顯示Function的定義內容
    https://ithelp.ithome.com.tw/upload/images/20210920/20140827nCwPNn0Nda.png
    熟悉上列三種方式,之後若遇到說明文件中沒有提到的Funtion,也能自己透過VS Code去了解該Function有哪些參數及要如何使用。

上一篇
Day 05 - Scanners
下一篇
Day 07 - Ticks
系列文
深入解析 Shioaji API30

尚未有邦友留言

立即登入留言