DhanHQ 2.6.1 → 2.6.3

data/docs/ARCHIVE_README.md

@@ -1,784 +0,0 @@
-# DhanHQ - Ruby Client for DhanHQ API
-
-DhanHQ is a **Ruby client** for interacting with **Dhan API v2.0**. It provides **ActiveRecord-like** behavior, **RESTful resource management**, and **ActiveModel validation** for seamless integration into **algorithmic trading applications**.
-
-## ⚡ Features
-
-✅ **ORM-like Interface** (`find`, `all`, `where`, `save`, `update`, `destroy`)
-✅ **ActiveModel Integration** (`validations`, `errors`, `serialization`)
-✅ **Resource Objects for Trading** (`Orders`, `Positions`, `Holdings`, etc.)
-✅ **Supports WebSockets for Market Feeds**
-✅ **Error Handling & Validations** (`ActiveModel::Errors`)
-✅ **DRY & Modular Code** (`Helpers`, `Contracts`, `Request Handling`)
-
----
-
-## 📌 Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'DhanHQ', git: 'https://github.com/shubhamtaywade82/dhanhq-client.git', branch: 'main'
-```
-
-Then execute:
-
-```
-bundle install
-```
-
-Or install it manually:
-
-```
-gem install dhanhq
-```
-
-🔹 Configuration
-Set your DhanHQ API credentials:
-
-```ruby
-require 'DhanHQ'
-
-DhanHQ.configure_with_env
-DhanHQ.logger.level = (ENV["DHAN_LOG_LEVEL"] || "INFO").upcase.then { |level| Logger.const_get(level) }
-```
-
-**Minimum environment variables**
-
-* `DHAN_CLIENT_ID` – trading account client id issued by Dhan.
-* `DHAN_ACCESS_TOKEN` – API access token generated from the Dhan console.
-
-If either key is missing `configure_with_env` raises an error. Ensure your
-application loads them into `ENV` before requiring the gem.
-
-**Optional overrides**
-
-* `DHAN_LOG_LEVEL` – change logger verbosity (`INFO` default).
-* `DHAN_BASE_URL` – point REST calls to an alternate host.
-* `DHAN_WS_VERSION` – lock WebSocket connections to a specific version.
-* `DHAN_WS_ORDER_URL` – override the order update WebSocket endpoint.
-* `DHAN_WS_USER_TYPE` – choose between `SELF` and `PARTNER` streaming modes.
-* `DHAN_PARTNER_ID` / `DHAN_PARTNER_SECRET` – required when streaming as a partner.
-
-Create a `.env` file in your project root to supply the minimum values (and any
-optional overrides you need):
-
-```dotenv
-DHAN_CLIENT_ID=your_client_id
-DHAN_ACCESS_TOKEN=your_access_token
-```
-
-The gem requires `dotenv/load`, so these variables are loaded automatically when you require `DhanHQ`.
-
-To override defaults (base URL, WebSocket settings, partner credentials), set
-`DHAN_BASE_URL`, `DHAN_WS_VERSION`, `DHAN_WS_ORDER_URL`, `DHAN_WS_USER_TYPE`,
-`DHAN_PARTNER_ID`, and `DHAN_PARTNER_SECRET` before calling
-`configure_with_env`.
-
-## 🚀 Usage
-
-✅ Placing an Order
-
-```ruby
-order = DhanHQ::Models::Order.new(
-  transaction_type: DhanHQ::Constants::TransactionType::BUY,
-  exchange_segment: DhanHQ::Constants::ExchangeSegment::NSE_FNO,
-  product_type: DhanHQ::Constants::ProductType::MARGIN,
-  order_type: DhanHQ::Constants::OrderType::LIMIT,
-  validity: DhanHQ::Constants::Validity::DAY,
-  security_id: "43492",
-  quantity: 125,
-  price: 100.0
-)
-
-order.save
-puts order.persisted? # true
-```
-
-✅ Fetching an Order
-
-```ruby
-order = DhanHQ::Models::Order.find("452501297117")
-puts order.price # Current price of the order
-```
-
-✅ Updating an Order
-
-```ruby
-order.update(price: 105.0)
-puts order.price # 105.0
-```
-
-✅ Canceling an Order
-
-```ruby
-order.cancel
-```
-
-✅ Fetching All Orders
-
-```ruby
-orders = DhanHQ::Models::Order.all
-puts orders.count
-```
-
-✅ Querying Orders
-
-```ruby
-pending_orders = DhanHQ::Models::Order.where(status: DhanHQ::Constants::OrderStatus::PENDING)
-puts pending_orders.first.order_id
-```
-
-✅ Exiting Positions
-
-```ruby
-positions = DhanHQ::Models::Position.all
-position = positions.first
-position.exit!
-```
-
-### Orders
-
-#### Place
-
-```ruby
-order = DhanHQ::Models::Order.new(transaction_type: DhanHQ::Constants::TransactionType::BUY, security_id: "123", quantity: 1)
-order.save
-```
-
-#### Modify
-
-```ruby
-order.modify(price: 102.5)
-```
-
-#### Cancel
-
-```ruby
-order.cancel
-```
-
-### Trades
-
-```ruby
-DhanHQ::Models::Trade.today
-DhanHQ::Models::Trade.find_by_order_id("452501297117")
-```
-
-### Positions
-
-```ruby
-positions = DhanHQ::Models::Position.all
-active = DhanHQ::Models::Position.active
-DhanHQ::Models::Position.convert(position_id: "1", product_type: DhanHQ::Constants::ProductType::CNC)
-```
-
-### Holdings
-
-```ruby
-DhanHQ::Models::Holding.all
-```
-
-### Funds
-
-```ruby
-DhanHQ::Models::Funds.fetch
-balance = DhanHQ::Models::Funds.balance
-```
-
-### Option Chain
-
-```ruby
-DhanHQ::Models::OptionChain.fetch(security_id: "1333", expiry_date: "2024-06-30")
-DhanHQ::Models::OptionChain.fetch_expiry_list(security_id: "1333")
-```
-
-### Historical Data
-
-```ruby
-DhanHQ::Models::HistoricalData.daily(security_id: "1333", exchange_segment: DhanHQ::Constants::ExchangeSegment::NSE_EQ, instrument: DhanHQ::Constants::InstrumentType::EQUITY, from_date: "2024-01-01", to_date: "2024-01-31")
-DhanHQ::Models::HistoricalData.intraday(security_id: "1333", exchange_segment: DhanHQ::Constants::ExchangeSegment::NSE_EQ, instrument: DhanHQ::Constants::InstrumentType::EQUITY, interval: "15", from_date: "2024-09-11", to_date: "2024-09-15")
-```
-
-### Instrument Model with Convenience Methods
-
-The Instrument model provides convenient instance methods that automatically use the instrument's attributes:
-
-```ruby
-# Find an instrument
-instrument = DhanHQ::Models::Instrument.find("IDX_I", "NIFTY")
-
-# Market Feed Methods - automatically uses instrument's attributes
-ltp_data = instrument.ltp        # Last traded price
-ohlc_data = instrument.ohlc     # OHLC data
-quote_data = instrument.quote   # Full quote depth
-
-# Historical Data Methods
-daily_data = instrument.daily(from_date: "2024-01-01", to_date: "2024-01-31")
-intraday_data = instrument.intraday(from_date: "2024-09-11", to_date: "2024-09-15", interval: "15")
-
-# Option Chain Methods
-expiries = instrument.expiry_list
-chain = instrument.option_chain(expiry: "2024-02-29")
-```
-
-## 🔹 Available Resources
-
-| Resource                 | Model                                    | Actions                                             |
-| ------------------------ | ---------------------------------------- | --------------------------------------------------- |
-| Orders                   | `DhanHQ::Models::Models::Order`          | `find`, `all`, `where`, `place`, `update`, `cancel` |
-| Trades                   | `DhanHQ::Models::Models::Trade`          | `all`, `find_by_order_id`                           |
-| Forever Orders           | `DhanHQ::Models::Models::ForeverOrder`   | `create`, `find`, `modify`, `cancel`, `all`         |
-| Holdings                 | `DhanHQ::Models::Models::Holding`        | `all`                                               |
-| Positions                | `DhanHQ::Models::Models::Position`       | `all`, `find`, `exit!`                              |
-| Funds & Margin           | `DhanHQ::Models::Models::Funds`          | `fund_limit`, `margin_calculator`                   |
-| Ledger                   | `DhanHQ::Models::Models::Ledger`         | `all`                                               |
-| Market Feeds             | `DhanHQ::Models::Models::MarketFeed`     | `ltp, ohlc`, `quote`                                |
-| Historical Data (Charts) | `DhanHQ::Models::Models::HistoricalData` | `daily`, `intraday`                                 |
-| Option Chain             | `DhanHQ::Models::Models::OptionChain`    | `fetch`, `fetch_expiry_list`                        |
-
-## 📌 Development
-
-Set `DHAN_DEBUG=true` to log HTTP requests during development:
-
-```bash
-export DHAN_DEBUG=true
-```
-
-Running Tests
-
-```bash
-bundle exec rspec
-```
-
-Installing Locally
-
-```bash
-bundle exec rake install
-```
-
-Releasing a New Version
-
-```bash
-bundle exec rake release
-```
----
-
-## WebSocket Market Feed (NEW)
-
-### What you get
-
-* **Modes**
-
-  * `:ticker` → LTP + LTT
-  * `:quote`  → OHLCV + totals (recommended default)
-  * `:full`   → quote + **OI** + **best-5 depth**
-* **Normalized ticks** (Hash):
-
-  ```ruby
-  {
-    kind: :quote,                 # :ticker | :quote | :full | :oi | :prev_close | :misc
-    segment: DhanHQ::Constants::ExchangeSegment::NSE_FNO,           # string enum
-    security_id: "12345",
-    ltp: 101.5,
-    ts:  1723791300,              # LTT epoch (sec) if present
-    vol: 123456,                  # quote/full
-    atp: 100.9,                   # quote/full
-    day_open: 100.1, day_high: 102.4, day_low: 99.5, day_close: nil,
-    oi: 987654,                   # full or OI packet
-    bid: 101.45, ask: 101.55      # from depth (mode :full)
-  }
-  ```
-
-### Start, subscribe, stop
-
-```ruby
-DhanHQ.configure_with_env
-DhanHQ.logger.level = (ENV["DHAN_LOG_LEVEL"] || "INFO").upcase.then { |level| Logger.const_get(level) }
-
-ws = DhanHQ::WS::Client.new(mode: :quote).start
-
-ws.on(:tick) do |t|
-  puts "[#{t[:segment]}:#{t[:security_id]}] LTP=#{t[:ltp]} kind=#{t[:kind]}"
-end
-
-# Subscribe instruments (≤100 per frame; send multiple frames if needed)
-ws.subscribe_one(segment: DhanHQ::Constants::ExchangeSegment::IDX_I,   security_id: "13")     # NIFTY index value
-ws.subscribe_one(segment: DhanHQ::Constants::ExchangeSegment::NSE_FNO, security_id: "12345")  # an option
-
-# Unsubscribe
-ws.unsubscribe_one(segment: DhanHQ::Constants::ExchangeSegment::NSE_FNO, security_id: "12345")
-
-# Graceful disconnect (sends broker disconnect code 12, no reconnect)
-ws.disconnect!
-
-# Or hard stop (no broker message, just closes and halts loop)
-ws.stop
-
-# Safety: kill all local sockets (useful in IRB)
-DhanHQ::WS.disconnect_all_local!
-```
-
-### Under the hood
-
-* **Request codes** (per Dhan docs)
-
-  * Subscribe: **15** (ticker), **17** (quote), **21** (full)
-  * Unsubscribe: **16**, **18**, **22**
-  * Disconnect: **12**
-* **Limits**
-
-  * Up to **100 instruments per SUB/UNSUB** message (client auto-chunks)
-  * Up to 5 WS connections per user (per Dhan)
-* **Backoff & 429 cool-off**
-
-  * Exponential backoff with jitter
-  * Handshake **429** triggers a **60s cool-off** before retry
-* **Reconnect & resubscribe**
-
-  * On reconnect the client resends the **current subscription snapshot** (idempotent)
-* **Graceful shutdown**
-
-  * `ws.disconnect!` or `ws.stop` prevents reconnects
-  * An `at_exit` hook stops all registered WS clients to avoid leaked sockets
-
----
-
-## Exchange Segment Enums
-
-Use the string enums below in WS `subscribe_*` and REST params:
-
-| Enum           | Exchange | Segment           |
-| -------------- | -------- | ----------------- |
-| `IDX_I`        | Index    | Index Value       |
-| `NSE_EQ`       | NSE      | Equity Cash       |
-| `NSE_FNO`      | NSE      | Futures & Options |
-| `NSE_CURRENCY` | NSE      | Currency          |
-| `BSE_EQ`       | BSE      | Equity Cash       |
-| `MCX_COMM`     | MCX      | Commodity         |
-| `BSE_CURRENCY` | BSE      | Currency          |
-| `BSE_FNO`      | BSE      | Futures & Options |
-
----
-
-## Accessing ticks elsewhere in your app
-
-### Direct handler
-
-```ruby
-ws.on(:tick) { |t| do_something_fast(t) } # avoid heavy work here
-```
-
-### Shared TickCache (recommended)
-
-```ruby
-# app/services/live/tick_cache.rb
-class TickCache
-  MAP = Concurrent::Map.new
-  def self.put(t)  = MAP["#{t[:segment]}:#{t[:security_id]}"] = t
-  def self.get(seg, sid) = MAP["#{seg}:#{sid}"]
-  def self.ltp(seg, sid) = get(seg, sid)&.dig(:ltp)
-end
-
-ws.on(:tick) { |t| TickCache.put(t) }
-ltp = TickCache.ltp("NSE_FNO", "12345")
-```
-
-### Filtered callback
-
-```ruby
-def on_tick_for(ws, segment:, security_id:, &blk)
-  key = "#{segment}:#{security_id}"
-  ws.on(:tick){ |t| blk.call(t) if "#{t[:segment]}:#{t[:security_id]}" == key }
-end
-```
-
----
-
-## Rails integration (example)
-
-**Goal:** Generate signals from clean **Historical Intraday OHLC** (5-min bars), and use **WebSocket** only for **exits/trailing** on open option legs.
-
-1. **Initializer**
-   `config/initializers/dhanhq.rb`
-
-   ```ruby
-   DhanHQ.configure_with_env
-   DhanHQ.logger.level = (ENV["DHAN_LOG_LEVEL"] || "INFO").upcase.then { |level| Logger.const_get(level) }
-   ```
-
-2. **Start WS supervisor**
-   `config/initializers/stream.rb`
-
-   ```ruby
-   INDICES = [
-     { segment: DhanHQ::Constants::ExchangeSegment::IDX_I, security_id: "13" },  # NIFTY index value
-     { segment: DhanHQ::Constants::ExchangeSegment::IDX_I, security_id: "25" }   # BANKNIFTY index value
-   ]
-
-   Rails.application.config.to_prepare do
-     $WS = DhanHQ::WS::Client.new(mode: :quote).start
-     $WS.on(:tick) do |t|
-       TickCache.put(t)
-       Execution::PositionGuard.instance.on_tick(t)  # trailing & fast exits
-     end
-     INDICES.each { |i| $WS.subscribe_one(segment: i[:segment], security_id: i[:security_id]) }
-   end
-   ```
-
-3. **Bar fetch (every 5 min) via Historical API**
-
-   * Fetch intraday OHLC at 5-minute boundaries.
-   * Update your `CandleSeries`; on each closed bar, run strategy to emit signals.
-     *(Use your existing `Bars::FetchLoop` + `CandleSeries` code.)*
-
-4. **Routing & orders**
-
-   * On signal: place **Super Order** (SL/TP/TSL) or fallback to Market + local trailing.
-   * After a successful place, **register** the leg in `PositionGuard` and **subscribe** its option on WS.
-
-5. **Shutdown**
-
-   ```ruby
-   at_exit { DhanHQ::WS.disconnect_all_local! }
-   ```
-
----
-
-## Super Orders
-
-Super orders are built for smart execution. They bundle entry, target, and stop-loss legs (with optional trailing jump) into one atomic request so the broker manages risk for you.
-
-The gem exposes all related REST endpoints so you can create, modify, cancel, and list super orders programmatically across exchanges and segments.
-
-### Endpoints
-
-| Method   | Path                                   | Description                           |
-| -------- | -------------------------------------- | ------------------------------------- |
-| `POST`   | `/super/orders`                        | Create a new super order              |
-| `PUT`    | `/super/orders/{order_id}`             | Modify a pending super order          |
-| `DELETE` | `/super/orders/{order_id}/{order_leg}` | Cancel a pending super order leg      |
-| `GET`    | `/super/orders`                        | Retrieve the list of all super orders |
-
-### Place Super Order
-
-Use this endpoint to create a new super order consisting of entry, target, stop-loss, and optional trailing jump. It is available for intraday, carry-forward, and MTF across supported exchanges.
-
-> ℹ️ Static IP whitelisting with Dhan support is required before invoking this API.
-
-```bash
-curl --request POST \
-  --url https://api.dhan.co/v2/super/orders \
-  --header 'Content-Type: application/json' \
-  --header 'access-token: JWT' \
-  --data '{Request JSON}'
-```
-
-#### Request body
-
-```json
-{
-  "dhan_client_id": "1000000003",
-  "correlation_id": "123abc678",
-  "transaction_type": "BUY",
-  "exchange_segment": "NSE_EQ",
-  "product_type": "CNC",
-  "order_type": "LIMIT",
-  "security_id": "11536",
-  "quantity": 5,
-  "price": 1500,
-  "target_price": 1600,
-  "stop_loss_price": 1400,
-  "trailing_jump": 10
-}
-```
-
-#### Parameters
-
-| Field              | Type                     | Description                                                                                                                                                                |
-| ------------------ | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `dhan_client_id`   | string *(required)*      | User specific identification generated by Dhan. When you call via `DhanHQ::Models::SuperOrder`, the gem injects your configured client id so you can omit the key in Ruby. |
-| `correlation_id`   | string                   | Caller supplied identifier for tracking                                                                                                                                    |
-| `transaction_type` | enum string *(required)* | Trading side. `BUY` or `SELL`.                                                                                                                                             |
-| `exchange_segment` | enum string *(required)* | Exchange segment (see appendix).                                                                                                                                           |
-| `product_type`     | enum string *(required)* | Product type. `CNC`, `INTRADAY`, `MARGIN`, or `MTF`.                                                                                                                       |
-| `order_type`       | enum string *(required)* | Order type. `LIMIT` or `MARKET`.                                                                                                                                           |
-| `security_id`      | string *(required)*      | Exchange standard security identifier.                                                                                                                                     |
-| `quantity`         | integer *(required)*     | Quantity for the entry leg.                                                                                                                                                |
-| `price`            | float *(required)*       | Entry price.                                                                                                                                                               |
-| `target_price`     | float *(required)*       | Target price for the super order.                                                                                                                                          |
-| `stop_loss_price`  | float *(required)*       | Stop-loss price for the super order.                                                                                                                                       |
-| `trailing_jump`    | float *(required)*       | Price jump size for trailing stop-loss.                                                                                                                                    |
-
-> 🐍 When you call `DhanHQ::Models::SuperOrder.create`, supply snake_case keys exactly as shown. The client automatically camelizes
-> them before submitting to Dhan's REST API and injects your configured `dhan_client_id`, allowing you to omit the key in Ruby code.
-
-#### Response
-
-```json
-{
-  "order_id": "112111182198",
-  "order_status": "PENDING"
-}
-```
-
-| Field          | Type        | Description                                         |
-| -------------- | ----------- | --------------------------------------------------- |
-| `order_id`     | string      | Order identifier generated by Dhan                  |
-| `order_status` | enum string | Latest status. `TRANSIT`, `PENDING`, or `REJECTED`. |
-
-### Modify Super Order
-
-Modify any leg while the order is `PENDING` or `PART_TRADED`. Once the entry leg trades fully, only the target and stop-loss legs (price and trailing jump) remain editable.
-
-> ℹ️ Static IP whitelisting with Dhan support is required before invoking this API.
-
-```bash
-curl --request PUT \
-  --url https://api.dhan.co/v2/super/orders/{order_id} \
-  --header 'Content-Type: application/json' \
-  --header 'access-token: JWT' \
-  --data '{Request JSON}'
-```
-
-#### Request body
-
-```json
-{
-  "dhan_client_id": "1000000009",
-  "order_id": "112111182045",
-  "order_type": "LIMIT",
-  "leg_name": "ENTRY_LEG",
-  "quantity": 40,
-  "price": 1300,
-  "target_price": 1450,
-  "stop_loss_price": 1350,
-  "trailing_jump": 20
-}
-```
-
-#### Parameters
-
-| Field             | Type                                   | Description                                                                                                         |
-| ----------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
-| `dhan_client_id`  | string *(required)*                    | User specific identification generated by Dhan. Automatically merged when using the Ruby model helpers.             |
-| `order_id`        | string *(required)*                    | Super order identifier generated by Dhan.                                                                           |
-| `order_type`      | enum string *(conditionally required)* | `LIMIT` or `MARKET`. Required when changing `ENTRY_LEG`.                                                            |
-| `leg_name`        | enum string *(required)*               | `ENTRY_LEG`, `TARGET_LEG`, or `STOP_LOSS_LEG`. Entry edits allowed only while status is `PENDING` or `PART_TRADED`. |
-| `quantity`        | integer *(conditionally required)*     | Quantity update for `ENTRY_LEG`.                                                                                    |
-| `price`           | float *(conditionally required)*       | Entry price update for `ENTRY_LEG`.                                                                                 |
-| `target_price`    | float *(conditionally required)*       | Target price update for `ENTRY_LEG` or `TARGET_LEG`.                                                                |
-| `stop_loss_price` | float *(conditionally required)*       | Stop-loss price update for `ENTRY_LEG` or `STOP_LOSS_LEG`.                                                          |
-| `trailing_jump`   | float *(conditionally required)*       | Trailing jump update for `ENTRY_LEG` or `STOP_LOSS_LEG`. Omit or set to `0` to cancel trailing.                     |
-
-#### Response
-
-```json
-{
-  "order_id": "112111182045",
-  "order_status": "TRANSIT"
-}
-```
-
-| Field          | Type        | Description                                                   |
-| -------------- | ----------- | ------------------------------------------------------------- |
-| `order_id`     | string      | Order identifier generated by Dhan                            |
-| `order_status` | enum string | Latest status. `TRANSIT`, `PENDING`, `REJECTED`, or `TRADED`. |
-
-### Cancel Super Order
-
-Cancel a pending or active super order leg with the order ID. Cancelling the entry leg removes all legs. Cancelling an individual target or stop-loss leg removes only that leg and it cannot be recreated on the same order.
-
-> ℹ️ Static IP whitelisting with Dhan support is required before invoking this API.
-
-```bash
-curl --request DELETE \
-  --url https://api.dhan.co/v2/super/orders/{order_id}/{order_leg} \
-  --header 'Content-Type: application/json' \
-  --header 'access-token: JWT'
-```
-
-#### Path parameters
-
-| Field       | Description                                                   | Example       |
-| ----------- | ------------------------------------------------------------- | ------------- |
-| `order_id`  | Super order identifier.                                       | `11211182198` |
-| `order_leg` | Leg to cancel. `ENTRY_LEG`, `TARGET_LEG`, or `STOP_LOSS_LEG`. | `ENTRY_LEG`   |
-
-#### Response
-
-```json
-{
-  "order_id": "112111182045",
-  "order_status": "CANCELLED"
-}
-```
-
-| Field          | Type        | Description                                                      |
-| -------------- | ----------- | ---------------------------------------------------------------- |
-| `order_id`     | string      | Order identifier generated by Dhan                               |
-| `order_status` | enum string | Latest status. `TRANSIT`, `PENDING`, `REJECTED`, or `CANCELLED`. |
-
-### Super Order List
-
-Fetch all super orders placed during the trading day. The response nests leg details under the entry leg, and each leg is also available in the standard order book.
-
-```bash
-curl --request GET \
-  --url https://api.dhan.co/v2/super/orders \
-  --header 'Content-Type: application/json' \
-  --header 'access-token: JWT'
-```
-
-#### Response
-
-```json
-[
-  {
-    "dhan_client_id": "1100003626",
-    "order_id": "5925022734212",
-    "correlation_id": "string",
-    "order_status": "PENDING",
-    "transaction_type": "BUY",
-    "exchange_segment": "NSE_EQ",
-    "product_type": "CNC",
-    "order_type": "LIMIT",
-    "validity": "DAY",
-    "trading_symbol": "HDFCBANK",
-    "security_id": "1333",
-    "quantity": 10,
-    "remaining_quantity": 10,
-    "ltp": 1660.95,
-    "price": 1500,
-    "after_market_order": false,
-    "leg_name": "ENTRY_LEG",
-    "exchange_order_id": "11925022734212",
-    "create_time": "2025-02-27 19:09:42",
-    "update_time": "2025-02-27 19:09:42",
-    "exchange_time": "2025-02-27 19:09:42",
-    "oms_error_description": "",
-    "average_traded_price": 0,
-    "filled_qty": 0,
-    "leg_details": [
-      {
-        "order_id": "5925022734212",
-        "leg_name": "STOP_LOSS_LEG",
-        "transaction_type": "SELL",
-        "total_quantity": 0,
-        "remaining_quantity": 0,
-        "triggered_quantity": 0,
-        "price": 1400,
-        "order_status": "PENDING",
-        "trailing_jump": 10
-      },
-      {
-        "order_id": "5925022734212",
-        "leg_name": "TARGET_LEG",
-        "transaction_type": "SELL",
-        "remaining_quantity": 0,
-        "triggered_quantity": 0,
-        "price": 1550,
-        "order_status": "PENDING",
-        "trailing_jump": 0
-      }
-    ]
-  }
-]
-```
-
-#### Parameters
-
-| Field                   | Type        | Description                                                                                         |
-| ----------------------- | ----------- | --------------------------------------------------------------------------------------------------- |
-| `dhan_client_id`        | string      | User specific identification generated by Dhan.                                                     |
-| `order_id`              | string      | Order identifier generated by Dhan.                                                                 |
-| `correlation_id`        | string      | Caller supplied correlation identifier.                                                             |
-| `order_status`          | enum string | Latest status. `TRANSIT`, `PENDING`, `CLOSED`, `REJECTED`, `CANCELLED`, `PART_TRADED`, or `TRADED`. |
-| `transaction_type`      | enum string | Trading side. `BUY` or `SELL`.                                                                      |
-| `exchange_segment`      | enum string | Exchange segment.                                                                                   |
-| `product_type`          | enum string | Product type. `CNC`, `INTRADAY`, `MARGIN`, or `MTF`.                                                |
-| `order_type`            | enum string | Order type. `LIMIT` or `MARKET`.                                                                    |
-| `validity`              | enum string | Order validity. `DAY`.                                                                              |
-| `trading_symbol`        | string      | Trading symbol reference.                                                                           |
-| `security_id`           | string      | Exchange security identifier.                                                                       |
-| `quantity`              | integer     | Ordered quantity.                                                                                   |
-| `remaining_quantity`    | integer     | Quantity pending execution.                                                                         |
-| `ltp`                   | float       | Last traded price.                                                                                  |
-| `price`                 | float       | Order price.                                                                                        |
-| `after_market_order`    | boolean     | Indicates if order was placed after market hours.                                                   |
-| `leg_name`              | enum string | Leg identifier: `ENTRY_LEG`, `TARGET_LEG`, or `STOP_LOSS_LEG`.                                      |
-| `trailing_jump`         | float       | Trailing jump for stop-loss.                                                                        |
-| `exchange_order_id`     | string      | Exchange generated identifier.                                                                      |
-| `create_time`           | string      | Order creation timestamp.                                                                           |
-| `update_time`           | string      | Latest update timestamp.                                                                            |
-| `exchange_time`         | string      | Exchange timestamp.                                                                                 |
-| `oms_error_description` | string      | OMS error description when applicable.                                                              |
-| `average_traded_price`  | float       | Average traded price.                                                                               |
-| `filled_qty`            | integer     | Quantity traded on the exchange.                                                                    |
-| `triggered_quantity`    | integer     | Quantity triggered for stop-loss or target legs.                                                    |
-| `leg_details`           | array       | Nested leg details for the super order.                                                             |
-
-> ✅ `CLOSED` indicates the entry leg and either target or stop-loss completed for the full quantity. `TRIGGERED` appears on target and stop-loss legs to highlight which one fired; inspect `triggered_quantity` for executed quantity.
-
----
-
-## Packet parsing (for reference)
-
-* **Response Header (8 bytes)**:
-  `feed_response_code (u8, BE)`, `message_length (u16, BE)`, `exchange_segment (u8, BE)`, `security_id (i32, LE)`
-* **Packets supported**:
-
-  * **1** Index (surface as raw/misc unless documented)
-  * **2** Ticker: `ltp`, `ltt`
-  * **4** Quote: `ltp`, `ltt`, `atp`, `volume`, totals, `day_*`
-  * **5** OI: `open_interest`
-  * **6** Prev Close: `prev_close`, `oi_prev`
-  * **7** Market Status (raw/misc unless documented)
-  * **8** Full: quote + `open_interest` + 5× depth (bid/ask)
-  * **50** Disconnect: reason code
-
----
-
-## Best practices
-
-* Keep the `on(:tick)` handler **non-blocking**; push work to a queue/thread.
-* Use `mode: :quote` for most strategies; switch to `:full` only if you need depth/OI in real-time.
-* Call **`ws.disconnect!`** (or `ws.stop`) when leaving IRB / tests.
-  Use **`DhanHQ::WS.disconnect_all_local!`** to be extra safe.
-* Don’t exceed **100 instruments per SUB frame** (the client auto-chunks).
-* Avoid rapid connect/disconnect loops; the client already **backs off & cools off** when server replies 429.
-
----
-
-## Troubleshooting
-
-* **429: Unexpected response code**
-  You connected too frequently or have too many sockets. The client auto-cools off for **60s** and backs off. Prefer `ws.disconnect!` before reconnecting; and call `DhanHQ::WS.disconnect_all_local!` to kill stragglers.
-* **No ticks after reconnect**
-  Ensure you re-subscribed after a clean start (the client resends the snapshot automatically on reconnect).
-* **Binary parse errors**
-  Run with `DHAN_LOG_LEVEL=DEBUG` to inspect; we safely drop malformed frames and keep the loop alive.
-
----
-
-
-## 📌 Contributing
-
-Bug reports and pull requests are welcome on GitHub at:
-🔗 <https://github.com/shubhamtaywade82/dhanhq>
-
-This project follows a code of conduct to maintain a safe and welcoming community.
-
-## 📌 License
-
-This gem is available under the MIT License.
-🔗 <https://opensource.org/licenses/MIT>
-
-## 📌 Code of Conduct
-
-Everyone interacting in the DhanHQ project is expected to follow the
-🔗 Code of Conduct.
-
-```markdown
-This **README.md** file is structured and formatted for **GitHub** or any **Markdown-compatible** documentation system. 🚀
-```