Trade Book

This API endpoint Retrieves the complete trade book/ledger for a client's trading account. Provides a comprehensive record of all trades executed, including order details, product information, prices, quantities, timestamps, and other relevant trade data for auditing and regulatory compliance purposes.

Endpoint

Base URL
https://connects.torusdigital.com/api/v1/trade/book

Header Parameters

NameValue

Content-Type

application/json

Authorization

Bearer <token>

Request Parameter

NameValueMandatoryDescription

source

N

Y

Source of the request (e.g., " N")

Request

curl --location 'https://connects.torusdigital.com/api/v1/trade/book' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data '{
  "source": "N"
}'

Response

{
    "data": [
     {
            "algo_id": "0",
            "client_id": "TOR001",
            "display_name": "VODAFONE IDEA LIMITED",
            "encash_flag": "N",
            "exch_order_no": "1400000000177679",
            "exch_order_time": "2024-05-28 10:50:52",
            "exch_trade_time": "2024-05-28 10:50:52",
            "exchange": "NSE",
            "exchange_inst_name": "Other",
            "expiry_date": "0001-01-01",
            "instrument": "EQUITY",
            "isin": "INE669E01016",
            "last_updated_time": "2024-05-28 10:50:52",
            "lot_size": 1,
            "mkt_pro_flag": "N",
            "mkt_pro_value": 0,
            "mkt_type": "NL",
            "opt_type": "XX",
            "order_date_time": "2024-05-28 10:50:51",
            "order_no": "1141240528106",
            "order_type": "MKT",
            "pan_no": "BBTPS7354E",
            "participant_type": "B",
            "placed_by": "CUSTOMER",
            "placed_by_entity_id": "TOR001",
            "product": "C",
            "product_name": "CNC",
            "quantity": 2,
            "row_no": 0,
            "security_id": "14366",
            "segment": "E",
            "series": "EQ",
            "settlor": "90245",
            "strike_price": 0,
            "symbol": "IDEA",
            "tick_size": 5,
            "trade_no": "80103634",
            "trade_value": 29.3,
            "traded_price": 14.65,
            "txn_type": "B"
        }
    ],
    "message": "Success",
    "status": "success"
}

Response Parameter

ParameterDescription

order_date_time

Order Entry Date Time - The date and time when the order was entered.

exch_order_time

Exchange Order Time - The time when the order was received by the exchange.

exch_trade_time

Exchange Trade Time - The time when the trade was executed on the exchange.

last_updated_time

Last Updated Time - The last time the order details were updated.

order_no

Order Number - Unique identifier for the order.

exch_order_no

Exchange Order Number - Unique identifier for the order assigned by the exchange.

exchange

Exchange - The exchange where the order is placed (e.g., NSE, BSE).

txn_type

Transaction Type - Type of transaction (e.g., Buy, Sell).

segment

Segment - The segment of the market (e.g., Equity, Derivatives).

order_type

Order Type - Type of order (e.g., Limit, Market, Stop Loss).

symbol

Symbol - The trading symbol of the security.

product

Product - Type of product (e.g., Cash, Margin).

product_name

Product Name - Name of the product.

quantity

Quantity - The number of shares or contracts.

traded_price

Trade Price - The price at which the trade was executed.

trade_value

Trade Value - The total value of the trade.

trade_no

Trade Number - Unique identifier for the trade.

security_id

Security Id - Identifier for the security being traded.

row_no

Row Number/Index - The row number in the dataset.

pan_no

PAN Number - Permanent Account Number of the client.

participant_type

Participant Type - Type of participant (e.g., Client, Dealer).

mkt_pro_flag

Market Protection Flag - Indicator for market protection.

mkt_pro_value

Market Protection Value - Value associated with market protection.

settlor

Settlor - The entity responsible for settlement.

encash_flag

Encash Flag - Indicator if the encashment is allowed.

mkt_type

Market Type - Type of market (e.g., Normal, Odd Lot, Auction).

strike_price

Strike Price - The strike price for options.

expiry_date

Expiry Date - The expiry date for derivatives.

opt_type

Option Type - The type of option (e.g., Call, Put).

instrument

Instrument Name - Name of the financial instrument.

lot_size

Lot Size - The lot size for the instrument.

series

Series - Series of the security (e.g., EQ for equities).

isin

ISIN Code - International Securities Identification Number.

display_name

Custom Symbol Name - Custom name for the symbol.

exchange_inst_name

Instrument Name - Name of the instrument on the exchange.

placed_by

Placed By - The entity or person who placed the order.

tick_size

Tick Size - The minimum price movement for the security.

algo_id

Algo ID - Identifier for the algorithm used, if any.

placed_by_entity_id

Placed By Entity Id - Identifier for the entity that placed the order.

Last updated