Skip to main content
POST
Buscar documentos do Banco Central
Os parâmetros base — keywords, q, modes, page, limit, sort e intervalos de data — são os mesmos de todos os endpoints e estão descritos em Conceitos de busca.

Authorizations

x-api-key
string
header
required

Chave de API da Nomos. Clientes criam e gerenciam chaves em https://nomos.pro/organization/developers (Organização → Desenvolvedores).

Query Parameters

page
integer
default:1

Número da página.

Required range: x >= 1
limit
integer
default:10

Resultados por página. Máximo 20.

Required range: 1 <= x <= 20
q
string

Busca por texto livre. Pode ser usada junto com keywords.

modes
string

Modos de busca separados por vírgula. sensitive diferencia maiúsculas e acentos; keyword exige correspondência exata.

sort
enum<string>
default:newest

Ordenação. newest = mais recentes por data; recently_updated = movimentados há menos tempo; older = mais antigos primeiro; relevance = mais aderentes às palavras-chave.

Available options:
newest,
recently_updated,
older,
relevance

Body

application/json

Palavras-chave e filtros do domínio. Todo campo é opcional; um corpo vazio retorna os resultados mais recentes.

keywords
object

Palavras-chave booleanas. Combine os três operadores livremente.

Example:
type
string[]

Tipos de documento do Bacen. Deixe vazio para todos.

Example:
date
object

Filtra por data de publicação. Informe sempre from e to.

Example:

Response

Página de resultados.

Uma página de documentos mais os metadados de paginação.

results
object[]

Documentos encontrados. O formato é específico de cada domínio e evolui ao longo do tempo. Todo item traz link_to_nomos_api, um deep link para o registro no App da Nomos.

pagination
object

Metadados de paginação (page, limit, total).