Overview
The Foreign Financial Instruments API provides reference data for foreign securities held in user accounts. This data includes current market prices (closing values) which are essential for Quicko to calculate unrealized P&L (Profit & Loss) on foreign holdings that have not been sold yet. When users hold foreign stocks, depository receipts, mutual funds, or ETFs, we need up-to-date pricing information to accurately compute:- Unrealized gains/losses on active foreign positions
- Portfolio valuations in foreign currencies
- Tax compliance reporting based on foreign investment holdings
- Tax gain/loss harvesting opportunities on international securities
Response Format
Your API should return financial instrument reference data organized by four categories:Stock Instruments
Stock data should include the following fields:| Param | Type | Required | Description |
|---|---|---|---|
| isin | string | No | ISIN is the international security identification number |
| symbol | string | Yes | Symbol or description of stock |
| 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 calendar year |
| closing_value | number | Yes | Closing value as of last traded date of the calendar year (used to calculate current market value and unrealized P&L) |
Depository Receipt Instruments
Depository receipt data should include the following fields:| Param | Type | Required | Description |
|---|---|---|---|
| isin | string | No | ISIN is the international security identification number |
| symbol | string | Yes | Symbol or description of receipt |
| 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 calendar year |
| closing_value | number | Yes | Closing value as of last traded date of the calendar year (used to calculate current market value and unrealized P&L) |
Mutual Fund Instruments
Mutual fund data should include the following fields:| Param | Type | Required | Description |
|---|---|---|---|
| isin | string | No | ISIN is the international security identification number |
| scheme_name | 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 calendar year |
| closing_value | number | Yes | Closing value as of last traded date of the calendar year (used to calculate current market value and unrealized P&L) |
ETF Instruments
ETF data should include the following fields:| Param | Type | Required | Description |
|---|---|---|---|
| isin | string | No | ISIN is the international security identification number |
| scheme_name | 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 calendar year |
| closing_value | number | Yes | Closing value as of last traded date of the calendar year (used to calculate current market value and unrealized P&L) |