Skip to main content
Three environment variables and two flags is a lot to absorb at once. You don’t need all of them. Pick the level you actually want and verify it works before adding the next one.

​
Level 1 — Market data only

No credentials at all. Proves the install and the client wiring with nothing at risk.
You get prices, order books, klines, funding rates, and the supported networks and assets. Every tool in the market module works with no key.
Start here even if you ultimately want trading. If market data works, the server is installed and your client is spawning it correctly — which eliminates most of the troubleshooting surface before credentials are involved.

​
Level 2 — Full account access, still read-only

Add the three credentials. You can now read balances, orders, positions, fills, fee tiers, and history. No order can be placed, because trading tools are not registered.
See Getting your credentials for how to obtain these, and the scope table for which API-key permissions each group of tools needs.

​
Level 3 — Trading

Add the opt-in flag. Order placement, cancellation, position closing, leverage changes, and internal transfers become available.
Read Risk and safety before this step. Two tools — cancel_all_orders and close_positions — act on your entire account when called without a market, and they are single-word requests for an agent.

​
Which module does what

Omitting YELLOW_PRO_MODULES loads all modules. Full details in Configuration.