System Reference

Complete reference for standardized codes, classifications, and enumerations used throughout Privé APIs.

Asset Classes

Used for categorizing investment products.

CodeLabelDescription
EQUITYEquityStocks, equity funds, equity ETFs
FIXEDINCOMEFixed IncomeBonds, bond funds, fixed income ETFs
ALTERNATIVEAlternativesHedge funds, private equity, commodities derivatives
REALESTATEReal EstateREITs, real estate funds, property investments
COMMODITYCommodityPhysical commodities, commodity funds
FXFXForeign exchange, currency funds
HYBRIDHybridMulti-asset, balanced funds, target-date funds
CASHCash & EquivalentMoney market funds, savings, deposits
OTHEROtherUncategorized or custom asset types

Usage Example:

{
  "assetId": "US0378331005",
  "assetName": "Apple Inc.",
  "assetClass": "EQUITY"
}

Geographic Regions

Used for geographic classification and exposure analysis.

CodeLabelDescription
NORTH_AMERICAN. AmericaUnited States, Canada
LATIN_AMERICALatin AmericaMexico, Central and South America
EUROPE_DEVELOPEDEurope DevelopedWestern Europe (Germany, France, UK, etc.)
EUROPE_EMERGINGEurope EmergingEastern Europe
UNITED_KINGDOMUnited KingdomUK-specific exposure
ASIA_DEVELOPEDAsia DevelopedJapan, Singapore, Hong Kong, Australia
ASIA_EMERGINGAsia EmergingChina, India, Southeast Asia
JAPANJapanJapan-specific exposure
AUSTRALASIAAustralasiaAustralia, New Zealand
AFRICA_MIDDLE_EASTAfrica/Middle EastAfrica and Middle Eastern countries
GLOBALGlobalWorldwide/multi-regional exposure
OTHEROtherUnspecified or mixed regions

Usage Example:

{
  "fundName": "Emerging Asia Equity Fund",
  "region": "ASIA_EMERGING"
}

Sectors

Used for sector classification (primarily for equity investments).

Equity Sectors

CodeLabel
EQ_BASIC_BROADEquity-Broad
EQ_BASIC_MATERIALSEquity-Basic Materials
EQ_CONGLOMERATESEquity-Conglomerates
EQ_CONSUMER_GOODSEquity-Consumer Goods
EQ_FINANCIALEquity-Financial
EQ_HEALTHCAREEquity-Healthcare
EQ_INDUSTRIAL_GOODSEquity-Industrial Goods
EQ_SERVICESEquity-Services
EQ_TECHNOLOGYEquity-Technology
EQ_UTILITIESEquity-Utilities
EQ_ENERGYEquity-Energy
EQ_TELECOMEquity-Telecom
EQ_REAL_ESTATEEquity-Real Estate
EQ_TRANSPORTEquity-Transportation
EQ_AGRIBUSINESSEquity-Agribusiness
EQ_INFRASTRUCTUREEquity-Infrastructure
EQ_NATURAL_RESOURCEEquity-Natural Resources
EQ_GOVERNMENTEquity-Government
EQ_GREENTECH_ETHICALEquity-Green Technology Ethical
EQ_OTHEREquity-Other

Fixed Income Sectors

CodeLabel
FI_BROADFixed Income-Broad
FI_CORPFixed Income-Corporate
FI_GOVFixed Income-Government
FI_MMFFixed Income-Money Market
FI_HIGH_YIELDFixed Income-High Yield
FI_INFLATIONFixed Income-Inflation
FI_CONVERTIBLE_BONDFixed Income-Convertible Bond
FI_FIXED_RATEFixed Income-IRTO
FI_MUNIFixed Income-Muni
FI_SECURITIZEDFixed Income-Securitized
FI_DERIVATIVEFixed Income-Derivative

Alternative Sectors

CodeLabel
ALT_BROADAlternatives-Broad
ALT_HFAlternatives-Hedge Fund
ALT_PEAlternatives-Private Equity
ALT_VOLAlternatives-Volatility
ALT_ESG_ISLAMICAlternatives-ESG/Islamic
ALT_FXAlternatives-FX

Commodity Sectors

CodeLabel
COMM_BROADCommodity-Broad
COMM_AGRICommodity-Agriculture
COMM_ENERGYCommodity-Energy
COMM_INDUSTRIAL_METALSCommodity-Industrial Metals
COMM_PRECIOUS_METALSCommodity-Precious Metals
COMM_SOFTCommodity-Soft

Real Estate Sectors

CodeLabel
REALESTATE_BROADReal Estate-Broad
REALESTATE_BUILDING_CONSTRUCTIONReal Estate-Building and Construction
REALESTATE_REITReal Estate-REIT

Hybrid Sectors

CodeLabel
HYBRID_BROADHybrid-Broad
HYBRID_VOLATILITYHybrid-Volatility
HYBRID_TARGET_DATEHybrid-Target Date
HYBRID_TARGET_RISKHybrid-Target Risk

Usage Example:

{
  "fundName": "Tech Growth Fund",
  "assetClass": "EQUITY",
  "sector": "EQ_TECHNOLOGY"
}

Document Types

Used when requesting asset-related documents.

CodeLabelDescription
2Fact SheetMonthly/quarterly fund fact sheet
3KIIDKey Investor Information Document (EU requirement)
4ProspectusFull legal prospectus
5Annual ReportAnnual financial report
6Semi-Annual ReportHalf-yearly financial report
7Product Highlight SheetMarketing summary document
8Risk DisclosureRisk disclosure statement
9Term SheetStructured product term sheet
10Product Key FactsProduct Key Facts Statement (Hong Kong)
11Term Sheet and Risk DisclosureCombined 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:

CodeCurrency
USDUS Dollar
EUREuro
GBPBritish Pound
CHFSwiss Franc
JPYJapanese Yen
SGDSingapore Dollar
HKDHong Kong Dollar
AUDAustralian Dollar
CNYChinese Yuan

Usage Example:

{
  "portfolioValue": 1000000,
  "currency": "USD"
}

Transaction Types

CodeDescription
BUYPurchase of securities
SELLSale of securities
DEPOSITCash deposit into account
WITHDRAWALCash withdrawal from account
DIVIDENDDividend payment received
INTERESTInterest income
FEEManagement or transaction fee
SWITCHFund switching (sell one, buy another)
TRANSFER_INTransfer of securities into account
TRANSFER_OUTTransfer of securities out of account
CORPORATE_ACTIONStock split, merger, spin-off, etc.

Account Status Codes

CodeDescription
ACTIVEAccount is active and operational
PENDINGAccount creation in progress
SUSPENDEDTemporarily suspended (no new transactions)
CLOSEDPermanently closed
RESTRICTEDLimited operations allowed

Risk Profile Types

CodeDescriptionUse Case
MIFIDMiFID II compliant risk questionnaireEuropean advisors
CUSTOMCustom/proprietary risk assessmentFirms with own methodology
SIMPLESimplified risk questionnaireBasic advisory

Investment Guideline Rule Types

Rule TypeDescriptionExample
MAX_SINGLE_POSITIONMaximum % in single security"No more than 5% in any one stock"
MAX_ASSET_CLASSMaximum % in asset class"Max 30% in alternatives"
MIN_ASSET_CLASSMinimum % in asset class"At least 20% in bonds"
EXCLUDE_ASSETForbidden securities"No tobacco stocks"
EXCLUDE_SECTORForbidden sectors"No weapons manufacturers"
EXCLUDE_REGIONForbidden geographies"No Russian securities"
MIN_CREDIT_RATINGMinimum bond credit rating"Only investment-grade bonds (BBB- or higher)"
MAX_LEVERAGEMaximum 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

Next >>