A rentabilidade da carteira, com benchmarks
A rentabilidade por cotização (como a tela: aporte e retirada não distorcem), acumulada desde
o dia anterior ao inicio, da carteira inteira ou de um recorte (contas, ativos ou o
grupo de uma estratégia). Valores em fração: 0,05 é 5%.
A série só vai até atualizado_ate, o último dia que o Meu Dinheiro calculou; os benchmarks
param na mesma data, para a comparação ser na mesma janela. inicio antes de 2018-01-01, o
marco da rentabilidade, vira 2018-01-01, e a resposta traz o inicio usado. Se
atualizado_ate não for ontem, abra Investimentos no Meu Dinheiro para atualizar; a leitura
não recalcula nem grava.
accessTokenAuthorizationBearer <token>Access token (mda_…) obtido em POST /auth/token. Vale 1 hora.
inicio?stringO primeiro dia do período. Sem o parâmetro, um ano antes do fim.
datefim?stringO último dia, até ontem. Sem o parâmetro, ontem.
dateintervalo?stringUm ponto por dia (até 366 dias), mes ou ano; o ponto do mês e do ano é o último dia com cota nele.
"mes""dia""mes""ano"benchmarks?stringOs índices para comparar, separados por vírgula (GET /investimentos/benchmarks).
contas?stringIds das contas de investimento, separados por vírgula.
ativos?stringIds dos ativos, separados por vírgula. Não combina com estrategia.
estrategia?integerO id de uma estratégia (GET /investimentos/estrategias).
grupo?integerO id de um grupo da estrategia; exige estrategia.
moeda?stringCódigo ISO 4217 em que a carteira é medida, convertida. Sem o parâmetro, BRL.
detalhar?booleanCom true, cada ponto traz também o saldo do dia e os aportes e as retiradas desde o ponto anterior (o primeiro, desde o inicio).
falsepor_ativo?booleanCom true, a resposta traz também series: uma série para cada ativo de ativos (ou da estrategia), restrita às contas; sem ativos, uma para cada conta de contas. Até 20 séries, cada uma com os benchmarks por ponto, e só com intervalo mes ou ano (com dia, 400). Compara vários ativos numa chamada só.
falseA série.
application/json- response
inicio*stringO início usado, depois do piso de 2018-01-01.
datefim*stringdateatualizado_ate*|O último dia calculado; nulo se a carteira nunca foi processada. Se não for ontem, abra Investimentos no Meu Dinheiro para atualizar.
dateintervalo*string"dia""mes""ano"moeda*stringrentabilidade_periodo*|A do último ponto, em fração; nula sem cota no período.
benchmarks_periodo*Cada benchmark pedido, no mesmo período, em fração.
pontos*array<>series?array<>Só com por_ativo. Uma série por ativo ou por conta, no mesmo período.
curl -X GET "https://example.com/investimentos/rentabilidade"{ "inicio": "2019-08-24", "fim": "2019-08-24", "atualizado_ate": "2019-08-24", "intervalo": "dia", "moeda": "string", "rentabilidade_periodo": 0, "benchmarks_periodo": { "property1": 0, "property2": 0 }, "pontos": [ { "data": "2019-08-24", "rentabilidade_acumulada": 0, "benchmarks": { "property1": 0, "property2": 0 }, "saldo": 0, "aportes": 0, "retiradas": 0 } ], "series": [ { "tipo": "ativo", "ativo_id": 0, "conta_id": 0, "codigo": "string", "nome": "string", "rentabilidade_periodo": 0, "benchmarks_periodo": { "property1": 0, "property2": 0 }, "pontos": [ { "data": "2019-08-24", "rentabilidade_acumulada": 0, "benchmarks": { "property1": 0, "property2": 0 } } ] } ]}As estratégias de alocação da carteira GET
"Tipo de ativo" (id 0), que o app monta a partir do tipo de cada ativo, e as estratégias ativas do workspace. Sem o plano avançado de investimentos, só as do sistema, como no app. O id do grupo da "Tipo de ativo" é o código do tipo.
A rentabilidade de cada ativo no período, do maior para o menor GET
Por ativo em cada conta, desde `inicio` até a última cota calculada (`atualizado_ate`), com o valor atual e a participação da posição de hoje (nulos quando a posição já fechou).