System Reference
Complete reference for standardized codes, classifications, and enumerations used throughout Privé APIs.
Asset Classes
Used for categorizing investment products.
| Code | Label | Description |
|---|---|---|
EQUITY | Equity | Stocks, equity funds, equity ETFs |
FIXEDINCOME | Fixed Income | Bonds, bond funds, fixed income ETFs |
ALTERNATIVE | Alternatives | Hedge funds, private equity, commodities derivatives |
REALESTATE | Real Estate | REITs, real estate funds, property investments |
COMMODITY | Commodity | Physical commodities, commodity funds |
FX | FX | Foreign exchange, currency funds |
HYBRID | Hybrid | Multi-asset, balanced funds, target-date funds |
CASH | Cash & Equivalent | Money market funds, savings, deposits |
OTHER | Other | Uncategorized or custom asset types |
Usage Example:
{
"assetId": "US0378331005",
"assetName": "Apple Inc.",
"assetClass": "EQUITY"
}
Geographic Regions
Used for geographic classification and exposure analysis.
| Code | Label | Description |
|---|---|---|
NORTH_AMERICA | N. America | United States, Canada |
LATIN_AMERICA | Latin America | Mexico, Central and South America |
EUROPE_DEVELOPED | Europe Developed | Western Europe (Germany, France, UK, etc.) |
EUROPE_EMERGING | Europe Emerging | Eastern Europe |
UNITED_KINGDOM | United Kingdom | UK-specific exposure |
ASIA_DEVELOPED | Asia Developed | Japan, Singapore, Hong Kong, Australia |
ASIA_EMERGING | Asia Emerging | China, India, Southeast Asia |
JAPAN | Japan | Japan-specific exposure |
AUSTRALASIA | Australasia | Australia, New Zealand |
AFRICA_MIDDLE_EAST | Africa/Middle East | Africa and Middle Eastern countries |
GLOBAL | Global | Worldwide/multi-regional exposure |
OTHER | Other | Unspecified or mixed regions |
Usage Example:
{
"fundName": "Emerging Asia Equity Fund",
"region": "ASIA_EMERGING"
}
Sectors
Used for sector classification (primarily for equity investments).
Equity Sectors
| Code | Label |
|---|---|
EQ_BASIC_BROAD | Equity-Broad |
EQ_BASIC_MATERIALS | Equity-Basic Materials |
EQ_CONGLOMERATES | Equity-Conglomerates |
EQ_CONSUMER_GOODS | Equity-Consumer Goods |
EQ_FINANCIAL | Equity-Financial |
EQ_HEALTHCARE | Equity-Healthcare |
EQ_INDUSTRIAL_GOODS | Equity-Industrial Goods |
EQ_SERVICES | Equity-Services |
EQ_TECHNOLOGY | Equity-Technology |
EQ_UTILITIES | Equity-Utilities |
EQ_ENERGY | Equity-Energy |
EQ_TELECOM | Equity-Telecom |
EQ_REAL_ESTATE | Equity-Real Estate |
EQ_TRANSPORT | Equity-Transportation |
EQ_AGRIBUSINESS | Equity-Agribusiness |
EQ_INFRASTRUCTURE | Equity-Infrastructure |
EQ_NATURAL_RESOURCE | Equity-Natural Resources |
EQ_GOVERNMENT | Equity-Government |
EQ_GREENTECH_ETHICAL | Equity-Green Technology Ethical |
EQ_OTHER | Equity-Other |
Fixed Income Sectors
| Code | Label |
|---|---|
FI_BROAD | Fixed Income-Broad |
FI_CORP | Fixed Income-Corporate |
FI_GOV | Fixed Income-Government |
FI_MMF | Fixed Income-Money Market |
FI_HIGH_YIELD | Fixed Income-High Yield |
FI_INFLATION | Fixed Income-Inflation |
FI_CONVERTIBLE_BOND | Fixed Income-Convertible Bond |
FI_FIXED_RATE | Fixed Income-IRTO |
FI_MUNI | Fixed Income-Muni |
FI_SECURITIZED | Fixed Income-Securitized |
FI_DERIVATIVE | Fixed Income-Derivative |
Alternative Sectors
| Code | Label |
|---|---|
ALT_BROAD | Alternatives-Broad |
ALT_HF | Alternatives-Hedge Fund |
ALT_PE | Alternatives-Private Equity |
ALT_VOL | Alternatives-Volatility |
ALT_ESG_ISLAMIC | Alternatives-ESG/Islamic |
ALT_FX | Alternatives-FX |
Commodity Sectors
| Code | Label |
|---|---|
COMM_BROAD | Commodity-Broad |
COMM_AGRI | Commodity-Agriculture |
COMM_ENERGY | Commodity-Energy |
COMM_INDUSTRIAL_METALS | Commodity-Industrial Metals |
COMM_PRECIOUS_METALS | Commodity-Precious Metals |
COMM_SOFT | Commodity-Soft |
Real Estate Sectors
| Code | Label |
|---|---|
REALESTATE_BROAD | Real Estate-Broad |
REALESTATE_BUILDING_CONSTRUCTION | Real Estate-Building and Construction |
REALESTATE_REIT | Real Estate-REIT |
Hybrid Sectors
| Code | Label |
|---|---|
HYBRID_BROAD | Hybrid-Broad |
HYBRID_VOLATILITY | Hybrid-Volatility |
HYBRID_TARGET_DATE | Hybrid-Target Date |
HYBRID_TARGET_RISK | Hybrid-Target Risk |
Usage Example:
{
"fundName": "Tech Growth Fund",
"assetClass": "EQUITY",
"sector": "EQ_TECHNOLOGY"
}
Document Types
Used when requesting asset-related documents.
| Code | Label | Description |
|---|---|---|
2 | Fact Sheet | Monthly/quarterly fund fact sheet |
3 | KIID | Key Investor Information Document (EU requirement) |
4 | Prospectus | Full legal prospectus |
5 | Annual Report | Annual financial report |
6 | Semi-Annual Report | Half-yearly financial report |
7 | Product Highlight Sheet | Marketing summary document |
8 | Risk Disclosure | Risk disclosure statement |
9 | Term Sheet | Structured product term sheet |
10 | Product Key Facts | Product Key Facts Statement (Hong Kong) |
11 | Term Sheet and Risk Disclosure | Combined document |
API Usage:
POST /restful/assets/2/documents
Authorization: Bearer {token}
{
"assetId": "LU0274208692",
"documentTypes": [2, 3, 4],
"language": "en"
}
Response:
{
"documents": [
{
"type": 2,
"label": "Fact Sheet",
"url": "https://docs.prive.com/factsheet-LU0274208692-2024-01.pdf",
"date": "2024-01-31"
},
{
"type": 3,
"label": "KIID",
"url": "https://docs.prive.com/kiid-LU0274208692-2024-01.pdf",
"date": "2024-01-15"
}
]
}
Currency Codes
Privé supports all ISO 4217 currency codes. Common examples:
| Code | Currency |
|---|---|
USD | US Dollar |
EUR | Euro |
GBP | British Pound |
CHF | Swiss Franc |
JPY | Japanese Yen |
SGD | Singapore Dollar |
HKD | Hong Kong Dollar |
AUD | Australian Dollar |
CNY | Chinese Yuan |
Usage Example:
{
"portfolioValue": 1000000,
"currency": "USD"
}
Transaction Types
| Code | Description |
|---|---|
BUY | Purchase of securities |
SELL | Sale of securities |
DEPOSIT | Cash deposit into account |
WITHDRAWAL | Cash withdrawal from account |
DIVIDEND | Dividend payment received |
INTEREST | Interest income |
FEE | Management or transaction fee |
SWITCH | Fund switching (sell one, buy another) |
TRANSFER_IN | Transfer of securities into account |
TRANSFER_OUT | Transfer of securities out of account |
CORPORATE_ACTION | Stock split, merger, spin-off, etc. |
Account Status Codes
| Code | Description |
|---|---|
ACTIVE | Account is active and operational |
PENDING | Account creation in progress |
SUSPENDED | Temporarily suspended (no new transactions) |
CLOSED | Permanently closed |
RESTRICTED | Limited operations allowed |
Risk Profile Types
| Code | Description | Use Case |
|---|---|---|
MIFID | MiFID II compliant risk questionnaire | European advisors |
CUSTOM | Custom/proprietary risk assessment | Firms with own methodology |
SIMPLE | Simplified risk questionnaire | Basic advisory |
Investment Guideline Rule Types
| Rule Type | Description | Example |
|---|---|---|
MAX_SINGLE_POSITION | Maximum % in single security | "No more than 5% in any one stock" |
MAX_ASSET_CLASS | Maximum % in asset class | "Max 30% in alternatives" |
MIN_ASSET_CLASS | Minimum % in asset class | "At least 20% in bonds" |
EXCLUDE_ASSET | Forbidden securities | "No tobacco stocks" |
EXCLUDE_SECTOR | Forbidden sectors | "No weapons manufacturers" |
EXCLUDE_REGION | Forbidden geographies | "No Russian securities" |
MIN_CREDIT_RATING | Minimum bond credit rating | "Only investment-grade bonds (BBB- or higher)" |
MAX_LEVERAGE | Maximum leverage ratio | "No more than 1.5x leverage" |
Time Zones
All timestamps in API responses are in UTC (ISO 8601 format).
Example:
{
"transactionDate": "2024-01-15T14:30:00Z",
"createdAt": "2024-01-15T14:30:00.123Z"
}
Converting to Local Time (Python):
from datetime import datetime
import pytz
utc_time = datetime.fromisoformat("2024-01-15T14:30:00Z".replace('Z', '+00:00'))
singapore_tz = pytz.timezone('Asia/Singapore')
local_time = utc_time.astimezone(singapore_tz)
print(f"Singapore time: {local_time}")
Date Formats
All dates use ISO 8601 format: YYYY-MM-DD
Examples:
2024-01-15✅01/15/2024❌15-Jan-2024❌
Updated 9 days ago
Next >>
