quantbrasil assets returns
Calcula retornos canônicos para um ou mais ativos
Sintaxe
quantbrasil assets returns <ticker...>Esta é uma operação de leitura. Modos de saída: json, human.
Argumentos e opções
| Nome | Tipo | Obrigatório | Descrição | Padrão |
|---|---|---|---|---|
ticker | Argumento | Sim | Um ou mais tickers | — |
--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 assets returns PETR4 VALE3 --period mtd
quantbrasil assets returns BTC-USD QQQ --period ytd
quantbrasil assets returns PETR4 --from 2026-01-01 --to 2026-07-15Saída (--json)
Estrutura da resposta retornada com --json:
export interface AssetReturnsResponse {
requested_start_date: string;
requested_end_date: string;
returns: AssetReturnItem[];
summary_markdown: string;
warnings: string[];
}
export interface AssetReturnItem {
ticker: string;
baseline_date: string;
baseline_close: number;
end_date: string;
end_close: number;
total_return: number;
}Exemplo de resposta
{
"requested_start_date": "2026-01-01",
"requested_end_date": "2026-07-16",
"returns": [
{
"ticker": "PETR4",
"baseline_date": "2026-01-02",
"baseline_close": 33.1,
"end_date": "2026-07-16",
"end_close": 37.61,
"total_return": 0.1362
}
],
"summary_markdown": "PETR4 acumulou +13,62% no período solicitado.",
"warnings": []
}