---
id: shioaji
version: "1.7.2"
license: unclear
license_treatment: unclear
maintenance: active
---

# shioaji — Shioaji — cross-language, cross-platform universal trading API. Native Python bindings, HTTP API with SSE streaming, standalone CLI, and a visual dashboard.

License: unclear · Maintenance: active · Downloads: 158.2K/mo

## What it is and what it does

Shioaji is a trading platform API maintained by Sinopac that connects Python developers to Taiwan's financial markets. It provides three entry points: native Python bindings (import shioaji), a built-in HTTP server with OpenAPI documentation and SSE streaming, and a CLI tool for server management and direct trading commands. The package handles authentication via API keys and CA certificates, then exposes market data subscriptions, contract lookups, and order placement across stocks, futures, options, and combo orders.

The package is designed for both novice traders and experienced developers. It integrates with standard Python data-science libraries (numpy, scipy, pandas, pytorch, tensorflow) for building custom trading models, and its HTTP API makes it accessible from any language (JavaScript, Go, C#, Java, Rust, C/C++). A visual dashboard provides live monitoring of server status, SSE connections, accounts, and API usage. The project is actively maintained on a 14-day release cycle and supports Python 3.7 through 3.14 across macOS, Linux, and Windows.

Use it for:

- Build a Python trading bot that subscribes to real-time tick data for Taiwan stocks and executes orders based on custom signals.
- Use the HTTP API from a Node.js or Go application to access Taiwan market data and place orders without native Python bindings.
- Monitor live trading activity and server health through the built-in dashboard while managing multiple accounts and API connections.
- Develop a machine-learning model in PyTorch or TensorFlow that ingests Shioaji market data and generates trading recommendations.
- Integrate Shioaji into a web app uploaded to the dashboard for a self-contained trading interface with live data and order placement.

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

Shioaji is a trading API for Taiwan's financial markets that provides native Python bindings, HTTP endpoints, and a CLI for placing orders and subscribing to real-time market data for stocks, futures, options, and combo orders.

Yes, with conditions. Shioaji is actively maintained and production-stable for accessing Taiwan's financial markets via Python, HTTP, or CLI. Install it if you have a Sinopac trading account and need programmatic access to stocks, futures, or options. However, verify the license terms first—the metadata does not declare an SPDX license, so confirm it aligns with your use case before committing to production. Medium install friction is acceptable for a compiled trading library.

## Install

pip install shioaji
uv add shioaji
poetry add shioaji

## Installing shioaji

Before you install: Medium install friction due to compiled wheels for multiple platforms and Python versions (3.7–3.14). Package is actively maintained with releases on a 14-day cycle; last release was 8 days ago and the repository shows recent activity.

License in practice: License treatment is unclear—no SPDX identifier or raw license text is available in the metadata. Verify the actual license terms before use, particularly if integrating into proprietary or commercial systems.

Quickstart:

import shioaji as sj

api = sj.Shioaji()
accounts = api.login(api_key="YOUR_KEY", secret_key="YOUR_SECRET")
api.activate_ca(ca_path="/path/to/Sinopac.pfx", ca_passwd="YOUR_CA_PASSWORD")
contract = api.Contracts.Stocks["2330"]
api.subscribe(contract, quote_type="tick")

Requires a Sinopac trading account with API credentials and a CA certificate file (Sinopac.pfx) to authenticate and activate trading.

Verify before relying:

- Whether the unclear license permits commercial or proprietary use without restrictions.
- Whether the HTTP server mode and cross-language support are production-ready or still experimental.
- Performance characteristics and latency guarantees for real-time streaming and order execution.

## Package facts

- License: not declared (unclear)
- Python support: supports_current
- Install friction: medium
- Maintenance: active
- Downloads: 158.2K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

taiwan stock trading api, python trading platform, real-time market data streaming, futures and options trading, sinopac trading api, programmatic order placement, cross-language trading api, trading-api, taiwan-markets, real-time-streaming

[View on SkillFed](https://skillfed.io/packages/shioaji) · [View on PyPI](https://pypi.org/project/shioaji/)