Holdings - MX Documentation

Holdings webhooks notify you when a holding is created, updated, or deleted in the MX system for any user in the client. The payload for this webhook includes an action field that specifies the associated value of created, updated, or deleted.

WARNINGAs of January 1, 2025, CUSIP is no longer supported. For more information, refer to the investment documentation.

Field	Data Type	Definition
`account_guid`	String	The unique identifier for the account the holding belongs to. 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 (often in the form of preferred shares or bonds).
`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 such as real estate, commodities, and precious metals.
`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_maturity_date`	String	The maturity date for a bond.
`cost_basis`	Decimal	The cost basis is the original value of an asset adjusted for stock splits, dividends, and capital distributions.
`created_at`	Integer	The date and time when the holding was created.
`currency_code`	String	The ISO 4217 currency code.
`daily_change`	Decimal	The change from the previous day in the price of the security.
`deleted_at`	Integer	The date and time when the holding was deleted.
`description`	String	The description of the holding.
`equity_classification`	String	The equity classification of the holding.
`fixed_income_classification`	String	A graphical representation of the investment style of the fixed income funds within a holding (like bonds) according to the Morningstar Style Box.
`guid`	String	The unique identifier for the holding. Defined by MX.
`holding_type`	String	The type of holding, such as a mutual fund, equity, or bond.
`id`	String	The unique identifier for the holding. Defined by the data provider.
`is_deleted`	Boolean	Whether the holding has been deleted.
`isin`	String	The International Securities Identification Number (ISIN) in ISO 6166 format.
`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.
`member_is_managed_by_user`	Boolean	Whether the member to which the holding belongs is 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.
`revision`	Integer	The revision number of this holding record.
`sector`	String	The area of the economy the holding is invested in.
`sedol`	String	The Stock Exchange Daily Official List (SEDOL) classification code, represented as a seven-character code (for example, B03MM40).
`shares`	Decimal	The number of shares owned for the holding.
`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	The ticker symbol, which is an abbreviation used to uniquely identify publicly traded stocks, bonds, mutual funds, and ETFs.
`unknown_weight`	Decimal	The percentage of a holding’s stock value with an investment style currently undefined by MX.
`updated_at`	Integer	The date and time when the holding was last updated.
`user_guid`	String	The unique identifier for the user the holding is attached to. Defined by MX.
`user_id`	String	The unique partner-defined identifier for the user.

Example Payload

JSON

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

​Example Payload

Example Payload