Contract Note Parser
Parse Contract Note PDF
This endpoint parses Contract Note PDF files from various brokers including Zerodha, Groww, Upstox, ICICI Securities, and others.
What is a Contract Note? A contract note is a legal document that provides details of all trades executed by an investor. It includes:
- Trade details with timestamps, quantities, and prices
- Brokerage and charges breakdown
- Settlement information
- Regulatory compliance details
Supported Brokers:
- Zerodha Broking Limited
- Groww Invest Tech Private Limited
- Upstox (RKSV Securities)
- ICICI Securities Limited
- Auto-detection for unknown brokers
Key Features:
- Auto-detection: Automatically identifies broker type from PDF content
- Comprehensive parsing: Extracts equity transactions, derivatives transactions, detailed trades, and charges
- Flexible input: Accepts both file upload and URL-based PDF input
- Password protection: Supports password-protected PDFs
The API returns structured data including contract note information, client details, transaction summaries, and detailed trade-by-trade breakdowns.
post/v4/contract_note/parse
Request body
Example request
{
"broker_type": "zerodha",
"password": "FAXAK2545F",
"pdf_file": "JVBERi0xLjQKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwo...",
"pdf_url": "https://example.com/contract_note.pdf"
}Response
Successfully parsed contract note
Example response
{
"data": {
"broker_info": {
"broker_type": "zerodha",
"name": "Zerodha Broking Limited",
"sebi_registration": "INZ000031633"
},
"client_info": {
"gst_state_code": "7",
"name": "VIRENDER KUMAR",
"pan": "FAXAK2545F",
"place_of_supply": "DELHI",
"ucc": "YS3654"
},
"contract_note_info": {
"contract_note_number": "CNT-25/26-73436720",
"settlement_date": "2025-08-06",
"settlement_number": "2025149",
"trade_date": "2025-08-05"
},
"derivatives_transactions": [
{
"buy_sell_bf_cf": "B",
"contract_description": "NIFTY24802410DPE"
}
],
"detailed_trades": [
{
"buy_sell": "B",
"exchange": "NSE",
"order_number": "1000000042939390",
"order_time": "13:13:13",
"security_description": "CASTROLIND-EQ/INE172A01027",
"trade_number": "4006567",
"trade_time": "13:13:13"
}
],
"equity_transactions": [
{
"isin": "INE172A01027",
"security_name": "CASTROLIND",
"security_symbol": "CASTROLIND"
}
]
},
"msg": "success",
"status": "success"
}