Skip to main content
Read how the trdrs CLI runs an API call from your terminal, without writing code or building a curl command. Use this page when you want to explore the API, check an account, or script a quick task.
The CLI isn’t published: its package isn’t on npm and its repository isn’t public, so nothing on this page installs. Call the API from your terminal with curl, as every guide shows.
trdrs is a command-line client with no dependencies. It reads the engine’s OpenAPI document each time it runs, so its commands always match the API: a route added to the engine is a command the next time you type trdrs. The rest of this page describes the CLI as it’s built.

​
Point it at the sandbox

The CLI reads the same environment variables as the programmatic trading quickstart. Set them in your shell:
The CLI then sends TRDRS_TRADING_API_KEY on the trading, account and market data routes, and TRDRS_PRE_REGISTRATION_KEY on every route under /api/pre-registration/. It lists the Venue API’s routes, under /api/venues/, in its venue-platform-preview group, but it reads no Venue key, so call those routes with curl and your Venue key, which starts with trdrs_vk_.

​
Find and run a command

Commands are grouped the way the API reference groups routes, and named after each route’s title. Type less to see what’s there:
Each command prints the response as JSON. trdrs api takes a method and a path, for anything you’d rather name directly.

​
Confirm trading writes

A trading write never goes out by accident. Without --live, the CLI prints the exact request it would send, with your key hidden, and stops:
Read it, then run the same command with --live to send it. When your data has no clientOrderId, the CLI makes one and prints it. Reuse that id if you retry, and the retry can’t place a second order.

​
Next steps

Programmatic trading

Create a Trading API key and find the account to trade.

TypeScript SDK

Read how the SDK makes the same calls from code, with typed methods.