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).

POSThttps://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ório

Chave de API criada em API Keys. Veja Chaves e limites.

Parâmetros de rota

toolstringobrigatório

backtest, metrics, correlation, optimize, attribution ou montecarlo.

Corpo (JSON)

instrumentsarray

Tickers ou códigos de série (ex.: PETR4, bacen/12, CDI). Use isto ou portfolio.

portfolioobject

Carteira: {"slug": "minha-carteira"} para uma salva, ou {"items": [{"instrument": "PETR4", "weight": 60}, ...]} com pesos em %.

startstring · date

Início da janela.

endstring · date

Fim da janela. Padrão: o último dia com dado.

frequencystringpadrão: daily

Frequência dos retornos.

Valores aceitos:dailymonthly
benchmarkstring

Referência para beta e retorno relativo (ex.: CDI, IBOV).

Resposta

Envelope { success, data, meta }. Campos de data:

conventionsobject
benchmarkobject
seriesobject[]
growthobject
drawdownobject
rollingobject
calendarobject
drawdownsobject[]
correlationobject
portfolionull
warningsstring[]
attributionsstring[]