tranzium/autoview-syntax.txt

## autoview-syntax.txt
---------- Usage
The syntax created by these parameters is placed in an alert's description on TradingView
to be utilized by Autoview, a Chrome Extension.

Autoview:     https://chrome.google.com/webstore/detail/autoview/okdhadoplaoehmeldlpakhpekjcpljmb
> Website:    https://autoview.with.pink
> Help:       https://use.autoview.with.pink
> Discord:    https://discordapp.com/invite/BFz8VPn
TradingView:  https://tradingview.go2cloud.org/aff_c?offer_id=2&aff_id=1187


---------- Syntax
<letter>=<value>
<letter>=<value> <letter>=<value>...


---------- Parameters
Alias         ?    type          default         values

account       a    string        *               Anything (excluding special characters)
book          b    string        <all>           buy, long, sell, short
cancel/close  c    string        n/a             order, position
> maximum     cm   decimal       <all>           #, min#-max#, %, min%-max%
> max. order  cmo  string        oldest          newest, oldest, lowest, highest, smallest, biggest, random
disabled      d    boolean       0               0, 1
leverage      l    integer       <all>           >= 0
price         p    decimal       0               #, min#-max#, %, min%-max%
quantity      q    decimal       100%            #, min#-max#, %, min%-max%
shared             boolean       0               0, 1
stoploss      sl   integer       n/a             #, min#-max#, %, min%-max%
order type    t    string        limit          limit, market, open, close, fok, ioc, post
take profit   tp   integer       n/a             #, min#-max#, %, min%-max%
yield         y    string        balance         balance, equity

-- Override
exchange      e    string        <symbol>        1BROKER, OKCOIN
symbol        s    string        <symbol>        BTCCNY, GBPNZD, LTCUSD3M, ...


---------- Examples
-- Place a buy order of 5 quantity (market price)
b=buy q=5 t=market

-- Place a short at an undercut of $0.05
b=short p=-0.05 q=1

-- Place a long of 1-10 contracts, between the top price and an undercut of $1-2
b=long p=1-2 q=1-10


---------- Notes
PERCENTAGES: Will automatically be converted to a decimal (i.e. / 100).
e.g. 20% = 0.2
e.g. 115% = 1.15

PRICE: When using percentages, the calculation will be based directly off the top value.
e.g. $300 * 50% = $150
e.g. undercut @ p=95%: $300 * 0.95 = $285
e.g. overcut @ p=105%: $300 * 1.05 = $315

ORDER TYPE: [limit, market] apply to both opening orders and closing positions.
[close] applies to position closing orders.
[open] applies to canceling open orders.
[fok] Fill Or Kill orders will either completely fill or be aborted.
[ioc] Immediate Or Cancel orders can be partially or completely filled, but any remaining portion is cancelled.
[post] If any part of the order would have executed, it will be cancelled instead.
e.g. Cancel all open orders: c=order t=open
e.g. Cancel all position closing orders: c=order t=close
e.g. Cancel all orders: c=order

SYMBOL: Until more Forex exchanges are implemented, FX symbols will default to 1Broker.

YIELD: [balance] will use your available balance in calculations
[equity] will use your entire account balance in calculations
-- Using [equity] may cause orders to fail due to calculated contract quantity.
	---------- Usage
	The syntax created by these parameters is placed in an alert's description on TradingView
	to be utilized by Autoview, a Chrome Extension.

	Autoview: https://chrome.google.com/webstore/detail/autoview/okdhadoplaoehmeldlpakhpekjcpljmb
	> Website: https://autoview.with.pink
	> Help: https://use.autoview.with.pink
	> Discord: https://discordapp.com/invite/BFz8VPn
	TradingView: https://tradingview.go2cloud.org/aff_c?offer_id=2&aff_id=1187


	---------- Syntax
	<letter>=<value>
	<letter>=<value> <letter>=<value>...


	---------- Parameters
	Alias ? type default values

	account a string * Anything (excluding special characters)
	book b string <all> buy, long, sell, short
	cancel/close c string n/a order, position
	> maximum cm decimal <all> #, min#-max#, %, min%-max%
	> max. order cmo string oldest newest, oldest, lowest, highest, smallest, biggest, random
	disabled d boolean 0 0, 1
	leverage l integer <all> >= 0
	price p decimal 0 #, min#-max#, %, min%-max%
	quantity q decimal 100% #, min#-max#, %, min%-max%
	shared boolean 0 0, 1
	stoploss sl integer n/a #, min#-max#, %, min%-max%
	order type t string limit limit, market, open, close, fok, ioc, post
	take profit tp integer n/a #, min#-max#, %, min%-max%
	yield y string balance balance, equity

	-- Override
	exchange e string <symbol> 1BROKER, OKCOIN
	symbol s string <symbol> BTCCNY, GBPNZD, LTCUSD3M, ...


	---------- Examples
	-- Place a buy order of 5 quantity (market price)
	b=buy q=5 t=market

	-- Place a short at an undercut of $0.05
	b=short p=-0.05 q=1

	-- Place a long of 1-10 contracts, between the top price and an undercut of $1-2
	b=long p=1-2 q=1-10


	---------- Notes
	PERCENTAGES: Will automatically be converted to a decimal (i.e. / 100).
	e.g. 20% = 0.2
	e.g. 115% = 1.15

	PRICE: When using percentages, the calculation will be based directly off the top value.
	e.g. $300 * 50% = $150
	e.g. undercut @ p=95%: $300 * 0.95 = $285
	e.g. overcut @ p=105%: $300 * 1.05 = $315

	ORDER TYPE: [limit, market] apply to both opening orders and closing positions.
	[close] applies to position closing orders.
	[open] applies to canceling open orders.
	[fok] Fill Or Kill orders will either completely fill or be aborted.
	[ioc] Immediate Or Cancel orders can be partially or completely filled, but any remaining portion is cancelled.
	[post] If any part of the order would have executed, it will be cancelled instead.
	e.g. Cancel all open orders: c=order t=open
	e.g. Cancel all position closing orders: c=order t=close
	e.g. Cancel all orders: c=order

	SYMBOL: Until more Forex exchanges are implemented, FX symbols will default to 1Broker.

	YIELD: [balance] will use your available balance in calculations
	[equity] will use your entire account balance in calculations
	-- Using [equity] may cause orders to fail due to calculated contract quantity.