Investimentos
Posição, rentabilidade por cotização, benchmarks, indicadores e análise mensal da carteira.
A carteira de investimentos do workspace, com os números das telas do módulo de investimentos. Somente leitura.
Acesso
Exige a permissão do módulo de investimentos e o módulo no plano do workspace. Sem a permissão,
403 forbidden; sem o módulo no plano vigente, 403 plan_required. Conta oculta para a
credencial fica fora de toda soma, e pedi-la em contas responde 404.
O que cada rota traz
| Rota | Para quê |
|---|---|
GET /investimentos/carteira | A posição de hoje, por ativo em cada conta: quantidade, preço médio, valor investido, valor atual, resultado e participação |
GET /investimentos/estrategias | As estratégias de alocação e os grupos, para filtrar as outras rotas |
GET /investimentos/rentabilidade | A série da rentabilidade, da carteira ou de um recorte, com benchmarks |
GET /investimentos/rentabilidade/ativos | A rentabilidade de cada ativo no período, do maior para o menor |
GET /investimentos/benchmarks | Os índices de comparação: cdi, ipca, igpm, poupanca, selic, ibovespa, smll, ifix, sp500, msci_world, usd |
GET /investimentos/indicadores | Rentabilidade, volatilidade (diária e anualizada) e Sharpe contra o CDI |
GET /investimentos/analise | Por mês ou ano: saldos, aportes, retiradas, proventos, variação, custos e IR |
Rentabilidade por cotização
A rentabilidade é a variação da cota da carteira, como num fundo: aporte e retirada não a
distorcem. É diferente do resultado da posição (valor_atual − valor_investido, sobre o preço
médio), que muda com cada compra e venda. Valores em fração: 0.05 é 5%.
A série acumula desde o dia anterior ao inicio, e rentabilidade_periodo é a do último ponto.
benchmarks_periodo traz cada índice pedido na mesma janela, para comparar direto.
Para comparar vários ativos, peça por_ativo=true: a resposta traz series, uma por ativo de
ativos (ou da estratégia), ou uma por conta de contas quando não há ativos, até 20, cada uma
com os benchmarks por ponto, com intervalo mes ou ano (a série diária é um ativo por vez). "Quais ativos ficaram abaixo do CDI, e desde quando" sai em duas
chamadas: o ranking (/rentabilidade/ativos) e a série dos que ficaram abaixo, com por_ativo.
atualizado_ate
O Meu Dinheiro calcula a rentabilidade dia a dia quando o módulo de investimentos é aberto no app.
atualizado_ate é o último dia calculado: a série e os benchmarks param nele. Se não for ontem, a
carteira não foi aberta desde então, e os números são de atualizado_ate. O valor dos títulos
indexados e das contas na posição também vem desse cálculo. Para atualizar, abra Investimentos
no Meu Dinheiro; a API não recalcula nem grava durante a leitura.
Período
- Marco: não há rentabilidade antes de 2018-01-01.
inicioanterior vira 2018-01-01, e a resposta traz oiniciousado. - Série:
intervalomes(padrão),anooudia, este até 366 dias. O ponto do mês e do ano é o último dia com cota nele. - Análise:
inicioefimemAAAA-MM, até 60 meses. Ela roda na hora e pesa pelo número de ativos × meses: numa carteira grande, o período pedido pode não caber de uma vez. Aí a resposta é 422analysis_too_complex, commax_meses_sugeridodentro deerror(o maior período que cabe; nulo quando nem um mês cabe). Repita com ele ou recorte porcontas. - Indicadores: do primeiro dia do mês de
inicioao último do defim.
Recorte
contas e ativos (listas de ids), ou estrategia e grupo (de GET /investimentos/estrategias;
a estratégia 0 é "Tipo de ativo", e o id do grupo dela é o código do tipo). ativos e
estrategia não se combinam. A rentabilidade e os indicadores aceitam os quatro; a carteira e a
análise, todos menos ativos; a rentabilidade por ativo não recorta. moeda em ISO 4217 converte os valores; padrão BRL.
Limites conhecidos
Os números são os da tela, inclusive onde o cálculo ainda está em revisão (venda parcial de título indexado, custódia em conta de investimento, posição vendida sem cotação). Quando eles mudarem no app, mudam aqui também.