An Extensions help you streaming with real-time data
Project description
Shioaji Realtime Kline Extension
An Extensions help you streaming with real-time data
Table Of Contents
About The Project
When you use Shioaji Python API for technical analysis, you may need real-time data, and in different time dimensions, this package can help you subscribe to tick data and convert it into Kbars type (exactly the same as Shioaji Kbars ), to assist you in converting from Kbars to use more immediate data.
Description
- To use the extension just initialize the object
import shioaji_realtime_kbars
Contracts = shioaji_realtime_kbars.ShioajiRealtimeKbars(api)
- Get the real-time Kbars data with function
shioaji_realtime_kbars.Kbars(
contract: shioaji.contracts.BaseContract,
period: str = '5min'
) -> shioaji.data.Kbars
:information_source: period format can refer to the pandas document.
:warning: If you using this extension, you start with the market is opened and transactions frequently time. The latest Kline will be a little error.
Example : I use this extension in 8:45:10 in future market. The 8:46 Kline will have a little error. Ths data after 8:47 will be correct. So run this extension before the market is opened.
Getting Started
This is an example of how you may give instructions on setting up your project locally.
pip install shioaji_realtime_kbars
Usage
kbars
Refer to the shioaji sample
import pandas as pd
kbars = api.kbars(
contract=api.Contracts.Stocks["2330"],
start="2023-01-15",
end="2023-01-16",
)
df = pd.DataFrame({**kbars})
df.ts = pd.to_datetime(df.ts)
df.tail(5)
Change to
Contracts = shioaji_realtime_kbars.ShioajiRealtimeKbars(api)
Contracts.subscribe(api.Contracts.Futures.MXF.MXFR1)
Contracts.subscribe(api.Contracts.Futures.TXF.TXFR1)
@api.on_tick_stk_v1()
def callback(exchange: Exchange, tick : TickSTKv1):
Contracts.update(tick, "stk")
@api.on_tick_fop_v1()
def callback(exchange : Exchange, tick : TickFOPv1):
Contracts.update(tick, "fop")
while True:
MXFR1_1K = Contracts.kbars(api.Contracts.Futures.MXF.MXFR1, "1min")
df = pd.DataFrame({**MXFR1_1K })
df.ts = pd.to_datetime(df.ts)
print(df.tail(2), end = "\n")
MXFR1_5K = Contracts.kbars(api.Contracts.Futures.MXF.MXFR1, "5min")
df = pd.DataFrame({**MXFR1_5K })
df.ts = pd.to_datetime(df.ts)
print(df.tail(2), end = "\n")
Callback funtion
shioaji_realtime_kbars.ShioajiRealtimeKbars.subscribe?
Signature:
shioaji_realtime_kbars.ShioajiRealtimeKbars.subscribe(
contract: List[Union[shioaji.contracts.Option, shioaji.contracts.Future, shioaji.contracts.Stock, shioaji.contracts.Index]],
last_days: int = 0,
cb: Any = List[[callback_function, period]]
) -> None
Example
If you want to clearly write your strategy. You can refer to example
def strategy(period, kbars):
print(period)
df = pd.DataFrame({**kbars}, columns = ["ts", "Open", "High", "Low", "Close", "Volume", "Amount"])
df.ts = pd.to_datetime(df.ts)
### Write your strategy here ###
print(df.tail(5), end = "\n")
if __name__ == "__main__":
api = sj.Shioaji(simulation = True)
api.login(
api_key=config.API_KEY,
secret_key=config.API_SECRET
)
Contracts = shioaji_realtime_kbars.ShioajiRealtimeKbars(api)
Contracts.subscribe(api.Contracts.Futures.MXF.MXFR1, last_days = 3, cb = [[strategy, "1min"], [strategy, "5min"]])
@api.on_tick_fop_v1()
def callback(exchange : Exchange, tick : TickFOPv1):
Contracts.update(tick, "fop")
Event().wait()
Version
- v1.0.7 (2023/10/11) Add TSE, TFE simtrade filter Fix kbars with no historical problem
- v1.0.6 (2023/7/28) Fis display
- v1.0.5 (2023/7/19) Add callback function
- v1.0.4 (2023/7/17)
- v1.0.3 (2023/6/30) Fix Stock kbars problem issue
- v1.0.1 Fix Naming Problem
- v1.0.0
Roadmap
See the open issues for a list of proposed features (and known issues).
Authors
- You-rui, Lin - ** - You-rui, Lin - Whole project
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for shioaji_realtime_kbars-1.0.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | abe80f747de8ed742061bd1fcd912f366a3e35e3fc8408b57f941b7b93d55627 |
|
MD5 | 0e174ad8c0e166466bc726cb37f1222e |
|
BLAKE2b-256 | 3458ff09c314b598d36d98f03994f75279737e2ffd5bda3fa0a93f6077e89e20 |
Hashes for shioaji_realtime_kbars-1.0.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 06d0a39aeaeb0c53278d7889e32578acacc8fd5486c1699819c1e8364445a91e |
|
MD5 | bfce0dac51f25b27c221e57b2ca777df |
|
BLAKE2b-256 | 3471be1454a91b25417a95cbc8f7c808f139bdff5979d16df4b3f0091bca2f27 |