Nexus API
Holdings Overview
Holdings represent individual investment positions within investment accounts, including stocks, bonds, mutual funds, and other securities.
Holding Fields
warning
As of January 1, 2025, CUSIP is no longer supported. Please refer to the most-up-to-date investment documentation.
| Field Name | Data Type | Description |
|---|---|---|
account_guid | String | Unique identifier for the account. Defined by MX. |
allocations_cash | Decimal | The percentage of a holding held in cash or cash equivalents. |
allocations_convertible | Decimal | The percentage of a holding held in convertible shares. |
allocations_foreign_bond | Decimal | The percentage of a holding held in US bonds. |
allocations_foreign_stock | Decimal | The percentage of a holding held in non-US stocks. |
allocations_other | Decimal | The percentage of a holding held in otherwise undefined assets. Real estate, commodities, and precious metals are examples of 'other' assets. |
allocations_preferred | Decimal | The percentage of a holding held in preferred stocks. |
allocations_unknown | Decimal | The percentage of a holding held in assets that are currently undefined by MX. |
allocations_us_bond | Decimal | The percentage of a holding held in US bonds. |
allocations_us_stock | Decimal | The percentage of a holding held in US stocks. |
bond_coupon_rate | Decimal | The coupon rate for a bond. |
bond_coupon_rate_set_by | Integer | The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). |
bond_coupon_rate_set_by_name | String | The source that set the data ( FEED, USER, or SYSTEM ). |
bond_maturity_date | String | The bond maturity date, represented in ISO 8601 format without a timestamp (e.g. 2015-04-13). |
bond_maturity_date_set_by | Integer | The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). |
bond_maturity_date_set_by_name | String | The source that set the data ( FEED, USER, or SYSTEM ). |
cost_basis | Decimal | The cost basis is the original value of an asset adjusted for stock splits, dividends, and capital distributions. |
cost_basis_set_by | Integer | The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). |
cost_basis_set_by_name | String | The source that set the data ( FEED, USER, or SYSTEM ). |
cost_basis_updated_at | String | Date and time the cost basis was last updated, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00). |
created_at | String | Date and time the holding was created, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00). |
currency_code | String | The ISO 4217 three-character currency code (e.g. USD). |
currency_code_set_by | Integer | The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). |
currency_code_set_by_name | String | The source that set the data ( FEED, USER, or SYSTEM ). |
daily_change | Decimal | The change from the previous day in the price of the security. |
daily_change_set_by | Integer | The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). |
daily_change_set_by_name | String | The source that set the data ( FEED, USER, or SYSTEM ). |
deleted_at | String | Date and time the holding was deleted, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00). |
description | String | Description of the holding. |
description_set_by | Integer | The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). |
description_set_by_name | String | The source that set the data ( FEED, USER, or SYSTEM ). |
equity_classification | Integer | A graphical representation of the investment style of the stocks and stock funds within a holding according to the Morningstar Style Box. See Holding Classification for more information. |
equity_classification_set_by | Integer | The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). |
equity_classification_set_by_name | String | The source that set the data ( FEED, USER, or SYSTEM ). |
external_guid | String | Partner created identifier for the holding. |
feed_bond_coupon_rate | Decimal | The coupon rate for a bond, as defined by our data feed. See bond_coupon_rate for more information. |
feed_bond_maturity_date | String | The bond maturity date, as defined by our data feed. See bond_maturity_rate for more information. |
feed_cost_basis | Decimal | Cost basis, as provided by our data feed. See cost_basis for more information. |
feed_currency_code | String | The ISO 4217 three-character currency code, as provided by our data feed (e.g. USD). |
feed_cusip | String | The cusip, as provided by our data feed. See cusip for more information. |
feed_daily_change | Decimal | Daily change of the holding, as provided by our data feed. See daily_change for more information. |
feed_description | String | Description of the holding, as provided by our data feed. See description for more information. |
feed_equity_classification | String | The equity classification, as defined by our data feed. See equity_classification for more information. |
feed_fixed_income_classification | String | The fixed income classification, as defined by our data feed. See fixed_income_classification for more information. |
feed_isin | String | The International Securities Identification Number (ISIN), as defined by our data feed. See fixed_income_classification for more information. |
feed_market_value | Decimal | Market value of the holding, as provided by our data feed. See market_value for more information. |
feed_purchase_price | Decimal | Purchase price of the holding, as provided by our data feed. See purchase_price for more information. |
feed_sector | Integer | The area of the economy the holding is invested in, as defined by our data feed. See sector for more information. |
feed_sedol | String | The Stock Exchange Daily Official List (SEDOL) classification code, as defined by our data feed. See sedol for more information. |
feed_shares | Decimal | Shares for the holding, as provided by our data feed. See shares for more information. |
feed_symbol | String | Ticker symbol, as provided by our data feed. See symbol for more information. |
fixed_income_classification | Integer | A graphical representation of the investment style of the fixed income funds within a holding (like bonds) according to the Morningstar Style Box. See Fixed Income Classification for more information. |
fixed_income_classification_set_by | Integer | The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). |
fixed_income_classification_set_by_name | String | The source that set the data ( FEED, USER, or SYSTEM ). |
guid | String | Unique transaction identifier. Defined by MX. |
holding_type | Integer | The type of holding, such as Mutual Fund, Equity, or Bond. |
holding_type_name | String | The name of the holding type. |
holding_type_set_by | Integer | The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). |
holding_type_set_by_name | String | The source that set the data ( FEED, USER, or SYSTEM ). |
is_deleted | Boolean | If the holding is deleted, this field will be true. Otherwise, this field will be false. |
isin | String | The International Securities Identification Number (ISIN) in ISO 6166 format. |
isin_set_by | Integer | The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). |
isin_set_by_name | String | The source that set the data ( FEED, USER, or SYSTEM ). |
large_core_weight | Decimal | The percentage of a holding's stock value with a large core investment style. |
large_growth_weight | Decimal | The percentage of a holding's stock value with a large growth investment style. |
large_value_weight | Decimal | The percentage of a holding's stock value with a large value investment style. |
market_value | Decimal | The market value of the holding. |
market_value_set_by | Integer | The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). |
market_value_set_by_name | String | The source that set the data ( FEED, USER, or SYSTEM ). |
member_is_managed_by_user | Boolean | If the member the holding belongs to is managed by the user, this field will be true. Otherwise, the member is managed by the MX partner and this field will be false. Members created with Nexus are considered to be managed by the user. |
metadata | String | Additional information a partner can store on the holding. |
mid_core_weight | Decimal | The percentage of a holding's stock value with a mid core investment style. |
mid_growth_weight | Decimal | The percentage of a holding's stock value with a mid growth investment style. |
mid_value_weight | Decimal | The percentage of a holding's stock value with a mid value investment style. |
purchase_price | Decimal | The purchase price of the holding. |
purchase_price_set_by | Integer | The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). |
purchase_price_set_by_name | String | The source that set the data ( FEED, USER, or SYSTEM ). |
sector | Integer | The area of the economy the holding is invested in. |
sector_set_by | Integer | The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). |
sector_set_by_name | String | The source that set the data ( FEED, USER, or SYSTEM ). |
sedol | String | The Stock Exchange Daily Official List (SEDOL) classification code, represented as a seven-character code (e.g. B03MM40). |
sedol_set_by | Integer | The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). |
sedol_set_by_name | String | The source that set the data ( FEED, USER, or SYSTEM ). |
shares | Decimal | The number of shares for the holding. |
shares_set_by | Integer | The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). |
shares_set_by_name | String | The source that set the data ( FEED, USER, or SYSTEM ). |
small_core_weight | Decimal | The percentage of a holding's stock value with a small core investment style. |
small_growth_weight | Decimal | The percentage of a holding's stock value with a small growth investment style. |
small_value_weight | Decimal | The percentage of a holding's stock value with a small value investment style. |
symbol | String | Ticker symbol. Abbreviation used to uniquely identify publicly traded stocks, bonds, mutual funds, and ETFs. |
symbol_set_by | Integer | The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). |
symbol_set_by_name | String | The source that set the data ( FEED, USER, or SYSTEM ). |
updated_at | String | Date and time the transaction was updated, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00). |
unknown_weight | Decimal | The percentage of a holding's stock value with an investment style currently undefined by MX. |
user_guid | String | Unique identifier for the user. Defined by MX. |
Holding Classification
| Value | Definition |
|---|---|
| 0 | UNKNOWN |
| 1 | LARGE_VALUE |
| 2 | LARGE_CORE |
| 3 | LARGE_GROWTH |
| 4 | MID_VALUE |
| 5 | MID_CORE |
| 6 | MID_GROWTH |
| 7 | SMALL_VALUE |
| 8 | SMALL_CORE |
| 9 | SMALL_GROWTH |
Fixed Income Classification
| Value | Definition |
|---|---|
| 0 | UNKNOWN_FIXED_INCOME_CLASSIFICATION |
| 1 | HIGH_LIMITED |
| 2 | HIGH_MODERATE |
| 3 | HIGH_EXTENSIVE |
| 4 | MEDIUM_LIMITED |
| 5 | MEDIUM_MODERATE |
| 6 | MEDIUM_EXTENSIVE |
| 7 | LOW_LIMITED |
| 8 | LOW_MODERATE |
| 9 | LOW_EXTENSIVE |
Holding Type
| Value | Definition |
|---|---|
| 0 | UNKNOWN_TYPE |
| 1 | EQUITY |
| 2 | EXCHANGE_TRADED_FUND |
| 3 | MONEY_MARKET |
| 4 | MUTUAL_FUND |
| 5 | HEDGE_FUND |
| 6 | ANNUITY |
| 7 | UNIT_INVESTMENT_TRUST |
| 8 | CASH |
| 9 | FIXED_INCOME |
| 10 | OPTIONS |
Holding set_by
| Date Source | Definition | Information |
|---|---|---|
| 1 | FEED | Information provided from the MX data feed. |
| 2 | USER | Information provided from the user. |
| 3 | SYSTEM | Information provided from the MX system. |