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

Parse Contract Note PDF

cURL

curl --request POST \
  --url https://api.casparser.in/v4/contract_note/parse \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form pdf_file='@example-file' \
  --form 'password=<string>'

200

{
  "status": "success",
  "msg": "success",
  "data": {
    "contract_note_info": {
      "contract_note_number": "CNT-25/26-73436720",
      "trade_date": "2025-08-05",
      "settlement_number": "2025149",
      "settlement_date": "2025-08-06"
    },
    "broker_info": {
      "broker_type": "zerodha",
      "name": "Zerodha Broking Limited",
      "sebi_registration": "INZ000031633"
    },
    "client_info": {
      "name": "VIRENDER KUMAR",
      "pan": "FAXAK2545F",
      "ucc": "YS3654",
      "place_of_supply": "DELHI",
      "gst_state_code": "7",
      "address": "<string>"
    },
    "equity_transactions": [
      {
        "isin": "INE172A01027",
        "security_name": "CASTROLIND",
        "security_symbol": "CASTROLIND",
        "buy_quantity": 123,
        "buy_wap": 123,
        "buy_total_value": 123,
        "sell_quantity": 123,
        "sell_wap": 123,
        "sell_total_value": 123,
        "net_obligation": 123
      }
    ],
    "derivatives_transactions": [
      {
        "contract_description": "NIFTY24802410DPE",
        "buy_sell_bf_cf": "B",
        "quantity": 123,
        "wap_per_unit": 123,
        "brokerage_per_unit": 123,
        "closing_rate_per_unit": 123,
        "net_total": 123
      }
    ],
    "detailed_trades": [
      {
        "order_number": "1000000042939390",
        "order_time": "13:13:13",
        "trade_number": "4006567",
        "trade_time": "13:13:13",
        "security_description": "CASTROLIND-EQ/INE172A01027",
        "buy_sell": "B",
        "exchange": "NSE",
        "quantity": 123,
        "brokerage": 123,
        "net_rate_per_unit": 123,
        "closing_rate_per_unit": 123,
        "net_total": 123,
        "remarks": "<string>"
      }
    ],
    "charges_summary": {
      "pay_in_pay_out_obligation": 123,
      "taxable_value_brokerage": 123,
      "exchange_transaction_charges": 123,
      "cgst": 123,
      "sgst": 123,
      "igst": 123,
      "securities_transaction_tax": 123,
      "sebi_turnover_fees": 123,
      "stamp_duty": 123,
      "net_amount_receivable_payable": 123
    }
  }
}

Authorizations

x-api-key · string · header · required

Your API key for authentication. Use sandbox-with-json-responses as Sandbox key.

Body

multipart/form-dataapplication/json

pdf_file · file · required

Contract note PDF file to parse

password · string · required

Password for the PDF file (usually PAN number)

broker_type · enum<string>

Optional broker type override

Available options: zerodha, groww, upstox, icici

Response

200

application/json

Successfully parsed contract note

status · string

Example:

"success"

msg · string

Example:

"success"

data · object

Show child attributes