Tradebook | Foreign Securities

Client Details Sheet

Client Details List

Param	Type	Required	Description
name	`string`	Yes	Name of the client
pan	`string`	Yes	PAN of the client
client_id	`string`	Yes	Client ID for the client

Client TIN Table

Param	Type	Required	Description
country	`string`	Yes	Country where investments were made
tin	`string`	Yes	TIN for the country or passport number

Stock Tradebook Sheet

Metadata

Param	Type	Required	Description
currency	`string`	No	The 3 letter currency code for the price based on ISO 4217

Stock Tradebook Table

Param	Type	Required	Description
isin	`string`	No	ISIN is the international security identification number
trade_id	`string`	No	Transaction ID of the particular trade
symbol	`string`	Yes	Symbol or description of equity stock
quantity	`number`	Yes	Trading quantity
date	`number`	Yes	Transaction epoch timestamp
price	`number`	Yes	The unit price of the equity share
transaction_type	`string`	Yes	Indicates whether the order is : `buy` Or `sell`,
transfer_expenses	`number`	Yes	Any expense relating to the transfer of shares
label	`string`	No	Refer to labels for possible values
product_type	`string`	Yes	Indicates whether the order is : `delivery` , `intraday`

Reference Data Table

Param	Type	Required	Description
isin	`string`	No	ISIN is the international security identification number
symbol	`string`	Yes	Symbol or description of equity share
address	`string`	No	Address of the company
country	`string`	Yes	Country of the company
zip_code	`string`	Yes	Zip code of the address
52_week_high	`number`	Yes	52 week high price for the symbol for the FY
closing_value	`number`	Yes	closing value for the symbol

Dividend Table

Param	Type	Required	Description
isin	`string`	No	ISIN is the international security identification number
symbol	`string`	Yes	Symbol or description of equity share
quantity	`number`	Yes	Trading quantity
date	`number`	Yes	Transaction epoch timestamp
dividend_amount	`number`	Yes	Dividend amount received
tax_withheld	`number`	Yes	TDS amount deducted on the dividend

ADR Tradebook Sheet

Metadata

Param	Type	Required	Description
currency	`string`	No	The 3 letter currency code for the price based on ISO 4217

ADR Tradebook Table

Param	Type	Required	Description
isin	`string`	No	ISIN is the international security identification number
trade_id	`string`	No	Transaction ID of the particular trade
symbol	`string`	Yes	Symbol or description of ADR
quantity	`number`	Yes	Trading quantity
date	`number`	Yes	Transaction epoch timestamp
price	`number`	Yes	The unit price of the ADR
transaction_type	`string`	Yes	Indicates whether the order is : `buy` Or `sell`,
transfer_expenses	`number`	Yes	Any expense relating to the transfer of ADR
label	`string`	No	Refer to labels for possible values
product_type	`string`	Yes	Indicates whether the order is : `delivery` , `intraday`

Reference Data Table

Param	Type	Required	Description
isin	`string`	No	ISIN is the international security identification number
symbol	`string`	Yes	Symbol or description of adr
address	`string`	No	Address of the company
country	`string`	Yes	Country of the company
zip_code	`string`	Yes	Zip code of the address
52_week_high	`number`	Yes	52 week high price for the symbol for the FY
closing_value	`number`	Yes	closing value for the symbol

Dividend Table

Param	Type	Required	Description
isin	`string`	No	ISIN is the international security identification number
symbol	`string`	Yes	Symbol or description of adr
quantity	`number`	Yes	Trading quantity
date	`number`	Yes	Transaction epoch timestamp
dividend_amount	`number`	Yes	Dividend amount received
tax_withheld	`number`	Yes	TDS amount deducted on the dividend

Mutual Fund Tradebook Sheet

Metadata

Param	Type	Required	Description
currency	`string`	No	The 3 letter currency code for the price based on ISO 4217

Mutual Fund Tradebook Table

Param	Type	Required	Description
isin	`string`	No	ISIN is the international security identification number
trade_id	`string`	No	Transaction ID of the particular trade
scheme_name	`string`	Yes	Scheme name of the mutual fund
scheme_type	`string`	Yes	Scheme type, possible values `equity`, `debt`, `other`
quantity	`number`	Yes	Trading quantity
date	`number`	Yes	Transaction epoch timestamp
price	`number`	Yes	The unit price of the mutual fund
transaction_type	`string`	Yes	Indicates whether the order is : `buy` Or `sell`,
transfer_expenses	`number`	Yes	Any expense relating to the transfer of Mutual funds
label	`string`	No	Refer to labels for possible values

Reference Data Table

Param	Type	Required	Description
isin	`string`	No	ISIN is the international security identification number
symbol	`string`	Yes	Symbol or description of fund
address	`string`	No	Address of the company
country	`string`	Yes	Country of the company
zip_code	`string`	Yes	Zip code of the address
52_week_high	`number`	Yes	52 week high price for the symbol for the FY
closing_value	`number`	Yes	closing value for the symbol

Dividend Table

Param	Type	Required	Description
isin	`string`	No	ISIN is the international security identification number
symbol	`string`	Yes	Symbol or description of fund
quantity	`number`	Yes	Trading quantity
date	`number`	Yes	Transaction epoch timestamp
dividend_amount	`number`	Yes	Dividend amount received
tax_withheld	`number`	Yes	TDS amount deducted on the dividend

ETF Tradebook Sheet

Metadata

Param	Type	Required	Description
currency	`string`	No	The 3 letter currency code for the price based on ISO 4217

ETF Tradebook Table

Param	Type	Required	Description
isin	`string`	No	ISIN is the international security identification number
trade_id	`string`	No	Transaction ID of the particular trade
scheme_name	`string`	Yes	Scheme name of the mutual fund
scheme_type	`string`	Yes	Scheme type, possible values `equity`, `debt`, `other`
quantity	`number`	Yes	Trading quantity
date	`number`	Yes	Transaction epoch timestamp
price	`number`	Yes	The unit price of the mutual fund
transaction_type	`string`	Yes	Indicates whether the order is : `buy` Or `sell`,
transfer_expenses	`number`	Yes	Any expense relating to the transfer of Mutual funds
label	`string`	No	Refer to labels for possible values
product_type	`string`	Yes	Indicates whether the order is : `delivery` , `intraday`

Reference Data Table

Param	Type	Required	Description
isin	`string`	No	ISIN is the international security identification number
symbol	`string`	Yes	Symbol or description of fund
address	`string`	No	Address of the company
country	`string`	Yes	Country of the company
zip_code	`string`	Yes	Zip code of the address
52_week_high	`number`	Yes	52 week high price for the symbol for the FY
closing_value	`number`	Yes	closing value for the symbol

Dividend Table

Param	Type	Required	Description
isin	`string`	No	ISIN is the international security identification number
symbol	`string`	Yes	Symbol or description of fund
quantity	`number`	Yes	Trading quantity
date	`number`	Yes	Transaction epoch timestamp
dividend_amount	`number`	Yes	Dividend amount received
tax_withheld	`number`	Yes	TDS amount deducted on the dividend

Interest Income Sheet

Interest Income Table

Param	Type	Required	Description
description	`string`	No	Description of interest credit
date	`number`	Yes	Transaction ID of the particular entry
amount	`number`	Yes	Interest amount received
tax_withheld	`number`	Yes	TDS amount deducted on the interest