Referência da API

System

Saúde e metadados da API

GET/v1/healthgetHealth

Status da API e frescor dos dados

Resposta 200

Status

objectHealth

statusstringokdegraded

versionstring

data_freshnessobject

Chamada

curl

curl -H "Authorization: Bearer db_live_xxxxxxxxxxxx" \
  "https://api.databolsa.com/v1/v1/health"

python · httpx

import httpx

resp = httpx.get(
    "https://api.databolsa.com/v1/v1/health",
    headers={"Authorization": "Bearer db_live_xxxxxxxxxxxx"},
)
resp.raise_for_status()
data = resp.json()

javascript · fetch

const resp = await fetch("https://api.databolsa.com/v1/v1/health", {
  headers: { Authorization: "Bearer db_live_xxxxxxxxxxxx" },
});
const data = await resp.json();

GET/v1/searchsearch

Busca unificada (typeahead) por ações/FIIs/índices/títulos/macro

Parâmetros

q *querystring

limitqueryinteger

Resposta 200

Resultados ranqueados

object[]SearchResult

kindstringstockfiiindexbondmacro

tickerstring

titlestring

subtitlestring | null

hrefstring

scorenumber

Chamada

curl

curl -H "Authorization: Bearer db_live_xxxxxxxxxxxx" \
  "https://api.databolsa.com/v1/v1/search"

python · httpx

import httpx

resp = httpx.get(
    "https://api.databolsa.com/v1/v1/search",
    headers={"Authorization": "Bearer db_live_xxxxxxxxxxxx"},
)
resp.raise_for_status()
data = resp.json()

javascript · fetch

const resp = await fetch("https://api.databolsa.com/v1/v1/search", {
  headers: { Authorization: "Bearer db_live_xxxxxxxxxxxx" },
});
const data = await resp.json();

GET/v1/ingestgetIngestHealth

Saúde da ingestão (última run, fontes, histórico)

Resposta 200

Saúde da ingestão

object

latestunknown

sourcesobject[]IngestSourceHealth

sourcestring

statusstringokstaleerrorno_data

last_fetchstring | null

age_daysnumber | null

datasetsnumber

missingnumber

failed_validationnumber

oknumber

skipnumber

missnumber

errnumber

rowsnumber

duration_snumber | null

recent_runsobject[]IngestRunSummary

run_idstring

triggerstring

started_atstring

finished_atstring

duration_snumber

exitnumber

okboolean

error_countnumber

Chamada

curl

curl -H "Authorization: Bearer db_live_xxxxxxxxxxxx" \
  "https://api.databolsa.com/v1/v1/ingest"

python · httpx

import httpx

resp = httpx.get(
    "https://api.databolsa.com/v1/v1/ingest",
    headers={"Authorization": "Bearer db_live_xxxxxxxxxxxx"},
)
resp.raise_for_status()
data = resp.json()

javascript · fetch

const resp = await fetch("https://api.databolsa.com/v1/v1/ingest", {
  headers: { Authorization: "Bearer db_live_xxxxxxxxxxxx" },
});
const data = await resp.json();