Skip to content

Latest commit

 

History

History
50 lines (45 loc) · 9.45 KB

Holding.md

File metadata and controls

50 lines (45 loc) · 9.45 KB

Holding

Properties

Name Type Description Notes
symbol str The symbol of the security.<br><br><b>Applicable containers</b>: investment<br> [optional] [readonly]
exercised_quantity float The quantity of the employee stock options that are already exercised or bought by the employee.<br><b>Note</b>: Once the employee stock options is exercised, they are either converted to cash value or equity positions depending on the FI. The exercised quantity field is only applicable to employee stock options.<br><br><b>Applicable containers</b>: investment<br> [optional] [readonly]
cusip_number str The CUSIP (Committee on Uniform Securities Identification Procedures) identifies most the financial instruments in the United States and Canada.<br><br><b>Applicable containers</b>: investment<br> [optional] [readonly]
asset_classification list[AssetClassification] Asset classification applied to the holding. <br><br><b>Applicable containers</b>: investment<br> [optional] [readonly]
vested_quantity float The quantity of units or shares that are already vested on a vest date.<br><b>Note</b>: The vested quantity field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.<br><br><b>Applicable containers</b>: investment<br> [optional] [readonly]
description str The description (name) for the holding (E.g., Cisco Systems)<br>For insurance container, the field is only applicable for insurance annuity and variable life insurance types. <br><br><b>Applicable containers</b>: investment, insurance<br> [optional] [readonly]
unvested_value Money [optional]
security_style str Indicates the security style of holding identified through the security service.<br><br><b>Applicable containers</b>: investment, insurance<br> [optional] [readonly]
vested_value Money [optional]
option_type str The type of the option position (i.e., put or call).<br><b>Note</b>: The option type field is only applicable to options.<br><br><b>Applicable containers</b>: investment<br><b>Applicable Values</b><br> [optional] [readonly]
last_updated str The date when the information was last updated in the system.<br><br><b>Applicable containers</b>: investment, insurance<br> [optional] [readonly]
match_status str Indicates the security match status id of the investment option identified during security normalization.<br><br><b>Applicable containers</b>: investment<br> [optional] [readonly]
holding_type str Type of holding<br><br><b>Applicable containers</b>: investment, insurance<br> [optional] [readonly]
maturity_date str The stated maturity date of a bond or CD.<br><br><b>Applicable containers</b>: investment<br> [optional] [readonly]
price Money [optional]
term str The fixed duration for which the bond or CD is issued.<br><b>Note</b>: The term field is only applicable to CD.<br><br><b>Applicable containers</b>: investment<br> [optional] [readonly]
contract_quantity float The quantity of tradeable units in a contract.<br><b>Note</b>: The contract quantity field is only applicable to commodity and currency.<br><br><b>Applicable containers</b>: investment<br> [optional] [readonly]
id int Unique identifier for the security added in the system. This is the primary key of the holding resource.<br><br><b>Applicable containers</b>: investment, insurance<br> [optional] [readonly]
is_short bool Indicates that the holding is a short trading.<br><br><b>Applicable containers</b>: investment<br> [optional] [readonly]
value Money [optional]
expiration_date str The date on which an option, right or warrant expires.<br><b>Note</b>: The expiration date field is only applicable to options and employee stock options.<br><br><b>Applicable containers</b>: investment<br> [optional] [readonly]
interest_rate float The interest rate on a CD.<br><b>Note</b>: The interest rate field is only applicable to CD.<br><br><b>Applicable containers</b>: investment<br> [optional] [readonly]
quantity float The quantity held for the holding.<br><b>Note</b>: Only for bonds the quantity field indicates the normalized quantity and not the quantity aggregated from the site. The quantity field is only applicable to restricted stock units/awards, performance units, currency, and commodity.<br>For insurance container, the field is only applicable for insurance annuity and variable life insurance types.<br><br><b>Applicable containers</b>: investment, insurance<br> [optional] [readonly]
accrued_interest Money [optional]
grant_date str The date on which equity awards like ESOP, RSU, etc., are issued or granted.<br><b>Note</b>: The grant date field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.<br><br><b>Applicable containers</b>: investment<br> [optional] [readonly]
sedol str The SEDOL (Stock Exchange Daily Official List) is a set of security identifiers used in the United Kingdom and Ireland for clearing purposes.<br><b>Note</b>: The SEDOL field is only applicable to the trade related transactions<br><br><b>Applicable containers</b>: investment<br> [optional] [readonly]
vested_shares_exercisable float The number of vested shares that can be exercised by the employee. It is usually equal to the vested quantity.<br><b>Note</b>: The vested shares exercisable field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.<br><br><b>Applicable containers</b>: investment<br> [optional] [readonly]
spread Money [optional]
account_id int Unique identifier of the account to which the security is linked.<br><br><b>Applicable containers</b>: investment, insurance<br> [optional] [readonly]
enriched_description str The enrichedDescription is the security description of the normalized holding<br><br><b>Applicable containers</b>: investment, insurance<br> [optional] [readonly]
coupon_rate float The stated interest rate for a bond.<br><br><b>Applicable containers</b>: investment<br> [optional] [readonly]
created_date str The date on which the holding is created in the Yodlee system.<br><br><b>Applicable containers</b>: investment, insurance<br> [optional] [readonly]
accrued_income Money [optional]
security_type str Indicates the security type of holding identified through the security service.<br><br><b>Applicable containers</b>: investment, insurance<br> [optional] [readonly]
provider_account_id int Unique identifier for the user's association with the provider.<br><br><b>Applicable containers</b>: investment, insurance<br> [optional] [readonly]
unvested_quantity float Indicates the number of unvested quantity or units.<br><b>Note</b>: The unvested quantity field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.<br><br><b>Applicable containers</b>: investment<br> [optional] [readonly]
cost_basis Money [optional]
vesting_date str The date on which a RSU, RSA, or an employee stock options become vested.<br><b>Note</b>: The vesting date field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.<br><br><b>Applicable containers</b>: investment<br> [optional] [readonly]
isin str The ISIN (International Securities Identification Number) is used worldwide to identify specific securities. It is equivalent to CUSIP for international markets.<br><br><b>Note</b>: The ISIN field is only applicable to the trade related transactions<br><br><b>Applicable containers</b>: investment<br> [optional] [readonly]
strike_price Money [optional]

[Back to Model list] [Back to API list] [Back to README]