API reference
Every operation, grouped by what you want to do. New here? Start with Getting started.
Orders
Place, modify and cancel orders in one or many accounts, and estimate margin first.
Bracket and cover orders
Orders the broker protects with its own stop-loss and target.
Positions and portfolio
Read positions, holdings, trades and funds; exit or convert a position.
Triggers
Alerts, stop-loss, targets, entries, ladders and loss limits the server watches tick by tick.
- GET List v2 triggers
- POST Create a v2 trigger
- GET One v2 trigger
- PATCH Change a v2 trigger
- DELETE Cancel a v2 trigger
- POST Pause a v2 trigger
- POST Resume a paused v2 trigger
- POST Check a v2 trigger without creating it
- GET What v2 triggers can do
- GET A v2 trigger's journey
- GET A v2 trigger's indicator values now
Protection (classic triggers)
The first trigger API: protect one position with a stop-loss, target and trail.
GTT orders
Good-till-triggered orders the broker holds for you.
Risk limits
Your overall daily loss limit and exposure cap for automated strategies.
Backtests
Run a strategy version over past days and read its trades.
Deployments
Run a strategy on paper or live accounts, then pause, stop or take it live.
- GET List a strategy's deployments
- POST Deploy a strategy
- GET Get a deployment
- POST Pause a deployment
- POST Resume a deployment
- GET A deployment's journey
- POST Stop a deployment
- POST Exit open trades now
- POST Take a forward test live
- GET Live values of a deployment
- GET List a deployment's cycles
- GET Get a cycle with its journey
- POST Send a signal to a deployment
- POST Stop every strategy
Strategy gallery
Browse, copy, buy and publish strategy templates.
- POST List a strategy in the gallery
- GET Browse the gallery
- GET Your gallery listings
- GET Get a gallery listing
- DELETE Withdraw your listing
- POST Copy a listing into your strategies
- POST Buy a paid listing
- GET Your platform credits
- GET Whether a version may be listed
- GET Paid-template settings
- GET Your purchase receipts
- GET Your earnings as an author
Strategy builder
What a strategy can use, ready-made templates, and checks before you save or deploy.
Automated strategies
Write, check, version and share strategy documents.
- GET List strategies
- POST Create a strategy
- GET Get a strategy
- PATCH Edit a strategy's draft
- DELETE Archive a strategy
- GET List a strategy's versions
- POST Save the draft as a version
- GET Get a version
- POST Clone a strategy
- GET Export a strategy
- POST Import a strategy
- PUT Share a strategy
- DELETE Stop sharing a strategy
Strategy P&L
Today's positions and P&L grouped by the strategy tag on your orders.
Accounts and profile
Your linked broker accounts and who the credential belongs to.
Instruments
Find the instrument token to trade, its lot size and expiries.
Activity log
Everything that happened on your accounts, in plain English.
Live stream
One WebSocket with your orders and portfolio as they change.
Webhooks
Signed HTTPS calls to your server when orders, trades or positions change.
Notifications
Telegram and in-app notifications, and which events go where.
Signal URLs
Secret URLs that turn TradingView, Chartink or Kuberhunt alerts into orders.
Watchlists
Your stock lists; a stock strategy can run on one.
API keys
Create and revoke the keys your code uses.
Partner apps (OAuth)
Apps that act for other users: register, exchange tokens, disconnect.
- GET List your partner apps
- POST Register a partner app
- PATCH Set a partner app's webhook
- DELETE Disable a partner app
- POST Rotate a partner app's client secret
- POST Rotate a partner app's webhook secret
- POST Exchange a code or refresh token for tokens
- GET List connected partner apps
- DELETE Disconnect a partner app
API description
This API as an OpenAPI document, for code generators and tools.