tickwire-cli
The tickwire command for the Tickwire MT4/MT5 cloud API, built on the
tickwire Python SDK.
Not published yet. pip install tickwire-cli won't find it. Install from source, from the
repository root (the SDK first, because the CLI needs it):
pip install ./sdk/python ./cli
Once it is published:
pip install tickwire-cli # or "tickwire-cli[keyring]" to keep keys in the OS keychain
Python 3.11 or newer. MIT licensed.
Quick start
A free sandbox (no sign-in, no card) against the public API:
export TICKWIRE_SANDBOX_URL=https://api.tickwire.io
tickwire sandbox create # one simulated MT5 account; the key is stored, never printed
tickwire --sandbox accounts list
tickwire --sandbox trade open <account-id> --side buy --symbol EURUSD --volume 0.01 --reason "test"
With your own API key:
export TICKWIRE_API_URL=https://api.tickwire.io
tickwire login # hidden prompt; the key is checked, then stored
tickwire accounts list
tickwire listen --forward-to http://localhost:3000/webhooks
tickwire trigger trade.outcome
tickwire logs tail -f --status errors # your request log, new calls as they happen
The sandbox key from sandbox create is restricted: it can manage accounts,
trade and read, but not use webhooks (listen, trigger). For those, use your
own key, or a sandbox key made from it (POST /v1/sandbox/keys) with
tickwire login --sandbox.
Commands
login: the key comes from a hidden prompt or stdin, never from an argument, and is never printed. It is stored in the OS keychain or in a0600file.trade open|close:--reasonis mandatory and anIdempotency-Keyis sent automatically. The result isapplied,no_change,rejected,heldorunknown(exit codes 0, 0, 3, 4, 5). Anunknownresult is never retried.listen --forward-to: events are signed by the server, verified by the CLI, then forwarded byte for byte.logs tail: your request log, oldest first,--followfor new calls. Redacted bodies of failed calls only with--bodies, and only when the API returns them to your key. Waits forRetry-Afteron429.--jsonworks with every command.
Full documentation: tickwire.io/docs/cli.
Metadata
Release files for tickwire-cli 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| tickwire_cli-0.1.0.tar.gz | 39.7 kB | Without provenance | Details for tickwire_cli-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| tickwire_cli-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for tickwire_cli-0.1.0-py3-none-any.whl |
Total release size: 69.0 kB
Release files / tickwire_cli-0.1.0.tar.gz
| Download URL | tickwire_cli-0.1.0.tar.gz |
|---|---|
| Size | 39.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
779e75dc797423f9d8906d07921bc99dffa718909798517e8dd0760106e5db38
|
|
BLAKE2b-256 checksum How to use checksums |
a502d220157edddba873531a7cdd0dc25f28464761442a23047bd07734d6a718
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
Release files / tickwire_cli-0.1.0-py3-none-any.whl
| Download URL | tickwire_cli-0.1.0-py3-none-any.whl |
|---|---|
| Size | 29.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fbe87c219bad082e3eb34e6d2f60f26902af9c4f23de57ce3c447092cedc65cb
|
|
BLAKE2b-256 checksum How to use checksums |
07e2bcf353731de3fa707a85eb3caebd6630e926e0b1bcf52f66d5229cd78df6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
Security for tickwire-cli 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.