Skip to main content

Visão geral

Na plataforma, cada ordem se refere a um título (CDB, LCI, LCA etc.). O identificador público do título na API é o cetip_code. Consulte um ativo com GET /assets/{cetip_code}. Nas ofertas, os dados do título vêm em campos no próprio Ask (name, cetip_code, asset_type, asset_indexer etc.). Nas ordens, o resumo do título está em metadata (asset_name, maturity_date, issuer), além de asset_code e asset_type no topo.

Campos do esquema Asset

A tabela abaixo reflete o que a API expõe em GET /assets/{cetip_code}. Tipos e formatos seguem o contrato em uso (OpenAPI em Referência da API). cetip_code deve ser alfanumérico, com 1 a 64 caracteres (^[A-Za-z0-9]{1,64}$). Um UUID ou qualquer outro valor fora desse padrão retorna 422 e não é encaminhado.

Indexação e rentabilidade

A indexação descreve em que indicador o título se ancora (por exemplo CDI ou IPCA). No livro de ofertas esse dado aparece em asset_indexer e segue os valores do enum AssetIndexer. A rentabilidade da oferta está nos campos do Ask (sempre string no JSON, ou null):
  • ask_percentage_yield — parcela pós-fixada em relação ao indexador, expressa como fração do indicador (por exemplo "1.0" para 100% do CDI). Use quando a remuneração é um múltiplo do indexador sem spread prefixado explícito sobre o indicador.
  • ask_prefixed_yield — parcela prefixada ou spread sobre o indexador, em decimal (por exemplo "0.02" para dois pontos percentuais ao ano quando a estrutura for “indicador + spread”). Use quando há taxa prefixada ou acréscimo fixo sobre o indexador.
Em resumo: títulos só pós-fixados em relação ao indicador tendem a preencher ask_percentage_yield e deixar ask_prefixed_yield como null. Estruturas indicador + spread (ou parcela prefixada relevante) tendem a preencher ask_prefixed_yield e podem deixar ask_percentage_yield como null. Por exemplo, um título que rende 100% do CDI e não tem spread sobre o indicador terá ask_percentage_yield como "1.0" e ask_prefixed_yield como null. Já um título que rende CDI + 2% terá ask_prefixed_yield como "0.02" e ask_percentage_yield como null. O endpoint de ativo não devolve campos de rentabilidade. Para convenções de datas e valores numéricos, veja Definições.

Valores enumerados retornados pela API

Os valores abaixo são os serializados em JSON (como a API devolve nas strings dos campos indicados).

Tipo de um ativo (AssetType)

Indexador de um ativo (AssetIndexer)

O indexador aparece em asset_indexer nas respostas de ofertas e de ativo. Use esta mesma tabela de valores.

Tipo de resgate do principal (AssetRedemptionType)

Tipo de resgate dos juros (AssetInterestRedemptionType)

Via API

Consulte o título pelo cetip_code. Nas ofertas, os mesmos enums aparecem em campos flat do Ask. Nas ordens, use asset_code, asset_type e metadata. O PDF CETIP é baixado pela ordem: Baixar arquivo CETIP.

Detalhes de um ativo

GET /assets/{cetip_code} — detalhes de um ativo pelo código CETIP.

Listar ofertas

GET /asks — lista de ofertas com filtros por tipo, indexador, vencimento e código CETIP.