Skip to content

AI Coding Assistant

Shioaji is the first financial API in Taiwan to support LLM.txt and AI Coding Agent Skills.

We provide AI-friendly resources to help you integrate the trading API with AI coding assistants. Whether you're using Claude Code, Cursor, or other AI-powered development tools, these resources enable AI to understand and assist with Shioaji API development.

Available Resources

LLM.txt

We provide machine-readable documentation files that AI assistants can consume to understand the Shioaji API:

File Description
llms.txt Structured links to all documentation pages
llms-full.txt Complete documentation content in plain text

These files follow the llms.txt standard and are automatically updated when documentation changes.

Usage: Simply provide the URL to your AI assistant: 

https://sinotrade.github.io/llms-full.txt

AI Coding Agent Skills

For deeper integration, we provide skills/plugins for popular AI coding agents:

Claude Code

Claude Code is Anthropic's official CLI for AI-assisted development.

Install the Shioaji skill: 

claude plugin marketplace add Sinotrade/Shioaji
claude plugin install shioaji

OpenAI Codex CLI

In a Codex session, use the skill-installer: 

$skill-installer install shioaji from Sinotrade/Shioaji --path skills/shioaji

Skill Capabilities

Once installed, AI coding agents can assist you with:

  • Authentication and login procedures
  • Contract specifications (stocks, futures, options)
  • Order placement and management
  • Real-time market data streaming
  • Account balance and position tracking
  • Historical data retrieval

Example prompts: 

How do I subscribe to real-time stock quotes with Shioaji?
Help me place a limit order for TSMC stock
Show me how to get my account positions

Getting Started Prompt

New to Shioaji? Use this prompt to let AI guide you through the complete setup and testing process:

I'm new to Shioaji and want to start trading. Please guide me through the complete
setup process step by step:

1. How to open a Sinopac account
2. How to sign the API terms of service
3. How to apply for API Key and Secret Key
4. How to complete the simulation mode testing (login test, stock order test, futures order test)
5. How to verify my test passed (signed=True)
6. How to apply for and activate the CA certificate
7. How to switch to production mode

Please check my progress at each step and help me troubleshoot any issues.

This prompt helps AI walk you through the entire onboarding process, which is required before you can trade in production mode.

Best Practices

  1. Provide context - Tell the AI you're working with Shioaji Taiwan trading API
  2. Reference documentation - Point AI to the llms-full.txt for comprehensive knowledge
  3. Verify generated code - Always review AI-generated trading code before execution
  4. Use simulation mode - Test AI-generated strategies in simulation mode first

Important

AI-generated trading code should always be reviewed and tested in simulation mode before use with real money. The AI assistant provides guidance based on documentation but cannot guarantee trading outcomes.