Sway Charts API Documentation
  • REST API Specification
    • Getting Started
      • Introduction
      • Errors
      • API Versioning
      • Conditional Requests & Updates
      • Entity Versioning
      • Data Types and Formats
      • Rate Limits & Throttling
    • Authentication & Authorization
      • HMAC Authentication
      • POST Create Session Token
      • POST Ping
      • POST Logout
    • Trading
      • POST Place Order
      • PUT Modify Order
      • DELETE Cancel Order
    • Reference Data
      • GET List Instruments
      • List Instrument Details
    • Users and Accounts
      • GET Get Users
      • GET List Account Portfolio
      • GET List Open Positions
      • GET List Open Orders
      • GET List Cash Transfers
      • GET POST List Orders
      • GET List Account Metrics
      • GET List Account Events
    • Market Data
      • POST Request Market Data
    • Conversion Rates
      • POST Get Conversion Rates
    • Cash Transaction
      • Single Order Request
      • Order Group Request
      • Order Response
      • Instrument
      • Instrument Details
      • Trading Session
      • Limit Value
      • Margin Rate
      • Margin Tier
      • User Details
      • Account Details
      • Account Portfolio
      • Balance
      • Position
      • Order
      • Order Leg
      • Execution
      • Cash Transfer
      • Historic Order List
      • Account Metrics
      • Position Metrics
      • Currency Metrics
      • Account Event
      • Market Data Request
      • Market Data Event Type
      • Market Data List
      • Quote
      • Candle
      • Conversion Rate
    • Revision History
Powered by GitBook
On this page
  • number Order Id
  • string Order Code
  • string Order Type
  • string TIF
  • number Price Offset
  • string Price Link
  • date Expiration Date
  • Links
  • Executions
  1. REST API Specification
  2. Cash Transaction

Order

Field
Value
Type

account

Unique code of the account

orderId

Internal numeric id of an order chain in the system

orderCode

Internal unique string code of an order chain in the system

String, required

version

Numeric version of the account.

clientOrderId

Unique order id assigned by the client during order placement

actionCode

Internal unique code of the last order modification

String, required

legCount

Always 1

type

Order type

String, required

instrument

Symbol of the order’s instrument

String, required

status

Status of the order

finalStatus

Boolean value indicating if order is in final state

Boolean, required

legs

List of exactly 1 order leg

side

Side of the order. Either BUY (long) or SELL (short)

String, required

tif

Time in force (expiration time for the order)

String, required

priceOffset

Price offset for protection orders

priceLink

Price link for protection orders

String, optional

expireDate

Order expiration date in UTC

Date, optional

openTime

Timestamp in UTC when this position was opened

Timestamp, required

openPrice

Price at which the position was opened

marginRate

Order margin rate

issueTime

Timestamp in UTC when this order was accepted by the system

Date, required

transactionTime

Timestamp in UTC of the last order modification or fill

Date, required

links

List of the links between this order and other orders in its group

Order Link, optional

executions

List of all executions for this order

cashTransactions

List of all cash transactions related to this order. Reports are ordered chronologically.

hedgedOrderId

For broker orders, a numeric id of the client order this order hedges. Included only for Dealer users

externalOrderId

For broker orders, order id at the liquidity provider. Included only for Dealer users

String, optional

number Order Id

This value is assigned when an order is initially placed and does not change when an order is replaced or cancelled.

string Order Code

This value is assigned when an order is initially placed and does not change when an order is replaced or cancelled.

number Version

Numeric version of the account to which last update of this order is related. Client can use this value to find out which of the updates is more recent (its version is greater).

string Order Type

Possible values:

  • MARKET

  • LIMIT

  • STOP

string TIF

One of:

  • GTC (Markets, Limits, Stops)

  • DAY (Limits, Stops)

  • GTD (Limits, Stops, in this case the expireDate field will be present)

number Price Offset

Price offset for protection orders. When parent order is triggered, either stop or limit price of protection order will be taken from parent trigger order's fill price with price offset. If this value is not null, the priceLink field must be present.

string Price Link

Price link for protection orders. Possible values:

  • TRIGGERED_STOP - stop price of the order will be taken from parent trigger order's fill price

  • TRIGGERED_LIMIT - limit price of the order will be taken from parent trigger order's fill price

date Expiration Date

Order expiration date in UTC. Must be present if the tif field is GTD. Otherwise, must be omitted.

Links

Absent if the order is not a part of a group. Links are calculated only for the 'list-open-orders' request.

Executions

List of all executions for this order. This includes order status changes, replaces, cancels and trades. Reports are ordered chronologically.

PreviousPositionNextOrder Leg

Last updated 1 year ago

, required

, required

, required

, required

, required

, required

, required

, optional

, required

, optional

, optional

, optional

, optional

Account code
Number
Number
Client Id
Number
Order Status
Order Leg
Number
Number
Number
Cash Transaction
Number
Execution