Alert Syntax

Name	Key	Default	Values	Description
Account	`a`	*	Anything (excluding special characters)	The alias for the API credentials you want to use for this command.
Auto Borrow	`ab`	0	0, 1	Funds will be borrowed to ensure sufficient funds when placing an order.
Account Identifier	`aid`	n/a	Anything	Using a specific account when multiple accounts are available.
Auto Margin Replenishment	`amr`	0	0, 1	Available funds in your account will be transferred to the margin of the position.
Auto Repay	`ar`	0	0, 1	Automatic repayment will be triggered when the order is finished.
Blind Carbon Copy	`bcc`	0	0, 1	Relay this command to the configured endpoint only. Exchange requests will not be made.
Book	`b`	all	buy, long; sell, short	The side of the market you would like to play.
Cancel / Close	`c`	n/a	order, position	Used to cancel open orders or close open positions.
Carbon Copy	`cc`	0	0, 1	Relay this command to the configured endpoint and exchange.
Close	`close`	1	0, 1	A Close order will cancel other active limit orders with the same side and symbol.
Cancel / Close Maximum	`cm`	all	Static: #, % Random: #-#, %-%	Cancels orders or closes positions (see`cmo`for ordering).
Cancel / Close Maximum Order	`cmo`	oldest	newest, oldest; lowest, highest; smallest, biggest; random	How the orders are sorted for canceling. How the positions are sorted for closing. Adjust repaying strategy from recently expiring to highest rate first (e.g.`y=repay cmo=highest`)
Close On Trigger	`cot`	0	0, 1	When creating a closing order, this is recommended to avoid failing by insufficient available margin
Delay	`delay`	n/a	> 0	Delay allows for a pause (in seconds) between commands within the same alert (e.g.`delay=10`).
Disabled	`d`	0	0, 1	Prevents any live action from the command. This is helpful for debugging by outputting the live parameters.
Date/Time	`dt`	n/a	e.g. 2020-09-14	The date/time when the order will be cancelled (if still an open order).
Exchange	`e`	`Chart Symbol`	Binance, Kraken, ...	The receiving exchange for your command.
Extended Hours	`eh`	0	0, 1	Order will be eligible to execute in premarket/after hours.
Expiration Time	`t`	2592000 1 month	> 0	How long (in seconds) to wait for the condition to be triggered before cancelling the order.
Fee	`f`	0	0, 1	Switch the trading fee to the exchange provided option.
Fixed Guaranteed Stop Loss	`fgsl`	n/a	Static: # Random: #-#	Order created with a price threshold which is guaranteed against slippage.
Fixed Price	`fp`	n/a	Static: # Random: #-#	The literal price in which to place an order or close a position.
Fixed Price Bound	`fpb`	n/a	Static: # Random: #-#	The worst market price that may be used to fill this Stop Order. If the market gaps and crosses through both the price and the price bound, the Stop Order will be cancelled instead of being filled.
Fixed Stop Loss	`fsl`	n/a	Static: # Random: #-#	Triggers the order (buy or sell) when the last traded price hits the stop price.
Fixed Stop Loss Trigger Price	`fslx`	n/a	Static: # Random: #-#	Triggers the stop loss order when the last traded price hits this price.
Fixed Take Profit	`ftp`	n/a	Static: # Random: #-#	Triggers the order (buy or sell) when the last price hits the profit price.
Fixed Take Profit Trigger Price	`ftpx`	n/a	Static: # Random: #-#	Triggers the take profit order when the last traded price hits this price.
Fixed Trailing Stop	`fts`	n/a	Static: # Random: #-#	The trailing stop price adjusts or "trails" the market price by a specified amount.
Fixed Trigger Price	`fpx`	n/a	Static: # Random: #-#	Set the price stop limit orders.
Guaranteed Stop Loss	`gsl`	n/a	Static: #, % Random: #-#, %-%	Order created with a price threshold which is guaranteed against slippage.
Hedge mode	`hedge`	n/a	1	Open both Buy and Sell side positions simultaneously.
Hidden / Iceberg	`h`	n/a	Static: #, % Random: #-#, %-%	Sets the order to be hidden if 0. If > 0 this portion of the position to be visible (i.e. Iceberg).
Identifier	`id`	Date.now()	<= 26 characters code [a-z0-9.:-_]	A unique identifier among open orders. Automatically generated if not used.
Leverage	`l`	all	>= 0	Leverage allows your available balance to be multiplied but increases risk.
Leverage Type	`lt`	n/a	cross, isolated	Change leverage type when placing new orders.
One Cancels the Other	`oco`	0	0, 1	A conditional order that combines a limit order with a stop-limit order.
One Sends the Other	`oso`	0	0, 1	OSO orders allow for the most complex multi-bracket trading strategies.
Price	`p`	0	Static: #, % Random: #-#, %-%	The amount to undercut or over-cut the top order in the book.
Price Bound	`pb`	n/a	Static: #, % Random: #-#, %-%	The worst market price that may be used to fill this Stop Order. If the market gaps and crosses through both the price and the price bound, the Stop Order will be cancelled instead of being filled.
Price Source	`ps`	top	last, top, position	(last, top) Change the reference for Price (`p`) calculations. (position) When closing positions (`c=position`), use the position average in calculations.
Trigger Price	`px`	n/a	Static: #, % Random: #-#, %-%	Set the price for stop orders.
Trigger Price Source	`pxs`	last	last, mark, index	Change the reference for Trigger Price (`px`) calculations.
Quantity	`q`	100%	Static: #, % Random: #-#, %-%	The portion of your balance or position you would like to effect.
Reduce Only	`ro`	0	0, 1	Order can only reduce your position, not increase it.
Symbol	`s`	`Chart Symbol`	BTCUSD3M, LTCUSD, PINKBTC, ...	The receiving exchange's market for your command.
Stop Loss	`sl`	n/a	Static: #, % Random: #-#, %-%	Triggers the order (buy or sell) when the last traded price hits the stop price.
Stop Loss Trigger Price	`slx`	n/a	Static: #, % Random: #-#, %-%	Triggers the stop loss order when the last traded price hits this price.
Order Type	`t`	limit	limit, market, fok, ioc, post, close, open, settle, stop	Limit: Order will be placed in the books to await being filled. Market: Place order in the book for immediate filling (`p`is ignored). 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. Close / Open: Can be used together with code c=order for specific order types. Stop: Stop Order request.
Take Profit	`tp`	n/a	Static: #, % Random: #-#, %-%	Triggers the order (buy or sell) when the last price hits the profit price.
Take Profit Trigger Price	`tpx`	n/a	Static: # Random: #-#	Triggers the take profit order when the last traded price hits this price.
Testing	`testing`	0	0, 1	While enabled, prevents any live action from any command until disabled. This is helpful for debugging by outputting the live parameters.
Trailing Stop	`ts`	n/a	Static: #, % Random: #-#, %-%	The trailing stop price adjusts or "trails" the market price by a specified amount.
Unit	`u`	contracts	contracts, currency	The quantity (`q`) unit being provided.
Wallet	`w`	n/a	Anything	The currencies to transfer from wallet account to another (e.g. spot to margin). Multiple currencies may be used (e.g.`w=btc,cad,usdt`)
Yield	`y`	balance	balance, equity, margin, spot, borrow, repay, futures, delivery, spot-futures, spot-delivery, contract, investment, spot-contract, spot-investment	Balance: Your available balance excluding open orders/positions. Equity: Your available balance including profit/loss. Margin: Move balance from Spot wallet to Margin wallet Spot: Move balance from Margin wallet to Spot wallet Borrow: Apply for a loan for each Wallet asset Repay: Repay loan for Wallet asset