Kite Connect

https://kite.trade/docs/connect/v3/
Admin
Kite Connect is a set of REST-like HTTP APIs that enable building complete stock market investment...
Tokens:102,129
Snippets:381
Trust Score:9.2
Update:1 week ago
Show doc for...
Tokens:
Raw
### Sample JSON response for retrieving all SIPs

Source: https://kite.trade/docs/connect/v3/mutual-funds

Example response containing a list of SIP objects with fields like status, sip_id, fund, frequency, and instalment details.

```json
{
"data": [
  {
    "status": "ACTIVE",
    "sip_reg_num": null,
    "created": "2021-05-05 05:56:27",
    "dividend_type": "idcw",
    "instalment_amount": 500.0,
    "fund": "Aditya Birla Sun Life Liquid Fund - Direct Plan",
    "instalments": -1,
    "next_instalment": "2021-05-12",
    "transaction_type": "BUY",
    "trigger_price": 0,
    "step_up": {
      "05-05": 10
    },
    "tradingsymbol": "INF209K01VD7",
    "tag": "coiniossip",
    "frequency": "weekly",
    "last_instalment": "2021-05-05 05:56:27",
    "pending_instalments": -1,
    "instalment_day": 0,
    "sip_type": "sip",
    "completed_instalments": 0,
    "sip_id": "892741486820670"
  },
  {
    "status": "ACTIVE",
    "sip_reg_num": null,
    "created": "2021-05-25 10:55:09",
    "dividend_type": "idcw",
    "instalment_amount": 1000.0,
    "fund": "HDFC Balanced Advantage Fund - Direct Plan",
    "instalments": -1,
    "next_instalment": "2021-06-01",
    "transaction_type": "BUY",
    "trigger_price": 0,
    "step_up": {
      "25-05": 10
    },
    "tradingsymbol": "INF179K01VY8",
    "tag": "coiniossip",
    "frequency": "weekly",
    "last_instalment": "2021-05-25 10:55:09",
    "pending_instalments": -1,
    "instalment_day": 0,
    "sip_type": "sip",
    "completed_instalments": 0,
    "sip_id": "109195857904698"
  },
  {
    "status": "ACTIVE",
    "sip_reg_num": "15158182",
    "created": "2021-05-22 10:45:29",
    "dividend_type": "idcw",
    "instalment_amount": 1000.0,
    "fund": "HDFC Balanced Advantage Fund - Direct Plan",
    "instalments": 9999,
    "next_instalment": "2021-07-12",
    "transaction_type": "BUY",
    "trigger_price": 0,
    "step_up": {},
    "tradingsymbol": "INF179K01VY8",
    "tag": "coinandroidsip",
    "frequency": "monthly",
    "last_instalment": "2021-06-10 08:37:11",
    "pending_instalments": 9998,
    "instalment_day": 10,
    "sip_type": "amc_sip",
    "completed_instalments": 1,
    "sip_id": "846479755969168"
  },
  {
    "status": "ACTIVE",
    "sip_reg_num": "16055666",
    "created": "2021-06-18 03:56:46",
    "dividend_type": "idcw",
    "instalment_amount": 1000.0,
    "fund": "HDFC Balanced Advantage Fund - Direct Plan",
    "instalments": 9999,
    "next_instalment": "2021-07-30",
    "transaction_type": "BUY",
    "trigger_price": 0,
    "step_up": {},
    "tradingsymbol": "INF179K01VY8",
    "tag": "coinandroidsip",
    "frequency": "monthly",
    "last_instalment": "2021-06-30 08:33:07",
    "pending_instalments": 9998,
    "instalment_day": 30,
    "sip_type": "amc_sip",
    "completed_instalments": 1,
    "sip_id": "749073272501476"
  },
  {
    "status": "ACTIVE",
    "sip_reg_num": null,
    "created": "2020-11-20 01:06:11",
    "dividend_type": "growth",
    "instalment_amount": 7427.0,
    "fund": "HDFC Hybrid Equity Fund - Direct Plan",
    "instalments": -1,
    "next_instalment": "2021-02-19",
    "transaction_type": "BUY",
    "trigger_price": 0,
    "step_up": {
      "20-11": 30
    },
    "tradingsymbol": "INF179K01XZ1",
    "tag": "coinandroidsip",
    "frequency": "quarterly",
    "last_instalment": "2020-11-20 01:06:11",
    "pending_instalments": -1,
    "instalment_day": 0,
    "sip_type": "sip",
    "completed_instalments": 0,
    "sip_id": "576440634181776"
  }]
}

```

--------------------------------

### Sample response for GET /mf/orders

Source: https://kite.trade/docs/connect/v3/mutual-funds

Example JSON response from the /mf/orders endpoint, showing a list of orders with statuses like REJECTED and OPEN, along with fields such as order_id, tradingsymbol, amount, and status_message.

```json
{
  "status": "success",
  "data": [
    {
      "status": "REJECTED",
      "purchase_type": "FRESH",
      "folio": null,
      "order_timestamp": "2021-06-30 08:33:07",
      "average_price": 0.0,
      "exchange_order_id": "254657127",
      "last_price": 30.6800,
      "tradingsymbol": "INF179K01VY8",
      "settlement_id": "2122061",
      "transaction_type": "BUY",
      "order_id": "271989e0-a64e-4cf3-b4e4-afb8f38dd203",
      "amount": 1000.0,
      "tag": null,
      "placed_by": "ZV8062",
      "exchange_timestamp": "2021-06-30",
      "variety": "amc_sip",
      "last_price_date": "2021-06-29",
      "status_message": "AMC SIP: Insufficient balance.",
      "fund": "HDFC Balanced Advantage Fund - Direct Plan",
      "quantity": 0.0
    },
    {
      "status": "REJECTED",
      "purchase_type": "ADDITIONAL",
      "folio": null,
      "order_timestamp": "2021-06-30 01:30:02",
      "average_price": 0.0,
      "exchange_order_id": null,
      "last_price": 52.7980,
      "tradingsymbol": "INF174K01LS2",
      "settlement_id": null,
      "transaction_type": "BUY",
      "order_id": "ef7e696c-2fa6-400b-b180-eb25e6a04ccf",
      "amount": 2000.0,
      "tag": "coinandroidsip",
      "placed_by": "ZV8062",
      "exchange_timestamp": null,
      "variety": "sip",
      "last_price_date": "2021-06-29",
      "status_message": "SIP: Insufficient balance.",
      "fund": "Kotak Flexicap Fund - Direct Plan",
      "quantity": 0.0
    },
    {
      "status": "OPEN",
      "purchase_type": "FRESH",
      "folio": null,
      "order_timestamp": "2021-06-29 12:20:28",
      "average_price": 0.0,
      "exchange_order_id": null,
      "last_price": 10.4324,
      "tradingsymbol": "INF761K01EE1",
      "settlement_id": null,
      "transaction_type": "BUY",
      "order_id": "2b6ad4b7-c84e-4c76-b459-f3a8994184f1",
      "amount": 5000.0,
      "tag": null,
      "placed_by": "ZV8062",
      "exchange_timestamp": null,
      "variety": "regular",
      "last_price_date": "2021-06-29",
      "status_message": "Insufficient fund. 1/5",
      "fund": "BOI AXA Arbitrage Fund - Direct Plan",
      "quantity": 0.0
    },
    {
      "status": "REJECTED",
      "purchase_type": "FRESH",
      "folio": null,
      "order_timestamp": "2021-06-29 08:36:41",
      "average_price": 0.0,
      "exchange_order_id": "254447867",
      "last_price": 271.7500,
      "tradingsymbol": "INF179K01WA6",
      "settlement_id": "2122060",
      "transaction_type": "BUY",
      "order_id": "40410882-b1f8-4938-bb08-4bef2765cbfb",
      "amount": 1000.0,
      "tag": null,
      "placed_by": "ZV8062",
      "exchange_timestamp": "2021-06-29",
      "variety": "amc_sip",
      "last_price_date": "2021-06-29",
      "status_message": "AMC SIP: Insufficient balance.",
      "fund": "HDFC Balanced Advantage Fund - Direct Plan",
      "quantity": 0.0
    },
    {
      "status": "OPEN",
      "purchase_type": "FRESH",
      "folio": null,
      "order_timestamp": "2021-06-24 15:37:27",
      "average_price": 0.0,
      "exchange_order_id": null,
      "last_price": 11.5182,
      "tradingsymbol": "INF109K01V59",
      "settlement_id": null,
      "transaction_type": "BUY",
      "order_id": "e67b8741-5054-4fd5-a2da-8c672e1f494a",
      "amount": 5000.0,
      "tag": null,
      "placed_by": "ZV8062",
      "exchange_timestamp": null,
      "variety": "regular",
      "last_price_date": "2021-06-29",
      "status_message": "Insufficient fund. 3/5",
      "fund": "ICICI Prudential Bond Fund - Direct Plan",
      "quantity": 0.0
    }
  ]
}

```

--------------------------------

### Positions API response example

Source: https://kite.trade/docs/connect/v3/portfolio

Example JSON response from the Positions API. Contains 'net' and 'day' arrays with position details such as tradingsymbol, exchange, quantity, average price, and profit/loss metrics.

```json
{
    "status": "success",
    "data": {
        "net": [
            {
                "tradingsymbol": "LEADMINI17DECFUT",
                "exchange": "MCX",
                "instrument_token": 53496327,
                "product": "NRML",
                "quantity": 1,
                "overnight_quantity": 0,
                "multiplier": 1000,
                "average_price": 161.05,
                "close_price": 0,
                "last_price": 161.05,
                "value": -161050,
                "pnl": 0,
                "m2m": 0,
                "unrealised": 0,
                "realised": 0,
                "buy_quantity": 1,
                "buy_price": 161.05,
                "buy_value": 161050,
                "buy_m2m": 161050,
                "sell_quantity": 0,
                "sell_price": 0,
                "sell_value": 0,
                "sell_m2m": 0,
                "day_buy_quantity": 1,
                "day_buy_price": 161.05,
                "day_buy_value": 161050,
                "day_sell_quantity": 0,
                "day_sell_price": 0,
                "day_sell_value": 0
            },
            {
                "tradingsymbol": "GOLDGUINEA17DECFUT",
                "exchange": "MCX",
                "instrument_token": 53505799,
                "product": "NRML",
                "quantity": 0,
                "overnight_quantity": 3,
                "multiplier": 1,
                "average_price": 0,
                "close_price": 23232,
                "last_price": 23355,
                "value": 801,
                "pnl": 801,
                "m2m": 276,
                "unrealised": 801,
                "realised": 0,
                "buy_quantity": 4,
                "buy_price": 23139.75,
                "buy_value": 92559,
                "buy_m2m": 93084,
                "sell_quantity": 4,
                "sell_price": 23340,
                "sell_value": 93360,
                "sell_m2m": 93360,
                "day_buy_quantity": 1,
                "day_buy_price": 23388,
                "day_buy_value": 23388,
                "day_sell_quantity": 4,
                "day_sell_price": 23340,
                "day_sell_value": 93360
            },
            {
                "tradingsymbol": "SBIN",
                "exchange": "NSE",
                "instrument_token": 779521,
                "product": "CO",
                "quantity": 0,
                "overnight_quantity": 0,
                "multiplier": 1,
                "average_price": 0,
                "close_price": 0,
                "last_price": 308.4,
                "value": -2,
                "pnl": -2,
                "m2m": -2,
                "unrealised": -2,
                "realised": 0,
                "buy_quantity": 1,
                "buy_price": 311,
                "buy_value": 311,
                "buy_m2m": 311,
                "sell_quantity": 1,
                "sell_price": 309,
                "sell_value": 309,
                "sell_m2m": 309,
                "day_buy_quantity": 1,
                "day_buy_price": 311,
                "day_buy_value": 311,
                "day_sell_quantity": 1,
                "day_sell_price": 309,
                "day_sell_value": 309
            }
        ],
        "day": [
            {
                "tradingsymbol": "GOLDGUINEA17DECFUT",
                "exchange": "MCX",
                "instrument_token": 53505799,
                "product": "NRML",
                "quantity": -3,
                "overnight_quantity": 0,
                "multiplier": 1,
                "average_price": 23340,
                "close_price": 23232,
                "last_price": 23355,
                "value": 69972,
                "pnl": -93,
                "m2m": -93,
                "unrealised": -93,
                "realised": 0,
                "buy_quantity": 1,
                "buy_price": 23388,
                "buy_value": 23388,
                "buy_m2m": 23388,
                "sell_quantity": 4,
                "sell_price": 23340,
                "sell_value": 93360,
                "sell_m2m": 93360,
                "day_buy_quantity": 1,
                "day_buy_price": 23388,
                "day_buy_value": 23388,
                "day_sell_quantity": 4,
                "day_sell_price": 23340,
                "day_sell_value": 93360
            }
        ]
    }
}
```

--------------------------------

### get()

Source: https://kite.trade/docs/connect/v3/publisher

Returns an array of all added entries in the basket.

```APIDOC
## get()

### Description
Returns an array of all added entries in the basket.

### Method
get

### Returns
- array - Array of all added entries.
```

--------------------------------

### GET /mf/sips/

Source: https://kite.trade/docs/connect/v3/mutual-funds

Retrieves the list of all open SIP orders.

```APIDOC
## GET /mf/sips/

### Description
Retrieves the list of all open SIP orders.

### Method
GET

### Endpoint
https://api.kite.trade/mf/sips/

### Parameters
#### Headers
- **X-Kite-Version** (string) - Required - API version header, set to "3".
- **Authorization** (string) - Required - Authentication token in the format `token api_key:access_token`.

### Response
#### Success Response (200)
- **status** (string) - Status of the response.
- **data** (array) - List of SIP order objects.
  - **status** (string) - SIP status.
  - **purchase_type** (string) - Type of purchase.
  - **folio** (string|null) - Folio number.
  - **order_timestamp** (string) - Timestamp of order placement.
  - **average_price** (number) - Average execution price.
  - **exchange_order_id** (string|null) - Exchange order ID.
  - **last_price** (number) - Last traded price.
  - **tradingsymbol** (string) - Trading symbol.
  - **settlement_id** (string|null) - Settlement ID.
  - **transaction_type** (string) - Transaction type.
  - **order_id** (string) - Unique order ID.
  - **amount** (number) - Order amount.
  - **tag** (string|null) - Tag.
  - **placed_by** (string) - User ID.
  - **exchange_timestamp** (string|null) - Exchange timestamp.
  - **variety** (string) - Variety.
  - **last_price_date** (string) - Date of last price.
  - **status_message** (string) - Status message.
  - **fund** (string) - Fund name.
  - **quantity** (number) - Quantity.

#### Response Example
```
{
  "status": "success",
  "data": [
    {
      "status": "OPEN",
      "purchase_type": "FRESH",
      "folio": null,
      "order_timestamp": "2021-06-29 12:20:28",
      "average_price": 0.0,
      "exchange_order_id": null,
      "last_price": 10.4324,
      "tradingsymbol": "INF761K01EE1",
      "settlement_id": null,
      "transaction_type": "BUY",
      "order_id": "2b6ad4b7-c84e-4c76-b459-f3a8994184f1",
      "amount": 5000.0,
      "tag": null,
      "placed_by": "ZV8062",
      "exchange_timestamp": null,
      "variety": "regular",
      "last_price_date": "2021-06-29",
      "status_message": "Insufficient fund. 1/5",
      "fund": "BOI AXA Arbitrage Fund - Direct Plan",
      "quantity": 0.0
    }
  ]
}
```
```

--------------------------------

### link()

Source: https://kite.trade/docs/connect/v3/publisher

Links the basket to the given HTML element, which when clicked, will start the transaction in an overlay popup.

```APIDOC
## link()

### Description
Links the basket to the given HTML element, which when clicked, will start the transaction in an overlay popup.

### Method
link

### Arguments
- element_selector (string) - Required - HTML selector for the target element, e.g., '#buy-button', '.buttons'.

### Example
kite.link("#custom-button");
```

--------------------------------

### Install kiteconnect with uv in a project

Source: https://kite.trade/docs/connect/v3/agent-setup

Initializes a new project and adds the kiteconnect SDK using uv. Run this in a terminal.

```bash
uv init my-kite-app && cd my-kite-app
uv add kiteconnect

```

--------------------------------

### GET /user/margins - JSON response

Source: https://kite.trade/docs/connect/v3/user

Example JSON response from the margins endpoint showing equity and commodity segments with available and utilised margin details.

```json
{
    "status": "success",
    "data": {
      "equity": {
        "enabled": true,
        "net": 99725.05000000002,
        "available": {
          "adhoc_margin": 0,
          "cash": 245431.6,
          "opening_balance": 245431.6,
          "live_balance": 99725.05000000002,
          "collateral": 0,
          "intraday_payin": 0
        },
        "utilised": {
          "debits": 145706.55,
          "exposure": 38981.25,
          "m2m_realised": 761.7,
          "m2m_unrealised": 0,
          "option_premium": 0,
          "payout": 0,
          "span": 101989,
          "holding_sales": 0,
          "turnover": 0,
          "liquid_collateral": 0,
          "stock_collateral": 0,
          "delivery": 0
        }
      },
      "commodity": {
        "enabled": true,
        "net": 100661.7,
        "available": {
          "adhoc_margin": 0,
          "cash": 100661.7,
          "opening_balance": 100661.7,
          "live_balance": 100661.7,
          "collateral": 0,
          "intraday_payin": 0
        },
        "utilised": {
          "debits": 0,
          "exposure": 0,
          "m2m_realised": 0,
          "m2m_unrealised": 0,
          "option_premium": 0,
          "payout": 0,
          "span": 0,
          "holding_sales": 0,
          "turnover": 0,
          "liquid_collateral": 0,
          "stock_collateral": 0,
          "delivery": 0
        }
      }
    }
  }

```

--------------------------------

### Build a trade basket with KiteConnect.ready(), add(), renderButton(), and link()

Source: https://kite.trade/docs/connect/v3/publisher

Include the publisher.js plugin, then use KiteConnect.ready() to safely initialize a Kite instance and add multiple orders to a basket. Call renderButton() to generate a branded Kite button in a container, or link() to attach the basket to an existing element. Wrap all code in KiteConnect.ready() because assets load asynchronously.

```html
<!-- A Kite button will be generated inside this container //-->
<p id="default-button"></p>

<!-- The basket will be linked to this element's onClick //-->
<button id="custom-button">Buy the basket</button>

<!-- Include the plugin //-->
<script src="https://kite.trade/publisher.js?v=3"></script>

<script>
  // Only run your custom code once KiteConnect has fully initialised.
  // Use KiteConnect.ready() to achieve this.
  KiteConnect.ready(function () {
    // Initialize a new Kite instance.
    // You can initialize multiple instances if you need.
    var kite = new KiteConnect("your_api_key");

    // Add a stock to the basket
    kite.add({
      exchange: "NSE",
      tradingsymbol: "INFY",
      quantity: 5,
      transaction_type: "BUY",
      order_type: "MARKET",
    });

    // Add another stock
    kite.add({
      exchange: "NSE",
      tradingsymbol: "SBIN",
      quantity: 1,
      order_type: "LIMIT",
      transaction_type: "SELL",
      price: 105,
    });

    // Add a Cover Order
    kite.add({
      tradingsymbol: "RELIANCE",
      exchange: "NSE",
      transaction_type: "BUY",
      order_type: "LIMIT",
      product: "MIS",
      price: 915.15,
      quantity: 1,
      variety: "co",
      trigger_price: 910,
      readonly: true,
    });

    // Register an (optional) callback.
    kite.finished(function (status, request_token) {
      alert("Finished. Status is " + status);
    });

    // Render the in-built button inside a given target
    kite.renderButton("#default-button");

    // OR, link the basket to any existing element you want
    kite.link("#custom-button");
  });
</script>
```

--------------------------------

### Place an order with place_order()

Source: https://kite.trade/docs/connect/v3/agent-setup

Places a regular, day-valid, limit buy order for INFY on NSE with CNC product. Returns an order_id. Uses SDK constants for variety, exchange, product, and order type.

```python
order_id = kite.place_order(
    variety=kite.VARIETY_REGULAR,
    exchange=kite.EXCHANGE_NSE,
    tradingsymbol="INFY",
    transaction_type=kite.TRANSACTION_TYPE_BUY,
    quantity=1,
    product=kite.PRODUCT_CNC,
    order_type=kite.ORDER_TYPE_LIMIT,
    price=1500,
    validity=kite.VALIDITY_DAY,
)
print("Order placed:", order_id)

```

--------------------------------

### Response for GET /triggers/gtt

Source: https://kite.trade/docs/connect/v3/gtt

Example JSON response from the /triggers/gtt endpoint. Contains a list of triggers with fields such as id, type, status, condition, and orders. The response includes both active and triggered GTTs.

```json
{
    "status": "success",
    "data": [
        {
            "id": 112127,
            "user_id": "XX0000",
            "parent_trigger": null,
            "type": "single",
            "created_at": "2019-09-12 13:25:16",
            "updated_at": "2019-09-12 13:25:16",
            "expires_at": "2020-09-12 13:25:16",
            "status": "active",
            "condition": {
                "exchange": "NSE",
                "last_price": 798,
                "tradingsymbol": "INFY",
                "trigger_values": [
                    702
                ],
                "instrument_token": 408065
            },
            "orders": [
                {
                    "exchange": "NSE",
                    "tradingsymbol": "INFY",
                    "product": "CNC",
                    "order_type": "LIMIT",
                    "transaction_type": "BUY",
                    "quantity": 1,
                    "price": 702.5,
                    "result": null
                }
            ],
            "meta": {}
        },
        {
            "id": 105099,
            "user_id": "XX0000",
            "parent_trigger": null,
            "type": "two-leg",
            "created_at": "2019-09-09 15:13:22",
            "updated_at": "2019-09-09 15:15:08",
            "expires_at": "2020-01-01 12:00:00",
            "status": "triggered",
            "condition": {
                "exchange": "NSE",
                "last_price": 102.6,
                "tradingsymbol": "RAIN",
                "trigger_values": [
                    102.0,
                    103.7
                ],
                "instrument_token": 3926273
            },
            "orders": [
                {
                    "exchange": "NSE",
                    "tradingsymbol": "RAIN",
                    "product": "CNC",
                    "order_type": "LIMIT",
                    "transaction_type": "SELL",
                    "quantity": 1,
                    "price": 1,
                    "result": null
                },
                {
                    "exchange": "NSE",
                    "tradingsymbol": "RAIN",
                    "product": "CNC",
                    "order_type": "LIMIT",
                    "transaction_type": "SELL",
                    "quantity": 1,
                    "price": 1,
                    "result": {
                        "account_id": "XX0000",
                        "exchange": "NSE",
                        "tradingsymbol": "RAIN",
                        "validity": "DAY",
                        "product": "CNC",
                        "order_type": "LIMIT",
                        "transaction_type": "SELL",
                        "quantity": 1,
                        "price": 1,
                        "meta": "{\"app_id\":12617,\"gtt\":105099}",
                        "timestamp": "2019-09-09 15:15:08",
                        "triggered_at": 103.7,
                        "order_result": {
                            "status": "failed",
                            "order_id": "",
                            "rejection_reason": "Your order price is lower than the current lower circuit limit of 70.65. Place an order within the daily range."
                        }
                    }
                }
            ],
            "meta": null
        }
    ]
}

```

--------------------------------

### Run a one-off script with uv

Source: https://kite.trade/docs/connect/v3/agent-setup

Runs a Python script with the kiteconnect package available without creating a project. The script file main.py must exist in the current directory.

```bash
uv run --with kiteconnect main.py

```

--------------------------------

### GET /alerts

Source: https://kite.trade/docs/connect/v3/alerts

Retrieves all alerts for the authenticated user.

```APIDOC
## GET /alerts

### Description
Retrieves all alerts for the authenticated user.

### Method
GET

### Endpoint
/alerts

### Response
#### Success Response (200)
- **alerts** (array) - List of alert objects.

#### Response Example
{
  "alerts": [
    {
      "uuid": "string",
      "instrument": "string",
      "condition": "string",
      "trigger_price": "number",
      "status": "active"
    }
  ]
}
```

--------------------------------

### Authenticate with Kite Connect

Source: https://kite.trade/docs/connect/v3/agent-setup

Sets up a KiteConnect client, prints the login URL, exchanges the request_token for an access_token, and sets it on the client. The access_token is valid for the trading day. Replace 'your_api_key', 'request_token_here', and 'your_api_secret' with actual values.

```python
from kiteconnect import KiteConnect

kite = KiteConnect(api_key="your_api_key")

# Send the user to kite.login_url(); capture the request_token from the
# redirect URL after they log in.
print(kite.login_url())

# Exchange the request_token for an access_token.
data = kite.generate_session("request_token_here", api_secret="your_api_secret")
kite.set_access_token(data["access_token"])

```

--------------------------------

### GET /orders/:order_id/trades

Source: https://kite.trade/docs/connect/v3/orders

Retrieve the trades generated by an order.

```APIDOC
## GET /orders/:order_id/trades

### Description
Retrieve the trades generated by an order.

### Method
GET

### Endpoint
/orders/:order_id/trades

### Parameters
#### Path Parameters
- **order_id** (string) - Required - The ID of the order.

### Response
#### Success Response (200)
- **trades** (array) - List of trades generated by the order.

#### Response Example
{
  "trades": []
}
```

--------------------------------

### KiteConnect.ready()

Source: https://kite.trade/docs/connect/v3/publisher

Safe wrapper for all API calls that waits asynchronously for all assets to load. Use this to ensure the plugin is fully initialized before making any calls.

```APIDOC
## KiteConnect.ready()

### Description
Safe wrapper for all API calls that waits asynchronously for all assets to load. Use this to ensure the plugin is fully initialized before making any calls.

### Method
ready

### Arguments
- function() - Callback function to execute after the plugin is ready.

### Example
KiteConnect.ready(function () {
  // Your code here
});
```

--------------------------------

### GET /trades

Source: https://kite.trade/docs/connect/v3/orders

Retrieve the list of all executed trades for the day.

```APIDOC
## GET /trades

### Description
Retrieve the list of all executed trades for the day.

### Method
GET

### Endpoint
/trades

### Response
#### Success Response (200)
- **trades** (array) - List of executed trades.

#### Response Example
{
  "trades": []
}
```

--------------------------------

### Response for placing an order

Source: https://kite.trade/docs/connect/v3/orders

Example JSON response returned when an order is successfully placed. It contains a status of 'success' and the order_id in the data object.

```json
{
    "status": "success",
    "data": {
      "order_id": "151220000000000"
    }
  }
```

--------------------------------

### GET /orders/:order_id

Source: https://kite.trade/docs/connect/v3/orders

Retrieve the history of a given order.

```APIDOC
## GET /orders/:order_id

### Description
Retrieve the history of a given order.

### Method
GET

### Endpoint
/orders/:order_id

### Parameters
#### Path Parameters
- **order_id** (string) - Required - The ID of the order.

### Response
#### Success Response (200)
- **order_history** (array) - List of order history entries.

#### Response Example
{
  "order_history": []
}
```

--------------------------------

### Sample response for all trades

Source: https://kite.trade/docs/connect/v3/orders

Example JSON response from the trades endpoint, showing a list of trade objects with attributes such as trade_id, order_id, exchange, tradingsymbol, and fill_timestamp.

```json
{
  "status": "success",
  "data": [
    {
      "trade_id": "10000000",
      "order_id": "200000000000000",
      "exchange": "NSE",
      "tradingsymbol": "SBIN",
      "instrument_token": 779521,
      "product": "CNC",
      "average_price": 420.65,
      "quantity": 1,
      "exchange_order_id": "300000000000000",
      "transaction_type": "BUY",
      "fill_timestamp": "2021-05-31 09:16:39",
      "order_timestamp": "09:16:39",
      "exchange_timestamp": "2021-05-31 09:16:39"
    },
    {
      "trade_id": "40000000",
      "order_id": "500000000000000",
      "exchange": "CDS",
      "tradingsymbol": "USDINR21JUNFUT",
      "instrument_token": 412675,
      "product": "MIS",
      "average_price": 72.755,
      "quantity": 1,
      "exchange_order_id": "600000000000000",
      "transaction_type": "BUY",
      "fill_timestamp": "2021-05-31 11:18:27",
      "order_timestamp": "11:18:27",
      "exchange_timestamp": "2021-05-31 11:18:27"
    },
    {
      "trade_id": "70000000",
      "order_id": "800000000000000",
      "exchange": "MCX",
      "tradingsymbol": "GOLDPETAL21JUNFUT",
      "instrument_token": 58424839,
      "product": "NRML",
      "average_price": 4852,
      "quantity": 1,
      "exchange_order_id": "312115100078593",
      "transaction_type": "BUY",
      "fill_timestamp": "2021-05-31 16:00:36",
      "order_timestamp": "16:00:36",
      "exchange_timestamp": "2021-05-31 16:00:36"
    },
    {
      "trade_id": "90000000",
      "order_id": "1100000000000000",
      "exchange": "MCX",
      "tradingsymbol": "GOLDPETAL21JUNFUT",
      "instrument_token": 58424839,
      "product": "NRML",
      "average_price": 4852,
      "quantity": 1,
      "exchange_order_id": "1200000000000000",
      "transaction_type": "BUY",
      "fill_timestamp": "2021-05-31 16:08:41",
      "order_timestamp": "16:08:41",
      "exchange_timestamp": "2021-05-31 16:08:41"
    }
  ]
}

```

--------------------------------

### GET /gtt/triggers/:id

Source: https://kite.trade/docs/connect/v3/gtt

Retrieve an individual trigger by its ID.

```APIDOC
## GET /gtt/triggers/:id

### Description
Retrieve an individual trigger by its ID.

### Method
GET

### Endpoint
/gtt/triggers/:id

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the trigger to retrieve

### Response
#### Success Response (200)
- **status** (string) - Success status
- **data** (object) - The trigger details

#### Response Example
(No example provided in source)

```

--------------------------------

### Sample order object

Source: https://kite.trade/docs/connect/v3/gtt

Example order object for a GTT order. Contains exchange, tradingsymbol, transaction_type, quantity, order_type, product, and price.

```json
{
  "exchange": "NSE",
  "tradingsymbol": "INFY",
  "transaction_type": "BUY",
  "quantity": 1,
  "order_type": "LIMIT",
  "product": "CNC",
  "price": 702.5
}
```

--------------------------------

### Sample orders for single trigger

Source: https://kite.trade/docs/connect/v3/gtt

Example orders array for a single-leg GTT. Contains one order that executes when the trigger value is reached.

```json
[
  {
    "exchange": "NSE",
    "tradingsymbol": "INFY",
    "transaction_type": "BUY",
    "quantity": 1,
    "order_type": "LIMIT",
    "product": "CNC",
    "price": 702.5
  }
]
```

--------------------------------

### Retrieve alerts with curl GET /alerts

Source: https://kite.trade/docs/connect/v3/alerts

Use this GET request to retrieve active alerts and alerts in other states from the /alerts endpoint. The response contains a list of alert objects with fields such as type, status, lhs/rhs attributes, and for ATO alerts a basket of order items.

```bash
curl "https://api.kite.trade/alerts" \
    -H "X-Kite-Version: 3" \
    -H "Authorization: token api_key:access_token"

```

```json
{
  "status": "success",
  "data": [
    {
      "type": "simple",
      "user_id": "AB1234",
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "name": "NIFTY 50",
      "status": "enabled",
      "disabled_reason": "",
      "lhs_attribute": "LastTradedPrice",
      "lhs_exchange": "INDICES",
      "lhs_tradingsymbol": "NIFTY 50",
      "operator": ">=",
      "rhs_type": "constant",
      "rhs_attribute": "",
      "rhs_exchange": "",
      "rhs_tradingsymbol": "",
      "rhs_constant": 27000,
      "alert_count": 0,
      "created_at": "2025-05-26 12:07:50",
      "updated_at": "2025-05-26 12:07:50"
    },
    {
      "type": "ato",
      "user_id": "AB1234",
      "uuid": "e888ed4a-6801-406f-bdc2-002db5a8411d",
      "name": "buy gold",
      "status": "disabled",
      "disabled_reason": "",
      "basket": {
        "items": [
          {
            "id": 275218517,
            "tradingsymbol": "GOLDBEES",
            "exchange": "NSE",
            "instrument_token": 3693569,
            "weight": 10000,
            "params": {
              "validity": "DAY",
              "validity_ttl": 0,
              "variety": "regular",
              "product": "CNC",
              "order_type": "LIMIT",
              "transaction_type": "BUY",
              "quantity": 10000,
              "disclosed_quantity": 0,
              "price": 72.22,
              "trigger_price": 0,
              "squareoff": 0,
              "stoploss": 0,
              "trailing_stoploss": 0,
              "gtt": {
                "target": 0,
                "stoploss": 0
              },
              "tags": []
            }
          }
        ]
      },
      "lhs_attribute": "LastTradedPrice",
      "lhs_exchange": "NSE",
      "lhs_tradingsymbol": "GOLDBEES",
      "operator": "<=",
      "rhs_type": "constant",
      "rhs_attribute": "",
      "rhs_exchange": "",
      "rhs_tradingsymbol": "",
      "rhs_constant": 71.8,
      "alert_count": 1,
      "created_at": "2025-02-17 08:24:10",
      "updated_at": "2025-02-17 09:15:20"
    }
  ]
}

```

--------------------------------

### JSON response from /user/profile

Source: https://kite.trade/docs/connect/v3/user

Example JSON response returned by the /user/profile API. Contains user details such as user_id, email, broker, and lists of enabled exchanges, products, and order types.

```json
{
  "status": "success",
  "data": {
    "user_id": "AB1234",
    "user_type": "individual",
    "email": "xxxyyy@gmail.com",
    "user_name": "AxAx Bxx",
    "user_shortname": "AxAx",
    "broker": "ZERODHA",
    "exchanges": [
      "BFO",
      "MCX",
      "NSE",
      "CDS",
      "BSE",
      "BCD",
      "MF",
      "NFO"
    ],
    "products": [
      "CNC",
      "NRML",
      "MIS",
      "BO",
      "CO"
    ],
    "order_types": [
      "MARKET",
      "LIMIT",
      "SL",
      "SL-M"
    ],
    "avatar_url": null,
    "meta": {
      "demat_consent": "physical"
    }
  }
}

```

--------------------------------

### GET /orders

Source: https://kite.trade/docs/connect/v3/orders

Retrieve the list of all orders (open and executed) for the day.

```APIDOC
## GET /orders

### Description
Retrieve the list of all orders (open and executed) for the day.

### Method
GET

### Endpoint
/orders

### Response
#### Success Response (200)
- **orders** (array) - List of orders.

#### Response Example
{
  "orders": []
}
```

--------------------------------

### GET /alerts/{uuid}/history

Source: https://kite.trade/docs/connect/v3/alerts

Retrieves the history of a specific alert.

```APIDOC
## GET /alerts/{uuid}/history

### Description
Retrieves the history of a specific alert.

### Method
GET

### Endpoint
/alerts/{uuid}/history

### Parameters
#### Path Parameters
- **uuid** (string) - Required - The unique identifier of the alert.

### Response
#### Success Response (200)
- **history** (array) - List of historical events for the alert.

#### Response Example
{
  "history": [
    {
      "timestamp": "string",
      "event": "string"
    }
  ]
}
```

--------------------------------

### Sample orders for two-leg trigger

Source: https://kite.trade/docs/connect/v3/gtt

Example orders array for a two-leg (OCO) GTT. Contains two orders; the corresponding order executes when either trigger value is reached, the other remains dormant.

```json
[
  {
    "exchange": "NSE",
    "tradingsymbol": "INFY",
    "transaction_type": "SELL",
    "quantity": 1,
    "order_type": "LIMIT",
    "product": "CNC",
    "price": 702.5
  },
  {
    "exchange": "NSE",
    "tradingsymbol": "INFY",
    "transaction_type": "SELL",
    "quantity": 1,
    "order_type": "LIMIT",
    "product": "CNC",
    "price": 798.5
  }
]
```

--------------------------------

### Place a regular order with curl

Source: https://kite.trade/docs/connect/v3/orders

Use this curl command to place a regular order via the Kite Connect API. It sends a POST request to /orders/regular with the required parameters. The response contains an order_id if the order is successfully placed.

```bash
curl https://api.kite.trade/orders/regular \
    -H "X-Kite-Version: 3" \
    -H "Authorization: token api_key:access_token" \
    -d "tradingsymbol=ACC" \
    -d "exchange=NSE" \
    -d "transaction_type=BUY" \
    -d "order_type=MARKET" \
    -d "quantity=1" \
    -d "product=MIS" \
    -d "validity=DAY" \
    -d "market_protection=-1"
```
Tokens:
Raw