Read modification state

GET

https://api.liftx.io

positions

get-for-modification

Read canonical position get-for-modification

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

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

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

{
  "success": true,
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "user_id": 1,
    "status": 1,
    "revision": 7,
    "instrument_id": "COPY_EXACT_CATALOG_ID",
    "instrument_type": 2,
    "instrument_topology": 2,
    "position_side": 1,
    "base": "BTC",
    "quote": "USDT",
    "exchange_link_id": 17,
    "margin_mode": 1,
    "leverage": 2,
    "order_grid_enabled": false,
    "open_orders": [
      {
        "row_id": 1,
        "created_at_ms": 1893456000000,
        "price_atomic": "70000",
        "price_scale": 0,
        "quantity_atomic": "1",
        "quantity_scale": 4,
        "executed": [],
        "projected_order_status": 1,
        "order_fsm_state": 2,
        "exchange_submitted": true,
        "slot_id": "SYNTHETIC_CURRENT_OPEN_SLOT",
        "order_id": "33333333-3333-4333-8333-333333333333"
      }
    ],
    "open_order_type": 1,
    "sl_enabled": false,
    "slx_enabled": false,
    "tp_enabled": false,
    "position_fsm_state": 2,
    "created_at": 1893456000,
    "updated_at": 1893456000,
    "tick_step_atomic": "1",
    "tick_step_scale": 1,
    "lot_step_base_atomic": "1",
    "lot_step_base_scale": 4,
    "min_size_base_atomic": "1",
    "min_size_base_scale": 4,
    "contract_value_atomic": "1",
    "contract_value_scale": 2,
    "funding_fee_quote_atomic": "0",
    "funding_fee_quote_scale": 0,
    "alloc_open_executed_atomic": "0",
    "alloc_open_executed_scale": 0,
    "alloc_close_executed_atomic": "0",
    "alloc_close_executed_scale": 0,
    "alloc_net_exposure_atomic": "0",
    "alloc_net_exposure_scale": 0,
    "executed_cost_quote_atomic": "0",
    "executed_cost_quote_scale": 0,
    "next_funding_fee_quote_atomic": "0",
    "next_funding_fee_quote_scale": 0,
    "next_funding_time": 0
  }
}

{
  "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 for the exact active position.

Behavior

Returns the current active Position publication with revision, slots and physical order identities. It is not a ready-to-submit PositionRequest. Construct a complete intended request, preserve current rows and send its revision as expected_revision on a new MODIFY command. A stale or absent active runtime position is not a safe basis for modification.

Request example

GET /v1/positions/get-for-modification?id=11111111-1111-4111-8111-111111111111&exchange_link_id=17&instrument_id=COPY_EXACT_CATALOG_ID
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

exchange_link_id

integer

required

Required range: 1 <= x <= 9007199254740991

instrument_id

string

required

Response

Success

success

boolean

required

data

object

required

Canonical owner publication. Fixed-point coefficients and scales; revision is used for modify preconditions. Lifecycle fields and attached orders are observations, not command receipt completion.

Show child attributes

message

string

Read canonical position get-for-modification

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

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

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

{
  "success": true,
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "user_id": 1,
    "status": 1,
    "revision": 7,
    "instrument_id": "COPY_EXACT_CATALOG_ID",
    "instrument_type": 2,
    "instrument_topology": 2,
    "position_side": 1,
    "base": "BTC",
    "quote": "USDT",
    "exchange_link_id": 17,
    "margin_mode": 1,
    "leverage": 2,
    "order_grid_enabled": false,
    "open_orders": [
      {
        "row_id": 1,
        "created_at_ms": 1893456000000,
        "price_atomic": "70000",
        "price_scale": 0,
        "quantity_atomic": "1",
        "quantity_scale": 4,
        "executed": [],
        "projected_order_status": 1,
        "order_fsm_state": 2,
        "exchange_submitted": true,
        "slot_id": "SYNTHETIC_CURRENT_OPEN_SLOT",
        "order_id": "33333333-3333-4333-8333-333333333333"
      }
    ],
    "open_order_type": 1,
    "sl_enabled": false,
    "slx_enabled": false,
    "tp_enabled": false,
    "position_fsm_state": 2,
    "created_at": 1893456000,
    "updated_at": 1893456000,
    "tick_step_atomic": "1",
    "tick_step_scale": 1,
    "lot_step_base_atomic": "1",
    "lot_step_base_scale": 4,
    "min_size_base_atomic": "1",
    "min_size_base_scale": 4,
    "contract_value_atomic": "1",
    "contract_value_scale": 2,
    "funding_fee_quote_atomic": "0",
    "funding_fee_quote_scale": 0,
    "alloc_open_executed_atomic": "0",
    "alloc_open_executed_scale": 0,
    "alloc_close_executed_atomic": "0",
    "alloc_close_executed_scale": 0,
    "alloc_net_exposure_atomic": "0",
    "alloc_net_exposure_scale": 0,
    "executed_cost_quote_atomic": "0",
    "executed_cost_quote_scale": 0,
    "next_funding_fee_quote_atomic": "0",
    "next_funding_fee_quote_scale": 0,
    "next_funding_time": 0
  }
}

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

Discovery and account data

Positions and history

Templates

Commands and streams

TradingView webhook

Session-only Settings

Read modification state

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