Overview
The Foreign Securities Holdings API provides a snapshot of all foreign securities currently held by a user on a specific date. This includes foreign stocks, depository receipts, mutual funds, and ETFs. Foreign holdings data is critical for Quicko to understand international portfolio composition, calculate capital gains/losses in foreign currencies, and prepare accurate tax reports for international investments.Query Parameters
Your API should accept anas_on_date query parameter to retrieve holdings for a specific date. This allows Quicko to fetch historical holdings snapshots when needed for tax compliance and regulatory reporting on foreign investments.
Response Format
Your API should return holdings data organized by client details and four security categories:Client Details
Client information should include the following fields:| Param | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Name of the client |
| pan | string | Yes | PAN of the client |
| client_id | string | Yes | Unique identifier of the Client’s investment account |
| country | string | Yes | Country where investments were made |
| tin | string | Yes | TIN for the country or passport number |
Stock Holdings
Stock holdings data should include the following fields:| Param | Type | Description |
|---|---|---|
| isin | string | ISIN is the international security identification number |
| symbol | string | Symbol or description of equity stock |
| quantity | number | Trading quantity |
| buy_date | number | The date on which the equity stock was bought |
| buy_price | number | Price at which a unit was bought |
| currency | number | The 3 letter currency code for the price based on ISO 4217 |
| transaction_type | string | Indicates whether the order is :buy , sell, send, receive Or trade, |
| label | string | Refer to label for possible values |
| last_traded_price | string | Last traded market price of the equity stock. |
Depository Receipt Holdings
Depository receipt holdings data should include the following fields:| Param | Type | Description |
|---|---|---|
| isin | string | ISIN is the international security identification number |
| symbol | string | Symbol or description of depositary receipt. |
| quantity | number | Trading quantity |
| buy_date | number | The date on which the receipt was bought |
| buy_price | number | Price at which a unit was bought |
| currency | number | The 3 letter currency code for the price based on ISO 4217 |
| transaction_type | string | Indicates whether the order is :buy , sell, send, receive Or trade, |
| label | string | Refer to label for possible values |
| last_traded_price | string | Last traded market price of the receipt.. |
Mutual Fund Holdings
Mutual fund holdings data should include the following fields:| Param | Type | Description |
|---|---|---|
| isin | string | ISIN is the international security identification number |
| scheme_name | string | Symbol or description of fund |
| quantity | number | Trading quantity |
| buy_date | number | The date on which the fund was bought |
| buy_price | number | Price at which a unit was bought |
| currency | number | The 3 letter currency code for the price based on ISO 4217 |
| transaction_type | string | Indicates whether the order is :buy , sell, send, receive Or trade, |
| label | string | Refer to label for possible values |
| last_traded_price | string | Last traded market price of the fund. |
ETF Holdings
ETF holdings data should include the following fields:| Param | Type | Description |
|---|---|---|
| isin | string | ISIN is the international security identification number |
| scheme_name | string | Symbol or description of fund |
| quantity | number | Trading quantity |
| buy_date | number | The date on which the fund was bought |
| buy_price | number | Price at which a unit was bought |
| currency | number | The 3 letter currency code for the price based on ISO 4217 |
| transaction_type | string | Indicates whether the order is :buy , sell, send, receive Or trade, |
| label | string | Refer to label for possible values |
| last_traded_price | string | Last traded market price of the fund. |