Carteiras e análises
Rodar uma análise de carteira
Calcula métricas de risco, correlações, backtest, otimização, atribuição ou Monte Carlo. Informe os ativos (instruments) ou uma carteira (portfolio: salva, por slug, ou com items na própria chamada).
POST
https://api.fintay.com.br/v1/analytics/{tool}Cada ferramenta aceita campos próprios além destes:
backtest recebe portfolios (até 3), initial e rebalance; optimize recebe o objetivo; montecarlo, o horizonte em anos.Os ativos precisam ter histórico de preços conferido; caso contrário a resposta é
422.Autorização
X-API-KeystringheaderobrigatórioChave de API criada em API Keys. Veja Chaves e limites.
Parâmetros de rota
toolstringobrigatóriobacktest, metrics, correlation, optimize, attribution ou montecarlo.
Corpo (JSON)
instrumentsarrayTickers ou códigos de série (ex.: PETR4, bacen/12, CDI). Use isto ou portfolio.
portfolioobjectCarteira: {"slug": "minha-carteira"} para uma salva, ou {"items": [{"instrument": "PETR4", "weight": 60}, ...]} com pesos em %.
startstring · dateInício da janela.
endstring · dateFim da janela. Padrão: o último dia com dado.
frequencystringpadrão: dailyFrequência dos retornos.
Valores aceitos:
dailymonthlybenchmarkstringReferência para beta e retorno relativo (ex.: CDI, IBOV).
Resposta
Envelope { success, data, meta }. Campos de data:
conventionsobjectbenchmarkobjectseriesobject[]growthobjectdrawdownobjectrollingobjectcalendarobjectdrawdownsobject[]correlationobjectportfolionullwarningsstring[]attributionsstring[]