Skip to main content
GET
Get close order information and closed position details

Authorizations

x-api-key
string
header
default:lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
required

API key of the application. Only valid together with the x-user-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it. The pair is granted the same permissions the operation's OAuth scopes describe.

Demo credential for trying the API from these docs: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663

x-user-key
string
header
default:eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
required

User-specific authentication key. Only valid together with the x-api-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it.

Demo credential for trying the API from these docs: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_

Headers

x-request-id
string<uuid>
required

A unique request identifier.

Example:

"46e56d40-0db6-4298-9094-5858bd517bc6"

Path Parameters

orderId
integer<int64>
required

The unique identifier of the order.

Response

Close order information retrieved successfully.

Close-order information returned by Admin TAPI, including execution status and the positions affected by the close order.

orderID
integer<int64>
required

Unique identifier of the close order.

CID
integer<int64>
required

Customer account identifier associated with the close order.

statusID
integer<int32>
required

Current internal status identifier of the close order.

orderType
integer<int32>
required

Internal order-type identifier.

operationType
integer<int32>
required

Internal operation-type identifier.

assetCurrencyID
integer<int32>
required

Identifier of the asset currency.

accountCurrencyID
integer<int32>
required

Identifier of the account currency.

instrumentID
integer<int32>
required

Identifier of the instrument associated with the close order.

requestOccurred
string<date-time>
required

UTC timestamp at which the close-order request occurred.

proceeds
number<decimal>
required

Total proceeds calculated across the positions affected by the close order.

externalOperationType
integer<int32>
required

External operation-type identifier; zero when no external operation is associated.

token
string

Correlation token assigned to the request.

referenceID
string | null

External reference identifier associated with the close order, when available.

closeActionType
integer<int32> | null

Internal close-action type, when available.

errorCode
integer<int32> | null

Error code produced while processing the close order, when applicable.

errorMessage
string | null

Error message produced while processing the close order, when applicable.

externalOperationData
string | null

Data associated with the external operation, when available.

positions
object[]

Positions affected by the close order.