shioaji-cli

The standalone shioaji command-line tool and local HTTP API server of Shioaji, SinoPac Securities' trading API for Taiwan stocks, futures and options.

It is a single native binary: it does not depend on your Python version (free-threaded 3.14t included) and carries no Python extension. Its version is always the same as the shioaji package.

Install

uv tool install shioaji-cli          # or pin a release line: "shioaji-cli==1.7.*"
shioaji --help

One-off use without installing:

uvx --from shioaji-cli shioaji server start

Install either shioaji-cli or the shioaji Python package as a tool, not both: both provide the same shioaji command. Use shioaji instead when you also need the Python API.

Quick start

Put your API key in the environment or a .env file in the working directory:

SJ_API_KEY=your-api-key
SJ_SEC_KEY=your-secret-key

Start the local server. It runs in simulation mode by default:

shioaji server start              # simulation
shioaji server check              # shows the mode and auth status
shioaji server start --production # real trading; place orders with care
shioaji server stop

Other commands start the server in the background on first use:

shioaji auth accounts
shioaji contracts get 2330
shioaji data ticks --code 2330
shioaji order --help

Output is TOON by default; add -f json for JSON.

Local HTTP API

While running, the server exposes the full trading API over HTTP with SSE streaming at http://127.0.0.1:8080, so any language can use it. Interactive API docs are at /docs, the OpenAPI document at /openapi.json, and a web dashboard at /.

Common settings (environment variables):

Links

• Documentation: https://sinotrade.github.io/
• Release notes: https://sinotrade.github.io/release/
• Issues: https://github.com/Sinotrade/Shioaji/issues