Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yvictor/shioajici

Last synced: 15 days ago
JSON representation

Host: GitHub
URL: https://github.com/yvictor/shioajici
Owner: Yvictor
Created: 2021-10-21T04:43:12.000Z (about 3 years ago)
Default Branch: master
Last Pushed: 2023-01-05T05:43:21.000Z (about 2 years ago)
Last Synced: 2024-12-25T02:28:09.297Z (24 days ago)
Language: Dockerfile
Size: 66.4 KB
Stars: 1
Watchers: 3
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # Shioaji

![shioaji-logo](https://sinotrade.github.io/images/shioaji-logo-01.png)![sinopac-logo](https://www.sinotrade.com.tw/Images/logo.png)

[![PyPI - Status](https://img.shields.io/pypi/v/shioaji.svg?style=for-the-badge)](https://pypi.org/project/shioaji)

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/shioaji.svg?style=for-the-badge)]()

[![PyPI - Downloads](https://img.shields.io/pypi/dm/shioaji.svg?style=for-the-badge)](https://pypi.org/project/shioaji)

[![Build - Status](https://img.shields.io/docker/cloud/build/sinotrade/shioaji?style=for-the-badge)](https://hub.docker.com/r/sinotrade/shioaji/builds)

[![Coverage](https://img.shields.io/badge/coverage%20-99%25-yellowgreen.svg?style=for-the-badge)]()

[![Binder](https://img.shields.io/badge/launch-Tutorial-ff69b4.svg?style=for-the-badge)](https://mybinder.org/v2/gh/Sinotrade/Sinotrade.github.io/master?filepath=tutorial%2Fshioaji_tutorial.ipynb)

[![doc](https://img.shields.io/badge/docs%20-passing-orange.svg?style=for-the-badge)](https://sinotrade.github.io/)

[![Telegram](https://img.shields.io/badge/chat-%20on%20telegram-blue.svg?style=for-the-badge)](https://t.me/joinchat/973EyAQlrfthZTk1)

Shioaji is sinopac provide the most pythonic api for trading the taiwan and global financial market.

You can use your favorite Python packages such as numpy, scipy, pandas, pytorch or tensorflow to build your own trading model with intergrated the shioaji api on cross platform.

- [Installation](#installation)

    - [Binaries](#binaries)

    - [Docker Image](#docker-image)

- [Quickstarts](#quickstarts)

- [Communication](#communication)

- [Releases and Contributing](#releases-and-contributing)

- [The Team](#the-team)

## Installation

### Binaries

simple using pip to install

```

pip install shioaji

```

### Docker Image

simple run with interactive mode in docker 

```

docker run -it sinotrade/shioaji:latest

```

or

```

docker run -it sinotrade/shioaji:{version}

```

run with jupyter lab or notebook

```

docker run -p 8888:8888 sinotrade/shioaji:jupyter

```

## [Quickstarts](https://sinotrade.github.io/quickstart/)

## Initialization

```python

import shioaji as sj

api = sj.Shioaji()

accounts = api.login("YOUR_PERSON_ID", "YOUR_PASSWORD")

api.activate_ca(

    ca_path="/c/your/ca/path/Sinopac.pfx",

    ca_passwd="YOUR_CA_PASSWORD",

    person_id="Person of this Ca",

)

```

Just import our API library like other popular python library and new the instance to start using our API. Login your account and activate the certification then you can start placing order.

## [Streaming Market Data](https://sinotrade.github.io/tutor/market_data/streaming/)

```python

api.quote.subscribe(api.Contracts.Stocks["2330"], quote_type="tick")

api.quote.subscribe(api.Contracts.Stocks["2330"], quote_type="bidask")

api.quote.subscribe(api.Contracts.Futures["TXFC0"], quote_type="tick")

```

Subscribe the real time market data. Simplely pass contract into quote `subscribe` function and give the quote type will receive the streaming data.

## [Place Order](https://sinotrade.github.io/tutor/order/Stock/)

```python

contract = api.Contracts.Stocks["2890"]

order = api.Order(

    price=9.6,

    quantity=1,

    action="Buy",

    price_type="LMT",

    order_type="ROD",

    order_lot="Common",

    account=api.stock_account,

)

# or

order = api.Order(

    price=9.6,

    quantity=1,

    action=sj.constant.Action.Buy,

    price_type=sj.constant.TFTStockPriceType.LMT,

    order_type=sj.constant.TFTOrderType.ROD,

    order_lot=sj.constant.TFTStockOrderLot.Common,

    account=api.stock_account,

)

trade = api.place_order(contract, order)

```

Like the above subscribing market data using the contract, then need to define the order. Pass them into `place_order` function, then it will return the trade that describe the status of your order.

## Conclusion

This quickstart demonstrates how easy to use our package for native Python users. Unlike many other trading API is hard for Python developer. We focus on making more pythonic trading API for our users. 

More usage detail on document.

[![doc](https://img.shields.io/badge/docs%20-passing-orange.svg?style=for-the-badge)](https://sinotrade.github.io/)

## Communication

[![Gitter](https://badges.gitter.im/Sinotrade/Shioaji.svg)](https://gitter.im/Sinotrade/Shioaji?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

- Gitter: general chat, online discussions, collaboration etc.

- GitHub issues: bug reports, feature requests, install issues, RFCs, thoughts, etc.

## Releases and Contributing

Shioaji has a 14 day release cycle. See the release [change log](https://sinotrade.github.io/release/). Please let us know if you encounter a bug by [filing an issue](https://github.com/Sinotrade/Shioaji/issues).

We appreciate all suggestions. If you have any idea want us to implement, please discuss with us in gitter.

## The Team

Shioaji is currently maintained by [Sally](https://github.com/SsallyLin), [Yvictor](https://github.com/Yvictor), [Sam](https://github.com/linsamtw), [CC.Chiao](https://github.com/luckchiao) and [Po Chien Yang](https://github.com/ypochien) with major contributions.