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

Account Metrics

PreviousHistoric Order ListNextPosition Metrics

Last updated 1 year ago

CtrlK
Field
Value
Type

account

Unique code of the account

Account code, required

version

Numeric version of the account.

Number, required

equity

Balance + Floating Profit/Loss

Number, required

balance

Total balance of the account in account’s base currency

Number, required

availableBalance

Total balance available for withdrawal in account’s base currency

Number, required

availableFunds

Funds available for trading in the account’s base currency

, required

allocatedFunds

Total funds allocated to hold the current portfolio of product positions and / or orders for the whole account

, required

marginFree

Free margin (Equity - Margin)

, required

openPl

Open (Unrealized) Profit/Loss

, required

totalPl

Total PnL on the account

, required

margin

Used margin

, required

openPositionsCount

Number of open (non-zero quantity) positions

, required

openOrdersCount

Number of order chains in non-final state

, required

positions

If requested, contains a list of per-position metrics

, *optional**

balances

If requested, contains a list of individual currency position metrics (balance metrics)

, *optional**

Number
Number
Number
Number
Number
Number
Number
Number
Position metrics
Balance metrics