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 Lime Financial.
Let’s get started 🚀
Market Order
The traders can write the webhook payload for setting up Market orders using these four payload fields:
- Symbol
- Action
- Quantity
- Class
Symbol
The ticker symbol of the options. Lime Financial uses a specific format to represent them by the combination of the Stock ticker symbol, Expiration Date, Option Type, and Strike price.
The format is as follows:
[Stock Ticker Symbol] [ _ ] [Expiration Date] [Option Type] [Strike Price]
For example
AAPL221121C145
AMZN221121P3500
META_221121C50
- "AAPL", "AMZN", and "META" are the stock ticker symbols for Apple Inc., Amazon.com Inc., and Meta Platforms Inc., respectively.
- The underscore {_} separates the stock symbol from the rest of the options contract information.
- "221121" represents the expiration date of the options contract in the format of YYMMDD (21, November 2022).
- "C" indicates a call option, and "P" indicates a put option.
- "145", "3500", and "50" are the respective strike prices of the call or put options.
Action
The single action field in the order of the option can be any one of the following.
- Buy: Triggers an action to purchase the asset.
- Sell: Triggers an action to sell the asset.
- Buy-to-Cover: Triggers an action to buy back and close a previously sold asset (ending a short trade).
- Sell-Short: Triggers an action to sell borrowed assets with the expectation of buying them back at a lower price.
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 bonds.
EXAMPLE
I. Buy
{
"symbol": "AAPL_221121C145",
"action": "buy",
"quantity": 123,
"class": "option"
}
II. Sell
{
"symbol": "AAPL_221121C145",
"action": "sell",
"quantity": 123,
"class": "option"
}
III. Buy-To-Cover
{
"symbol": "AAPL_221121C145",
"action": "buy_to_cover",
"quantity": 123,
"class": "option"
}
IV. Sell-Short
{
"symbol": "AAPL_221121C145",
"action": "sell_short",
"quantity": 123,
"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. Lime Financial uses a specific format to represent them by the combination of the Stock ticker symbol, Expiration Date, Option Type, and Strike price.
The format is as follows:
[Stock Ticker Symbol] [ _ ] [Expiration Date] [Option Type] [Strike Price]
For example
AAPL221121C145
AMZN221121P3500
META_221121C50
- "AAPL", "AMZN", and "META" are the stock ticker symbols for Apple Inc., Amazon.com Inc., and Meta Platforms Inc., respectively.
- The underscore {_} separates the stock symbol from the rest of the options contract information.
- "221121" represents the expiration date of the options contract in the format of YYMMDD (21, November 2022).
- "C" indicates a call option, and "P" indicates a put option.
- "145", "3500", and "50" are the respective strike prices of the call or put options.
Action
The single action field in the order of the option can be any one of the following.
- Buy: Triggers an action to purchase the asset.
- Sell: Triggers an action to sell the asset.
- Buy-to-Cover: Triggers an action to buy back and close a previously sold asset (ending a short trade).
- Sell-Short: Triggers an action to sell borrowed assets with the expectation of buying them back at a lower price.
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 bonds.
EXAMPLE
I. Buy
{
"symbol": "AAPL_221121C145",
"action": "buy",
"quantity": 123,
"limit_price": 123.98,
"class": "option"
}
II. Sell
{
"symbol": "AAPL_221121C145",
"action": "sell",
"quantity": 123,
"limit_price": 123.98,
"class": "option"
}
III. Buy-To-Cover
{
"symbol": "AAPL_221121C145",
"action": "buy_to_cover",
"quantity": 123,
"limit_price": 123.98,
"class": "option"
}
IV. Sell-Short
{
"symbol": "AAPL_221121C145",
"action": "sell_short",
"quantity": 123,
"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. Lime Financial uses a specific format to represent them by the combination of the Stock ticker symbol, Expiration Date, Option Type, and Strike price.
The format is as follows:
[Stock Ticker Symbol] [ _ ] [Expiration Date] [Option Type] [Strike Price]
For example
AAPL221121C145
AMZN221121P3500
META_221121C50
- "AAPL", "AMZN", and "META" are the stock ticker symbols for Apple Inc., Amazon.com Inc., and Meta Platforms Inc., respectively.
- The underscore {_} separates the stock symbol from the rest of the options contract information.
- "221121" represents the expiration date of the options contract in the format of YYMMDD (21, November 2022).
- "C" indicates a call option, and "P" indicates a put option.
- "145", "3500", and "50" are the respective strike prices of the call or put options.
Action
The single action field in the order of the option can be any one of the following.
- Buy: Triggers an action to purchase the asset.
- Sell: Triggers an action to sell the asset.
- Buy-to-Cover: Triggers an action to buy back and close a previously sold asset (ending a short trade).
- Sell-Short: Triggers an action to sell borrowed assets with the expectation of buying them back at a lower price.
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 bonds.
EXAMPLE
I. Buy
{
"symbol": "AAPL_221121C145",
"action": "buy",
"quantity": 123,
"stop_price": 123.98,
"class": "option"
}
II. Sell
{
"symbol": "AAPL_221121C145",
"action": "sell",
"quantity": 123,
"stop_price": 123.98,
"class": "option"
}
III. Buy-To-Cover
{
"symbol": "AAPL_221121C145",
"action": "buy_to_cover",
"quantity": 123,
"stop_price": 123.98,
"class": "option"
}
IV. Sell-Short
{
"symbol": "AAPL_221121C145",
"action": "sell_short",
"quantity": 123,
"stop_price": 123.98,
"class": "option"
}
Stop-Limit Order
The traders can write the webhook payload for setting up Stop-Limit orders using these five payload fields:
- Symbol
- Action
- Quantity
- Limit_price
- Stop_price
- Class
Symbol
The ticker symbol of the options. Lime Financial uses a specific format to represent them by the combination of the Stock ticker symbol, Expiration Date, Option Type, and Strike price.
The format is as follows:
[Stock Ticker Symbol] [ _ ] [Expiration Date] [Option Type] [Strike Price]
For example
AAPL221121C145
AMZN221121P3500
META_221121C50
- "AAPL", "AMZN", and "META" are the stock ticker symbols for Apple Inc., Amazon.com Inc., and Meta Platforms Inc., respectively.
- The underscore {_} separates the stock symbol from the rest of the options contract information.
- "221121" represents the expiration date of the options contract in the format of YYMMDD (21, November 2022).
- "C" indicates a call option, and "P" indicates a put option.
- "145", "3500", and "50" are the respective strike prices of the call or put options.
Action
The single action field in the order of the option can be any one of the following.
- Buy: Triggers an action to purchase the asset.
- Sell: Triggers an action to sell the asset.
- Buy-to-Cover: Triggers an action to buy back and close a previously sold asset (ending a short trade).
- Sell-Short: Triggers an action to sell borrowed assets with the expectation of buying them back at a lower price.
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 bonds.
EXAMPLE
I. Buy
{
"symbol": "AAPL_221121C145",
"action": "buy",
"quantity": 123,
"limit_price": 123.98,
"stop_price": 123.98,
"class": "option"
}
II. Sell
{
"symbol": "AAPL_221121C145",
"action": "sell",
"quantity": 123,
"limit_price": 123.98,
"stop_price": 123.98,
"class": "option"
}
III. Buy-To-Cover
{
"symbol": "AAPL_221121C145",
"action": "buy_to_cover",
"quantity": 123,
"limit_price": 123.98,
"stop_price": 123.98,
"class": "option"
}
IV. Sell-Short
{
"symbol": "AAPL_221121C145",
"action": "sell_short",
"quantity": 123,
"limit_price": 123.98,
"stop_price": 123.98,
"class": "option"
}