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
scope
enum<string>
required
Available options:
api_key,
trading_account
reason
string
default:Paused by API key
Required string length: 1 - 200

Response

Pauses now covering this key

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