Skip to main content
POST
Error
Use the ticket to open the WebSocket: it covers connecting, the auth frame, subscribing to channels and close codes. For reconnecting and rebuilding state, see the Streaming guide.

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.

Response

A ticket bound to this key, its trading account and mode

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