Referência da API

FIIs

Fundos imobiliários — indicadores e distribuições

GET/v1/fiis/{ticker}getFii

Perfil do fundo imobiliário

Parâmetros

ticker *pathstring

Resposta 200

FII

objectFii

tickerstring

cnpjstring | null

namestring | null

segmentstring | null

administratorstring | null

managerstring | null

is_paperboolean

Chamada

curl

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

python · httpx

import httpx

resp = httpx.get(
    "https://api.databolsa.com/v1/v1/fiis/PETR4",
    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/fiis/PETR4", {
  headers: { Authorization: "Bearer db_live_xxxxxxxxxxxx" },
});
const data = await resp.json();

GET/v1/fiis/{ticker}/indicatorsgetFiiIndicators

Indicadores do FII (snapshot)

Parâmetros

ticker *pathstring

Resposta 200

Indicadores do FII

object

tickerstring

reference_datestring | null

indicatorsobject[]IndicatorValue

namestring

labelstring

valuenumber | nullnull quando não calculável — ver reason

unitstringratiopercentbrlbrl_per_sharecountdays

reasonstring | null

reference_datestring | null

ttmboolean

lineageobjectLineage

sourcestring

referencestring

urlstring | null

methodology_urlstring

Chamada

curl

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

python · httpx

import httpx

resp = httpx.get(
    "https://api.databolsa.com/v1/v1/fiis/PETR4/indicators",
    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/fiis/PETR4/indicators", {
  headers: { Authorization: "Bearer db_live_xxxxxxxxxxxx" },
});
const data = await resp.json();

GET/v1/fiis/{ticker}/indicators/historygetFiiIndicatorHistory

Histórico de um indicador do FII (informe mensal)

Parâmetros

ticker *pathstring

name *querystring

fromquerystring

toquerystring

Resposta 200

Série do indicador

object

tickerstring

namestring

labelstring

unitstringratiopercentbrlbrl_per_sharecountdays

observationsobject[]Observation

datestring

valuenumber | null

Chamada

curl

curl -H "Authorization: Bearer db_live_xxxxxxxxxxxx" \
  "https://api.databolsa.com/v1/v1/fiis/PETR4/indicators/history"

python · httpx

import httpx

resp = httpx.get(
    "https://api.databolsa.com/v1/v1/fiis/PETR4/indicators/history",
    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/fiis/PETR4/indicators/history", {
  headers: { Authorization: "Bearer db_live_xxxxxxxxxxxx" },
});
const data = await resp.json();

GET/v1/fiis/{ticker}/distributionslistFiiDistributions

Distribuições (rendimentos) do FII

Parâmetros

ticker *pathstring

cursorquerystring

limitqueryinteger

fromquerystring

toquerystring

Resposta 200

Página de distribuições

object

dataobject[]FiiDistribution

ex_datestring | null

payment_datestring | null

value_per_sharenumber | null

tax_freeboolean

metaobject

next_cursorstring | null

countintegerItens nesta página

Chamada

curl

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

python · httpx

import httpx

resp = httpx.get(
    "https://api.databolsa.com/v1/v1/fiis/PETR4/distributions",
    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/fiis/PETR4/distributions", {
  headers: { Authorization: "Bearer db_live_xxxxxxxxxxxx" },
});
const data = await resp.json();

GET/v1/fiis/{ticker}/reportslistFiiReports

Informes mensais do FII

Parâmetros

ticker *pathstring

cursorquerystring

limitqueryinteger

fromquerystring

toquerystring

Resposta 200

Página de informes

object

dataobject[]FiiMonthlyReport

reference_monthstring | null

net_asset_valuenumber | null

value_per_sharenumber | null

monthly_dividend_yield_pctnumber | null

shareholdersnumber | null

shares_issuednumber | null

metaobject

next_cursorstring | null

countintegerItens nesta página

Chamada

curl

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

python · httpx

import httpx

resp = httpx.get(
    "https://api.databolsa.com/v1/v1/fiis/PETR4/reports",
    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/fiis/PETR4/reports", {
  headers: { Authorization: "Bearer db_live_xxxxxxxxxxxx" },
});
const data = await resp.json();