Webhooks
TradersPost allows third party applications like TradingView and TrendSpider to integrate with your connected brokers via webhooks.
Webhooks are automated messages sent from applications when something happens. They have a message that can contain a payload of data and are sent to a unique URL.
In the context of automated trading, the webhook message contains all the information about the trade signal like what ticker to buy and at what price. Here is an example simple webhook.
{
"ticker": "AMD",
"action": "buy"
}
Once you have connected your broker, you will be ready to create a webhook. To create your first webhook, follow these steps.
- 1.Navigate to Webhooks and click the New Webhook button at the top right. Give it a name and choose which asset class this webhook should work for.
- 2.Review the other optional available settings. These settings are optional and can be ignored if you are just getting started.
- 3.Finally, click the Save button and your webhook will be created.
- 4.Now you will see a Webhook URL and a Copy button. You can use the copy button to copy the webhook URL to your clipboard for pasting it in TradingView later.
You can continue reading and learning about webhooks below. You can always come back to this page later to learn about the functionality that you can control with the webhook JSON payload.
Here is a quick reference list of all the supported fields and values for the TradersPost webhook JSON.
- ticker - The ticker symbol name. Example AMD.
- action - The signal action. The only supported values are
buy,sell,exit,canceloradd. - sentiment - The signal sentiment. The only supported values are
bullish,long,bearish,shortandflat. - price - The price of the buy or sell action. If you omit this value, the current market price will be used when the trade is executed.
- quantity - The quantity to enter. If you omit this value, the quantity will be dynamically calculated or defaulted to 1. Check Use signal quantity in your strategy subscription settings to use this quantity.
- takeProfit - The take profit to attach to your entry order. This objects supported fields are
limitPrice,price,percent. Check Use signal take profit in your strategy subscription settings to use this take profit. - stopLoss - The stop loss to attach to your entry order. This objects supported fields are
type,percent,amount,stopPrice,limitPrice,trailPriceandtrailPercent. Check Use signal stop loss in your strategy subscription settings to use this stop loss.
Properties other than the ones listed above can be sent, but will be ignored by TradersPost. This means you can send extra properties for debugging purposes.
Here is the full reference documentation for the TradersPost webhook JSON.
post
https://webhooks.traderspost.io
/trading/webhook/{uuid}/{password}
TradersPost Webhook Request API documentation.
Parameters
Query
uuid*
String
Unique webhook UUID string used to identify a webhook. This never changes.
password*
String
Password string used to protect access to your webhook. You can change this by clicking Generate New URL in TradersPost when editing your webhook.
Body
ticker*
String
The ticker symbol name. Example AMD.
action*
String
The signal action. Supported values are buy, sell, exit, cancel or add.
buy - Exit bearish position and optionally open bullish position
sell - Exit bullish position and optionally open bearish position
exit - Exit open position without entering a new position on the other side.
cancel - Cancel open orders
add - Add to existing open position
sentiment
String
bullish - Open position after trade is executed should be bullish or flat.
bearish - Open position after trade is executed should be bearish or flat.
flat - No position should be open after trade is executed.
price
String
The price of the buy or sell action. If you omit this value, the current market price will be used when the trade is executed.
quantity
String
The quantity to enter. If you omit this value, the quantity will be dynamically calculated or defaulted to 1.
Responses
200: OK
Successful webhook response.
400: Bad Request
Rejected webhook response.
404: Not Found
Webhook not found.
500: Internal Server Error
Something went wrong
Here are some example webhook JSON payloads to demonstrate the different use cases.
{
"ticker": "SQ",
"action": "buy"
}
{
"ticker": "SQ",
"action": "exit"
}
You can also use the sentiment field to exit a bullish position without entering a bearish position on the other side. When you send sentiment=flat, it will always exit the full quantity of the open position.
{
"ticker": "SQ",
"action": "sell",
"sentiment": "flat"
}
{
"ticker": "SQ",
"action": "sell"
}
{
"ticker": "SQ",
"action": "exit"
}
You can also use the sentiment field to exit a bearish position without entering a bullish position on the other side. When you send sentiment=flat, it will always exit the full quantity of the open position.
{
"ticker": "SQ",
"action": "buy",
"sentiment": "flat"
}
Cancel all the open orders for the given ticker.
{
"ticker": "SQ",
"action": "cancel"
}
You can add to an existing open position by using the add action. This will add to the existing open position regardless of if Allow add to position is checked in your strategy subscription settings.
{
"ticker": "SQ",
"action": "add"
}
The signal quantity will only be used if you check Use signal quantity in the strategy subscription settings in TradersPost.
{
"ticker": "SQ",
"action": "buy",
"quantity": 5
}
The full quantity of the open position in the broker will be exited if you do not send a quantity in the exit signal. TradersPost is only able to partially exit open positions by sending the explicit quantity to exit in the webhook JSON.
The signal price is optional. If you omit a price from the signal, the mid point between the bid and the ask will be used if you have limit orders configured.
{
"ticker": "SQ",
"action": "buy",
"price": 60.30
}
You can optionally send take profit information with your entry signals.
The signal take profit will only be used if you check Use signal take profit in the strategy subscription settings in TradersPost.
The following fields are allowed on the takeProfit object, but never together. You can only choose one of the three types of take profit types (limitPrice, percent, or amount).
- limitPrice - Absolute limit price calculated on the webhook sender side.
- percent: Relative percentage take profit to calculate relative to entry price. The entry price for market orders is estimated based on the mid point between the bid and ask on the most recent quote.
- amount - Relative dollar amount take profit to calculate relative to entry price. The entry price for market orders is estimated based on the mid point between the bid and ask on the most recent quote.
When using market orders and you are calculating a relative take profit price, TradersPost will fetch a quote from your broker and use the price from the quote as the entry price in order to calculate the take profit limit price since with markets orders, we don't know the price you will be filled at so we have to use the quote price.
{
"ticker": "SQ",
"action": "buy",
"takeProfit": {
"percent": 10
}
}
{
"ticker": "SQ",
"action": "buy",
"takeProfit": {
"amount": 10
}
}
{
"ticker": "SQ",
"action": "buy",
"takeProfit": {
"limitPrice": 19.99
}
}
You can optionally send stop loss information with your entry signals.
The signal stop loss will only be used if you check Use signal stop loss in the strategy subscription settings in TradersPost.
The following fields are allowed on the stopLoss object.
- type - Type of stop loss. If a value is provided, it overrides the stop loss type configured in strategy subscription settings. Allowed values are: stop, stop_limit, trailing_stop.
- percent: Relative percentage stop loss to calculate relative to entry price.
- amount - Relative dollar amount stop loss to calculate relative to entry price.
- stopPrice - Absolute stop price calculated on the webhook sender side.
- limitPrice - Absolute limit price calculated on the webhook sender side. type must be set to stop_limit to use this field.
- trailPrice - A dollar value away from the highest water mark. If you set this to 2.00 for a sell trailing stop, the stop price is always hwm - 2.00. type must be set to trailing_stop to use this field.
- trailPercent - A percent value away from the highest water mark. If you set this to 1.0 for a sell trailing stop, the stop price is always hwm * 0.99. type must be set to trailing_stop to use this field.
Percentage stop loss calculated relative to entry price.
When using market orders and you are calculating a relative stop loss price, TradersPost will fetch a quote from your broker and use the price from the quote as the entry price in order to calculate the stop loss stop price since with markets orders, we don't know the price you will be filled at so we have to use the quote price.
{
"ticker": "SQ",
"action": "buy",
"stopLoss": {
"type": "stop",
"percent": 5
}
}
{
"ticker": "SQ",
"action": "buy",
"stopLoss": {
"type": "stop",
"amount": 5
}
}
{
"ticker": "SQ",
"action": "buy",
"stopLoss": {
"type": "stop",
"stopPrice": 10.71
}
}
{
"ticker": "SQ",
"action": "buy",
"stopLoss": {
"type": "stop_limit",
"stopPrice": 10.71,
"limitPrice": 10.75
}
}
{
"ticker": "SQ",
"action": "buy",
"stopLoss": {
"type": "trailing_stop",
"trailPercent": 1
}
}
{
"ticker": "SQ",
"action": "buy",
"stopLoss": {
"type": "trailing_stop",
"trailPrice": 1
}
}
You can use the take profit and stop loss functionality together. Just send us both the
takeProfit and stopLoss with your entry signal. Here is an example.{
"ticker": "SQ",
"action": "buy",
"takeProfit": {
"limitPrice": 19.99
},
"stopLoss": {
"type": "stop",
"stopPrice": 10.71
}
}
The JSON that gets sent to TradersPost has to be precisely accurate in order for us to accept it. It is important to pay attention all the details, all the little characters have meaning and are important. Here are the types of errors you may encounter when sending JSON to TradersPost webhooks.
post-required - HTTP POST method is required.
All webhook HTTP requests must be sent with a request method of POST. All other request methods will not be accepted.
malformed-json - Could not parse JSON payload.
If you have a parse error in your JSON code, TradersPost will not be able to extract the instructions from the signal. Here are some common mistakes people make.
No trailing comma
Notice the trailing comma on line 3, the JSON specification requires that there be no final trailing comma on the last item in a JSON object.
{
"ticker": "TSLA",
"action": "buy",
}
Here is the corrected JSON.
{
"ticker": "TSLA",
"action": "buy"
}
Invalid double quote character
Some applications will convert a double quote like
"quote" to a left and right side double quote like “quote”. Notice the difference between " and “ . JSON parsers don't like it when you use the latter. Here is an example invalid signal.{
“ticker”: “TSLA”,
“action”: “buy”
}
Here is the corrected JSON.
{
"ticker": "TSLA",
"action": "buy"
}
invalid-payload - Invalid payload. action and ticker is required.
The minimum required fields are an action and ticker. All other fields are optional.
invalid-action - Invalid action provided.
Action must be one of: buy, sell, exit, cancel, add. The available actions available for webhooks are buy, sell, exit, cancel and add.
invalid-sentiment - Invalid sentiment provided.
Sentiment must be one of: bullish, bearish, flat. The available sentiments are bullish, bearish and flat. You can optionally exchange long for bullish and short for bearish. This is for compatibility with TradingView strategies out of the box.
invalid-sentiment-action - Invalid sentiment action provided.
Sentiment can only be used with action buy or sell. You can only pass a sentiment in a webhook request when using action=buy or action=sell.
For example, sending a payload with
"action": "exit" and "sentiment": "flat" will produce an error since only the "action": "exit" is needed.// Invalid JSON
{
"ticker": "GOOGL",
"action": "exit",
"sentiment": "flat"
}
// Valid JSON that will exit the entire GOOGL position
{
"ticker": "GOOGL",
"action": "exit"
}
not-trading-view - Request did not come from TradingView.
If you check Limit to TradingView in your webhook configuration, then the only IP addresses that will be allowed to send a request to it will be from TradingView.
not-trend-spider - Request did not come from TrendSpider.
If you check Limit to TrendSpider in your webhook configuration, then the only IP addresses that will be allowed to send a request to it will be from TrendSpider.
invalid-ip-address - Request did not come from configured IP addresses.
If you enter an ip address in Limit to IP Addresses in your webhook configuration, then the only IP addresses that will be allowed to send a request to it will be from the configure ip addresses.
ticker-does-not-exist - Ticker does not exist.
If the passed ticker does not exist in our ticker database then the webhook request will be rejected.
invalid-password - Password is invalid.
Every webhook has a password that can be regenerated by clicking the Generate New URL button when viewing a webhook
empty-ticker-name - Empty ticker name provided.
Sending an empty ticker name is not allowed.
{
"ticker": "",
"action": "buy"
}
unsupported-ticker - Ticker is not allowed on this webhook.
If your webhook is restricted to a specific list of tickers and you send a ticker not in that list, then the webhook request will be rejected.
invalid-quantity - Invalid quantity.
Quantities must be a valid numeric value. Any other non numeric values will cause the webhook request to be rejected.
invalid-asset-class - Invalid asset class.
If you send a ticker for an asset class that the webhook does not support, then the webhook request will be rejected.
Because TradersPost works using standard webhooks, this enables users to integrate with third party platforms that support sending alerts as webhooks.
Here are some popular platforms that enable you to build strategies and send alerts as webhooks.
- TradingView - TradingView is a social network of 30 million traders and investors using the world's best charts and tools to spot trading opportunities across global markets.
- TrendSpider - TrendSpider provides technical analysis software for retail traders and investors focused on the US equity and foreign exchange markets.
In addition to sending webhooks from third parties, you can send webhooks to TradersPost from custom code using programming languages like PHP or Python. Here is an example using PHP and the Symfony HTTP Client.
mkdir traderspost
cd traderspost
Now require the
symfony/http-client package using composer.composer require symfony/http-client
Now you are ready to create a file named
traderspost-test.php and paste the following code inside of the file.<?php
// traderspost-test.php
require 'vendor/autoload.php';
use Symfony\Component\HttpClient\HttpClient;
$webhookUrl = 'https://traderspost.io/trading/webhook/9d9f8620-d60d-416e-827e-0ec01ef93532/9b5b8c4264421f5515fd4fcb6571af50';
$client = HttpClient::create();
$response = $client->request('POST', $webhookUrl, [
'json' => [
'ticker' => 'AMD',
'action' => 'buy',
'price' => 85.50,
]
]);
echo $response->getContent();
Now you are ready to send the webhook to TradersPost!
php traderspost-test.php
{"success":true,"id":"cd481b19-9bb7-4845-8227-523203971d47","payload":{"ticker":"AMD","action":"buy","price":85.50}}
This is a simple example, but you can combine this with a service like Polygon.io to get live real-time market data and build your own completely custom trading strategies and TradersPost can handle the integrations with your broker.
Last modified 21d ago