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
GetScriptRunDetail Parameters:
NameParameterData TypeRequiredDescription
ScriptIdpathstringYesScript ID
ScriptRunDetail Parameters:
NameParameterData TypeRequiredDescription
ScriptIdformstringNo
NameformstringNo
ActiveOrdersformList<Order>No
OrderExecutionsformList<ExecutionReport>No
CurrentSubscriptionsformList<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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ScriptId: String,
	Name: String,
	ActiveOrders: 
	[
		{
			ClientId: String,
			OrderId: String,
			Timestamp: 0001-01-01,
			Exchange: ,
			Type: Market,
			Side: Buy,
			Status: New,
			Price: 0,
			Quantity: 0,
			Remaining: 0,
			Filled: 0,
			SessionId: String,
			SessionSubId: String,
			LastTradeTimestamp: 0001-01-01,
			Fills: 
			[
				{
					
				}
			],
			Cost: 0
		}
	],
	OrderExecutions: 
	[
		{
			
		}
	],
	CurrentSubscriptions: 
	[
		{
			
		}
	]
}