Buying Signals

Last updated 7 days ago

Open positions automatically from your buying signals.

post
It works with GET too, but POST is more secure.

https://zignaly.com
/api/signals.php
This endpoint allows you to send buying signals. If you want to use GET instead of POST, just add the parameters to the URL.
Request
Response
Query Parameters
takeProfitAmountPercentage1
optional
string
The percentage from the total position size that will be sold once this target (determined by the ending number) has been reached. The amount between all your targets has to be equal to 100.
takeProfitPrice1
optional
string
You can add as many targets as you wish, you just need to increase the final number on each. You can establish the target by price using this param or by percentage using the takeProfitPercentage param.
takeProfitPercentage1
optional
string
You can add as many targets as you wish, you just need to increase the final number on each. You can establish the target by percentage using this param or by price using the takeProfitPrice param.
stopLossPercentage
optional
number
If the option from the provider configuration "Get Stop Loss Value from Signal" is checked, the position will use this price as stop loss.
limitPrice
optional
string
If present the "price" parameter and "buy price deviation" will ignore using this value instead.
positionSizeQuote
optional
string
The coin used to determine the position size. If any is provided the quote coin from the pair will be used.
positionSize
optional
string
The size of your position investment.
sellTTL
optional
string
If the position is still opened after this seconds have passed, the position will be closed selling at current market price.
buyTTL
optional
string
If the buy hasn't been completed after this seconds pass, the buy order will be removed and the position closed.
trailingStopDistancePercentage
optional
string
The distance below is the higher price at what the position will be sold. It's a percentage value
trailingStopTriggerPrice
optional
string
If the price reaches this value, the trailing stop will be activated. You can use trailingStopTriggerPercentage instead of this param.
trailingStopTriggerPercentage
optional
string
If the buying price plus this percentage is reached, the trailing stop will be activated. you can use trailingStopTriggerPrice instead of percentage.
MDXXXXXX
optional
string
This is a free field for sending metadata. Start the word with MD, followed by whatever name you want to give, example: MDSource and it will be stored as metaData->Source.
pair
required
string
The pair for what this signal is, example: XRPBTC.
key
required
string
The generated key that was created in the provider creation step.
type
optional
string
buy or sell, default is buy.
volume
optional
number
you can send the current volume at the time the signal was sent. Currently we don't use it for anything.
term
optional
string
short, shortmid, mid or long. If term is present, the position will be opened only if the term is selected in the provider configuration.
stopLoss
optional
number
If the option from the provider configuration Get Stop Loss Value From Signal is checked, the position will use this price as stop loss.
price
optional
number
If present, the buying order will sent with this price plus the configured Buy Price Deviation from your settings
signalId
optional
string
An unique identification for this signal. It could be used lately for selling the position through a sell signal.
exchange
optional
string
The signal would be opened only for this exchange. If it's missed, then it will be opened for your main exchange.
200: OK
Signal received.
{
}
400: Bad Request
The pair parameter is missing.
{
}
401: Unauthorized
The key parameter is missing.
{
}

In case you want to use GET instead of POST, parameters can be sent in the URL as in the example:

https://zignaly.com/api/signals.php?key=YOUR_PROVIDER_KEY&signalId=YOUR_UNIQUE_SIGNAL_ID&pair=XXXXXX&type=buy&price=0.0034&exchange=binance