In documentation code examples, replace <API_KEY_VALUE> with the session token.
Response
200 - application/vnd.mx.nexus.v1+json
OK
holdings
object[]
Hide child attributes
holdings.account_guid
string
Unique identifier for the account. Defined by MX.
Example:
"ACT-a8ba7faa-6ce8-4e05-a8b4-bd02ae2b8b9d"
holdings.allocations_cash
number
The percentage of a holding held in cash or cash equivalents.
Example:
88.0948
holdings.allocations_convertible
number
The percentage of a holding held in convertible shares (often in the form of preferred shares or bonds).
Example:
48.6542
holdings.allocations_foreign_bond
number
The percentage of a holding held in US bonds.
Example:
0.0139
holdings.allocations_foreign_stock
number
The percentage of a holding held in non-US stocks.
Example:
87.8851
holdings.allocations_other
number
The percentage of a holding held in otherwise undefined assets. Real estate, commodities, and precious metals are examples of 'other' assets.
Example:
0.0542
holdings.allocations_preferred
number
The percentage of a holding held in preferred stocks.
Example:
43.5169
holdings.allocations_unknown
number
The percentage of a holding held in assets that are currently undefined by MX.
Example:
0.023
holdings.allocations_us_bond
number
The percentage of a holding held in US bonds.
Example:
0.0563
holdings.allocations_us_stock
number
The percentage of a holding held in US stocks.
Example:
45.0999
holdings.bond_coupon_rate
number | null
The coupon rate for a bond.
holdings.bond_coupon_rate_set_by
integer | null
The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
Example:
1
holdings.bond_coupon_rate_set_by_name
string | null
The source that set the data (FEED, USER, or SYSTEM).
Example:
"FEED"
holdings.bond_maturity_date
string | null
The bond maturity date, represented in ISO 8601 format without a timestamp.
Example:
"2015-04-13T00:00:00.000Z"
holdings.bond_maturity_date_set_by
integer | null
The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
Example:
1
holdings.bond_maturity_date_set_by_name
string | null
The source that set the data (FEED, USER, or SYSTEM).
Example:
"FEED"
holdings.cost_basis
number | null
The cost basis is the original value of an asset adjusted for stock splits, dividends, and capital distributions.
holdings.cost_basis_set_by
integer | null
The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
Example:
1
holdings.cost_basis_set_by_name
string | null
The source that set the data (FEED, USER, or SYSTEM).
Example:
"FEED"
holdings.cost_basis_updated_at
string | null
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).
Example:
"2015-04-13T12:01:23.000Z"
holdings.created_at
string | null
Date and time the holding was created, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).
holdings.currency_code
string
The ISO 4217 three-character currency code (e.g. USD).
Example:
"USD"
holdings.currency_code_set_by
integer | null
The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
Example:
1
holdings.currency_code_set_by_name
string | null
The source that set the data (FEED, USER, or SYSTEM).
Example:
"FEED"
holdings.daily_change
number | null
The change from the previous day in the price of the security.
holdings.daily_change_set_by
integer | null
The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
Example:
1
holdings.daily_change_set_by_name
string | null
The source that set the data (FEED, USER, or SYSTEM).
Example:
"FEED"
holdings.deleted_at
string
Date and time the holding was deleted, represented in ISO 8601 format with timestamp.
Example:
"2015-04-13T12:01:23.000Z"
holdings.description
string
Description of the holding.
Example:
"a description"
holdings.description_set_by
integer
The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
Example:
1
holdings.description_set_by_name
string | null
The source that set the data ( FEED, USER, or SYSTEM ).
holdings.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.
Example:
5
holdings.equity_classification_set_by
integer
The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
Example:
2
holdings.equity_classification_set_by_name
string | null
The source that set the data ( FEED, USER, or SYSTEM ).
holdings.external_guid
string
Partner created identifier for the holding.
Example:
"holding-be73487f-2cd2-4a99-b78c-2f8fb866cbed"
holdings.fixed_income_classification
integer | null
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.
holdings.fixed_income_classification_set_by
integer | null
The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
holdings.fixed_income_classification_set_by_name
string | null
The source that set the data ( FEED, USER, or SYSTEM ).
holdings.feed_bond_coupon_rate
number | null
The bond coupon rate, as provided by our data feed. See bond_coupon_rate for more information.
holdings.feed_bond_maturity_date
string | null
The bond maturity date, as provided by our data feed. See bond_maturity_date for more information.
holdings.feed_cost_basis
number | null
The cost basis, as provided by our data feed. See cost_basis for more information.
holdings.feed_currency_code
string | null
The ISO 4217 three-character currency code, as provided by our data feed. See currency_code for more information.
holdings.feed_cusip
string | null
The Committee on Uniform Securities Identification Procedures (CUSIP) classification code, as provided by our data feed. See cusip for more information.
holdings.feed_daily_change
number | null
The change from the previous day in the price of the security, as provided by our data feed. See daily_change for more information.
holdings.feed_description
string | null
The description, as provided by our data feed. See description for more information.
holdings.feed_equity_classification
integer | null
The equity classification, as provided by our data feed. See equity_classification for more information.
holdings.feed_fixed_income_classification
integer | null
The fixed income classification, as provided by our data feed. See fixed_income_classification for more information.
holdings.feed_isin
string | null
The International Securities Identification Number (ISIN), as provided by our data feed. See isin for more information.
holdings.feed_market_value
number | null
The current market value of the holding, as provided by our data feed. See market_value for more information.
holdings.feed_purchase_price
number | null
The purchase price, as provided by our data feed. See purchase_price for more information.
holdings.feed_sector
integer | null
The area of the economy the holding is invested in, as provided by our data feed. See sector for more information.
holdings.feed_sedol
string | null
The Stock Exchange Daily Official List (SEDOL) classification code, as provided by our data feed. See sedol for more information.
holdings.feed_shares
number | null
The number of shares, as provided by our data feed. See shares for more information.
holdings.feed_symbol
string | null
The ticker symbol, as provided by our data feed. See symbol for more information.
holdings.guid
string
Unique transaction identifier. Defined by MX.
Example:
"holding-be73487f-2cd2-4a99-b78c-2f8fb866cbed"
holdings.holding_type
integer
The type of holding, such as Mutual Fund, Equity, or Bond.
Example:
1
holdings.holding_type_name
string
The name of the holding type.
Example:
"EQUITY"
holdings.holding_type_set_by
integer | null
The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
Example:
1
holdings.holding_type_set_by_name
string | null
The source that set the data ( FEED, USER, or SYSTEM ).
Example:
"FEED"
holdings.is_deleted
boolean
If the holding is deleted, this field will be true. Otherwise, this field will be false.
Example:
true
holdings.isin
string | null
The International Securities Identification Number (ISIN) in ISO 6166 format.
holdings.isin_set_by
integer | null
The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
Example:
1
holdings.isin_set_by_name
string | null
The source that set the data (FEED, USER, or SYSTEM).
Example:
"FEED"
holdings.large_core_weight
number
The percentage of a holding's stock value with a large core investment style.
Example:
0.053
holdings.large_growth_weight
number
The percentage of a holding's stock value with a large growth investment style.
Example:
63.7687
holdings.large_value_weight
number
The percentage of a holding's stock value with a large value investment style.
Example:
0.0103
holdings.market_value
number
The market value of the holding.
Example:
618
holdings.market_value_set_by
integer | null
The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
Example:
1
holdings.market_value_set_by_name
string | null
The source that set the data ( FEED, USER, or SYSTEM ).
Example:
"FEED"
holdings.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.
Example:
false
holdings.metadata
string
Additional information a partner can store on the holding.
Example:
"Additional Information"
holdings.mid_core_weight
number
The percentage of a holding's stock value with a mid core investment style.
Example:
61.9756
holdings.mid_growth_weight
number
The percentage of a holding's stock value with a mid growth investment style.
Example:
0.4567
holdings.mid_value_weight
number
The percentage of a holding's stock value with a mid value investment style.
Example:
0.0563
holdings.purchase_price
number
The purchase price of the holding.
Example:
35
holdings.purchase_price_set_by
integer | null
The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
Example:
1
holdings.purchase_price_set_by_name
string | null
The source that set the data ( FEED, USER, or SYSTEM ).
Example:
"FEED"
holdings.sector
integer
The area of the economy the holding is invested in.
Example:
205
holdings.sector_set_by
integer | null
The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
Example:
1
holdings.sector_set_by_name
string | null
The source that set the data ( FEED, USER, or SYSTEM ).
Example:
"FEED"
holdings.sedol
string | null
The Stock Exchange Daily Official List (SEDOL) classification code, represented as a seven-character code (e.g. B03MM40).
Example:
null
holdings.sedol_set_by
integer | null
The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
Example:
1
holdings.sedol_set_by_name
string | null
The source that set the data ( FEED, USER, or SYSTEM ).
Example:
"FEED"
holdings.shares
number
The number of shares owned for this holding.
Example:
125
holdings.shares_set_by
integer | null
The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
Example:
1
holdings.shares_set_by_name
string | null
The source that set the data ( FEED, USER, or SYSTEM ).
Example:
"FEED"
holdings.small_core_weight
number
The percentage of funds allocated to a small-cap, core equity holding.
Example:
0.5
holdings.small_growth_weight
number
The percentage of funds allocated to a small-cap, growth equity holding.
Example:
0.3
holdings.small_value_weight
number
The percentage of funds allocated to a small-cap, value equity holding.
Example:
0.3
holdings.symbol
string
The symbol that refers to the ticker symbol of the security (e.g. AAPL for Apple, Inc.).
Example:
"HDP"
holdings.symbol_set_by
integer | null
The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ).
Example:
1
holdings.symbol_set_by_name
string | null
The source that set the data ( FEED, USER, or SYSTEM ).
Example:
"FEED"
holdings.updated_at
string
Date and time the transaction was updated, represented in ISO 8601 format with timestamp.
Example:
"2015-04-13T12:01:23.000Z"
holdings.unknown_weight
number
The percentage of a holding's stock value with an investment style currently undefined by MX.