This document outlines the appropriate format that the traders must follow while writing the webhook payload for setting up the following types of Options orders to be executed into AutoShares.
Let’s get started 🚀
Market Order
The traders can write the webhook payload for setting up Market orders using these t payload fields:
- Symbol
- Action
- Quantity
Symbol
The ticker symbol of the options. AutoShares uses a specific format to represent them by the combination of the Stock ticker symbol, Expiration Date, Option Type, and Strike price. For the complete list of options symbols, please check this page.
The format is as follows:
[Stock Ticker Symbol] [Space] [Expiration Date] [Option Type] [Strike Price]
For example:
AAPL 240315C00140000
AMZN 230915P00056000
META 230825P00150000
- "AAPL", "AMZN", and "META" are the stock ticker symbols for Apple Inc., Amazon.com Inc., and Meta Platforms Inc., respectively.
- "240315" represents the expiration date of the options contract.
- "C" indicates a call option, and "P" indicates a put option.
- "140000", "56000", and "5000" are the respective strike prices of the call or put options.
Action
The signal action indicates the type of trade to be triggered. The action can be any of the following:
- Buy: Triggers an action to buy the asset.
- Sell: Triggers an action to sell the asset.
- Close: Triggers an action to close an existing open position and exit the trade.
Quantity
The number of assets to be traded. If omitted, the quantity will be dynamically calculated or defaulted to 1.
Class
The Class is a field or property that identifies and categorizes financial instruments such as futures, options, warrants, bonds, CFDs, crypto, forex, stocks, and funds. Required to be specified for assets with time-limited contracts like Options.
EXAMPLE
I. Buy
{
"symbol": "AAPL 240315C00140000",
"action": "buy",
"quantity": 123,
"class": "option"
}
II. Sell
{
"symbol": "AAPL 240315C00140000",
"action": "sell",
"quantity": 123,
"class": "option"
}
III. Close
{
"symbol": "AAPL 240315C00140000",
"action": "close",
"class": "option"
}
Limit Order
The traders can write the webhook payload for setting up Limit orders using these five payload fields:
- Symbol
- Action
- Quantity
- Limit_price
- Class
Symbol
The ticker symbol of the options. AutoShares uses a specific format to represent them by the combination of the Stock ticker symbol, Expiration Date, Option Type, and Strike price. For the complete list of options symbols.
The format is as follows:
[Stock Ticker Symbol] [Space] [Expiration Date] [Option Type] [Strike Price]
For example:
AAPL 240315C00140000
AMZN 230915P00056000
META 230825P00150000
- "AAPL", "AMZN", and "META" are the stock ticker symbols for Apple Inc., Amazon.com Inc., and Meta Platforms Inc., respectively.
- "240315" represents the expiration date of the options contract.
- "C" indicates a call option, and "P" indicates a put option.
- "140000", "56000", and "5000" are the respective strike prices of the call or put options.
Action
The signal action indicates the type of trade to be triggered. The action can be any of the following:
- Buy: Triggers an action to buy the asset.
- Sell: Triggers an action to sell the asset.
- Close: Triggers an action to close an existing open position and exit the trade.
Quantity
The number of assets to be traded. If omitted, the quantity will be dynamically calculated or defaulted to 1.
Limit_price
An optional field specifying the execution price for a “buy” or “sell” trade. If you specify the limit price the trade will be executed at the specified limit price. Or If you choose not to specify a limit price, the trade will be executed at the current market price.
Class
The Class is a field or property that identifies and categorizes financial instruments such as futures, options, warrants, bonds, CFDs, crypto, forex, stocks, and funds. Required to be specified for assets with time-limited contracts like Options.
EXAMPLE
I. Buy
{
"symbol": "AAPL 240315C00140000",
"action": "buy",
"quantity": 123,
"limit_price": 123.98,
"class": "option"
}
II. Sell
{
"symbol": "AAPL 240315C00140000",
"action": "sell",
"quantity": 123,
"limit_price": 123.98,
"class": "option"
}
III. Close
{
"symbol": "AAPL 240315C00140000",
"action": "close",
"limit_price": 123.98,
"class": "option"
}
Stop Order
The traders can write the webhook payload for setting up Stop orders using these five payload fields:
- Symbol
- Action
- Quantity
- Stop_price
- Class
Symbol
The ticker symbol of the options. AutoShares uses a specific format to represent them by the combination of the Stock ticker symbol, Expiration Date, Option Type, and Strike price. For the complete list of options symbols.
The format is as follows:
[Stock Ticker Symbol] [Space] [Expiration Date] [Option Type] [Strike Price]
For example:
AAPL 240315C00140000
AMZN 230915P00056000
META 230825P00150000
- "AAPL", "AMZN", and "META" are the stock ticker symbols for Apple Inc., Amazon.com Inc., and Meta Platforms Inc., respectively.
- "240315" represents the expiration date of the options contract.
- "C" indicates a call option, and "P" indicates a put option.
- "140000", "56000", and "5000" are the respective strike prices of the call or put options.
Action
The signal action indicates the type of trade to be triggered. The action can be any of the following:
- Buy: Triggers an action to buy the asset.
- Sell: Triggers an action to sell the asset.
- Close: Triggers an action to close an existing open position and exit the trade.
Quantity
The number of assets to be traded. If omitted, the quantity will be dynamically calculated or defaulted to 1.
Stop_price
An optional field specifying the price level at which a stop-loss or stop-limit order should be triggered. It helps limit potential losses by automatically closing the position when the specified price is reached.
Class
The Class is a field or property that identifies and categorizes financial instruments such as futures, options, warrants, bonds, CFDs, crypto, forex, stocks, and funds. Required to be specified for assets with time-limited contracts like Options.
EXAMPLE
I. Buy
{
"symbol": "AAPL 240315C00140000",
"action": "buy",
"quantity": 123,
"stop_price": 123.98,
"class": "option"
}
II. Sell
{
"symbol": "AAPL 240315C00140000",
"action": "sell",
"quantity": 123,
"stop_price": 123.98,
"class": "option"
}
III. Close
{
"symbol": "AAPL 240315C00140000",
"action": "close",
"stop_price": 123.98,
"class": "option"
}
Stop-Limit Order
The traders can write the webhook payload for setting up Stop-Limit orders using these six payload fields:
- Symbol
- Action
- Quantity
- Limit_price
- Stop_price
- Class
Symbol
The ticker symbol of the options. AutoShares uses a specific format to represent them by the combination of the Stock ticker symbol, Expiration Date, Option Type, and Strike price. For the complete list of options symbols.
The format is as follows:
[Stock Ticker Symbol] [Space] [Expiration Date] [Option Type] [Strike Price]
For example:
AAPL 240315C00140000
AMZN 230915P00056000
META 230825P00150000
- "AAPL", "AMZN", and "META" are the stock ticker symbols for Apple Inc., Amazon.com Inc., and Meta Platforms Inc., respectively.
- "240315" represents the expiration date of the options contract.
- "C" indicates a call option, and "P" indicates a put option.
- "140000", "56000", and "5000" are the respective strike prices of the call or put options.
Action
The signal action indicates the type of trade to be triggered. The action can be any of the following:
- Buy: Triggers an action to buy the asset.
- Sell: Triggers an action to sell the asset.
- Close: Triggers an action to close an existing open position and exit the trade.
Quantity
The number of assets to be traded. If omitted, the quantity will be dynamically calculated or defaulted to 1.
Limit_price
An optional field specifying the execution price for a “buy” or “sell” trade. If you specify the limit price the trade will be executed at the specified limit price. Or If you choose not to specify a limit price, the trade will be executed at the current market price.
Stop_price
An optional field specifying the price level at which a stop-loss or stop-limit order should be triggered. It helps limit potential losses by automatically closing the position when the specified price is reached.
Class
The Class is a field or property that identifies and categorizes financial instruments such as futures, options, warrants, bonds, CFDs, crypto, forex, stocks, and funds. Required to be specified for assets with time-limited contracts like Options.
EXAMPLE
I. Buy
{
"symbol": "AAPL 240315C00140000",
"action": "buy",
"quantity": 123,
"limit_price": 123.98,
"stop_price": 123.98,
"class": "option"
}
II. Sell
{
"symbol": "AAPL 240315C00140000",
"action": "sell",
"quantity": 123,
"limit_price": 123.98,
"stop_price": 123.98,
"class": "option"
}
III. Close
{
"symbol": "AAPL 240315C00140000",
"action": "close",
"limit_price": 123.98,
"stop_price": 123.98,
"class": "option"
}