Get an order template

GET

https://api.liftx.io

templates

get

Canonical template get

curl --request GET \
  --url https://api.liftx.io/v1/templates/get \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.liftx.io/v1/templates/get', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "44444444-4444-4444-8444-444444444444",
  "user_id": 1,
  "name": "Illustrative derivative limit",
  "instrument_type": 2,
  "position_side": 1,
  "margin_mode": 1,
  "leverage": 2,
  "order_grid_enabled": false,
  "open_price_deltas": [],
  "open_quantity_percent": [
    1000000
  ],
  "sl_enabled": false,
  "sl_price_rearrangement": false,
  "slx_enabled": false,
  "slx_tp_trailing_enabled": false,
  "slx_each_tp_trailing": false,
  "slx_sl_trailing_breakeven_enabled": false,
  "slx_sl_trigger_price_trailing_enabled": false,
  "tp_enabled": false,
  "tp_price_rearrangement": false,
  "tp_grid_enabled": false,
  "tp_pnls": [],
  "tp_quantity_percent": [],
  "open_order_type": 1,
  "sl_order_type": 2,
  "tp_order_type": 1,
  "created_at": 1893456000,
  "updated_at": 1893456000
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

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 the full bare template object. Preserve required fields and exact integer scales when editing. A template is reusable configuration, not an executable PositionRequest.

Request example

GET /v1/templates/get?id=11111111-1111-4111-8111-111111111111
Authorization: Bearer YOUR_API_KEY_FROM_PRIVATE_STORAGE

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.

Query Parameters

string<uuid>

required

Response

Success

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

Canonical template get

curl --request GET \
  --url https://api.liftx.io/v1/templates/get \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.liftx.io/v1/templates/get', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "44444444-4444-4444-8444-444444444444",
  "user_id": 1,
  "name": "Illustrative derivative limit",
  "instrument_type": 2,
  "position_side": 1,
  "margin_mode": 1,
  "leverage": 2,
  "order_grid_enabled": false,
  "open_price_deltas": [],
  "open_quantity_percent": [
    1000000
  ],
  "sl_enabled": false,
  "sl_price_rearrangement": false,
  "slx_enabled": false,
  "slx_tp_trailing_enabled": false,
  "slx_each_tp_trailing": false,
  "slx_sl_trailing_breakeven_enabled": false,
  "slx_sl_trigger_price_trailing_enabled": false,
  "tp_enabled": false,
  "tp_price_rearrangement": false,
  "tp_grid_enabled": false,
  "tp_pnls": [],
  "tp_quantity_percent": [],
  "open_order_type": 1,
  "sl_order_type": 2,
  "tp_order_type": 1,
  "created_at": 1893456000,
  "updated_at": 1893456000
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Discovery and account data

Positions and history

Templates

Commands and streams

TradingView webhook

Session-only Settings

Get an order template

Authorization

Behavior

Request example

Response and errors

Authorizations

Query Parameters

Response

​Authorization

​Behavior

​Request example

​Response and errors

Authorizations

Query Parameters

Response

Authorization

Behavior

Request example

Response and errors