List holdings by user - MX Documentation

Authorizations

Authorization

string

header

required

The MX Platform API requires basic access authentication using your client_id and api_key. These credentials must be Base64 encoded and included in the Authorization header of each API request to ensure secure access.

Here's an example using curl to access v20250224. Replace https://int-api.mx.com/endpoint with the actual API endpoint you wish to access and your Base64 encoded client_id and api_key.

curl -L -X POST `https://int-api.mx.com/endpoint' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Accept-Version: v20250224'
-H 'Authorization: Basic BASE_64_ENCODING_OF{client_id:api_key}'

Headers

Accept-Version

string

default:v20250224

required

MX Platform API version.

Example:

"v20250224"

Path Parameters

user_guid

string

required

The unique identifier for a user, beginning with the prefix USR-.

Query Parameters

page

integer

Results are paginated. Specify current page.

records_per_page

integer

This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

Response

200 - application/json

investment_holdings

object[]

Hide child attributes

investment_holdings.account_guid

string

The unique identifier for an account. Defined by MX.

Example:

"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1"

investment_holdings.cost_basis

number | null

The original value of an asset for tax purposes, usually the purchase price, used to calculate capital gains or losses. Accumulated price.

Example:

827

investment_holdings.coupon_yield

string | null

The rate of return the bonds coupon rate generates.

Example:

null

investment_holdings.currency_code

string | null

The three-character ISO 4217 currency code, for example, USD.

Example:

"USD"

investment_holdings.current_price

number | null

The present market price of a single unit of the holding (for example, stock price per share).

Example:

15

investment_holdings.daily_change

number | null

The daily change in the current_price of the holding since the previous trading day.

Example:

2.5

investment_holdings.description

string | null

A brief description of the holding, such as the company name for stocks or the bond type for bonds.

Example:

"Guggenheim Defensive Equity ETF"

investment_holdings.expiration

string | null

The expiration date associated with the holding.

Example:

null

investment_holdings.face_value

number | null

The nominal value of a bond or fixed-income security, paid to the holder at maturity.

Example:

1000

investment_holdings.frequency

string | null

The frequency of the interest paid on the bond (i.e. Annually, Monthly, etc.)

Example:

"ANNUALLY"

investment_holdings.guid

string | null

The unique identifier for the holding. Defined by MX.

Example:

"HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2"

investment_holdings.market_value

number | null

The current market value of the holding, calculated as the current price times the number of units (shares) owned.

Example:

989.5

investment_holdings.maturity_date

string | null

The maturity date associated with the holding.

Example:

null

investment_holdings.percentage_change

number | null

The percent change in the current_price of the holding compared to a previous time period. It is the percentage change that reflects the daily_change.

Example:

0.2

investment_holdings.purchase_price

number | null

The average price paid for the holding.

Example:

26.3

investment_holdings.quantity

string | null

The number of units of the holding owned (for example, number of shares of stock).

Example:

"5000.0"

investment_holdings.rate

number | null

The interest on the bond, subject to determining the payout amount of the bond.

Example:

null

investment_holdings.strike_price

number | null

The strike price associated to the option.

Example:

null

investment_holdings.symbol

string | null

The ticker symbol or unique identifier of the holding, used in stock exchanges.

Example:

"DEF"

investment_holdings.term

string | null

The length of time until the bond's principal amount is due to be repaid. It is the period from when the bond is issued until it reaches its maturity date.

Example:

null

investment_holdings.today_ugl_amount

number | null

The unrealized gain/loss amount for today.

Example:

200

investment_holdings.today_ugl_percentage

number | null

The unrealized gain/loss percentage for today.

Example:

0.27

investment_holdings.total_ugl_amount

number | null

The total unrealized gain/loss amount for an investment.

Example:

20000

investment_holdings.total_ugl_percentage

number | null

The total unrealized gain/loss for the holding since it was acquired.

Example:

26.67

investment_holdings.unvested_quantity

number | null

The number of units (for example, shares) of the holding that are not yet vested or owned outright by the holder.

Example:

null

investment_holdings.unvested_value

number | null

The value of the portion of the holding that is unvested.

Example:

null

investment_holdings.user_guid

string | null

The unique identifier for the user. Defined by MX.

Example:

"USR-fa7537f3-48aa-a683-a02a-b18940482f54"

investment_holdings.vested_quantity

number | null

The number of units (for example, shares) of the holding that are vested and fully owned by the holder.

Example:

null

investment_holdings.vested_value

number | null

The value of the portion of the holding that is vested and fully owned by the holder.

Example:

null

investment_holdings.created_at

string | null

The date and time the investment holding was created, represented in ISO 8601 format with a timestamp.

Example:

"2025-02-13T18:08:00+00:00"

investment_holdings.current_price_as_of

string | null

The date and time when the current price was last updated, represented in ISO 8601 format with a timestamp.

Example:

"2023-11-06T00:00:00Z"

investment_holdings.issue_date

string | null

The date on which a security was issued or made available for sale.

Example:

"2015-08-15"

investment_holdings.vesting_start_date

string | null

The date from which the vesting schedule for a holding begins.

Example:

null

investment_holdings.vesting_end_date

string | null

The date from which the vesting schedule for a holding ends.

Example:

null

investment_holdings.put_or_call

string | null

States whether the option is a PUT or CALL.

Example:

null

investment_holdings.holding_type

string | null

The type of investment (e.g., equity, fixed income, mutual fund, etc.)

Example:

"MUTUAL_FUND"

investment_holdings.term_unit

string | null

The unit type of the term associated to the bond. (Year, Month, etc.)

Example:

null

pagination

object

Hide child attributes

pagination.current_page

integer

The page delivered by the current response.

Example:

1

pagination.per_page

integer

The number of records delivered with each page.

Example:

25

pagination.total_entries

integer

The total number of records available.

Example:

1

pagination.total_pages

integer

The total number of pages available.

Example:

1