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
  • string Order Code
  • string Order Type
  • string Instrument
  • number Quantity
  • string Position Effect
  • string Position Code
  • string Side
  • number Price Offset
  • string Price Link
  • string TIF
  • date Expiration Date
  1. REST API Specification
  2. Cash Transaction

Single Order Request

PreviousCash TransactionNextOrder Group Request

Last updated 1 year ago

Field
Value
Type

orderCode

Unique order code that identifies the order on an account

String, required

type

Order type

String, required

instrument

Symbol of the instrument

String, required

quantity

Initial quantity of the order in units (not in lots)

positionEffect

The effect of this order on a position

String, optional

positionCode

ID of a position that should be modified by this order

String, optional

side

Order operation

String, required

limitPrice

Limit order price per unit of quantity. (use stopPrice for stop orders). Should be absent for Market and Stop orders

stopPrice

Stop order price per unit of quantity. (use limitPrice for limit orders). Should be absent for Market and Limit orders

priceOffset

Price offset for protection orders

priceLink

Price link for protection orders

String, optional

tif

Time in force (expiration time for the order)

String, optional

expireDate

Order expiration date in UTC

string Order Code

Order code for new orders is the unique id assigned by the client. The id is expected to be unique among all orders on an account. . For modify order requests the order code can be either a client order id (as assigned by the client during order placement) or an internal code assigned by the system ("action key" of the order chain).

string Order Type

Possible values:

  • MARKET

  • LIMIT

  • STOP

Order type cannot be changed after the order is issued. The value must be omitted in ‘Replace’ requests except group requests, which may contain new orders in Replace requests.

string Instrument

Instrument cannot be changed after the order is issued. In 'Modify' requests instrument must be the same as in original order.

number Quantity

Must be omitted or be zero for a ‘closing’ order linked to a position. In this case the positionCode field must be present and positionEffect should be set to ‘Close’. In this case quantity of the order will equal to the quantity of the position.

string Position Effect

Indicates whether the resulting position after a trade should be a new position or the trade should close an existing position. Required for position-based trading. If the value is ‘Close’, the positionCode field must be present.

Possible values:

  • OPEN

  • CLOSE

string Position Code

ID of a position that should be modified by this order. Used for position based trading. Must be present when positionEffect is ‘Close’ and omitted otherwise.

string Side

Possible values are :

  • BUY

  • SELL

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

string TIF

Time in force (expiration time for the order). One of:

  • GTC (Markets, Limits, Stops)

  • DAY (Limits, Stops)

  • GTD (Limits, Stops, requires the expireDate field)

Default value depends on the platform configuration.

date Expiration Date

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

, optional

, optional

, optional

, optional

, optional

See Client-originated Identifiers
Number
Number
Number
Number
Date