Skip to main content

RequestCalculateSymbolDividends

Request for a preliminary calculation of the amount of dividends in orders

Request format

{
"RequestId": "865bca00-56fd-4dac-8a1f-ff9bb3b6bf09",
"CollectSuffixes": true,
"Symbol": "USOIL",
"DividendsForShareInUsd": 0.03,
"Nodes": [ ],
"RequestName": "RequestCalculateSymbolDividends"
}

Request parameters:

NameDescription
RequestIdUnique request GUID
SymbolSymbol on which dividends are accrued
CollectSuffixestrue - use all symbol suffixes
DividendsForShareInUsdthe amount of dividends per share in USD on the specified Symbol
NodesList of nodes that participate in request. If the list is empty, all available nodes are requested.
RequestNameType of request

Response ResponseCalculateSymbolDividends

{
"Result": [
{
"Node": "Second",
"Platform": "Mt4",
"Result": [
{
"DividendsForShareInUsd": 0.03,
"DividendsInUsd": -945.9,
"Node": "Second",
"Platform": "Mt4",
"Symbol": "UKOIL",
"Description": "Brent Crude – ICE version",
"CollectSuffixes": false,
"OrdersCount": 129,
"VolumeBuyInUsd": 19544294.0,
"VolumeSellInUsd": -21529953.2,
"VolumeInUsd": -1985659.2,
"Orders": [
{
"DividendsInUsd": -300.0,
"DividendsInAccountCurrency": -300.0,
"Node": "Second",
"Platform": "Mt4",
"Order": 26321619,
"Login": 375423,
"Name": "user1",
"Symbol": "UKOIL",
"Currency": "USD",
"Cmd": "Sell",
"Lots": 10.0,
"VolumeInUsd": 626800.0,
"ProfitInUsd": -62200.0,
"OperationState": "None"
},
{
"DividendsInUsd": 6.0,
"DividendsInAccountCurrency": 6.0,
"Node": "Second",
"Platform": "Mt4",
"Order": 27421546,
"Login": 496545,
"Name": "user2",
"Symbol": "UKOIL",
"Currency": "USD",
"Cmd": "Buy",
"Lots": 0.2,
"VolumeInUsd": 12530.0,
"ProfitInUsd": 26.0,
"OperationState": "None"
}
]
}
],
"ResponseNode": "ResponseNodeCalculateSymbolDividends"
}
],
"RequestId": "0054d3f1-ece1-4a35-8791-5591b4691a34",
"ResponseMaster": "ResponseCalculateSymbolDividends"
}

Errors either an empty list or a list of node responses ResponseNodeError