GetLimitation : Returns user account information (e.g. which functions are allowed, Exchanges allowed, symbol limit, etc.)
Supported parameters
| accessKey | Access key according to your subscription | Required parameter. |
| xml | [true]/[false], default = [false] | Optional parameter. By default function will return JSON data. Functions will return XML data if set as [true] |
| format | CSV | Optional parameter. When format=CSV, data in CSV format will be returned. Please make sure not to pass xml parameter (neither True nor False) when format=CSV is sent. |
| Example | http://endpoint:port/GetLimitation/?accessKey=0a0b0c&xml=true |
What is returned ?
| Returns details about user account (what is allowed / disallowed) |
Example of returned data
| JSON |
| {“AllowedBandwidthPerHour”:-1, “AllowedCallsPerHour”:-1, “AllowedCallsPerMonth”:-1, “AllowedBandwidthPerMonth”:-1, “ExpirationDate”:1485468000000, “Enabled”:true, “AllowedExchanges”:[{“AllowedInstruments”:-1,”DataDelay”:0,”ExchangeName”:”DUMMY”},{“AllowedInstruments”:-1,”DataDelay”:0,”ExchangeName”:”NFO”}], “AllowedFunctions”:[{“FunctionName”:”GetExchangeMessages”,”IsEnabled”:false},{“FunctionName”:”GetHistory”,”IsEnabled”:true}], “HistoryLimitation”:{“TickEnabled”:true,”DayEnabled”:true,”MaxEOD”:100000,”MaxIntraday”:5,”MaxTicks”:5,”Hour_1Enabled”:true, “Hour_2Enabled”:true,”Hour_4Enabled”:true, “Minute_1Enabled”:true,”Minute_5Enabled”:true,”Minute_10Enabled”:true}} |
| XML |
|
<?xml version=”1.0″ encoding=”utf-16″ ?>
<LimitationInfoResult xmlns:xsd=”http://www.w3.org/2001/XMLSchema”
xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”>
<AllowedBandwidthPerHour>-1</AllowedBandwidthPerHour>
<AllowedCallsPerHour>-1</AllowedCallsPerHour>
<AllowedCallsPerMonth>-1</AllowedCallsPerMonth>
<AllowedBandwidthPerMonth>-1</AllowedBandwidthPerMonth>
<ExpirationDate>”01-01-0001 12:00:00 AM”</ExpirationDate>
<Enabled>true</Enabled>
<AllowedExchanges>
<AllowedInstruments>-1</AllowedInstruments>
<DataDelay>0</DataDelay>
<ExchangeName>DUMMY</ExchangeName>
</AllowedExchanges>
<AllowedExchanges>
<AllowedInstruments>-1</AllowedInstruments>
<DataDelay>0</DataDelay>
<ExchangeName>NFO</ExchangeName>
</AllowedExchanges>
<AllowedFunctions>
<IsEnabled>false</IsEnabled>
</AllowedFunctions>
<AllowedFunctions>
<FunctionName>GetHistory</FunctionName>
<IsEnabled>true</IsEnabled>
</AllowedFunctions>
<HistoryLimitation>
<TickEnabled>true</TickEnabled>
<DayEnabled>true</DayEnabled>
<MaxEOD>100000</MaxEOD>
<MaxIntraday>5</MaxIntraday>
<MaxTicks>5</MaxIntraday>
<Hour_1Enabled>true</Hour_1Enabled>
<Hour_2Enabled>true</Hour_2Enabled>
<Hour_4Enabled>true</Hour_4Enabled>
<Minute_1Enabled>true</Minute_1Enabled>
<Minute_5Enabled>true</Minute_5Enabled>
<Minute_10Enabled>true</Minute_10Enabled>
</HistoryLimitation>
</LimitationInfoResult > |
| CSV |
| AllowedBandwidthPerHour,AllowedCallsPerHour,AllowedBandwidthPerMonth,AllowedCallsPerMonth,Enabled,AllowedExchanges,AllowedFunctions,ExpirationDate,HistoryLimitation,SubscribeSnapshotLimitation,GetExchangeSnapshotLimitation,GetExchangeSnapshotInstrumentTypeLimitation,GetSnapshotLimitation -1,-1,-1,-1,True,System.Collections.Generic.List`1[IConnectorPlugin.DataAccess.LimitationInfo.ExchangePermissionsParams],System.Collections.Generic.List`1[IConnectorPlugin.DataAccess.LimitationInfo.FunctionPermissionsParams],1719772199000,IConnectorPlugin.DataAccess.LimitationInfo.HistoryLimitationParams,,IConnectorPlugin.DataAccess.LimitationInfo.GetSnapshotLimitationParams,, |
