Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

A Lean API key, sent as Authorization: Bearer <key>. A test key (lean_sk_test_...) simulates orders and fills with no money; a live key (lean_sk_live_...) trades for real within the key's limits. Every successful response says which mode answered in data.livemode.

Body

application/json
timeout_seconds
integer
required

Cancel every open order of the trading account, in this key’s mode, unless this is called again within this many seconds. 0 disarms the timer.

Required range: 0 <= x <= 86400

Response

The timer as armed, or disarmed

success
enum<boolean>
required
Available options:
true
data
object
required
meta
object
required