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

Position Metrics

PreviousAccount MetricsNextCurrency Metrics

Last updated 1 year ago

Field
Value
Type

version

Numeric version of the account.

, required

positionCode

Unique code of a position

String, required

symbol

Symbol of the position’s instrument

String, required

quantity

Current quantity of the position in units (not in lots); signed value

, required

quantityNotional

Current quantity of the position in notional units (not in lots); signed value

, required

rate

Rate used to calculate FPL (the "opposite" from the position, Bid for long positions, Ask for Short positions multiplied by conversion rate from instrument’s currency to account’s base currency)

, required

fpl

Floating profit-loss in account’s base currency

, required

convRate

Current conversion rate from the instrument’s currency to account’s base currency

, required

bidOpen

Bid price of the instrument at the moment of position opening.

, required

askOpen

Ask price of the instrument at the moment of position opening.

, required

margin

Margin in account’s base currency

, required

openPrice

Average price for a position in account currency

, required

openPriceInstrumentCcy

Average price for a position in instrument currency

, required

fplInstrumentCcy

Floating profit-loss in instrumnet’s base currency

, required

instrumentCurrency

Instrumnet’s base currency symbol

String, required

currentPriceInstrumentCcy

Current instrument price from the raw LP feed (only for offset accounts)

, *optional**

Number
Number
Number
Number
Number
Number
Number
Number
Number
Number
Number
Number
Number