Menu

xAPI
Protocol Documentation

Version 2.3.4

  1. Introduction

    This document presents information on API communication protocol. The communication protocol of the API uses JSON format.

    JSON format used by the server doesn't allow extensions (e.g. comments, other flags). JSON format standardization document is available under the following link: http://tools.ietf.org/html/rfc4627.

    The connection is performed by clean socket connection. For real trading SSL connection will be used.

  2. Definitions

    The following definitions will be used in this specification document:

    • simple type: type, which value is itself: int, int64, string, double, bool;
    • j-value (JSON value): any simple type, j-object or j-array;
    • j-object (JSON object): a record containing any number of named j-values (pair );
    • j-array (JSON array): an array where each element is j-value;
    • j-subvalue: j-value which is a component of a j-object.

    A j-object can contain zero elements. A j-array can have zero length. The name of j-value can be an empty string.

    Encoding of strings is set to UTF-8. In this format the server sends and receives data.

    Definition of unix-time:

    Unix time, or POSIX time, is a system for describing points in time, defined as the number of milliseconds elapsed since midnight Coordinated Universal Time (UTC) of January 1, 1970.
  3. General data format

    Each packet consists of exactly one main, unnamed j-value. The data stream consists of consecutive j–values, with no punctuation.

    The main j-value is a j-object containing exactly two j-subvalues which are j-objects. The first j-subobject is named header and consists of at least a field type as a simple type string. This is a packet type. The second j-subobject of the main packet j-object is named data and its content is specific to a given packet type. The specifications for different types of packages are described in the next chapter.

    A sample of properly defined packet:

    {
    	"command" : "login",
    	"arguments" : {
    		"userId" : "1000",
    		"password": "PASSWORD"
    	}
    }

    Every single command sent to the API is allowed to contain an optional field called customTag. The API guarantees to return the very same customTag in the command’s response. For example, the following command:

    {
    	"command" : "login",
    	"arguments" : {
    		"userId" : "1000",
    		"password": "PASSWORD"
    	},
    	"customTag": "my_login_command_id"
    }

    returns (in case of a successful login):

    {
    	"status": true,
    	"customTag": "my_login_command_id"
    }
  4. Communication with the API

    There are two IPs, that can be used interchangeably:

    • xapia.x-station.eu
    • xapib.x-station.eu

    Here are the addresses of DEMO and REAL servers:

    • DEMO: main port: 5124, streaming port: 5125,
    • REAL: main port: 5112, streaming port: 5113.

    Furthermore, WebSockets can be used to connect to the API using the following addresses:

    • wss://62.181.0.153:8079/demo
    • wss://62.181.0.153:8079/demoStreaming
    • wss://62.181.0.153:8079/real
    • wss://62.181.0.153:8079/reaLStreaming

    All servers use SSL connection.

    Communication is established as long as both server and client have opened and connected sockets.

    For convenience server guarantees that every separate reply to client command returned by server will be separated by two new line characters ("\n").

    1. Connection validation

      In order to provide best service for all users API set rules on connection and data send process. If any of the following rules is breached, then connection is closed immediately without server notification.

      List of rules:

      • At most 50 simultaneous connections from the same client address are allowed. If you need this rule can be lenified please contact the xStore Support Team.
      • Every new connection that fails to deliver data within one second from when it is established may be forced to close with no notification.
      • Each command invocation should not contain more than 1kB of data.
      • User should send requests in 200 ms intervals. This rule can be broken, but if it happens 6 times in a row the connection is dropped.
      • Each command should be a proper JSON object.

      Exception:

      If the client sends a request that is a valid JSON object, but does not conform to the published API (incorrect command, missing fields, etc.), the response is sent back with the error description but the connection is not closed.

      This rule prevents incorrect messages from reaching further down the processing chain and allows clients to analyze and understand the source of problem.

    2. Default login credentials

      Default login credentials can be obtained at: http://developers.xstore.pro/panel/.

    3. Input data format

      The input data format is a JSON object that consists of service name and command name. Some commands also require an object of command's arguments.

      If optional prettyPrint field is set to true, an output JSON is printed in human-readable format. prettyPrint field can be omitted.

      {
      	"command": "commandName",
      	"arguments": {
      		"arg1Name": 10,
      		"arg2Name": "Some text",
      		...
      	},
      	"prettyPrint": true
      }
    4. Output data format

      The output data format is a JSON object that consists of status and returnData fields if command succeeded, or status, errorCode and errorDescr fields if an error occurred.

      {
      	"status": true,
      	"returnData": JSON value
      }

      or, in case of an error:

      {
      	"status": false,
      	"errorCode": "E123",
      	"errorDescr": "Error description"
      }
    5. Time format

      Time is number of milliseconds from 01.01.1970, 00:00 GMT.

    6. Floating number format

      In all Floating numbers '.' (period) is used as a decimal separator.

  5. Available commands

    Request-Reply commands are performed on main connection socket. The reply is sent by main connection socket.

    1. Login

      In order to perform any action client application have to perform login process. No functionality is available before proper login process.

      After initial login, a new session is created and all commands are executed for a logged user until he/she logs out or drops the connection.

      Request:

      Parameters:

      NameTypeDesc
      userIdStringuserId
      passwordStringpassword
      appIdString(optional) application ID provided by the xStore Support Team
      appNameString(optional) application name

      Example:

      {
      	"command": "login",
      	"arguments": {
      		"userId": "1000",
      		"password": "PASSWORD",
      		"appId": "test",
      		"appName": "test"
      	}
      }
      

      After successful login the system responds with the status message that can contain the String representing streamSessionId field:

      
      {
      	"status": true,
      	"streamSessionId": "8469308861804289383"
      }
      
      

      Alternatively, when redirect is needed, the system responds with:

      {
      	"status": false,
      	"redirect": REDIRECT_RECORD (optional)
      }
      
      

      Format of REDIRECT_RECORD:

      nametypedescription
      mainPortNumberMain port for communication
      streamingPortNumberstreaming port
      addressStringaddress that the user should reconnect to in order to login

      Example:

      {
      	"mainPort": 1234,
      	"streamingPort": 1235,
      	"address": "xapia.x-station.eu"
      }
      

      The status of the correct login process is true. If the status is false, REDIRECT_RECORD may be present which defines the server that the user should log into instead of the current one. It is assumed that when using REDIRECT_RECORD data, secure connection (SSL) should be used.

      The streamSessionId field of the string type, if present, is a token that can be used to establish a streaming subscription on a separate network connection. streamSessionId is used in streaming subscription commands.

      streamSessionId is unique for the given main session and will change between login sessions.

    2. Logout

      Format of input:

      {
      	"command": "logout"
      }
      

      No returnData field in output. Only status message is sent.

    3. Retrieving trading data

      1. Command: getAllSymbols

        Description: Returns array of all symbols available for the user.

        Request:

        Example:

        {
        	"command": "getAllSymbols"
        }
        Response:

        Parameters:

        nametypedescription
        arrayArray of SYMBOL_RECORD

        Example:

        {
        	"status": true,
        	"returnData" : [SYMBOL_RECORD, SYMBOL_RECORD, ...]	
        }

        Format of SYMBOL_RECORD:

        Please be advised that result values for profit and margin calculation can be used optionally, because server is able to perform all profit/margin calculations for Client application by commands described later in this document.

        nametypedescription
        askFloating numberAsk price in account currency
        bidFloating numberBid price in account currency
        categoryNameStringCategory name
        contractSizeNumberSize of 1 lot
        currencyStringCurrency
        currencyPairBooleanIndicates whether the symbol represents a currency pair
        currencyProfitStringThe currency of calculated profit
        descriptionStringDescription
        expirationTimeNull if not applicable
        groupNameStringGroup name
        highFloating numberThe highest price in account currency
        initialMarginNumberInitial margin for 1 lot order, used for profit/margin calculation
        instantMaxVolumeNumberMaximum instant volume multiplied by 100 (in lots)
        leverageNumberSymbol leverage
        longOnlyBooleanLong only
        lotMaxFloating numberMaximum size of trade
        lotMinFloating numberMinimum size of trade
        lotStepFloating numberA value of minimum step by which the size of trade can be changed (within lotMin - lotMax range)
        lowFloating numberThe lowest price in account currency
        marginHedgedNumberUsed for profit calculation
        marginHedgedStrongBooleanFor margin calculation
        marginMaintenanceNumberFor margin calculation, null if not applicable
        marginModeNumberFor margin calculation
        percentageFloating numberPercentage
        precisionNumberNumber of symbol's price decimal places
        profitModeNumberFor profit calculation
        quoteIdNumberSource of price
        startingTimeNull if not applicable
        stopsLevelNumberStop level
        swap_rollover3daysNumberTime when additional swap is accounted for weekend
        swapEnableBooleanIndicates whether swap value is added to position on end of day
        swapLongFloating numberSwap value for long positions in account currency
        swapShortFloating numberSwap value for short positions in account currency
        swapTypeNumberType of swap calculated
        symbolStringSymbol name or null for deposit/withdrawal operations
        tickSizeFloating numberSmallest possible price change, used for profit/margin calculation, null if not applicable
        tickValueFloating numberValue of smallest possible price change, used for profit/margin calculation, null if not applicable
        timeTimeAsk & bid tick time
        timeStringStringTime in String
        typeNumberInstrument class number

        Example:

        {
        	"ask": 4000.0,
        	"bid": 4000.0,
        	"categoryName": "Forex",
        	"contractSize": 100000,
        	"currency": "USD",
        	"currencyPair": true,
        	"currencyProfit": "SEK",
        	"description": "USD/PLN",
        	"expiration": null,
        	"groupName": "Minor",
        	"high": 4000.0,
        	"initialMargin": 0,
        	"instantMaxVolume": 0,
        	"leverage": 1,
        	"longOnly": false,
        	"lotMax": 10.0,
        	"lotMin": 0.1,
        	"lotStep": 0.1,
        	"low": 3500.0,
        	"marginHedged": 0,
        	"marginHedgedStrong": false,
        	"marginMaintenance": null,
        	"marginMode": 4,
        	"percentage": 0.1,
        	"precision": 2,
        	"profitMode": 1,
        	"quoteId": 1,
        	"starting": null,
        	"stopsLevel": 0,
        	"swap_rollover3days": 0,
        	"swapEnable": true,
        	"swapLong": -2.55929,
        	"swapShort": 0.131,
        	"swapType": 0,
        	"symbol": "USDPLN",
        	"tickSize": 1.0,
        	"tickValue": 1.0,
        	"time": 1272446136891,
        	"timeString": "Thu May 23 12:23:44 EDT 2013",
        	"type": 21
        }

        Possible values of quoteId field:

        namevaluedescription
        fixed1fixed
        float2float
        depth3depth
        cross4cross
      2. Command: getCalendar

        Description: Returns calendar with market events.

        Request:

        Example:

        {
        	"command": "getCalendar"
        }
        Response:

        Parameters:

        nametypedescription
        arrayArray of CALENDAR_RECORD

        Example:

        {
        	"status": true,
        	"returnData" : [CALENDAR_RECORD, CALENDAR_RECORD, ...]	
        }

        Format of CALENDAR_RECORD:

        nametypedescription
        countryStringTwo letter country code
        currentStringMarket value (current), empty before time of release of this value (time from "time" record)
        forecastStringForecasted value
        impactStringImpact on market
        periodStringInformation period
        previousStringValue from previous information release
        timeTimeTime, when the information will be released (in this time empty "current" value should be changed with exact released value)
        titleStringName of the indicator for which values will be released

        Example:

        {
        	"country": "CA",
        	"current": "",
        	"forecast": "",
        	"impact": "3",
        	"period": "(FEB)",
        	"previous": "58.3",
        	"time": 1374846900000,
        	"title": "Ivey Purchasing Managers Index"
        }

        Possible values of impact field:

        namevaluedescription
        low1low
        medium2medium
        high3high
      3. Command: getChartLastRequest

        Description: Returns chart info, from start date to the current time. If the chosen period of CHART_LAST_INFO_RECORD is greater than 1 minute, the last candle returned by the API can change until the end of the period (the candle is being automatically updated every minute).

        Request:

        Parameters:

        nametypedescription
        infoCHART_LAST_INFO_RECORDinfo

        Example:

        {
        	"command": "getChartLastRequest",
        	"arguments": {
        		"info": CHART_LAST_INFO_RECORD
        	}
        }

        Format of CHART_LAST_INFO_RECORD:

        nametypedescription
        periodNumberPeriod code
        startTimeStart of chart block
        symbolStringSymbol

        Example:

        {
        	"period": 5,
        	"start": 1262944112000,
        	"symbol": "PKN.PL"
        }

        Possible values of period field:

        namevaluedescription
        PERIOD_M111 minute
        PERIOD_M555 minutes
        PERIOD_M151515 minutes
        PERIOD_M303030 minutes
        PERIOD_H16060 minutes (1 hour)
        PERIOD_H4240240 minutes (4 hours)
        PERIOD_D114401440 minutes (1 day)
        PERIOD_W11008010080 minutes (1 week)
        PERIOD_MN14320043200 minutes (30 days)
        Response:

        Parameters:

        nametypedescription
        digitsNumberprice precision
        rateInfosarrayArray of RATE_INFO_RECORD

        Example:

        {
        	"status": true,
        	"returnData" : {
        		"digits": 2,
        		"rateInfos": [RATE_INFO_RECORD, RATE_INFO_RECORD, ...]
        	}	
        }

        Format of RATE_INFO_RECORD:

        Price values must be divided by 10 to the power of digits in order to obtain exact prices.

        Ticks field - if ticks is not set or value is 0, getChartRangeRequest work as before (you must send valid start and end time fields).
        If ticks value is not equal to 0, field end is ignored.
        If ticks >0 (e.g. N) then API returns N candles from time start.
        If ticks <0 then API returns N candles to time start.
        It is possible for API to return fewer chart candles than set in tick field.

        nametypedescription
        closeFloating numberValue of close price (shift from open price)
        ctmTimeCandle start time in CET time zone (Central European Time)
        ctmStringStringString representation of the 'ctm' field
        highFloating numberHighest value in the given period (shift from open price)
        lowFloating numberLowest value in the given period (shift from open price)
        openFloating numberOpen price
        volFloating numberVolume in lots

        Example:

        {
        	"close": 1.0,
        	"ctm": 1378369375000,
        	"ctmString": "Sep 05, 2013 10:22:55 AM",
        	"high": 6.0,
        	"low": 0.0,
        	"open": 41848.0,
        	"vol": 0.0
        }
      4. Command: getChartRangeRequest

        Description: Returns chart info with data between given start and end dates. Method retrieves two oldest RATE_INFO_RECORD in case no data is available for selected period.

        Request:

        Parameters:

        nametypedescription
        infoCHART_RANGE_INFO_RECORDinfo

        Example:

        {
        	"command": "getChartRangeRequest",
        	"arguments": {
        		"info": CHART_RANGE_INFO_RECORD
        	}
        }

        Format of CHART_RANGE_INFO_RECORD:

        nametypedescription
        endTimeEnd of chart block
        periodNumberPeriod code
        startTimeStart of chart block
        symbolStringSymbol
        ticksNumberNumber of ticks needed, this field is optional, please read description below

        Example:

        {
        	"end": 1262944412000,
        	"period": 5,
        	"start": 1262944112000,
        	"symbol": "PKN.PL",
        	"ticks": 0
        }

        Possible values of period field:

        namevaluedescription
        PERIOD_M111 minute
        PERIOD_M555 minutes
        PERIOD_M151515 minutes
        PERIOD_M303030 minutes
        PERIOD_H16060 minutes (1 hour)
        PERIOD_H4240240 minutes (4 hours)
        PERIOD_D114401440 minutes (1 day)
        PERIOD_W11008010080 minutes (1 week)
        PERIOD_MN14320043200 minutes (30 days)
        Response:

        Parameters:

        nametypedescription
        digitsNumberprice precision
        rateInfosarrayArray of RATE_INFO_RECORD

        Example:

        {
        	"status": true,
        	"returnData" : {
        		"digits": 2,
        		"rateInfos": [RATE_INFO_RECORD, RATE_INFO_RECORD, ...]
        	}	
        }

        Format of RATE_INFO_RECORD:

        Price values must be divided by 10 to the power of digits in order to obtain exact prices.

        Ticks field - if ticks is not set or value is 0, getChartRangeRequest work as before (you must send valid start and end time fields).
        If ticks value is not equal to 0, field end is ignored.
        If ticks >0 (e.g. N) then API returns N candles from time start.
        If ticks <0 then API returns N candles to time start.
        It is possible for API to return fewer chart candles than set in tick field.

        nametypedescription
        closeFloating numberValue of close price (shift from open price)
        ctmTimeCandle start time in CET time zone (Central European Time)
        ctmStringStringString representation of the 'ctm' field
        highFloating numberHighest value in the given period (shift from open price)
        lowFloating numberLowest value in the given period (shift from open price)
        openFloating numberOpen price
        volFloating numberVolume in lots

        Example:

        {
        	"close": 1.0,
        	"ctm": 1378369375000,
        	"ctmString": "Sep 05, 2013 10:22:55 AM",
        	"high": 6.0,
        	"low": 0.0,
        	"open": 41848.0,
        	"vol": 0.0
        }
      5. Command: getCommissionDef

        Description: Returns calculation of commission and rate of exchange. The value is calculated as expected value, and therefore might not be perfectly accurate.

        Request:

        Parameters:

        nametypedescription
        symbolStringsymbol
        volumeFloating numbervolume

        Example:

        {
        	"command": "getCommissionDef",
        	"arguments": {
        		"symbol": "T.US",
        		"volume": 1.0
        	}
        }
        Response:

        Parameters:

        nametypedescription
        commissionFloating numbercalculated commission in account currency, could be null if not applicable
        rateOfExchangeFloating numberrate of exchange between account currency and instrument base currency, could be null if not applicable

        Example:

        {
        	"status": true,
        	"returnData" : {
        		"commission": 0.51,
        		"rateOfExchange": 0.1609
        	}	
        }
      6. Command: getCurrentUserData

        Description: Returns information about account currency, and account leverage.

        Request:

        Example:

        {
        	"command": "getCurrentUserData"
        }
        Response:

        Parameters:

        nametypedescription
        currencyStringaccount currency
        groupStringgroup
        leverageNumberLeverage for account. Leverage is used for margin calculation for Forex instruments.
        leverageMultiplierFloating numberleverageMultiplier

        Example:

        {
        	"status": true,
        	"returnData" : {
        		"currency": "PLN",
        		"group": "demoPLeurSTANDARD200",
        		"leverage": 1,
        		"leverageMultiplier": 0.25
        	}	
        }
      7. Command: getMarginLevel

        Description: Returns margin level for account.

        Request:

        Example:

        {
        	"command": "getMarginLevel"
        }
        Response:

        Parameters:

        nametypedescription
        balanceFloating numberbalance in account currency
        currencyStringuser currency
        equityFloating numbersum of balance and all profits in account currency
        marginFloating numbermargin requirements in account currency
        margin_freeFloating numberfree margin in account currency
        margin_levelFloating numbermargin level in account currency

        Example:

        {
        	"status": true,
        	"returnData" : {
        		"balance": 995800269.43,
        		"currency": "PLN",
        		"equity": 995985397.56,
        		"margin": 572634.43,
        		"margin_free": 995227635.00,
        		"margin_level": 173930.41
        	}	
        }
      8. Command: getMarginTrade

        Description: Returns expected margin for given instrument and volume. The value is calculated as expected margin value, and therefore might not be perfectly accurate.

        Request:

        Parameters:

        nametypedescription
        symbolStringsymbol
        volumeFloating numbervolume

        Example:

        {
        	"command": "getMarginTrade",
        	"arguments": {
        		"symbol": "EURPLN",
        		"volume": 1.0
        	}
        }
        Response:

        Parameters:

        nametypedescription
        marginFloating numbercalculated margin in account currency

        Example:

        {
        	"status": true,
        	"returnData" : {
        		"margin": 4399.350
        	}	
        }
      9. Command: getNews

        Description: Returns news from trading server which were sent within specified period of time.

        Request:

        Parameters:

        nametypedescription
        endTimeTime, 0 means current time for simplicity
        startTimeTime

        Example:

        {
        	"command": "getNews",
        	"arguments": {
        		"end": 0,
        		"start": 1275993488000
        	}
        }
        Response:

        Parameters:

        nametypedescription
        arrayArray of NEWS_TOPIC_RECORD

        Example:

        {
        	"status": true,
        	"returnData" : [NEWS_TOPIC_RECORD, NEWS_TOPIC_RECORD, ...]	
        }

        Format of NEWS_TOPIC_RECORD:

        nametypedescription
        bodyStringBody
        bodylenNumberBody length
        keyStringNews key
        timeTimeTime
        timeStringStringTime string
        titleStringNews title

        Example:

        {
        	"body": "<html>...</html>",
        	"bodylen": 110,
        	"key": "1f6da766abd29927aa854823f0105c23",
        	"time": 1262944112000,
        	"timeString": "May 17, 2013 4:30:00 PM",
        	"title": "Breaking trend"
        }
      10. Command: getProfitCalculation

        Description: Calculates estimated profit for given deal data Should be used for calculator-like apps only. Profit for opened transactions should be taken from server, due to higher precision of server calculation.

        Request:

        Parameters:

        nametypedescription
        closePriceFloating numbertheoretical close price of order
        cmdNumberOperation code
        openPriceFloating numbertheoretical open price of order
        symbolStringsymbol
        volumeFloating numbervolume

        Example:

        {
        	"command": "getProfitCalculation",
        	"arguments": {
        		"closePrice": 1.3000,
        		"cmd": 0,
        		"openPrice": 1.2233,
        		"symbol": "EURPLN",
        		"volume": 1.0
        	}
        }

        Possible values of cmd field:

        namevaluedescription
        BUY0buy
        SELL1sell
        BUY_LIMIT2buy limit
        SELL_LIMIT3sell limit
        BUY_STOP4buy stop
        SELL_STOP5sell stop
        BALANCE6Read only. Used in getTradesHistory for manager's deposit/withdrawal operations (profit>0 for deposit, profit<0 for withdrawal).
        Response:

        Parameters:

        nametypedescription
        profitFloating numberProfit in account currency

        Example:

        {
        	"status": true,
        	"returnData" : {
        		"profit": 714.303
        	}	
        }
      11. Command: getServerTime

        Description: Returns current time on trading server.

        Request:

        Example:

        {
        	"command": "getServerTime"
        }
        Response:

        Parameters:

        nametypedescription
        timeTimeTime
        timeStringStringTime described in form set on server (local time of server)

        Example:

        {
        	"status": true,
        	"returnData" : {
        		"time": 123456789,
        		"timeString": "Oct 25, 2012 3:39:53 PM"
        	}	
        }
      12. Command: getSymbol

        Description: Gets information about symbol available for the user.

        Request:

        Parameters:

        nametypedescription
        symbolStringsymbol

        Example:

        {
        	"command": "getSymbol",
        	"arguments": {
        		"symbol": "EURPLN"
        	}
        }
        Response:

        Parameters:

        nametypedescription
        SYMBOL_RECORDSYMBOL_RECORD

        Example:

        {
        	"status": true,
        	"returnData" : SYMBOL_RECORD	
        }

        Format of SYMBOL_RECORD:

        Please be advised that result values for profit and margin calculation can be used optionally, because server is able to perform all profit/margin calculations for Client application by commands described later in this document.

        nametypedescription
        askFloating numberAsk price in account currency
        bidFloating numberBid price in account currency
        categoryNameStringCategory name
        contractSizeNumberSize of 1 lot
        currencyStringCurrency
        currencyPairBooleanIndicates whether the symbol represents a currency pair
        currencyProfitStringThe currency of calculated profit
        descriptionStringDescription
        expirationTimeNull if not applicable
        groupNameStringGroup name
        highFloating numberThe highest price in account currency
        initialMarginNumberInitial margin for 1 lot order, used for profit/margin calculation
        instantMaxVolumeNumberMaximum instant volume multiplied by 100 (in lots)
        leverageNumberSymbol leverage
        longOnlyBooleanLong only
        lotMaxFloating numberMaximum size of trade
        lotMinFloating numberMinimum size of trade
        lotStepFloating numberA value of minimum step by which the size of trade can be changed (within lotMin - lotMax range)
        lowFloating numberThe lowest price in account currency
        marginHedgedNumberUsed for profit calculation
        marginHedgedStrongBooleanFor margin calculation
        marginMaintenanceNumberFor margin calculation, null if not applicable
        marginModeNumberFor margin calculation
        percentageFloating numberPercentage
        precisionNumberNumber of symbol's price decimal places
        profitModeNumberFor profit calculation
        quoteIdNumberSource of price
        startingTimeNull if not applicable
        stopsLevelNumberStop level
        swap_rollover3daysNumberTime when additional swap is accounted for weekend
        swapEnableBooleanIndicates whether swap value is added to position on end of day
        swapLongFloating numberSwap value for long positions in account currency
        swapShortFloating numberSwap value for short positions in account currency
        swapTypeNumberType of swap calculated
        symbolStringSymbol name or null for deposit/withdrawal operations
        tickSizeFloating numberSmallest possible price change, used for profit/margin calculation, null if not applicable
        tickValueFloating numberValue of smallest possible price change, used for profit/margin calculation, null if not applicable
        timeTimeAsk & bid tick time
        timeStringStringTime in String
        typeNumberInstrument class number

        Example:

        {
        	"ask": 4000.0,
        	"bid": 4000.0,
        	"categoryName": "Forex",
        	"contractSize": 100000,
        	"currency": "USD",
        	"currencyPair": true,
        	"currencyProfit": "SEK",
        	"description": "USD/PLN",
        	"expiration": null,
        	"groupName": "Minor",
        	"high": 4000.0,
        	"initialMargin": 0,
        	"instantMaxVolume": 0,
        	"leverage": 1,
        	"longOnly": false,
        	"lotMax": 10.0,
        	"lotMin": 0.1,
        	"lotStep": 0.1,
        	"low": 3500.0,
        	"marginHedged": 0,
        	"marginHedgedStrong": false,
        	"marginMaintenance": null,
        	"marginMode": 4,
        	"percentage": 0.1,
        	"precision": 2,
        	"profitMode": 1,
        	"quoteId": 1,
        	"starting": null,
        	"stopsLevel": 0,
        	"swap_rollover3days": 0,
        	"swapEnable": true,
        	"swapLong": -2.55929,
        	"swapShort": 0.131,
        	"swapType": 0,
        	"symbol": "USDPLN",
        	"tickSize": 1.0,
        	"tickValue": 1.0,
        	"time": 1272446136891,
        	"timeString": "Thu May 23 12:23:44 EDT 2013",
        	"type": 21
        }

        Possible values of quoteId field:

        namevaluedescription
        fixed1fixed
        float2float
        depth3depth
        cross4cross
      13. Command: getTickPrices

        Description: Returns array of current quotations for given symbols, only quotations that changed from given timestamp are returned. New timestamp obtained from output will be used as an argument of the next call of this command.

        Request:

        Parameters:

        nametypedescription
        levelNumberprice level
        symbolsarrayArray of symbol names (Strings)
        timestampTimetimestamp

        Example:

        {
        	"command": "getTickPrices",
        	"arguments": {
        		"level": 0,
        		"symbols": ["EURPLN", "AGO.PL", ...],
        		"timestamp": 1262944112000
        	}
        }

        Possible values of level field:

        namevaluedescription
        -1all available levels
        0base level bid and ask price for instrument
        >0specified level
        Response:

        Parameters:

        nametypedescription
        quotationsarrayArray of TICK_RECORD

        Example:

        {
        	"status": true,
        	"returnData" : {
        		"quotations": [TICK_RECORD, TICK_RECORD, ...]
        	}	
        }

        Format of TICK_RECORD:

        nametypedescription
        askFloating numberAsk price in account currency
        askVolumeNumberNumber of available lots to buy at given price or null if not applicable
        bidFloating numberBid price in account currency
        bidVolumeNumberNumber of available lots to buy at given price or null if not applicable
        highFloating numberThe highest price in account currency
        levelNumberPrice level
        lowFloating numberThe lowest price in account currency
        spreadRawFloating numberThe difference between raw ask and bid prices
        spreadTableFloating numberSpread representation
        symbolStringSymbol
        timestampTimeTimestamp

        Example:

        {
        	"ask": 4000.0,
        	"askVolume": 15000,
        	"bid": 4000.0,
        	"bidVolume": 16000,
        	"high": 4000.0,
        	"level": 0,
        	"low": 3500.0,
        	"spreadRaw": 0.000003,
        	"spreadTable": 0.00042,
        	"symbol": "KOMB.CZ",
        	"timestamp": 1272529161605
        }

        Possible values of level field:

        namevaluedescription
        -1all available levels
        0base level bid and ask price for instrument
        >0specified level
      14. Command: getTradeRecords

        Description: Returns array of trades listed in orders argument.

        Request:

        Parameters:

        nametypedescription
        ordersarrayArray of orders (integers)

        Example:

        {
        	"command": "getTradeRecords",
        	"arguments": {
        		"orders": [7489839, 7489841, ...]
        	}
        }
        Response:

        Parameters:

        nametypedescription
        arrayArray of TRADE_RECORD

        Example:

        {
        	"status": true,
        	"returnData" : [TRADE_RECORD, TRADE_RECORD, ...]	
        }

        Format of TRADE_RECORD:

        cmd is the operation code, for user's trade operations it equals to cmd from TRADE_TRANS_INFO record used as an argument in tradeTransaction command

        nametypedescription
        close_priceFloating numberClose price in account currency
        close_timeTimeNull if order is not closed
        close_timeStringStringNull if order is not closed
        closedBooleanClosed
        cmdNumberOperation code
        commentStringComment
        commissionFloating numberCommission in account currency
        customCommentStringThe value the customer may provide in order to retrieve it later.
        digitsNumberPrice precision
        expirationTimeNull if order is not closed
        expirationStringStringNull if order is not closed
        margin_rateFloating numberMargin rate
        open_priceFloating numberOpen price in account currency
        open_timeTimeOpen time
        open_timeStringStringOpen time string
        orderNumberOrder number for opened transaction
        order2NumberOrder number for closed transaction
        positionNumberOrder number common both for opened and closed transaction
        profitFloating numberProfit in account currency
        slFloating numberZero if stop loss is not set (in account currency)
        storageFloating numberorder swaps in account currency
        symbolStringSymbol
        timestampTimeTimestamp
        tpFloating numberZero if take profit is not set (in account currency)
        volumeFloating numberVolume in pips

        Example:

        {
        	"close_price": 1.3256,
        	"close_time": null,
        	"close_timeString": null,
        	"closed": false,
        	"cmd": 0,
        	"comment": "Web Trader",
        	"commission": 0.0,
        	"customComment": "Some text",
        	"digits": 4,
        	"expiration": null,
        	"expirationString": null,
        	"margin_rate": 0.0,
        	"open_price": 1.4,
        	"open_time": 1272380927000,
        	"open_timeString": "Fri Jan 11 10:03:36 CET 2013",
        	"order": 7497776,
        	"order2": 1234567,
        	"position": 1234567,
        	"profit": -2196.44,
        	"sl": 0.0,
        	"storage": -4.46,
        	"symbol": "EURUSD",
        	"timestamp": 1272540251000,
        	"tp": 0.0,
        	"volume": 0.10
        }

        Possible values of cmd field:

        namevaluedescription
        BUY0buy
        SELL1sell
        BUY_LIMIT2buy limit
        SELL_LIMIT3sell limit
        BUY_STOP4buy stop
        SELL_STOP5sell stop
        BALANCE6Read only. Used in getTradesHistory for manager's deposit/withdrawal operations (profit>0 for deposit, profit<0 for withdrawal).
      15. Command: getTrades

        Description: Returns array of user's trades.

        Request:

        Parameters:

        nametypedescription
        openedOnlybooleanif true then only opened trades will be returned

        Example:

        {
        	"command": "getTrades",
        	"arguments": {
        		"openedOnly": true
        	}
        }
        Response:

        Parameters:

        nametypedescription
        arrayArray of TRADE_RECORD

        Example:

        {
        	"status": true,
        	"returnData" : [TRADE_RECORD, TRADE_RECORD, ...]	
        }

        Format of TRADE_RECORD:

        cmd is the operation code, for user's trade operations it equals to cmd from TRADE_TRANS_INFO record used as an argument in tradeTransaction command

        nametypedescription
        close_priceFloating numberClose price in account currency
        close_timeTimeNull if order is not closed
        close_timeStringStringNull if order is not closed
        closedBooleanClosed
        cmdNumberOperation code
        commentStringComment
        commissionFloating numberCommission in account currency
        customCommentStringThe value the customer may provide in order to retrieve it later.
        digitsNumberPrice precision
        expirationTimeNull if order is not closed
        expirationStringStringNull if order is not closed
        margin_rateFloating numberMargin rate
        open_priceFloating numberOpen price in account currency
        open_timeTimeOpen time
        open_timeStringStringOpen time string
        orderNumberOrder number for opened transaction
        order2NumberOrder number for closed transaction
        positionNumberOrder number common both for opened and closed transaction
        profitFloating numberProfit in account currency
        slFloating numberZero if stop loss is not set (in account currency)
        storageFloating numberorder swaps in account currency
        symbolStringSymbol
        timestampTimeTimestamp
        tpFloating numberZero if take profit is not set (in account currency)
        volumeFloating numberVolume in pips

        Example:

        {
        	"close_price": 1.3256,
        	"close_time": null,
        	"close_timeString": null,
        	"closed": false,
        	"cmd": 0,
        	"comment": "Web Trader",
        	"commission": 0.0,
        	"customComment": "Some text",
        	"digits": 4,
        	"expiration": null,
        	"expirationString": null,
        	"margin_rate": 0.0,
        	"open_price": 1.4,
        	"open_time": 1272380927000,
        	"open_timeString": "Fri Jan 11 10:03:36 CET 2013",
        	"order": 7497776,
        	"order2": 1234567,
        	"position": 1234567,
        	"profit": -2196.44,
        	"sl": 0.0,
        	"storage": -4.46,
        	"symbol": "EURUSD",
        	"timestamp": 1272540251000,
        	"tp": 0.0,
        	"volume": 0.10
        }

        Possible values of cmd field:

        namevaluedescription
        BUY0buy
        SELL1sell
        BUY_LIMIT2buy limit
        SELL_LIMIT3sell limit
        BUY_STOP4buy stop
        SELL_STOP5sell stop
        BALANCE6Read only. Used in getTradesHistory for manager's deposit/withdrawal operations (profit>0 for deposit, profit<0 for withdrawal).
      16. Command: getTradesHistory

        Description: Returns array of user's trades which were closed within specified period of time.

        Request:

        Parameters:

        nametypedescription
        endTimeTime, 0 means current time for simplicity
        startTimeTime

        Example:

        {
        	"command": "getTradesHistory",
        	"arguments": {
        		"end": 0,
        		"start": 1275993488000
        	}
        }
        Response:

        Parameters:

        nametypedescription
        arrayArray of TRADE_RECORD

        Example:

        {
        	"status": true,
        	"returnData" : [TRADE_RECORD, TRADE_RECORD, ...]	
        }

        Format of TRADE_RECORD:

        cmd is the operation code, for user's trade operations it equals to cmd from TRADE_TRANS_INFO record used as an argument in tradeTransaction command

        nametypedescription
        close_priceFloating numberClose price in account currency
        close_timeTimeNull if order is not closed
        close_timeStringStringNull if order is not closed
        closedBooleanClosed
        cmdNumberOperation code
        commentStringComment
        commissionFloating numberCommission in account currency
        customCommentStringThe value the customer may provide in order to retrieve it later.
        digitsNumberPrice precision
        expirationTimeNull if order is not closed
        expirationStringStringNull if order is not closed
        margin_rateFloating numberMargin rate
        open_priceFloating numberOpen price in account currency
        open_timeTimeOpen time
        open_timeStringStringOpen time string
        orderNumberOrder number for opened transaction
        order2NumberOrder number for closed transaction
        positionNumberOrder number common both for opened and closed transaction
        profitFloating numberProfit in account currency
        slFloating numberZero if stop loss is not set (in account currency)
        storageFloating numberorder swaps in account currency
        symbolStringSymbol
        timestampTimeTimestamp
        tpFloating numberZero if take profit is not set (in account currency)
        volumeFloating numberVolume in pips

        Example:

        {
        	"close_price": 1.3256,
        	"close_time": null,
        	"close_timeString": null,
        	"closed": false,
        	"cmd": 0,
        	"comment": "Web Trader",
        	"commission": 0.0,
        	"customComment": "Some text",
        	"digits": 4,
        	"expiration": null,
        	"expirationString": null,
        	"margin_rate": 0.0,
        	"open_price": 1.4,
        	"open_time": 1272380927000,
        	"open_timeString": "Fri Jan 11 10:03:36 CET 2013",
        	"order": 7497776,
        	"order2": 1234567,
        	"position": 1234567,
        	"profit": -2196.44,
        	"sl": 0.0,
        	"storage": -4.46,
        	"symbol": "EURUSD",
        	"timestamp": 1272540251000,
        	"tp": 0.0,
        	"volume": 0.10
        }

        Possible values of cmd field:

        namevaluedescription
        BUY0buy
        SELL1sell
        BUY_LIMIT2buy limit
        SELL_LIMIT3sell limit
        BUY_STOP4buy stop
        SELL_STOP5sell stop
        BALANCE6Read only. Used in getTradesHistory for manager's deposit/withdrawal operations (profit>0 for deposit, profit<0 for withdrawal).
      17. Command: getTradingHours

        Description: Returns quotes and trading times.

        Request:

        Parameters:

        nametypedescription
        symbolsarrayArray of symbol names (Strings)

        Example:

        {
        	"command": "getTradingHours",
        	"arguments": {
        		"symbols": ["EURPLN", "AGO.PL", ...]
        	}
        }
        Response:

        Parameters:

        nametypedescription
        arrayArray of TRADING_HOURS_RECORD

        Example:

        {
        	"status": true,
        	"returnData" : [TRADING_HOURS_RECORD, TRADING_HOURS_RECORD, ...]	
        }

        Format of TRADING_HOURS_RECORD:

        nametypedescription
        quotesarrayArray of QUOTES_RECORD
        symbolStringSymbol
        tradingarrayArray of TRADING_RECORD

        Example:

        {
        	"quotes": [QUOTES_RECORD, QUOTES_RECORD, ...],
        	"symbol": "USDPLN",
        	"trading": [TRADING_RECORD, TRADING_RECORD, ...]
        }

        Format of QUOTES_RECORD:

        nametypedescription
        dayNumberDay of week
        fromTTimeStart time from 00:00 in ms
        toTTimeEnd time from 00:00 in ms

        Example:

        {
        	"day": ,
        	"fromT": 63000000,
        	"toT": 63300000
        }

        Possible values of day field:

        namevaluedescription
        1Monday
        2Tuesday
        3Wednesday
        4Thursday
        5Friday
        6Saturday
        7Sunday

        Format of TRADING_RECORD:

        nametypedescription
        dayNumberDay of week
        fromTTimeStart time from 00:00 in ms
        toTTimeEnd time from 00:00 in ms

        Example:

        {
        	"day": 2,
        	"fromT": 63000000,
        	"toT": 63300000
        }

        Possible values of day field:

        namevaluedescription
        1Monday
        2Tuesday
        3Wednesday
        4Thursday
        5Friday
        6Saturday
        7Sunday
      18. Command: getVersion

        Description: Returns the current API version.

        Request:

        Example:

        {
        	"command": "getVersion"
        }
        Response:

        Parameters:

        nametypedescription
        versionStringcurrent API version

        Example:

        {
        	"status": true,
        	"returnData" : {
        		"version": "2.3"
        	}	
        }
      19. Command: ping

        Description: Simple ping command

        Request:

        Example:

        {
        	"command": "ping"
        }
        Response:

        Example:

        {
        	"status": true	
        }
      20. Command: tradeTransaction

        Description: Starts trade transaction. tradeTransaction sends main transaction information to the server.

        How to verify that the trade request was accepted?

        The status field set to 'true' does not imply that the transaction was accepted. It only means, that the server acquired your request and began to process it. To analyse the status of the transaction (for example to verify if it was accepted or rejected) use the tradeTransactionStatus command with the order number, that came back with the response of the tradeTransaction command. You can find the example here: developers.xstore.pro/api/tutorials/opening_and_closing_trades

        Request:

        Parameters:

        nametypedescription
        tradeTransInfoTRADE_TRANS_INFOtradeTransInfo

        Example:

        {
        	"command": "tradeTransaction",
        	"arguments": {
        		"tradeTransInfo": TRADE_TRANS_INFO
        	}
        }

        Format of TRADE_TRANS_INFO:

        nametypedescription
        cmdNumberOperation code
        customCommentStringThe value the customer may provide in order to retrieve it later.
        expirationTimePending order expiration time
        orderNumber0 or position number for closing/modifications
        priceFloating numberTrade price
        slFloating numberStop loss
        symbolStringTrade symbol
        tpFloating numberTake profit
        typeNumberTrade transaction type
        volumeFloating numberTrade volume

        Example:

        {
        	"cmd": 0,
        	"customComment": "Some text",
        	"expiration": 1262944112000,
        	"order": 7497776,
        	"price": 37.47,
        	"sl": 0.0,
        	"symbol": "PKN.PL",
        	"tp": 0.0,
        	"type": 0,
        	"volume": 5.00
        }

        Possible values of cmd field:

        namevaluedescription
        BUY0buy
        SELL1sell
        BUY_LIMIT2buy limit
        SELL_LIMIT3sell limit
        BUY_STOP4buy stop
        SELL_STOP5sell stop
        BALANCE6Read only. Used in getTradesHistory for manager's deposit/withdrawal operations (profit>0 for deposit, profit<0 for withdrawal).

        Possible values of type field:

        namevaluedescription
        OPEN0order open, used for opening orders
        PENDING1order pending, only used in the streaming getTrades command
        CLOSE2order close
        MODIFY3order modify, only used in the tradeTransaction command
        DELETE4order delete, only used in the tradeTransaction command
        Response:

        Parameters:

        nametypedescription
        orderNumberorder

        Example:

        {
        	"status": true,
        	"returnData" : {
        		"order": 43
        	}	
        }
      21. Command: tradeTransactionStatus

        Description: Returns current transaction status. At any time of transaction processing client might check the status of transaction on server side. In order to do that client must provide unique order taken from tradeTransaction invocation.

        Request:

        Parameters:

        nametypedescription
        orderNumberorder

        Example:

        {
        	"command": "tradeTransactionStatus",
        	"arguments": {
        		"order": 43
        	}
        }
        Response:

        Parameters:

        nametypedescription
        askFloating numberPrice in account currency
        bidFloating numberPrice in account currency
        customCommentStringThe value the customer may provide in order to retrieve it later.
        messageStringCan be null
        orderNumberUnique order number
        requestStatusNumberRequest status code, described below

        Example:

        {
        	"status": true,
        	"returnData" : {
        		"ask": 1.392,
        		"bid": 1.392,
        		"customComment": "Some text",
        		"message": null,
        		"order": 43,
        		"requestStatus": 3
        	}	
        }

        Possible values of requestStatus field:

        namevaluedescription
        ERROR0error
        PENDING1pending
        REQUOTED2Price was requoted by dealer
        ACCEPTED3The transaction has been executed successfully
        REJECTED4The transaction has been rejected
        PRICED5Prices received
  6. Available streaming commands

    Each streaming command takes as an argument streamSessionId which is sent in response message for login command performed in main connection. streamSessionId token allows to identify user in streaming connection. In one streaming connection multiple commands with different streamSessionId can be invoked. It will cause sending streaming data for multiple login sessions in one streaming connection. streamSessionId is valid until logout command is performed on main connection or main connection is disconnected.

    1. Command: getBalance

      Description: Allows to get actual balance value for an account in real-time, as soon as it is available in the system.

      Subscribe format:

      Example:

      {
      	"command" : "getBalance",
      	"streamSessionId" : "8469308861804289383"
      }
      Unsubscribe format:

      Example:

      {
      	"command" : "stopBalance"
      }
      Format of data in stream:
      {
      	"command" : "balance",
      	"data" : STREAMING_BALANCE_RECORD
      }

      Format of STREAMING_BALANCE_RECORD:

      nametypedescription
      balanceFloating numberbalance
      equityFloating numbersum of balance and all profits
      marginFloating numbermargin requirements
      marginFreeFloating numberfree margin
      marginLevelFloating numbermargin level

      Example:

      {
      	"balance": 995800269.43,
      	"equity": 995985397.56,
      	"margin": 572634.43,
      	"marginFree": 995227635.00,
      	"marginLevel": 173930.41
      }
    2. Command: getCandles

      Description: Subscribes for and unsubscribes from API chart candles. The interval of every candle is 1 minute. A new candle arrives every minute.

      Subscribe format:

      Parameters:

      nametypedescription
      symbolStringSymbol

      Example:

      {
      	"command" : "getCandles",
      	"streamSessionId" : "8469308861804289383",
      	"symbol": "EURUSD"
      }
      Unsubscribe format:

      Parameters:

      nametypedescription
      symbolStringSymbol

      Example:

      {
      	"command" : "stopCandles",
      	"symbol": "EURUSD"
      }
      Format of data in stream:
      {
      	"command" : "candle",
      	"data" : STREAMING_CANDLE_RECORD
      }

      Format of STREAMING_CANDLE_RECORD:

      nametypedescription
      closeFloating numberValue of close price
      ctmTimeCandle start time in CET time zone (Central European Time)
      ctmStringStringString representation of the 'ctm' field
      highFloating numberHighest value in the given period
      lowFloating numberLowest value in the given period
      openFloating numberOpen price
      quoteIdNumberSource of price
      symbolStringSymbol
      volFloating numberVolume

      Example:

      {
      	"close": 1.0,
      	"ctm": 1378369375000,
      	"ctmString": "Sep 05, 2013 10:22:55 AM",
      	"high": 6.0,
      	"low": 0.0,
      	"open": 41848.0,
      	"quoteId": 2,
      	"symbol": "EURUSD",
      	"vol": 12.00
      }

      Possible values of quoteId field:

      namevaluedescription
      fixed1fixed
      float2float
      depth3depth
      cross4cross
    3. Command: getKeepAlive

      Description: Subscribes for and unsubscribes from 'keep alive' messages. A new 'keep alive' message is sent by the API every 3 seconds.

      Subscribe format:

      Example:

      {
      	"command" : "getKeepAlive",
      	"streamSessionId" : "8469308861804289383"
      }
      Unsubscribe format:

      Example:

      {
      	"command" : "stopKeepAlive"
      }
      Format of data in stream:
      {
      	"command" : "keepAlive",
      	"data" : STREAMING_KEEP_ALIVE_RECORD
      }

      Format of STREAMING_KEEP_ALIVE_RECORD:

      nametypedescription
      timeTimeCurrent timestamp

      Example:

      {
      	"time": 1262944112000
      }
    4. Command: getNews

      Description: Subscribes for and unsubscribes from news.

      Subscribe format:

      Example:

      {
      	"command" : "getNews",
      	"streamSessionId" : "8469308861804289383"
      }
      Unsubscribe format:

      Example:

      {
      	"command" : "stopNews"
      }
      Format of data in stream:
      {
      	"command" : "news",
      	"data" : STREAMING_NEWS_RECORD
      }

      Format of STREAMING_NEWS_RECORD:

      nametypedescription
      bodyStringBody
      keyStringNews key
      timeTimeTime
      titleStringNews title

      Example:

      {
      	"body": "<html>...</html>",
      	"key": "1f6da766abd29927aa854823f0105c23",
      	"time": 1262944112000,
      	"title": "Breaking trend"
      }
    5. Command: getProfits

      Description: Subscribes for and unsubscribes from profits.

      Subscribe format:

      Example:

      {
      	"command" : "getProfits",
      	"streamSessionId" : "8469308861804289383"
      }
      Unsubscribe format:

      Example:

      {
      	"command" : "stopProfits"
      }
      Format of data in stream:
      {
      	"command" : "profit",
      	"data" : STREAMING_PROFIT_RECORD
      }

      Format of STREAMING_PROFIT_RECORD:

      nametypedescription
      orderNumberOrder number
      order2NumberTransaction ID
      positionNumberPosition number
      profitFloating numberProfit

      Example:

      {
      	"order": 7497776,
      	"order2": 7497777,
      	"position": 7497776,
      	"profit": 7076.52
      }
    6. Command: getTickPrices

      Description: Establishes subscription for quotations and allows to obtain the relevant information in real-time, as soon as it is available in the system. The getTickPrices command can be invoked many times for the same symbol, but only one subscription for a given symbol will be created. This command has no confirmation

      Subscribe format:

      Parameters:

      nametypedescription
      symbolStringSymbol

      Example:

      {
      	"command" : "getTickPrices",
      	"streamSessionId" : "8469308861804289383",
      	"symbol": "EURUSD"
      }
      Unsubscribe format:

      Parameters:

      nametypedescription
      symbolStringSymbol

      Example:

      {
      	"command" : "stopTickPrices",
      	"symbol": "EURUSD"
      }
      Format of data in stream:
      {
      	"command" : "tickPrices",
      	"data" : STREAMING_TICK_RECORD
      }

      Format of STREAMING_TICK_RECORD:

      nametypedescription
      askFloating numberAsk
      askVolumeNumberNumber of available lots to buy at given price or null if not applicable
      bidFloating numberBid
      bidVolumeNumberNumber of available lots to buy at given price or null if not applicable
      highFloating numberHigh
      levelNumberPrice level
      lowFloating numberLow
      quoteIdNumberSource of price, detailed description below
      spreadRawFloating numberThe difference between raw ask and bid prices
      spreadTableFloating numberSpread representation
      symbolStringSymbol
      timestampTimeTimestamp

      Example:

      {
      	"ask": 4000.0,
      	"askVolume": 15000,
      	"bid": 4000.0,
      	"bidVolume": 16000,
      	"high": 4000.0,
      	"level": 0,
      	"low": 3500.0,
      	"quoteId": 0,
      	"spreadRaw": 0.000003,
      	"spreadTable": 0.00042,
      	"symbol": "KOMB.CZ",
      	"timestamp": 1272529161605
      }

      Possible values of quoteId field:

      namevaluedescription
      fixed1fixed
      float2float
      depth3depth
      cross4cross
    7. Command: getTrades

      Description: Establishes subscription for user trade status data and allows to obtain the relevant information in real-time, as soon as it is available in the system.

      Subscribe format:

      Example:

      {
      	"command" : "getTrades",
      	"streamSessionId" : "8469308861804289383"
      }
      Unsubscribe format:

      Example:

      {
      	"command" : "stopTrades"
      }
      Format of data in stream:
      {
      	"command" : "trade",
      	"data" : STREAMING_TRADE_RECORD
      }

      Format of STREAMING_TRADE_RECORD:

      New STREAMING_TRADE_RECORD are sent by streaming socket only in several cases:

      • - Opening the trade
      • - Closing the trade
      • - Modification of trade parameters
      • - Explicit trade update done by server system to synchronize data.

      Situation that trade was closed can be checked by field closed set to true in STREAMING_TRADE_RECORD format. Also close_time field will NOT be set to null. Various reasons of trade close could be found out by information in comment field of STREAMING_TRADE_RECORD for closed order. If the comment remained unchanged from that of opened order, then the order was closed by user. If there is annotation in comment string like:

      • - "[S/L]", then the trade was closed by stop loss
      • - "[T/P]", then the trade was closed by take profit
      • - "[S/O margin level% equity / margin (currency)]", then the trade was closed because of Stop Out (lack of money to maintain position). The example comment: [S/O -1968861.79% -24217.00 / 1.23 (USD)]

      The annotation are in brackets (regular or square, depending on situation) with additional data about the closing action.

      nametypedescription
      close_priceFloating numberClose price
      close_timeTimeNull if order is not closed
      closedBooleanClosed
      cmdNumberOperation code
      commentStringComment
      commissionFloating numberCommission
      customCommentStringThe value the customer may provide in order to retrieve it later.
      expirationTimeNull if order is not closed
      margin_rateFloating numberMargin rate
      open_priceFloating numberOpen price
      open_timeTimeOpen time
      orderNumberOrder number for opened transaction
      order2NumberTransaction id
      positionNumberPosition number (if type is 0 and 2) or transaction parameter (if type is 1)
      profitFloating numbernull unless the trade is closed (type=2) or opened (type=0)
      slFloating numberZero if stop loss is not set
      stateStringTrade state, should be used for detecting pending order's cancellation
      storageFloating numberStorage
      symbolStringSymbol
      tpFloating numberZero if take profit is not set
      typeNumbertype
      volumeFloating numberVolume

      Example:

      {
      	"close_price": 1.3256,
      	"close_time": null,
      	"closed": false,
      	"cmd": 0,
      	"comment": "Web Trader",
      	"commission": 0.0,
      	"customComment": "Some text",
      	"expiration": null,
      	"margin_rate": 3.9149000,
      	"open_price": 1.4,
      	"open_time": 1272380927000,
      	"order": 7497776,
      	"order2": 1234567,
      	"position": 1234567,
      	"profit": 68.392,
      	"sl": 0.0,
      	"state": "Modified",
      	"storage": -4.46,
      	"symbol": "EURUSD",
      	"tp": 0.0,
      	"type": 0,
      	"volume": 0.10
      }

      Possible values of cmd field:

      namevaluedescription
      BUY0buy
      SELL1sell
      BUY_LIMIT2buy limit
      SELL_LIMIT3sell limit
      BUY_STOP4buy stop
      SELL_STOP5sell stop
      BALANCE6Read only. Used in getTradesHistory for manager's deposit/withdrawal operations (profit>0 for deposit, profit<0 for withdrawal).

      Possible values of state field:

      namevaluedescription
      MODIFIED"Modified"pending order has been created
      DELETED"Deleted"pending order has been cancelled

      Possible values of type field:

      namevaluedescription
      OPEN0order open, used for opening orders
      PENDING1order pending, only used in the streaming getTrades command
      CLOSE2order close
      MODIFY3order modify, only used in the tradeTransaction command
      DELETE4order delete, only used in the tradeTransaction command
    8. Command: getTradeStatus

      Description: Allows to get status for sent trade requests in real-time, as soon as it is available in the system.

      Subscribe format:

      Example:

      {
      	"command" : "getTradeStatus",
      	"streamSessionId" : "8469308861804289383"
      }
      Unsubscribe format:

      Example:

      {
      	"command" : "stopTradeStatus"
      }
      Format of data in stream:
      {
      	"command" : "tradeStatus",
      	"data" : STREAMING_TRADE_STATUS_RECORD
      }

      Format of STREAMING_TRADE_STATUS_RECORD:

      nametypedescription
      customCommentStringThe value the customer may provide in order to retrieve it later.
      messageStringCan be null
      orderNumberUnique order number
      requestStatusNumberRequest status code, described below

      Example:

      {
      	"customComment": "Some text",
      	"message": null,
      	"order": 43,
      	"requestStatus": 3
      }

      Possible values of requestStatus field:

      namevaluedescription
      ERROR0error
      PENDING1pending
      REQUOTED2Price was requoted by dealer
      ACCEPTED3The transaction has been executed successfully
      REJECTED4The transaction has been rejected
      PRICED5Prices received
  7. Error messages

    Main reason of generated transaction server error messages is an error in the business logic of the application.

    Errors list returned from transaction server:

    Error codeError description
    BE001Invalid price
    BE002Invalid StopLoss or TakeProfit
    BE003Invalid volume
    BE004Login disabled
    BE005Login not found
    BE006Market for instrument is closed
    BE007Mismatched parameters
    BE008Modification is denied
    BE009Not enough money on account to perform trade
    BE010Off quotes
    BE011Opposite positions prohibited
    BE012Short positions prohibited
    BE013Price has changed
    BE014Request too frequent
    BE016, BE017Too many trade requests
    BE018Trading on instrument disabled
    BE019Trading timeout
    BE020-BE037, BE099Other error
    BE094Symbol does not exist for given account
    BE095Account cannot trade on given symbol
    BE096Pending order cannot be closed. Pending order must be deleted
    BE097Cannot close already closed order
    BE098No such transaction
    BE101Unknown instrument symbol
    BE102Unknown transaction type
    BE103User is not logged
    BE104Method does not exist
    BE105Incorrect period given
    BE106Missing data
    BE110Incorrect command format
    BE115, BE116Symbol does not exist
    BE117Invalid token
    BE118User already logged
    EX000Invalid parameters
    EX001, EX002, SExxxInternal error, in case of such error, please contact support
    EX003Internal error, request timed out
    EX004Login credentials are incorrect or this login is not allowed to use an application with this appId
    EX005Internal error, system overloaded
    EX006No access