Create an order template

POST

https://api.liftx.io

templates

create

Canonical template create

curl --request POST \
  --url https://api.liftx.io/v1/templates/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": 123,
  "name": "<string>",
  "instrument_type": 123,
  "position_side": 123,
  "order_grid_enabled": true,
  "open_price_deltas": [
    123
  ],
  "open_quantity_percent": [
    123
  ],
  "sl_enabled": true,
  "sl_price_rearrangement": true,
  "slx_enabled": true,
  "slx_tp_trailing_enabled": true,
  "slx_each_tp_trailing": true,
  "slx_sl_trailing_breakeven_enabled": true,
  "slx_sl_trigger_price_trailing_enabled": true,
  "tp_enabled": true,
  "tp_price_rearrangement": true,
  "tp_grid_enabled": true,
  "tp_pnls": [
    123
  ],
  "tp_quantity_percent": [
    123
  ],
  "open_order_type": 123,
  "sl_order_type": 123,
  "tp_order_type": 123,
  "created_at": 123,
  "updated_at": 123
}
'

import requests

url = "https://api.liftx.io/v1/templates/create"

payload = {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": 123,
    "name": "<string>",
    "instrument_type": 123,
    "position_side": 123,
    "order_grid_enabled": True,
    "open_price_deltas": [123],
    "open_quantity_percent": [123],
    "sl_enabled": True,
    "sl_price_rearrangement": True,
    "slx_enabled": True,
    "slx_tp_trailing_enabled": True,
    "slx_each_tp_trailing": True,
    "slx_sl_trailing_breakeven_enabled": True,
    "slx_sl_trigger_price_trailing_enabled": True,
    "tp_enabled": True,
    "tp_price_rearrangement": True,
    "tp_grid_enabled": True,
    "tp_pnls": [123],
    "tp_quantity_percent": [123],
    "open_order_type": 123,
    "sl_order_type": 123,
    "tp_order_type": 123,
    "created_at": 123,
    "updated_at": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    user_id: 123,
    name: '<string>',
    instrument_type: 123,
    position_side: 123,
    order_grid_enabled: true,
    open_price_deltas: [123],
    open_quantity_percent: [123],
    sl_enabled: true,
    sl_price_rearrangement: true,
    slx_enabled: true,
    slx_tp_trailing_enabled: true,
    slx_each_tp_trailing: true,
    slx_sl_trailing_breakeven_enabled: true,
    slx_sl_trigger_price_trailing_enabled: true,
    tp_enabled: true,
    tp_price_rearrangement: true,
    tp_grid_enabled: true,
    tp_pnls: [123],
    tp_quantity_percent: [123],
    open_order_type: 123,
    sl_order_type: 123,
    tp_order_type: 123,
    created_at: 123,
    updated_at: 123
  })
};

fetch('https://api.liftx.io/v1/templates/create', 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

templates:write; account template authority.

Behavior

Body limit is 64 KiB. The full codec requires identity/timestamp fields; creation replaces them with server-owned values and binds ownership to the authenticated account. No trading receipt or order execution occurs. After an ambiguous response, inspect the template list before explicitly retrying.

JSON body example

The following shows the request shape, not live credentials or executable market defaults. Replace timestamps only when creating a new reviewed intent; never mutate them on a command retry.

{
  "id": "44444444-4444-4444-8444-444444444444",
  "user_id": 0,
  "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": 0,
  "updated_at": 0
}

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. Do not automatically repeat a mutation after transport ambiguity. Trading commands reuse the exact immutable identity; credential issuance and template writes require their documented metadata/read reconciliation. 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.

Body

application/json

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

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 create

curl --request POST \
  --url https://api.liftx.io/v1/templates/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": 123,
  "name": "<string>",
  "instrument_type": 123,
  "position_side": 123,
  "order_grid_enabled": true,
  "open_price_deltas": [
    123
  ],
  "open_quantity_percent": [
    123
  ],
  "sl_enabled": true,
  "sl_price_rearrangement": true,
  "slx_enabled": true,
  "slx_tp_trailing_enabled": true,
  "slx_each_tp_trailing": true,
  "slx_sl_trailing_breakeven_enabled": true,
  "slx_sl_trigger_price_trailing_enabled": true,
  "tp_enabled": true,
  "tp_price_rearrangement": true,
  "tp_grid_enabled": true,
  "tp_pnls": [
    123
  ],
  "tp_quantity_percent": [
    123
  ],
  "open_order_type": 123,
  "sl_order_type": 123,
  "tp_order_type": 123,
  "created_at": 123,
  "updated_at": 123
}
'

import requests

url = "https://api.liftx.io/v1/templates/create"

payload = {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": 123,
    "name": "<string>",
    "instrument_type": 123,
    "position_side": 123,
    "order_grid_enabled": True,
    "open_price_deltas": [123],
    "open_quantity_percent": [123],
    "sl_enabled": True,
    "sl_price_rearrangement": True,
    "slx_enabled": True,
    "slx_tp_trailing_enabled": True,
    "slx_each_tp_trailing": True,
    "slx_sl_trailing_breakeven_enabled": True,
    "slx_sl_trigger_price_trailing_enabled": True,
    "tp_enabled": True,
    "tp_price_rearrangement": True,
    "tp_grid_enabled": True,
    "tp_pnls": [123],
    "tp_quantity_percent": [123],
    "open_order_type": 123,
    "sl_order_type": 123,
    "tp_order_type": 123,
    "created_at": 123,
    "updated_at": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    user_id: 123,
    name: '<string>',
    instrument_type: 123,
    position_side: 123,
    order_grid_enabled: true,
    open_price_deltas: [123],
    open_quantity_percent: [123],
    sl_enabled: true,
    sl_price_rearrangement: true,
    slx_enabled: true,
    slx_tp_trailing_enabled: true,
    slx_each_tp_trailing: true,
    slx_sl_trailing_breakeven_enabled: true,
    slx_sl_trigger_price_trailing_enabled: true,
    tp_enabled: true,
    tp_price_rearrangement: true,
    tp_grid_enabled: true,
    tp_pnls: [123],
    tp_quantity_percent: [123],
    open_order_type: 123,
    sl_order_type: 123,
    tp_order_type: 123,
    created_at: 123,
    updated_at: 123
  })
};

fetch('https://api.liftx.io/v1/templates/create', 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

Create an order template

Authorization

Behavior

JSON body example

Response and errors

Authorizations

Body

Response

​Authorization

​Behavior

​JSON body example

​Response and errors

Authorizations

Body

Response

Authorization

Behavior

JSON body example

Response and errors