Skip to main content

URL base

Todas as requisições devem ser feitas para:

Autenticação

A API utiliza autenticação via API Key. Inclua o header x-api-key em todas as requisições. Para gerar sua chave, consulte Autenticação.

Formatos de dados

Identificadores

ask_id e order_id usam o formato UUID v4.
O identificador público do título é cetip_code: alfanumérico, de 1 a 64 caracteres (^[A-Za-z0-9]{1,64}$). Um UUID nesse path retorna 422.

Datas e horários

Datas e horários seguem o padrão ISO 8601 com fuso explícito no valor.
Quando a API retorna apenas a data, sem horário, o formato é YYYY-MM-DD.
A plataforma segue a convenção ANBIMA para dias úteis e feriados.

Valores decimais

Em todas as respostas, a API serializa valores decimais (preços, rentabilidades, spreads etc.) como string no JSON, para preservar precisão. Isso vale para o esquema Ask (ask_price, ask_percentage_yield, ask_prefixed_yield).

Campos anuláveis

Alguns campos podem retornar null quando não se aplicam ao recurso ou ao tipo de ativo. Esses casos são indicados na documentação de cada endpoint.

Paginação

Os endpoints que retornam listas aceitam os parâmetros abaixo: GET /orders também devolve o header x-total-count com o total de itens que correspondem ao filtro, sem paginação.

Exemplo

Erros

Respostas de erro da aplicação seguem um formato padronizado com os campos error e message:
Validação de query, path ou body (limit fora da faixa, cetip_code inválido, campo desconhecido) usa o formato padrão do FastAPI:

Códigos HTTP

Códigos de erro