WebApi

<back to all web services

GetUIRequest

Get UI order status

The following routes are available for this service:
GET, OPTIONS/Orders/Ui/{RequestId}
GET, OPTIONS/Order/Ui/{RequestId}
GetUIRequest Parameters:
NameParameterData TypeRequiredDescription
AuthorizationheaderstringYesAuthorization token in the form "Bearer your_token_here"
RequestIdpathstringYes
UIRequest Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
CommandformUICommandNo
ProcessedformboolNo
SuccessformboolNo
MessageformstringNo
CreatedTimestampformDateTimeNo
ProcessedTimestampformDateTimeNo
DataformOrderNo
Order Parameters:
NameParameterData TypeRequiredDescription
ClientIdformstringNo
OrderIdformstringNo
TimestampformDateTimeNo
InstformInstrumentNo
ExchangeformExchangeNameNo
CurrencyPairformCurrencyPairNo
TypeformOrderTypeNo
SideformOrderSideNo
StatusformOrderStatusNo
PriceformdecimalNo
QuantityformdecimalNo
RemainingformdecimalNo
FilledformdecimalNo
SessionIdformstringNo
SessionSubIdformstringNo
LastTradeTimestampformDateTime?No
FillsformList<MarketDepthItem>No
CostformdecimalNo
Instrument Parameters:
NameParameterData TypeRequiredDescription
SymbolformCurrencyPairNo
ExchangeformExchangeNameNo
CurrencyPair Parameters:
NameParameterData TypeRequiredDescription
BaseformCurrencyNo
QuoteformCurrencyNo
NameformstringNo
Currency Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
MarketDepthItem Parameters:
NameParameterData TypeRequiredDescription
PriceformdecimalNo
QuantityformdecimalNo
TimestampformDateTimeNo
SideformOrderSideNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Orders/Ui/{RequestId} HTTP/1.1 
Host: burntrouter.info 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'UIRequest' using the custom 'csv' filter}No parameterless constructor defined for this object.