Guides

Each guide is one task, start to finish, with code you can copy.

• Getting started Create an API key, pick its scopes and make your first Cirrus API request in a few minutes.
• Place, modify and cancel an order Place an order in one or many broker accounts, change its price or quantity, cancel it and check its status.
• Protect a position Put a stop-loss and target on a position: held at your broker (GTT or stop order) where it can be, or watched by Cirrus.
• Price and indicator alerts Get told when a price, a tick field or an indicator crosses a level, on Telegram, in the app or at your webhook.
• Entry trigger with a bracket Wait for a price or condition to enter, then manage the trade with a target, a stop-loss and a trailing stop.
• Multiple targets (ladder) Book profit in steps: exit part of a position at each target and move the stop-loss up as each one is hit.
• Loss limits, profit lock and targets Stop trading for the day at a loss limit, lock in profit once it reaches a level, or exit everything at a profit target.
• Automated strategies Write a strategy, backtest it on past days, run it on paper accounts, then take it live.
• Webhooks and notifications Get a signed HTTPS call when orders, trades, positions or triggers change, verify it, and choose what reaches Telegram.
• The live stream Open one WebSocket and get your orders, positions, holdings and funds as they change, without polling.
• Errors, rate limits and retries Every error code and what to do about it, the rate limits, and how Idempotency-Key makes retries safe.
• OAuth for partner apps Build an app other Cirrus users connect to their accounts: authorization code with PKCE, tokens, refresh and revocation.