Position

A Position details the quantity of each Security for a combination of a reference date and a Broker.

This is not merely the aggregation of all buy and sell Transactions, but rather the result of all Security Events in a portfolio's history. These events encompass security-related occurrences, such as dividends, amortizations and splits, as well as transformations resulting from other positions, such as the expiration of a forward contract.

This allows the user to reconcile Gorila's Portfolio with the custodian financial institutions, keeping track of its entire composition.

Open and closed positions

Each position has a state (state): OPEN, when there is still a quantity of the security at the broker on the reference date, or CLOSED, when the position has already been fully zeroed out, for example, after a full sale, a position close or the security's maturity.

By default, the List Positions endpoint returns only open positions. To include closed positions, use the positionState parameter with the value CLOSED (closed positions only) or ALL (open and closed positions).

Where to access

These are the endpoints related to a portfolio's positions:

• List Positions: displays the quantity of each position
• List Position Market Values: displays the market value of each position
• List Position Average Prices: displays the average price of each position
• List Position Profit & Losses: displays the profit & loss of each position
• List Position Time-Weighted Returns: displays the time-weighted return of each position
• List Position Internal Rate of Return: displays the IRR (Internal Rate of Return) of each position
• List Position Invested Amount: displays the invested amount in each position
• List Position Security Prices: displays the last available price of each position's security
• List Position Liquidity: displays the liquidity, in days, of each position
• Get Portfolio Positions Allocation: displays the weight of each position relative to the portfolio's total exposure
• List Position Dividend Yield: displays the dividend yield of each position

Most of these endpoints allow filtering by security, asset class, security type, classification and broker, and some also allow grouping the result by these criteria (groupBy).

Except for allocation and dividend yield, these views are also available for the positions of an economic group, as in List Economic Group Positions.