Output Description

// Candle
{
  // Asset pair (BTCUSD...)
  // Type: string
  "a": "",

  // Market
  // Type: MarketType
  // Values:
  // - Spot: Spot
  // - Mt: Margin trading
  "m": "",

  // Price type
  // Type: CandlePriceType
  // Values:
  // - Unspecified: 
  // - Bid: 
  // - Ask: 
  // - Mid: 
  // - Trades: 
  "p": "",

  // Interval
  // Type: CandleTimeInterval
  // Values:
  // - Unspecified: 
  // - Sec: 
  // - Minute: 
  // - Min5: 
  // - Min15: 
  // - Min30: 
  // - Hour: 
  // - Hour4: 
  // - Hour6: 
  // - Hour12: 
  // - Day: 
  // - Week: 
  // - Month: 
  "i": "",

  // Candle open timestamp
  // Type: DateTime
  "t": "0001-01-01T00:00:00",

  // Open price
  // Type: double
  "o": 0.0,

  // Close price
  // Type: double
  "c": 0.0,

  // High price
  // Type: double
  "h": 0.0,

  // Low price
  // Type: double
  "l": 0.0,

  // Trading volume
  // Type: double
  "v": 0.0,

  // Opposite trading volume
  // Type: double
  "ov": 0.0,
}
    
provides candles. realm = 'prices', all parameters in the lower case.
Output Description

// Quote
{
  // Asset pair (BTCUSD...)
  // Type: string
  "a": "",

  // Market
  // Type: MarketType
  // Values:
  // - Spot: Spot
  // - Mt: Margin trading
  "m": "",

  // Price type
  // Type: QuotePriceType
  // Values:
  // - Ask: Ask price
  // - Bid: Bid price
  "pt": "",

  // Price
  // Type: double
  "p": 0.0,

  // Quote timestamp
  // Type: DateTime
  "t": "0001-01-01T00:00:00",
}
    
provides quotes. realm = 'prices', all parameters in the lower case.
Output Description

// BalanceUpdateMessage
{
  // Wallet Id
  // Type: string
  "id": "",

  // Asset (USD...)
  // Type: string
  "a": "",

  // Balance
  // Type: double
  "b": 0.0,

  // Reserved
  // Type: double
  "r": 0.0,
}
    
user balances updates. realm = 'prices', all parameters in the lower case.
Output Description

// OrderbookModel
{
  // AssetPair
  // Type: string
  "AssetPair": "",

  // IsBuy
  // Type: bool
  "IsBuy": false,

  // Timestamp
  // Type: DateTime
  "Timestamp": "0001-01-01T00:00:00",

  // Levels
  // Type: Level[]
  "Levels": [],
}
// Level
{
  // Id
  // Type: string
  "Id": "",

  // Volume
  // Type: double
  "Volume": 0.0,

  // Price
  // Type: double
  "Price": 0.0,
}
    
provides orderbooks. realm = 'prices', all parameters in the lower case. Mt is not implemented yet.
Output Description

// TradeLogItem
{
  // TradeLegId
  // Type: string
  "TradeLegId": "",

  // TradeId
  // Type: string
  "TradeId": "",

  // UserId
  // Type: string
  "UserId": "",

  // HashedUserId
  // Type: string
  "HashedUserId": "",

  // WalletId
  // Type: string
  "WalletId": "",

  // WalletType
  // Type: string
  "WalletType": "",

  // OrderId
  // Type: string
  "OrderId": "",

  // OrderType
  // Type: string
  "OrderType": "",

  // Direction
  // Type: Direction
  // Values:
  // - Buy: 
  // - Sell: 
  "Direction": "",

  // Asset
  // Type: string
  "Asset": "",

  // Volume
  // Type: decimal
  "Volume": Doc not implemented,

  // Price
  // Type: decimal
  "Price": Doc not implemented,

  // DateTime
  // Type: DateTime
  "DateTime": "0001-01-01T00:00:00",

  // OppositeOrderId
  // Type: string
  "OppositeOrderId": "",

  // OppositeAsset
  // Type: string
  "OppositeAsset": "",

  // OppositeVolume
  // Type: decimal?
  "OppositeVolume": null | 0.0,

  // IsHidden
  // Type: bool?
  "IsHidden": null | false,

  // Fee
  // Type: TradeLogItemFee
  "Fee": Doc not implemented,
}
// TradeLogItemFee
{
  // FromClientId
  // Type: string
  "FromClientId": "",

  // ToClientId
  // Type: string
  "ToClientId": "",

  // DateTime
  // Type: DateTime
  "DateTime": "0001-01-01T00:00:00",

  // Volume
  // Type: double
  "Volume": 0.0,

  // Asset
  // Type: string
  "Asset": "",

  // Type
  // Type: string
  "Type": "",

  // SizeType
  // Type: string
  "SizeType": "",

  // Size
  // Type: double?
  "Size": null | 0.0,

  // MakerSizeType
  // Type: string
  "MakerSizeType": "",

  // MakerSize
  // Type: double?
  "MakerSize": null | 0.0,

  // MakerFeeModificator
  // Type: double?
  "MakerFeeModificator": null | 0.0,
}
    
provides trades for a specific user. realm = 'prices', all parameters in the lower case.
Output Description

// Trade
{
  // Trade unique id
  // Type: string
  "Id": "",

  // Order unique id
  // Type: string
  "OrderId": "",

  // Instrument  unique id
  // Type: string
  "AssetPairId": "",

  // Trade type on order's side: buy or sell
  // Type: TradeClientType
  // Values:
  // - Buy: 
  // - Sell: 
  "Type": "",

  // Trade date and time
  // Type: DateTime
  "Date": "0001-01-01T00:00:00",

  // Trade effective price
  // Type: decimal
  "Price": Doc not implemented,

  // Trade effective volume
  // Type: decimal
  "Volume": Doc not implemented,
}
    
provides margin trades of all users. realm = 'prices'.
Output Description

// User update message
{
  // Updated account info, if exists
  // Type: MarginTradingAccountClientContract
  "Account": Doc not implemented,

  // Updated order info, if exists
  // Type: OrderClientContract
  "Order": Doc not implemented,

  // Stopout info, if exists
  // Type: AccountStopoutClientContract
  "AccountStopout": Doc not implemented,

  // Updated user info, if exists
  // Type: UserUpdateEntityClientContract
  "UserUpdate": Doc not implemented,
}
// Account info
{
  // Account id
  // Type: string
  "Id": "",

  // Trading condition id
  // Type: string
  "TradingConditionId": "",

  // Account base asset id
  // Type: string
  "BaseAssetId": "",

  // Account balance
  // Type: decimal
  "Balance": Doc not implemented,

  // Account Withdraw Transfer Limit
  // Type: decimal
  "WithdrawTransferLimit": Doc not implemented,

  // Account margin call limit
  // Type: decimal
  "MarginCall": Doc not implemented,

  // Account stopout limit
  // Type: decimal
  "StopOut": Doc not implemented,

  // Account total capital
  // Type: decimal
  "TotalCapital": Doc not implemented,

  // Account free margin
  // Type: decimal
  "FreeMargin": Doc not implemented,

  // Account available margin
  // Type: decimal
  "MarginAvailable": Doc not implemented,

  // Account used margin
  // Type: decimal
  "UsedMargin": Doc not implemented,

  // Account init margin
  // Type: decimal
  "MarginInit": Doc not implemented,

  // Account pnl
  // Type: decimal
  "PnL": Doc not implemented,

  // Open positions count
  // Type: int
  "OpenPositionsCount": 0,

  // Account margin usage level
  // Type: decimal
  "MarginUsageLevel": Doc not implemented,

  // Is account live (trading real money) or demo
  // Type: bool
  "IsLive": false,

  // Account legal entity
  // Type: string
  "LegalEntity": "",
}
// Account info
{
  // Order id
  // Type: string
  "Id": "",

  // Account id
  // Type: string
  "AccountId": "",

  // Instrument (asset pair) id
  // Type: string
  "Instrument": "",

  // Contract direction (buy - 0, sell - 1)
  // Type: int
  "Type": 0,

  // Order status (WaitingForExecution - 0, Active - 1, Closed - 2, Rejected - 3, Closing - 4)
  // Type: int
  "Status": 0,

  // Order close reason (None - 0, Close - 1, StopLoss - 2, TakeProfit - 3, StopOut - 4, Canceled - 5, CanceledBySystem - 6, CanceledByBroker - 7, ClosedByBroker - 8)
  // Type: int
  "CloseReason": 0,

  // Order reject reason (None - 0, NoLiquidity - 1, NotEnoughBalance - 2, LeadToStopOut - 3, AccountInvalidState - 4, InvalidExpectedOpenPrice - 5, InvalidVolume - 6, InvalidTakeProfit - 7, InvalidStoploss - 8, InvalidInstrument = 9, InvalidAccount - 10, TradingConditionError - 11, TechnicalError - 12)
  // Type: int
  "RejectReason": 0,

  // Order reject reason in human-readable text
  // Type: string
  "RejectReasonText": "",

  // Order expected open price
  // Type: decimal?
  "ExpectedOpenPrice": null | 0.0,

  // Order actual open price
  // Type: decimal
  "OpenPrice": Doc not implemented,

  // Order actual close price
  // Type: decimal
  "ClosePrice": Doc not implemented,

  // Order actual open date & time
  // Type: DateTime?
  "OpenDate": null | "0001-01-01T00:00:00",

  // Order actual close date & time
  // Type: DateTime?
  "CloseDate": null | "0001-01-01T00:00:00",

  // Order volume
  // Type: decimal
  "Volume": Doc not implemented,

  // Order matched volume
  // Type: decimal
  "MatchedVolume": Doc not implemented,

  // Order close volume
  // Type: decimal
  "MatchedCloseVolume": Doc not implemented,

  // Order take profit
  // Type: decimal?
  "TakeProfit": null | 0.0,

  // Order stop loss
  // Type: decimal?
  "StopLoss": null | 0.0,

  // Order floating profit loss
  // Type: decimal?
  "Fpl": null | 0.0,

  // Order total floating profit loss
  // Type: decimal?
  "TotalPnL": null | 0.0,

  // Order open comission
  // Type: decimal
  "OpenCommission": Doc not implemented,

  // Order close comission
  // Type: decimal
  "CloseCommission": Doc not implemented,

  // Order swap comission
  // Type: decimal
  "SwapCommission": Doc not implemented,
}
// Stopout info
{
  // Account id
  // Type: string
  "AccountId": "",

  // Closed positions count
  // Type: int
  "PositionsCount": 0,

  // Total profit & loss
  // Type: decimal
  "TotalPnl": Doc not implemented,
}
// User update info
{
  // Indicates account assets were updated
  // Type: bool
  "UpdateAccountAssetPairs": false,

  // Indicates accounts were updated
  // Type: bool
  "UpdateAccounts": false,
}
    
provides margin trading users and accounts updates. realm = 'prices'.
Output Description

// Trade
{
  // Id
  // Type: string
  "Id": "",

  // AssetPairId
  // Type: string
  "AssetPairId": "",

  // DateTime
  // Type: DateTime
  "DateTime": "0001-01-01T00:00:00",

  // Index
  // Type: int?
  "Index": null | 0,

  // Volume
  // Type: double
  "Volume": 0.0,

  // Price
  // Type: double
  "Price": 0.0,

  // Action
  // Type: TradeAction
  // Values:
  // - Buy: 
  // - Sell: 
  "Action": "",
}
    
provides trades for a instrument. realm = 'prices', all parameters in the lower case.
Output Description

// AssetUpdateMessage
{
  // Asset (USD...)
  // Type: string
  "Id": "",

  // Name
  // Type: string
  "Name": "",

  // DisplayId
  // Type: string
  "DisplayId": "",

  // Accuracy
  // Type: int
  "Accuracy": 0,

  // Symbol
  // Type: string
  "Symbol": "",

  // HideWithdraw
  // Type: bool
  "HideWithdraw": false,

  // HideDeposit
  // Type: bool
  "HideDeposit": false,

  // KycNeeded
  // Type: bool
  "KycNeeded": false,

  // BankCardsDepositEnabled
  // Type: bool
  "BankCardsDepositEnabled": false,

  // SwiftDepositEnabled
  // Type: bool
  "SwiftDepositEnabled": false,

  // BlockchainDepositEnabled
  // Type: bool
  "BlockchainDepositEnabled": false,

  // CategoryId
  // Type: string
  "CategoryId": "",

  // IsBase
  // Type: bool
  "IsBase": false,

  // IconUrl
  // Type: string
  "IconUrl": "",
}
    
Assets updates. realm = 'prices'
Output Description

// AssetPairUpdateMessage
{
  // Asset-pair (EURUSD...)
  // Type: string
  "Id": "",

  // Accuracy
  // Type: int
  "Accuracy": 0,

  // BaseAssetId
  // Type: string
  "BaseAssetId": "",

  // IsDisabled
  // Type: bool
  "IsDisabled": false,

  // InvertedAccuracy
  // Type: int
  "InvertedAccuracy": 0,

  // Name
  // Type: string
  "Name": "",

  // QuotingAssetId
  // Type: string
  "QuotingAssetId": "",

  // Source
  // Type: string
  "Source": "",

  // Source2
  // Type: string
  "Source2": "",
}
    
Asset-pairs updates. realm = 'prices'
Output Description

// Order
{
  // Id
  // Type: string
  "Id": "",

  // Status
  // Type: OrderStatus
  // Values:
  // - InOrderBook: 
  // - Processing: 
  // - Matched: 
  // - Cancelled: 
  // - Rejected: 
  // - Pending: 
  "Status": "",

  // RejectReason
  // Type: string
  "RejectReason": "",

  // AssetPairId
  // Type: string
  "AssetPairId": "",

  // Price
  // Type: double?
  "Price": null | 0.0,

  // LowerLimitPrice
  // Type: double?
  "LowerLimitPrice": null | 0.0,

  // LowerPrice
  // Type: double?
  "LowerPrice": null | 0.0,

  // UpperLimitPrice
  // Type: double?
  "UpperLimitPrice": null | 0.0,

  // UpperPrice
  // Type: double?
  "UpperPrice": null | 0.0,

  // Volume
  // Type: double
  "Volume": 0.0,

  // RemainingVolume
  // Type: double
  "RemainingVolume": 0.0,

  // Straight
  // Type: bool
  "Straight": false,

  // Type
  // Type: OrderType
  // Values:
  // - Limit: 
  // - Market: 
  // - StopLimit: 
  "Type": "",

  // OrderAction
  // Type: OrderAction
  // Values:
  // - Buy: 
  // - Sell: 
  "OrderAction": "",

  // CreateDateTime
  // Type: DateTime
  "CreateDateTime": "0001-01-01T00:00:00",

  // WalletId
  // Type: string
  "WalletId": "",
}
    
Orders. realm = 'prices'
Output Description

// HistoryExportGeneratedMessage
{
  // Id
  // Type: string
  "Id": "",

  // Url
  // Type: Uri
  "Url": Doc not implemented,
}
    
Generated csv urls. realm = 'prices'
Output Description

// Index
{
  // AssetId
  // Type: string
  "AssetId": "",

  // Name
  // Type: string
  "Name": "",

  // Value
  // Type: decimal
  "Value": Doc not implemented,

  // Composition
  // Type: Constituent[]
  "Composition": [],

  // Timestamp
  // Type: DateTime
  "Timestamp": "0001-01-01T00:00:00",

  // Return24H
  // Type: decimal
  "Return24H": Doc not implemented,

  // Return5D
  // Type: decimal
  "Return5D": Doc not implemented,

  // Return30D
  // Type: decimal
  "Return30D": Doc not implemented,

  // Max24H
  // Type: decimal
  "Max24H": Doc not implemented,

  // Min24H
  // Type: decimal
  "Min24H": Doc not implemented,

  // Volatility24H
  // Type: decimal
  "Volatility24H": Doc not implemented,

  // Volatility30D
  // Type: decimal
  "Volatility30D": Doc not implemented,
}
// Constituent
{
  // AssetId
  // Type: string
  "AssetId": "",

  // Weight
  // Type: decimal
  "Weight": Doc not implemented,
}
    
Indices updates. realm = 'prices'
Output Description

// MarketDataChangedEvent
{
  // AssetPairId
  // Type: string
  "AssetPairId": "",

  // VolumeBase
  // Type: decimal
  "VolumeBase": Doc not implemented,

  // VolumeQuote
  // Type: decimal
  "VolumeQuote": Doc not implemented,

  // PriceChange
  // Type: decimal
  "PriceChange": Doc not implemented,

  // LastPrice
  // Type: decimal
  "LastPrice": Doc not implemented,

  // High
  // Type: decimal
  "High": Doc not implemented,

  // Low
  // Type: decimal
  "Low": Doc not implemented,
}
    
Market data changes. realm = 'prices'
Output Description

// MarketDataChangedEvent
{
  // AssetPairId
  // Type: string
  "AssetPairId": "",

  // VolumeBase
  // Type: decimal
  "VolumeBase": Doc not implemented,

  // VolumeQuote
  // Type: decimal
  "VolumeQuote": Doc not implemented,

  // PriceChange
  // Type: decimal
  "PriceChange": Doc not implemented,

  // LastPrice
  // Type: decimal
  "LastPrice": Doc not implemented,

  // High
  // Type: decimal
  "High": Doc not implemented,

  // Low
  // Type: decimal
  "Low": Doc not implemented,
}
    
Market data changes by asset pair. realm = 'prices'