WebApi

<back to all web services

GetScriptRunDetail

Fetches a particular script running status

The following routes are available for this service:
GET, OPTIONS/Scripts/{ScriptId}/Detail
GET, OPTIONS/Scripts/{ScriptId}/run-detail
GetScriptRunDetail Parameters:
NameParameterData TypeRequiredDescription
AuthorizationheaderstringYesAuthorization token in the form "Bearer your_token_here"
ScriptIdpathstringYesScript ID
ScriptRunDetail Parameters:
NameParameterData TypeRequiredDescription
ScriptIdformstringNo
NameformstringNo
ActiveOrdersformIList<Order>No
OrderExecutionsformIList<ExecutionReport>No
CurrentSubscriptionsformIList<MarketSubscription>No
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
ExecutionReport Parameters:
NameParameterData TypeRequiredDescription
ClientIdformstringNo
OrderIdformstringNo
StatusformOrderStatusNo
TypeformOrderTypeNo
InstformInstrumentNo
SideformOrderSideNo
RemainingformdecimalNo
FilledformdecimalNo
LastTradeformMarketDepthItemNo
MarketSubscription Parameters:
NameParameterData TypeRequiredDescription
InstformInstrumentNo
DepthTypeformMarketDepthTypeNo
DepthformintNo

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

HTTP + XML

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

GET /Scripts/{ScriptId}/Detail HTTP/1.1 
Host: burntrouter.info 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ScriptRunDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Algomate.Scripting">
  <ActiveOrders i:nil="true" />
  <CurrentSubscriptions i:nil="true" />
  <Name>String</Name>
  <OrderExecutions i:nil="true" />
  <ScriptId>String</ScriptId>
</ScriptRunDetail>