APIs (Application Programming interface), is a software intermediary that allows two applications to talk to each other. In the case of a typical Trading API, on one end would be an application of your market broker (ICICI Securities for example) and on the other end would be your code or application.

There are numerous ways a Trading API can help you better your trading experience in not just stock markets, but other markets like commodities or forex as well. Trading APIs allow you to get live market prices, execute orders in real time, and help manage your orders and positions. Built especially for market participants with technical knowledge looking for personalised trading experience using innovative logic, Trading APIs can help one build a complete investment and trading platform in no time.

The Breeze API is a powerful Indian stock market API through which you can fetch live/historical stock market data, real-time OHLC and Options Chain data, order status over Websockets, automate your trading strategies and monitor your portfolio in real-time.

Breeze API allows up to 100 calls per minute and 5,000 calls per day, enabling you to fetch real-time data, automate trades, and monitor your portfolio with no additional charges.

These limits apply across all endpoints—whether you're pulling stock quotes, option chain data, or placing orders.

SDK stands for software development kit. Also known as a devkit, the SDK is a set of software-building tools for a specific platform, including the building blocks, debuggers, and, often, a framework or group of code libraries such as a set of routines specific to an operating system (OS). You can find three SDKs in Breeze API:

• Javascript SDK
  https://www.npmjs.com/package/breezeconnect
• C# SDK
  https://www.npmjs.com/package/breezeconnect
• Python SDK
  https://www.npmjs.com/package/breezeconnect

Option Chain API allows you to get option chain data for equities or indices within a given maturity period. To access the data, simply specify the instrument, the month the option expires, and whether you are interested in calls, puts, or both. Yes, Breeze allows you to use Options Chain API, where in a single API call you can get the entire chain with OHLC prices, Open Interest, Volume, and much more, and lets you filter the chain by the expiry date, right or strike price

There is no cost or fees which customer needs to pay to access Breeze API or the data which we provide. All ICICIdirect customers can use Breeze API and create Apps free of all charges. 

After successfully registering your App on Breeze login page, the API key and Secret Key should be available in the view Apps section in the homepage. Generate a session token for the respective App. Plug all 3 App credentials (API key, Secret Key and Session Token) in the Breeze API endpoint and start using the API. Please refer to our articles to see the step wise process

• https://www.icicidirect.com/futures-and-options/api/breeze/article/introduction-to-trading-apis-and-how-to-start-using-breezeapi/
• https://www.icicidirect.com/futures-and-options/api/breeze/article/what-is-a-session-key-and-how-to-generate-it-for-using-breezeapi

Breeze API currently supports trading in the following segments:

1) Stocks (Cash/Equity)

2) Derivatives (Futures & Options)

Some examples of order types that can be placed using the Breeze API include:

- Market orders

- Limit orders

- Stop Loss orders

Currently, the rate limit for API is 75 per minute and 5000 calls in a day per user

At present, Breeze API is only available for Resident Indians and not for NRI customers.

Breeze is a Rest API and it supports various languages such as Javascript, Python, Csharp, Java etc

One of the main benefits of using a Trading API to formulate your trading strategies is that it provides a way to test your strategy on historical data. Historical data helps traders do a scenario analysis for their strategies and backtest them, which is one of the most important steps in creating an automated trading system. Backtesting gives the traders a chance to optimise their portfolio and also indicate how their strategy might perform in the future, assuming market conditions do not change a lot. Breeze API has historical data for Futures and Options trading and at present support 3 years of data which can be used free of cost.

Yes, you may. We have websockets available for live data feed of markets. Please refer to our SDK page to know more.

Yes, it is available. Please click on https://pypi.org/project/breeze-connect/ to see the complete list of Python SDK methods available and how to use them

A basic level of programming knowledge is required to create strategies and use Breeze API.

You will have to use websockets to subscribe to live feeds of markets. Please click on

• https://pypi.org/project/breezeconnect/

to see the complete list of Python SDK methods available, including websockets and how to use them.

Breeze has SSL + (App Key, Secret Key) encryption + Checksum encryption of the whole data package so no amount of sniffing or hacking can reveal client data to the wannabe hacker.

Please refer to our SDK page which lists all the SDK methods including websockets for usage. Please click on https://pypi.org/project/breeze-connect/ to see the complete list of Python SDK methods available and how to use them. OHLC stands for Open, High, Low, and Close. It is a commonly used concept in trading and investing, especially in technical analysis. These four points of data, recorded for each trading period, form the foundation of many trading strategies and help investors assess market sentiment.

Please refer to our article

• https://www.icicidirect.com/futures-and-options/api/breeze/article/introduction-to-tradingapis-and-how-to-start-using-breezeapi.

A session key is a temporary key that is only used once, during one stretch of time, for encrypting and decrypting data. This is similar to One Time Passwords (OTP) that have to be generated once in the morning to login, and help in encrypting a communication session for each app separately. This key or token expires in 24 hours after generation or at midnight

Yes, it is required as per SEBI regulations

You will have to create a strategy by writing a programming code using Breeze API endpoints and open source libraries. You can then deploy them in your personal laptop/desktop in a IDE (like Jupyter, Spyder). Where can I deploy strategies I have created? Strategies should be deployed in your personal desktop/laptop in an IDE (like Jupyter, Spyder, VS) using Breeze API endpoint.

Yes, you can check the live positions through get_postions() function of Breeze.

To use Breeze API and code your strategy  follow these easy steps:

Process to Get Breeze API Access:

It is must to have a trading account with ICICI Direct - Breeze API is available only to registered ICICI Direct customers.

1. Visit the Official Breeze API Portal: 

Go to https://api.icicidirect.com/apiuser/home and login using your ICICI Direct credentials.

2. Generate API Keys: 

On the Breeze API dashboard, enter requisite details to generate your API Key and Secret Key.

3. Generate a Session Token: 

Navigate to the "View Apps" section to find your credentials and follow the instructions to generate your Session Token - required for authentication.

Yes, with Breeze API users can easily fetch 1sec, 1min data for historical backtesting purposes.

Code:

breeze.get_historical_data_v2(interval="1second", from_date= "2023-01-02T07:00:00.000Z", to_date= "2023-01-03T07:00:15.000Z", stock_code="ITC", exchange_code="NSE", product_type="cash")

The TOTP option is live in ICICIdirect API login page. Users can enable it by visiting the settings option at homepage:

https://www.icicidirect.com

No, Session key needs to be generated everyday manually according to SEBI guidelines. It is valid for 24 hours or until midnight.

Yes, make use of the following links:

1. Breeze connect library:https://pypi.org/project/breeze-connect/
2. Breeze documentation:https://api.icicidirect.com/breezeapi/documents/index.html#introduction
3. B2B documentation:https://api.icicidirect.com/apiuser/ICICIDirectAPIDOC.htm

With Breeze API, get a snapshot of the entire Option Chain of any stock code by just customizing the code below:

breeze.get_option_chain_quotes(stock_code="NIFTY", exchange_code="NFO", product_type="options", expiry_date="2022-12-25T06:00:00.000Z", right="call", strike_price="")

No, with Breeze API you get access to all the features like backtesting historical data, fetching live data via websockets etc absolutely free of cost

On subscribing to feeds, the callback is supposed to listen to any incoming data packets until the websocket is disconnected.

If we wish to stop feeds after a certain time , we can use time.sleep and then call unsubscribe_feeds .

#Connect to websocket

api.ws_connect()

# Callback to receive ticks. def on_ticks(ticks): print("Ticks: {}".format(ticks))

api.on_ticks = on_ticks

api.subscribe_feeds(stock_token="13.1!1050")

time.sleep(500)

api.unsubscribe_feeds(stock_token="13.1!1050")

To get the quotes of the mentioned stock code the following code can be customized:

breeze.get_quotes(stock_code="ICIBAN",

exchange_code="NFO",

expiry_date="2022-08-25T06:00:00.000Z",

product_type="futures",

right="others",

strike_price="0") Note: Please change exchange_code=“NFO” to get details about F&O

To get trade list of your account use the below code:

breeze.get_trade_list(from_date="2022-08-01T06:00:00.000Z",

to_date="2022-08-19T06:00:00.000Z",

exchange_code="NSE",

product_type="",

action="",

stock_code="")

Note: Please change exchange_code=“NFO” to get details about F&O

Sample code for using websockets:

from breeze_connect import BreezeConnect

# Initialize SDK breeze = BreezeConnect(api_key="your_api_key")

# Generate Session breeze.generate_session(api_secret="your_secret_key", session_token="your_api_session")

# Connect to websocket (it will connect to rate refresh server) breeze.ws_connect()

# Callback to receive ticks. def on_ticks(ticks): print("Ticks: {}".format(ticks))

# Assign the callbacks. breeze.on_ticks = on_ticks

# subscribe stocksfeeds breeze.subscribe_feeds(exchange_code="NFO", stock_code="ZEEENT", product_type="options", expiry_date="31-Mar-2022", strike_price="350", right="Call", get_exchange_quotes=True, get_market_depth=False

Sample code for modifying order:

breeze.modify_order(order_id="202208191100000001", exchange_code="NFO", order_type="limit", stoploss="0", quantity="250", price="290100", validity="day", disclosed_quantity="0", validity_date="2022-08-22T06:00:00.000Z")

Sample code for Squaring of Order:

breeze.square_off(exchange_code="NSE",

product="margin", stock_code="NIFTY", quantity="10", price="0", action="sell", order_type="market", validity="day", stoploss="0", disclosed_quantity="0", protection_percentage="", settlement_id="", cover_quantity="", open_quantity="", margin_amount="")

Sample code for fetching portfolio details: breeze.get_portfolio_holdings(exchange_code="NFO", from_date="2022-08-01T06:00:00.000Z", to_date="2022-08-19T06:00:00.000Z", stock_code="", portfolio_type="")

For setting funds:

breeze.set_funds(transaction_type="debit", amount="200", segment="Equity")

For getting funds: breeze.get_funds()