Shioaji provides a cross-platform Python API for trading in Taiwan's financial markets, including stocks, futures, and options. It targets Python developers seeking to build custom trading models using familiar libraries like Pandas and PyTorch. The platform offers a user-friendly interface, high performance, and unique AI coding agent integration for enhanced development.

How It Works

The API leverages a high-performance C++ core and FPGA event broker technology for speed and efficiency. It exposes a Pythonic interface for market data streaming, order placement, and account management. A key innovation is its integration with AI coding agents, offering AI-assisted guidance for API usage and development.

Quick Start & Requirements

• Installation: pip install shioaji or uv add shioaji. Docker image sinotrade/shioaji:latest is available.
• Prerequisites: Python environment, Sinopac API token/secret key, and a valid CA certificate (.pfx) with its password for authentication.
• AI Coding Agent Skills: Integration with platforms like Claude, Cursor, Copilot, and Codex via claude plugin install shioaji or npx skills add Sinotrade/Shioaji.
• Documentation: Primary details are within the README; further usage examples are implied.

Highlighted Details

• Pioneering AI coding agent skill support for a Taiwan trading API.
• True cross-platform compatibility, supporting Linux and macOS alongside Windows.
• High-performance backend utilizing C++ and FPGA event broker technology.
• Designed for seamless integration with the Python data science ecosystem.

Maintenance & Community

• Release Cycle: 14-day releases.
• Contribution: Bug reports via GitHub Issues; feature discussions on Gitter.
• Maintainers: Sally, Yvictor, CC.Chiao, Po Chien Yang.

Licensing & Compatibility

• License: Not explicitly stated in the provided README.
• Compatibility: Requires Sinopac account and CA certificate for full functionality. Commercial use implications are unclear due to the missing license.

Limitations & Caveats

The README does not specify a software license, posing a significant adoption risk. It requires specific authentication credentials (API keys, CA certificate) tied to Sinopac and Taiwan markets. AI coding agent integration may depend on third-party AI platform availability and configuration.