ICICI Direct (Breeze API) — How to Get Your API Credentials
Before you can use Breeze API, you need to register an app on ICICI Direct's API portal
and obtain an App Key (API Key), a Secret Key, and a
Session Token. This guide covers only that — getting your credentials.
It stops there.
Before You Start
- An active ICICI Direct trading account
- Your ICICI Direct login credentials, used to sign in to the API portal itself
Step 1: Log in to the Breeze API portal
Go to api.icicidirect.com/apiuser/home and log in with your ICICI Direct
credentials.
📸 Screenshot 1: Breeze API portal login page
Highlight the login form.
Step 2: Register an app
Open "Register an App" and create a new application by providing an App Name and a
Redirect URL (for local testing, ICICI Direct's own documentation examples use something
like https://127.0.0.1).
📸 Screenshot 2: Register an App form
Highlight the App Name and Redirect URL fields.
Step 3: Copy your App Key and Secret Key
Once registered, open "View Apps" in your dashboard to find the new app, then copy its
App Key (your API Key) and Secret Key — unique to that app.
📸 Screenshot 3: View Apps screen showing App Key and Secret Key
Mask the actual key values before sharing this screenshot with anyone —
use dummy values if illustrating this step.
Step 4: Generate a Session Token
From the same "View Apps" section, follow ICICI Direct's instructions to generate a
Session Token. All three credentials — App Key, Secret Key, and Session Token — are
required together to authenticate against the Breeze API.
📸 Screenshot 4: Session Token generation screen
Mask the actual token value before sharing — use a dummy value if illustrating this step.
What You Should Have Now
- App Key (API Key) — from the registered app
- Secret Key — from the registered app
- Session Token — generated separately, used alongside the two above
Like some other brokers' request-token/access-token flows, ICICI Direct's Session Token is
part of a login step distinct from the App Key/Secret pair — regenerating it periodically
is outside the scope of this guide.
Important Limitations
- Session Token expiry and rate limits are not covered in the pages reviewed for this guide — check ICICI Direct's Breeze API documentation directly for current figures.
- For API-specific queries, ICICI Direct's own support channel is
breezeapi@icicisecurities.com, per their documentation.
🔒 Security warning: Keep your Secret Key and Session Token confidential.
Never share them publicly. Never include real credentials in screenshots — use dummy
values or mask them.
Screenshot Checklist
- Breeze API portal login page
- Register an App form
- View Apps screen showing App Key and Secret Key
- Session Token generation screen
Source: ICICI Direct's official Breeze API documentation (api.icicidirect.com/breezeapi/documents) and ICICI Direct's own FAQs (icicidirect.com/faqs).
ZORVO