quantbrasil holdings historical-return
Calcula o retorno histórico de uma carteira salva
Sintaxe
quantbrasil holdings historical-return <holding-id>Esta é uma operação de leitura. Modos de saída: json, human.
Argumentos e opções
| Nome | Tipo | Obrigatório | Descrição | Padrão |
|---|---|---|---|---|
holding-id | Argumento | Sim | ID da carteira | — |
--from <date> | Opção | Não | Data inicial inclusiva no formato ISO | — |
--to <date> | Opção | Não | Data final inclusiva no formato ISO | — |
--period <period> | Opção | Não | Período de calendário (wtd, mtd, ytd) ou janela como 6m ou 1y | — |
--json | Opção | Não | Exibe saída JSON | — |
Exemplos
quantbrasil holdings historical-return 123 --from 2024-01-01 --to 2025-01-01
quantbrasil holdings historical-return 123 --period 1y
quantbrasil holdings historical-return 123 --period ytdSaída (--json)
Estrutura da resposta retornada com --json:
export interface HistoricalReturnResponse {
source_type: "saved_holding";
portfolio_id: number | null;
portfolio_name: string | null;
requested_start_date: string;
requested_end_date: string;
baseline_date: string;
effective_start_date: string;
effective_end_date: string;
total_return: number;
annualized_return: number;
max_drawdown: number;
daily_volatility: number | null;
annualized_volatility: number | null;
sharpe_ratio: number | null;
ibov_return: number | null;
cdi_return: number | null;
ipca_return: number | null;
holdings: HistoricalReturnHolding[];
summary_markdown: string;
assumptions: string[];
warnings: string[];
}
export interface HistoricalReturnHolding {
ticker: string;
weight_pct: number;
total_return: number;
contribution: number;
}Exemplo de resposta
{
"source_type": "saved_holding",
"portfolio_id": 182,
"portfolio_name": "Longo Prazo",
"requested_start_date": "2024-01-01",
"requested_end_date": "2025-01-01",
"baseline_date": "2024-01-02",
"effective_start_date": "2024-01-02",
"effective_end_date": "2024-12-30",
"total_return": 0.184,
"annualized_return": 0.181,
"max_drawdown": 0.09,
"daily_volatility": 0.014,
"annualized_volatility": 0.222,
"sharpe_ratio": 0.81,
"ibov_return": 0.12,
"cdi_return": 0.105,
"ipca_return": 0.045,
"holdings": [
{
"ticker": "PETR4",
"weight_pct": 60,
"total_return": 0.21,
"contribution": 0.126
},
{
"ticker": "VALE3",
"weight_pct": 40,
"total_return": 0.145,
"contribution": 0.058
}
],
"summary_markdown": "A carteira Longo Prazo rendeu +18,40% no período.",
"assumptions": ["Rebalanceamento apenas na data base."],
"warnings": []
}