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
  1. REST API Specification
  2. Cash Transaction

Instrument

PreviousOrder ResponseNextInstrument Details

Last updated 1 year ago

Field
Value
Type

type

Instrument type as configured on the platform (e.g. INDEX)

String, required

symbol

Unique instrument symbol

String, required

version

Version of the instrument. Numeric value that is increasing with each modification

, required

description

Human-readable description of an instrument

String, required

priceIncrement

Minimum price increment of the instrument (e.g. 0.0001)

, required

pipSize

Size of 1 pip in the system (e.g. 0.001)

, required

currency

Trading currency of the instrument

String, required

lotSize

Lot size of the instrument

, required

multiplier

Multiplier of the instrument

, required

underlying

Symbol of the underlying instrument. Omitted if an instrument has no underlying.

String, optional

product

Symbol of the product instrument (e.g. DJIA ).

String, optional

firstCurrency

For Forex instruments, contains the first currency in the pair (e.g. EUR for EUR/USD)

String, optional

tradingHours

Trading calendar for this instrument

List of objects

currencyType

For Currency instruments contains the currency type(FIAT, CRYPTO_CURRENCY or CRYPTO_TOKEN)

String, optional

Numeric value
Numeric value
Numeric value
Numeric value
Numeric value
Trading Session