Skip to main content
GET
Canonical template list
Preview contract. Production availability remains subject to activation and release qualification. Examples are synthetic; the documentation cannot submit requests.

Authorization

read; templates are account-owned.

Behavior

Returns a bare array, including an empty array when no templates exist. It is not wrapped in success/data and not limited to the credential instrument. Template reads place no trades.

Request example

All IDs and dates are illustrative. URL-encode opaque query values and supply each allowed key once. Optional filters and their types appear in the generated schema below.

Response and errors

The generated response schema below is the wire contract. Preserve fixed-point strings, nullable fields and endpoint-specific envelopes. Inspect HTTP status and Content-Type before decoding failures; reused trading routes may return JSON or plain text. Authentication, entitlement and exact link/instrument restrictions apply in addition to endpoint validation. See errors and recovery. Read the related guide for lifecycle, units and recovery semantics.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Success

id
string<uuid>
required
user_id
integer<int64>
required
name
string
required
instrument_type
integer<int64>
required
position_side
integer<int64>
required
order_grid_enabled
boolean
required
open_price_deltas
integer<int64>[]
required
open_quantity_percent
integer<int64>[]
required
sl_enabled
boolean
required
sl_price_rearrangement
boolean
required
slx_enabled
boolean
required
slx_tp_trailing_enabled
boolean
required
slx_each_tp_trailing
boolean
required
slx_sl_trailing_breakeven_enabled
boolean
required
slx_sl_trigger_price_trailing_enabled
boolean
required
tp_enabled
boolean
required
tp_price_rearrangement
boolean
required
tp_grid_enabled
boolean
required
tp_pnls
integer<int64>[]
required
tp_quantity_percent
integer<int64>[]
required
open_order_type
integer<int64>
required
sl_order_type
integer<int64>
required
tp_order_type
integer<int64>
required
created_at
integer<int64>
required
updated_at
integer<int64>
required
margin_mode
integer<int64> | null
leverage
integer<int64> | null
num_open_orders
integer<int64> | null
open_orders_step
integer<int64> | null
open_orders_factor
integer<int64> | null
sl_type
integer<int64> | null
sl_step_percent
integer<int64> | null
slx_tp_breakeven
integer<int64> | null
slx_sl_trailing_breakeven_indent_percent
integer<int64> | null
slx_sl_trigger_price_trailing_pl_percent_activation
integer<int64> | null
slx_sl_trigger_price_trailing_indent_percent
integer<int64> | null
slx_sl_trigger_price_trailing_step
integer<int64> | null
num_tp_orders
integer<int64> | null
tp_orders_step
integer<int64> | null
tp_orders_factor
integer<int64> | null