Skip to main content

Holdings

Holdings webhooks notify you when a holding is created, updated, or deleted in the MX system for any user on that partner's client.

warning

As of January 1, 2025, CUSIP is no longer supported. Please refer to the most-up-to-date investment documentation.

FieldData TypeDefinition
account_guidStringThe unique identifier for the account the holding belongs to. 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 (often in the form of preferred shares or bonds).
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_maturity_dateStringThe maturity date for a bond.
cost_basisDecimalThe cost basis is the original value of an asset adjusted for stock splits, dividends, and capital distributions.
created_atIntegerThe date and time at which the holding was created.
currency_codeStringThe ISO 4217 three-character currency code.
daily_changeDecimalThe change from the previous day in the price of the security.
deleted_atIntegerThe date and time at which the holding was deleted.
descriptionStringThe description of the holding.
equity_classificationStringThe equity classification of the holding.
fixed_income_classificationStringA graphical representation of the investment style of the fixed income funds within a holding (like bonds) according to the Morningstar Style Box.
guidStringThe unique identifier for the holding. Defined by MX.
holding_typeStringThe type of holding, such as Mutual Fund, Equity, or Bond.
idStringThe unique identifier for the holding. Defined by the data provider.
is_deletedBooleanIndicates if the holding has been deleted.
isinStringThe International Securities Identification Number (ISIN) in ISO 6166 format.
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.
member_is_managed_by_userBooleanThis indicates whether the member to which the holding belongs is 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.
revisionIntegerThe revision number of this holding record.
sectorStringThe area of the economy the holding is invested in.
sedolStringThe Stock Exchange Daily Official List (SEDOL) classification code, represented as a seven-character code (e.g. B03MM40).
sharesDecimalThe number of shares owned for the holding.
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.
unknown_weightDecimalThe percentage of a holding’s stock value with an investment style currently undefined by MX.
updated_atIntegerThe date and time at which the holding was last updated.
user_guidStringThe unique identifier for the user the holding is attached to. Defined by MX.
user_idStringThe unique partner-defined identifier for the user.

Example Payload


_59
POST /admin/webhooks
_59
HTTP/1.1
_59
content-type: application/json; charset=utf-8
_59
accept: application/json
_59
User-Agent: HTTPClient/1.0 (2.7.1, ruby 2.2.2
_59
(2015-09-02)) Date: Thu, 14 Apr 2016 04:26:04 GMT Content-Length: 231
_59
Host: abc.com
_59
{
_59
"action": "created",
_59
"holding": {
_59
"account_guid": "ACT-cdd93558-83bb-f4f5-8bbb-3866a1b60da1",
_59
"allocations_cash": null,
_59
"allocations_convertible": null,
_59
"allocations_foreign_bond": null,
_59
"allocations_foreign_stock": null,
_59
"allocations_other": null,
_59
"allocations_preferred": null,
_59
"allocations_unknown": null,
_59
"allocations_us_bond": null,
_59
"allocations_us_stock": null,
_59
"bond_coupon_rate": null,
_59
"bond_maturity_date": null,
_59
"cost_basis": 12.0,
_59
"created_at": 1489906930,
_59
"currency_code": "USD",
_59
"deleted_at": null,
_59
"description": "THERMOENERGY CORP COM STK USD0.001",
_59
"daily_change": 0.10,
_59
"equity_classification": "LARGE_VALUE",
_59
"fixed_income_classification": null,
_59
"guid": "HOL-0049cd2c-b9e3-fa3d-c08b-81e1de72a735",
_59
"holding_type": "EXCHANGE_TRADED_FUND",
_59
"id": "H-94743344",
_59
"is_deleted": false,
_59
"isin": null,
_59
"large_core_weight": null,
_59
"large_growth_weight": null,
_59
"large_value_weight": null,
_59
"market_value": 6066.7,
_59
"member_is_managed_by_user": true,
_59
"metadata": "Additional information",
_59
"mid_core_weight": null,
_59
"mid_growth_weight": null,
_59
"mid_value_weight": null,
_59
"purchase_price": 63.86,
_59
"revision": 0,
_59
"sector": null,
_59
"sedol": null,
_59
"shares": 95.0,
_59
"small_core_weight": null,
_59
"small_growth_weight": null,
_59
"small_value_weight": null,
_59
"symbol": "TMEN",
_59
"unknown_weight": null,
_59
"updated_at": 1489906930,
_59
"user_id": "U-1234567",
_59
"user_guid": "USR-51189187-f9cc-cfaf-2678-adcbbc7b05c6"
_59
}
_59
}

On this page