A indexação descreve em que indicador o título se ancora (por exemplo CDI ou IPCA). No livro de ofertas e nas ordens, esse dado aparece em asset.asset_indexer e segue os valores do enum AssetIndexer (tabela nesta página, na seção de enums).A rentabilidade no objeto asset é decomposta em dois campos decimais (sempre string no JSON), que a API preenche conforme o tipo de estrutura:
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.
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 percentage_yield e deixar prefixed_yield como null. Estruturas indicador + spread (ou parcela prefixada relevante) tendem a preencher prefixed_yield e podem deixar percentage_yield como null quando a API representa a rentabilidade dessa forma.Por exemplo, um título que rende 100% do CDI e não tem spread sobre o indicador, terá percentage_yield como "1.0" e prefixed_yield como null. Já um título que rende CDI + 2% (spread sobre o indicador), terá prefixed_yield como "0.02" e percentage_yield como null.Para convenções de datas e valores numéricos na API, veja Definições.
Respostas Order e Ask incluem asset_type, asset_code (CETIP) e o objeto aninhado asset com os mesmos campos de identificação e condições do título (asset_indexer, interest_redemption_type, redemption_type etc.).
Detalhes de um ativo
GET /assets/{id} — detalhes de um ativo específico pelo identificador.
Listar ofertas
GET /asks — lista de ofertas com filtros por tipo, indexador e vencimento.