WebApi

<back to all web services

UpdateScriptSubscriptions

Updates a script's market subscriptions

The following routes are available for this service:
PUT, OPTIONS/scripts/{ScriptId}/subscriptions
UpdateScriptSubscriptions Parameters:
NameParameterData TypeRequiredDescription
AuthorizationheaderstringYesAuthorization token in the form "Bearer your_token_here"
ScriptIdpathstringYesScript ID
SubscriptionsbodyList<MarketSubscription>YesNew instruments to subscribe to
MarketSubscription Parameters:
NameParameterData TypeRequiredDescription
InstformInstrumentNo
DepthTypeformMarketDepthTypeNo
DepthformintNo
Instrument Parameters:
NameParameterData TypeRequiredDescription
SymbolformCurrencyPairNo
ExchangeformExchangeNameNo
CurrencyPair Parameters:
NameParameterData TypeRequiredDescription
BaseformCurrencyNo
QuoteformCurrencyNo
NameformstringNo
Currency Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo

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.

PUT /scripts/{ScriptId}/subscriptions HTTP/1.1 
Host: burntrouter.info 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Authorization: String,
	ScriptId: String,
	Subscriptions: 
	[
		{
			
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		
	}
]