> ## Documentation Index
> Fetch the complete documentation index at: https://docs.liftx.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Get a command receipt
> Read an exact receipt UUID.
Preview contract. Production availability remains subject to activation and release qualification. Examples are synthetic; the documentation cannot submit requests.
## Authorization
Owning integration namespace; alternatively same-account `read` plus the exact authorized link/instrument.
## Behavior
Read an exact receipt UUID. Group detail includes up to 64 child targets; zero-target groups can omit targets. Other-namespace read permission does not grant mutation namespace authority. A receipt state never replaces actual position evidence.
## Request example
```http theme={null}
GET /v1/commands/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](/api/errors-and-limits).
Read the [related guide](/api/commands-and-receipts) for lifecycle, units and recovery semantics.
## OpenAPI
````yaml api/openapi.json GET /v1/commands/get
openapi: 3.1.0
info:
title: Liftx integrations
version: 1.0.0
description: >-
Preview contract for the Liftx API, TradingView webhook and session-owned
integration settings. Production availability is pending activation and
release qualification. External access requires Pro or trial entitlement and
is unmetered within bounded resource limits. Receipt acceptance does not
confirm execution completion. MCP is not active.
servers:
- url: https://api.liftx.io
security: []
paths:
/v1/commands/get:
get:
summary: Read an owned or same-account scoped receipt and bounded group detail
operationId: get_v1_commands_get
parameters:
- name: id
in: query
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Receipt'
examples:
open_handed_off:
summary: Synthetic OPEN owner evidence; not fill completion
description: >-
Synthetic documentation data, not an account snapshot,
executable market configuration or production-availability
assertion. IDs, quantities, prices, times and values are
illustrative.
value:
id: 22222222-2222-4222-8222-222222222222
client_command_id: demo-controller:cycle-001:open
action: open
state: handed_off
position_id: 11111111-1111-4111-8111-111111111111
error_code: null
created_at: 1893456000
updated_at: 1893456001
modify_observed:
summary: Synthetic MODIFY return; inspect current state
description: >-
Synthetic documentation data, not an account snapshot,
executable market configuration or production-availability
assertion. IDs, quantities, prices, times and values are
illustrative.
value:
id: aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa
client_command_id: demo-controller:cycle-001:modify
action: modify
state: execution_observed
position_id: 11111111-1111-4111-8111-111111111111
error_code: null
created_at: 1893456000
updated_at: 1893456002
termination_handed_off:
summary: Synthetic durable close request; not proof of flatness
description: >-
Synthetic documentation data, not an account snapshot,
executable market configuration or production-availability
assertion. IDs, quantities, prices, times and values are
illustrative.
value:
id: bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb
client_command_id: demo-controller:cycle-001:terminate
action: terminate
state: handed_off
position_id: 11111111-1111-4111-8111-111111111111
error_code: null
created_at: 1893456000
updated_at: 1893456003
terminal_request_kind: 1
terminal_request_seq: 1
uncertain_modification:
summary: >-
Synthetic unresolved modification; operator reconciliation
required
description: >-
Synthetic documentation data, not an account snapshot,
executable market configuration or production-availability
assertion. IDs, quantities, prices, times and values are
illustrative.
value:
id: aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa
client_command_id: demo-controller:cycle-001:modify
action: modify
state: operator_required
position_id: 11111111-1111-4111-8111-111111111111
error_code: EXECUTION_UNCERTAIN
created_at: 1893456000
updated_at: 1893456002
partial_group:
summary: Synthetic two-target group with different resolved outcomes
description: >-
Synthetic documentation data, not an account snapshot,
executable market configuration or production-availability
assertion. IDs, quantities, prices, times and values are
illustrative.
value:
id: 99999999-9999-4999-8999-999999999999
client_command_id: signal-a:exit-001
action: terminate
state: partial
position_id: null
error_code: null
created_at: 1893456000
updated_at: 1893456060
group:
target: strategy
target_count: 2
counts:
accepted: 0
dispatching: 0
execution_observed: 0
handed_off: 1
rejected: 0
expired: 1
operator_required: 0
targets:
- id: bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb
client_command_id: >-
liftx-group:99999999-9999-4999-8999-999999999999:11111111-1111-4111-8111-111111111111
action: terminate
state: handed_off
position_id: 11111111-1111-4111-8111-111111111111
error_code: null
created_at: 1893456000
updated_at: 1893456003
terminal_request_kind: 1
terminal_request_seq: 1
group_id: 99999999-9999-4999-8999-999999999999
- id: dddddddd-dddd-4ddd-8ddd-dddddddddddd
client_command_id: >-
liftx-group:99999999-9999-4999-8999-999999999999:cccccccc-cccc-4ccc-8ccc-cccccccccccc
action: terminate
state: expired
position_id: cccccccc-cccc-4ccc-8ccc-cccccccccccc
error_code: COMMAND_EXPIRED
created_at: 1893456000
updated_at: 1893456060
group_id: 99999999-9999-4999-8999-999999999999
empty_group:
summary: Synthetic zero-target capture; does not prove flatness
description: >-
Synthetic documentation data, not an account snapshot,
executable market configuration or production-availability
assertion. IDs, quantities, prices, times and values are
illustrative.
value:
id: 99999999-9999-4999-8999-999999999999
client_command_id: signal-a:exit-001
action: terminate
state: execution_observed
position_id: null
error_code: null
created_at: 1893456000
updated_at: 1893456060
group:
target: strategy
target_count: 0
counts:
accepted: 0
dispatching: 0
execution_observed: 0
handed_off: 0
rejected: 0
expired: 0
operator_required: 0
default:
description: >-
Integration errors use Error; existing trading handlers retain their
own JSON or text/plain error codec. Inspect status and content type.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
text/plain:
schema:
type: string
security:
- ApiKey: []
components:
schemas:
Receipt:
type: object
properties:
id:
type: string
format: uuid
client_command_id:
type: string
action:
type: string
state:
type: string
enum:
- accepted
- dispatching
- handed_off
- execution_observed
- rejected
- expired
- operator_required
- partial
position_id:
anyOf:
- type: string
format: uuid
- type: 'null'
error_code:
anyOf:
- type: string
- type: 'null'
created_at:
type: integer
format: int64
updated_at:
type: integer
format: int64
terminal_request_kind:
type: integer
enum:
- 1
- 2
terminal_request_seq:
type: integer
format: int64
minimum: 1
group_id:
type: string
format: uuid
description: Parent group on a child termination receipt.
group:
$ref: '#/components/schemas/GroupProgress'
targets:
type: array
maxItems: 64
items:
$ref: '#/components/schemas/GroupTargetReceipt'
description: >-
Group detail only: at most 64 frozen ordinary termination receipts.
Targets cannot contain nested groups or target arrays. Omitted on
list responses and zero-target groups.
required:
- id
- client_command_id
- action
- state
- position_id
- error_code
- created_at
- updated_at
additionalProperties: false
description: >-
Durable command receipt, never a fill/completion assertion. Terminal
request fields correlate a durable termination owner handoff. Terminal
arm writes kind/sequence while retaining dispatching; owner return or
startup canonical evidence advances handed_off. Group parent position_id
is null. Precedence is operator_required, dispatching, accepted, then
homogeneous resolved state or partial. Zero-target parent is
execution_observed. Counts and child states do not prove exposure is
flat.
dependentRequired:
terminal_request_kind:
- terminal_request_seq
terminal_request_seq:
- terminal_request_kind
targets:
- group
allOf:
- if:
required:
- group
then:
properties:
position_id:
type: 'null'
action:
const: terminate
not:
anyOf:
- required:
- group_id
- required:
- terminal_request_kind
- required:
- terminal_request_seq
Error:
type: object
properties:
success:
const: false
error:
type: object
properties:
code:
type: string
message:
type: string
required:
- code
- message
additionalProperties: false
required:
- success
- error
additionalProperties: false
GroupProgress:
type: object
properties:
target:
type: string
enum:
- strategy
- market
target_count:
type: integer
minimum: 0
maximum: 64
counts:
type: object
properties:
accepted:
type: integer
minimum: 0
maximum: 64
dispatching:
type: integer
minimum: 0
maximum: 64
execution_observed:
type: integer
minimum: 0
maximum: 64
handed_off:
type: integer
minimum: 0
maximum: 64
rejected:
type: integer
minimum: 0
maximum: 64
expired:
type: integer
minimum: 0
maximum: 64
operator_required:
type: integer
minimum: 0
maximum: 64
required:
- accepted
- dispatching
- execution_observed
- handed_off
- rejected
- expired
- operator_required
additionalProperties: false
required:
- target
- target_count
- counts
additionalProperties: false
description: >-
Counts sum to the immutable target_count. Zero targets records an
observed empty selection, not market flatness.
GroupTargetReceipt:
type: object
description: >-
One captured termination target in a group receipt. Targets are ordinary
command receipts, never nested groups. Each identifies its frozen
position and parent group. Its state and durable terminal-request fields
do not prove exposure is flat.
properties:
id:
type: string
format: uuid
client_command_id:
type: string
action:
type: string
const: terminate
description: Every captured group target is an ordinary termination command.
state:
type: string
enum:
- accepted
- dispatching
- handed_off
- execution_observed
- rejected
- expired
- operator_required
position_id:
type: string
format: uuid
description: Exact position UUID frozen into this group target at admission.
error_code:
anyOf:
- type: string
- type: 'null'
created_at:
type: integer
format: int64
updated_at:
type: integer
format: int64
terminal_request_kind:
type: integer
enum:
- 1
- 2
terminal_request_seq:
type: integer
format: int64
minimum: 1
group_id:
type: string
format: uuid
description: Exact parent group UUID; always present on a captured target.
required:
- id
- client_command_id
- action
- state
- position_id
- error_code
- created_at
- updated_at
- group_id
additionalProperties: false
dependentRequired:
terminal_request_kind:
- terminal_request_seq
terminal_request_seq:
- terminal_request_kind
securitySchemes:
ApiKey:
type: http
scheme: bearer
bearerFormat: lx_api_.<256-bit secret>
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.