Posição (Position)
Posição (Position) detalha a quantidade de cada Ativo (Security) em uma combinação de uma data de referência e um custodiante (Broker).
Isso não é apenas a agregação de todas as Transações (Transactions) de compra e venda, mas sim o resultado de todos os Eventos dos Ativos (Security Events) na história de um portfólio. Esses eventos englobam ocorrências relacionadas aos ativos, como dividendos, amortizações e desdobramentos, bem como transformações resultantes de outras posições, como o vencimento de um contrato a termo.
Isso permite que o usuário concilie o Portfólio (Portfolio) do Gorila com as instituições financeiras custodiantes, mantendo o controle de toda a sua composição.
Posições abertas e encerradas
Cada posição tem um estado (state): OPEN, quando ainda há quantidade do ativo no custodiante na data de referência, ou CLOSED, quando a posição já foi totalmente zerada, por exemplo, após uma venda total, um fechamento de posição ou o vencimento do ativo.
Por padrão, o endpoint List Positions retorna apenas as posições abertas. Para incluir as posições encerradas, use o parâmetro positionState com o valor CLOSED (apenas as encerradas) ou ALL (abertas e encerradas).
Onde acessar
Estes são os endpoints relacionados às posições de um portfólio:
- List Positions: exibe a quantidade de cada posição
- List Position Market Values: exibe o valor de mercado de cada posição
- List Position Average Prices: exibe o preço médio de cada posição
- List Position Profit & Losses: exibe o lucro e prejuízo de cada posição
- List Position Time-Weighted Returns: exibe o retorno ponderado no tempo de cada posição
- List Position Internal Rate of Return: exibe a TIR (Taxa Interna de Retorno) de cada posição
- List Position Invested Amount: exibe o valor investido em cada posição
- List Position Security Prices: exibe o último preço disponível do ativo de cada posição
- List Position Liquidity: exibe a liquidez, em dias, de cada posição
- Get Portfolio Positions Allocation: exibe o peso de cada posição em relação à exposição total do portfólio
- List Position Dividend Yield: exibe o dividend yield de cada posição
A maioria desses endpoints permite filtrar por ativo, classe de ativo, tipo de ativo, classificação e custodiante, e alguns também permitem agrupar o resultado por esses critérios (groupBy).
Com exceção da alocação e do dividend yield, essas visões também estão disponíveis para as posições de um Grupo Econômico, como em List Economic Group Positions.