shioaji-cli 1.7.9__py3-none-win_amd64.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: shioaji-cli
|
|
3
|
+
Version: 1.7.9
|
|
4
|
+
Summary: Shioaji standalone CLI and local HTTP API server
|
|
5
|
+
Author-email: yvictor <yvictor3141@gmail.com>
|
|
6
|
+
Project-URL: Homepage, https://sinotrade.github.io/
|
|
7
|
+
Project-URL: Documentation, https://sinotrade.github.io/
|
|
8
|
+
Project-URL: Repository, https://github.com/Sinotrade/Shioaji
|
|
9
|
+
Project-URL: Changelog, https://sinotrade.github.io/release/
|
|
10
|
+
Description-Content-Type: text/markdown
|
|
11
|
+
|
|
12
|
+
# shioaji-cli
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
[](https://pypi.org/project/shioaji-cli)
|
|
16
|
+
[](https://sinotrade.github.io/)
|
|
17
|
+
[](https://t.me/joinchat/973EyAQlrfthZTk1)
|
|
18
|
+
[](https://discord.gg/5nzmWCTnG7)
|
|
19
|
+
|
|
20
|
+
The standalone `shioaji` command-line tool and local HTTP API server of
|
|
21
|
+
[Shioaji](https://sinotrade.github.io/), SinoPac Securities' trading API for
|
|
22
|
+
Taiwan stocks, futures and options.
|
|
23
|
+
|
|
24
|
+
It is a single native binary: it does not depend on your Python version
|
|
25
|
+
(free-threaded 3.14t included) and carries no Python extension. Its version is
|
|
26
|
+
always the same as the [`shioaji`](https://pypi.org/project/shioaji/) package.
|
|
27
|
+
|
|
28
|
+
## Install
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
uv tool install shioaji-cli # or pin a release line: "shioaji-cli==1.7.*"
|
|
32
|
+
shioaji --help
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
One-off use without installing:
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
uvx --from shioaji-cli shioaji server start
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Install either `shioaji-cli` or the `shioaji` Python package as a tool, not
|
|
42
|
+
both: both provide the same `shioaji` command. Use `shioaji` instead when you
|
|
43
|
+
also need the Python API.
|
|
44
|
+
|
|
45
|
+
## Quick start
|
|
46
|
+
|
|
47
|
+
Put your API key in the environment or a `.env` file in the working directory:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
SJ_API_KEY=your-api-key
|
|
51
|
+
SJ_SEC_KEY=your-secret-key
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Start the local server. It runs in **simulation mode by default**:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
shioaji server start # simulation
|
|
58
|
+
shioaji server check # shows the mode and auth status
|
|
59
|
+
shioaji server start --production # real trading; place orders with care
|
|
60
|
+
shioaji server stop
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Other commands start the server in the background on first use:
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
shioaji auth accounts
|
|
67
|
+
shioaji contracts get 2330
|
|
68
|
+
shioaji data ticks --code 2330
|
|
69
|
+
shioaji order --help
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
Output is TOON by default; add `-f json` for JSON.
|
|
73
|
+
|
|
74
|
+
## Local HTTP API
|
|
75
|
+
|
|
76
|
+
While running, the server exposes the full trading API over HTTP with SSE
|
|
77
|
+
streaming at `http://127.0.0.1:8080`, so any language can use it. Interactive
|
|
78
|
+
API docs are at `/docs`, the OpenAPI document at `/openapi.json`, and a web
|
|
79
|
+
dashboard at `/`.
|
|
80
|
+
|
|
81
|
+
Common settings (environment variables):
|
|
82
|
+
|
|
83
|
+
| Variable | Default | Meaning |
|
|
84
|
+
|---|---|---|
|
|
85
|
+
| `SJ_PRODUCTION` | `false` | Production instead of simulation |
|
|
86
|
+
| `SJ_HTTP_ADDR` | `127.0.0.1:8080` | Bind address |
|
|
87
|
+
| `SJ_CA_PATH`, `SJ_CA_PASSWD` | | CA certificate for production orders |
|
|
88
|
+
| `SJ_RECEIVE_WINDOW` | `30000` | Login receive window in ms; raise it on `Sign data is timeout` |
|
|
89
|
+
| `SJ_LOG_DIR` | `~/.shioaji/logs` | Daily server log files, kept 14 days |
|
|
90
|
+
|
|
91
|
+
## Links
|
|
92
|
+
|
|
93
|
+
- Documentation: https://sinotrade.github.io/
|
|
94
|
+
- Release notes: https://sinotrade.github.io/release/
|
|
95
|
+
- Issues: https://github.com/Sinotrade/Shioaji/issues
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
shioaji_cli-1.7.9.data/scripts/shioaji.exe,sha256=sn5xAbkp3o3Tmuv_ZXZzc8BZWFfbMYqsej8EgguwVZQ,59787776
|
|
2
|
+
shioaji_cli-1.7.9.dist-info/METADATA,sha256=ksAfWHIO25qCUTeYnC4rTrxx7dBuB5NSgFbXiSg5cd4,3466
|
|
3
|
+
shioaji_cli-1.7.9.dist-info/WHEEL,sha256=D9-vy94_Xr36JmVABH0kRDWCSuBwUkY0uTm1EtS3Pcw,109
|
|
4
|
+
shioaji_cli-1.7.9.dist-info/RECORD,,
|