Brokerage Details

API for calculating brokerage fees associated with stock. It accepts input parameters like the instrument, quantity, and other necessary details, and provides a comprehensive breakdown of the total charges.

Header Parameters

Name	Required	Type	Description
Authorization	true	string	Requires the format Bearer access_token where access_token is obtained from the Token API.
Accept	true	string	Defines the content format the client expects, which should be set to application/json.

Query Parameters

Name	Required	Type	Description
instrument_token	true	string	Key of the instrument. For the regex pattern applicable to this field, see the Field Pattern Appendix.
quantity	true	integer (int32)	Quantity with which the order is to be placed
product	true	string	Product with which the order is to be placed
transaction_type	true	string	Indicates whether its a BUY or SELL order
price	true	number (float)	Price with which the order is to be placed

Responses

• 200
• 4XX

---

Response Body

{
    "status": "success",
    "data": {
        "charges": {
            "total": 208.27,
            "brokerage": 0.0,
            "taxes": {
                "gst": 1.02,
                "stt": 175.0,
                "stamp_duty": 26.23
            },
            "other_charges": {
                "transaction": 5.68,
                "clearing": 0.0,
                "ipft": 0.17,
                "sebi_turnover": 0.17
            },
            "dp_plan": {
                "name": "DP3A",
                "min_expense": 18.5
            }
            "otherTaxes": {
                "transaction": 5.68,
                "clearing": 0.0,
                "ipft": 0.17,
                "sebi_turnover": 0.17
            },
            "dpPlan": {
                "name": "DP3A",
                "min_expense": 18.5
            },
        }
    }
}

Name	Type	Description
status	string	A string indicating the outcome of the request. Typically success for successful operations.
data	object	Response data for brokerage
data.charges	object	Response data for charges details
data.charges.total	float	Total charges for the order
data.charges.brokerage	float	Brokerage charges for the order
data.charges.taxes	object	Taxes levied on order
data.charges.taxes.gst	float	GST charges
data.charges.taxes.stt	float	STT charges
data.charges.taxes.stamp_duty	float	Stamp duty charges
data.charges.other_charges	object	Other applicable charges
data.charges.other_charges.transaction	float	Transaction charges
data.charges.other_charges.clearing	float	Clearing charges
data.charges.other_charges.ipft	float	IPF charges
data.charges.other_charges.sebi_turnover	float	SEBI turnover charges
data.charges.dp_plan	object	dpPlan detail
data.charges.dp_plan.name	string	Name of the user's Depository Participant plan, indicating the specific DP service they are enrolled in.
data.charges.dp_plan.min_expense	float	Daily minimum charges per scrip on sales, not included in brokerage calculations, indicating extra costs under the user's DP plan.

Notice of Deprecation

The camelCase fields (otherTaxes, and dpPlan) are deprecated and will be removed in future versions. Use the snake_case versions for consistency.

Error codes

Error code	Description
UDAPI1059	The instrument_token is of invalid format - The given instrument_token format isn't correct
UDAPI1060	The quantity is required - The quantity field needs to be provided
UDAPI1064	The quantity cannot be zero - You cannot provide zero as the quantity value
UDAPI1063	The product is required - The product field is missing
UDAPI1054	The 'product' is invalid - The provided value for product is not acceptable
UDAPI1062	The transaction_type is required - You need to provide the transaction_type field
UDAPI1057	The ''transaction_type'' is invalid - The given value for transaction_type is not valid
UDAPI1061	The price is required - The price field is missing
UDAPI1065	The price cannot be zero - Zero is not an acceptable value for price

Examples

A comprehensive set of examples is provided to illustrate various use cases and implementation scenarios for this API. To view detailed examples and access sample code, please refer to: API Examples.

Loading...