Skip to main content

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 NameData TypeDescription
account_guidStringUnique identifier for the account. Defined by MX.
allocations_cashDecimalThe percentage of a holding held in cash or cash equivalents.
allocations_convertibleDecimalThe percentage of a holding held in convertible shares.
allocations_foreign_bondDecimalThe percentage of a holding held in US bonds.
allocations_foreign_stockDecimalThe percentage of a holding held in non-US stocks.
allocations_otherDecimalThe percentage of a holding held in otherwise undefined assets. Real estate, commodities, and precious metals are examples of 'other' assets.
allocations_preferredDecimalThe percentage of a holding held in preferred stocks.
allocations_unknownDecimalThe percentage of a holding held in assets that are currently undefined by MX.
allocations_us_bondDecimalThe percentage of a holding held in US bonds.
allocations_us_stockDecimalThe percentage of a holding held in US stocks.
bond_coupon_rateDecimalThe coupon rate for a bond.
bond_coupon_rate_set_byIntegerThe source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
bond_coupon_rate_set_by_nameStringThe source that set the data ( FEED, USER, or SYSTEM ).
bond_maturity_dateStringThe bond maturity date, represented in ISO 8601 format without a timestamp (e.g. 2015-04-13).
bond_maturity_date_set_byIntegerThe source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
bond_maturity_date_set_by_nameStringThe source that set the data ( FEED, USER, or SYSTEM ).
cost_basisDecimalThe cost basis is the original value of an asset adjusted for stock splits, dividends, and capital distributions.
cost_basis_set_byIntegerThe source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
cost_basis_set_by_nameStringThe source that set the data ( FEED, USER, or SYSTEM ).
cost_basis_updated_atStringDate 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_atStringDate and time the holding was created, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).
currency_codeStringThe ISO 4217 three-character currency code (e.g. USD).
currency_code_set_byIntegerThe source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
currency_code_set_by_nameStringThe source that set the data ( FEED, USER, or SYSTEM ).
daily_changeDecimalThe change from the previous day in the price of the security.
daily_change_set_byIntegerThe source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
daily_change_set_by_nameStringThe source that set the data ( FEED, USER, or SYSTEM ).
deleted_atStringDate and time the holding was deleted, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).
descriptionStringDescription of the holding.
description_set_byIntegerThe source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
description_set_by_nameStringThe source that set the data ( FEED, USER, or SYSTEM ).
equity_classificationIntegerA 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_byIntegerThe source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
equity_classification_set_by_nameStringThe source that set the data ( FEED, USER, or SYSTEM ).
external_guidStringPartner created identifier for the holding.
feed_bond_coupon_rateDecimalThe coupon rate for a bond, as defined by our data feed. See bond_coupon_rate for more information.
feed_bond_maturity_dateStringThe bond maturity date, as defined by our data feed. See bond_maturity_rate for more information.
feed_cost_basisDecimalCost basis, as provided by our data feed. See cost_basis for more information.
feed_currency_codeStringThe ISO 4217 three-character currency code, as provided by our data feed (e.g. USD).
feed_cusipStringThe cusip, as provided by our data feed. See cusip for more information.
feed_daily_changeDecimalDaily change of the holding, as provided by our data feed. See daily_change for more information.
feed_descriptionStringDescription of the holding, as provided by our data feed. See description for more information.
feed_equity_classificationStringThe equity classification, as defined by our data feed. See equity_classification for more information.
feed_fixed_income_classificationStringThe fixed income classification, as defined by our data feed. See fixed_income_classification for more information.
feed_isinStringThe International Securities Identification Number (ISIN), as defined by our data feed. See fixed_income_classification for more information.
feed_market_valueDecimalMarket value of the holding, as provided by our data feed. See market_value for more information.
feed_purchase_priceDecimalPurchase price of the holding, as provided by our data feed. See purchase_price for more information.
feed_sectorIntegerThe area of the economy the holding is invested in, as defined by our data feed. See sector for more information.
feed_sedolStringThe Stock Exchange Daily Official List (SEDOL) classification code, as defined by our data feed. See sedol for more information.
feed_sharesDecimalShares for the holding, as provided by our data feed. See shares for more information.
feed_symbolStringTicker symbol, as provided by our data feed. See symbol for more information.
fixed_income_classificationIntegerA 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_byIntegerThe source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
fixed_income_classification_set_by_nameStringThe source that set the data ( FEED, USER, or SYSTEM ).
guidStringUnique transaction identifier. Defined by MX.
holding_typeIntegerThe type of holding, such as Mutual Fund, Equity, or Bond.
holding_type_nameStringThe name of the holding type.
holding_type_set_byIntegerThe source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
holding_type_set_by_nameStringThe source that set the data ( FEED, USER, or SYSTEM ).
is_deletedBooleanIf the holding is deleted, this field will be true. Otherwise, this field will be false.
isinStringThe International Securities Identification Number (ISIN) in ISO 6166 format.
isin_set_byIntegerThe source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
isin_set_by_nameStringThe source that set the data ( FEED, USER, or SYSTEM ).
large_core_weightDecimalThe percentage of a holding's stock value with a large core investment style.
large_growth_weightDecimalThe percentage of a holding's stock value with a large growth investment style.
large_value_weightDecimalThe percentage of a holding's stock value with a large value investment style.
market_valueDecimalThe market value of the holding.
market_value_set_byIntegerThe source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
market_value_set_by_nameStringThe source that set the data ( FEED, USER, or SYSTEM ).
member_is_managed_by_userBooleanIf 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.
metadataStringAdditional information a partner can store on the holding.
mid_core_weightDecimalThe percentage of a holding's stock value with a mid core investment style.
mid_growth_weightDecimalThe percentage of a holding's stock value with a mid growth investment style.
mid_value_weightDecimalThe percentage of a holding's stock value with a mid value investment style.
purchase_priceDecimalThe purchase price of the holding.
purchase_price_set_byIntegerThe source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
purchase_price_set_by_nameStringThe source that set the data ( FEED, USER, or SYSTEM ).
sectorIntegerThe area of the economy the holding is invested in.
sector_set_byIntegerThe source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
sector_set_by_nameStringThe source that set the data ( FEED, USER, or SYSTEM ).
sedolStringThe Stock Exchange Daily Official List (SEDOL) classification code, represented as a seven-character code (e.g. B03MM40).
sedol_set_byIntegerThe source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
sedol_set_by_nameStringThe source that set the data ( FEED, USER, or SYSTEM ).
sharesDecimalThe number of shares for the holding.
shares_set_byIntegerThe source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
shares_set_by_nameStringThe source that set the data ( FEED, USER, or SYSTEM ).
small_core_weightDecimalThe percentage of a holding's stock value with a small core investment style.
small_growth_weightDecimalThe percentage of a holding's stock value with a small growth investment style.
small_value_weightDecimalThe percentage of a holding's stock value with a small value investment style.
symbolStringTicker symbol. Abbreviation used to uniquely identify publicly traded stocks, bonds, mutual funds, and ETFs.
symbol_set_byIntegerThe source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
symbol_set_by_nameStringThe source that set the data ( FEED, USER, or SYSTEM ).
updated_atStringDate and time the transaction was updated, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).
unknown_weightDecimalThe percentage of a holding's stock value with an investment style currently undefined by MX.
user_guidStringUnique identifier for the user. Defined by MX.

Holding Classification

ValueDefinition
0UNKNOWN
1LARGE_VALUE
2LARGE_CORE
3LARGE_GROWTH
4MID_VALUE
5MID_CORE
6MID_GROWTH
7SMALL_VALUE
8SMALL_CORE
9SMALL_GROWTH

Fixed Income Classification

ValueDefinition
0UNKNOWN_FIXED_INCOME_CLASSIFICATION
1HIGH_LIMITED
2HIGH_MODERATE
3HIGH_EXTENSIVE
4MEDIUM_LIMITED
5MEDIUM_MODERATE
6MEDIUM_EXTENSIVE
7LOW_LIMITED
8LOW_MODERATE
9LOW_EXTENSIVE

Holding Type

ValueDefinition
0UNKNOWN_TYPE
1EQUITY
2EXCHANGE_TRADED_FUND
3MONEY_MARKET
4MUTUAL_FUND
5HEDGE_FUND
6ANNUITY
7UNIT_INVESTMENT_TRUST
8CASH
9FIXED_INCOME
10OPTIONS

Holding set_by

Date SourceDefinitionInformation
1FEEDInformation provided from the MX data feed.
2USERInformation provided from the user.
3SYSTEMInformation provided from the MX system.