Pular para o conteúdo principal

POST /v1/quotes

O endpoint principal. Precifica um pool opcional de instrumentos ad-hoc mais uma lista de cotações que referenciam instrumentos por id (ad-hoc agrupados ou armazenados). Retorna um lote — uma entrada por cotação, cada uma com seu próprio status.

Corpo da requisição

{
"instruments": [ /* optional ad-hoc pool; each item needs an id */ ],
"quotes": [ /* one or more quotes */ ]
}

Campos da cotação

CampoObrigatórioDescrição
instrument_idsimid de um instrumento ad-hoc agrupado ou de um armazenado
input_kindsimyield · clean_price · dirty_price · transacted
input_valuesimo rendimento (decimal) ou preço (por 100), ou o caixa negociado
amount_kindnãonominal ou transacted (tamanho da operação)
amount_valuenãoobrigatório (> 0) quando amount_kind está definido
settlement_datenãodata ISO; o padrão é hoje
optionsnãoveja abaixo

input_kind

ValorVocê fornecea emrgex retorna
yieldum rendimentoo preço + métricas
clean_priceum preço limpoo rendimento resolvido + métricas
dirty_priceum preço sujoo rendimento resolvido + métricas
transactedum montante de caixa sujo (requer amount_kind: nominal)deriva o preço e, em seguida, resolve

options

OpçãoTipoDescrição
roundint (0–12)arredonda as saídas de valores/taxas para N casas decimais
with_cashflowsboolinclui o cronograma completo de fluxos de caixa descontados
yield_worstboolcalcula o rendimento até o pior (yield-to-worst) para títulos resgatáveis (callable)
coupon_typeFIXED/ACCRUALsobrescrita por cotação da mecânica do cupom (what-if)
index_rationumbernominal de índice publicado (VNA) para títulos indexados; toda saída de valor é multiplicada por index_ratio/100

Resposta — envelope do lote

{
"data": [
{
"index": 0,
"id": "MH12034",
"status": "ok",
"data": {
"instrument_id": "MH12034",
"convention": "NOMINAL · ACT/ACT.DRMH",
"calculation_code": "ACT/ACT.DRMH|NOMINAL",
"coupon_type": "ACCRUAL",
"settlement_date": "2026-06-09T00:00:00Z",
"metrics": { "yield": 0.1, "dirty_price": 112.547645, "clean_price": 107.853124, "...": "..." },
"next_coupon": { "date": "...", "interest": 5.75, "total": 5.75, "present_value": 5.7 }
}
}
],
"warnings": []
}
  • Cada item tem status: "ok" com um payload data, ou status: "failed" com um objeto error no formato RFC 7807 — uma cotação inválida nunca faz o lote inteiro falhar.
  • Uma resolução de preço→rendimento não convergente retorna um 422 por item.

Os cinco cenários de entrada

input_kind × amount_kind cobrem as combinações negociadas:

input_kindamount_kindUso
yieldnominalrendimento + valor de face → preço e caixa de liquidação
yieldtransactedrendimento + caixa → nominal implícito
clean_pricenominalpreço + valor de face → rendimento e caixa
clean_pricetransactedpreço + caixa → rendimento e nominal
transactednominalcaixa + valor de face → preço e rendimento

Veja Exemplos para os corpos completos das requisições.