DataBolsa docs
Referência da APIDados de mercadoScreeners

Universo de FIIs filtrável por segmento e tijolo/papel

Lista o universo de FIIs ATIVOS (com informe mensal nos últimos 6 meses; include_stale=true inclui encerrados/incorporados), filtrável por segmento, tijolo/papel e PL mínimo (min_pl); ordena por `sort`. Paginação por cursor (meta.next_cursor). Retorna ticker, nome, segmento e indicadores (dy, pvp, vacância…).

GET
/v1/screener/fiis
AuthorizationBearer <token>

In: header

Query Parameters

cursor?string
limit?integer
Default100
Range1 <= value <= 1000
segment?string

Filtra por segmento do FII (substring, case-insensitive), ex.: 'Logística', 'Papel'.

paper?string

true = papel (CRI), false = tijolo. Omitir = todos.

Value in"true" | "false"
min_pl?number

Patrimônio líquido mínimo (R$) — corta micro-fundos ilíquidos.

include_stale?string

true = inclui fundos sem informe mensal recente (encerrados/incorporados). Default: só fundos com informe nos últimos 6 meses.

Value in"true" | "false"
sort?string

Ordena por: ticker, preco, dy, dy_12m, pvp, vacancia, pl, patrimonio_liquido. Prefixe com '-' para decrescente (ex.: -dy_12m).

Response Body

curl -X GET "https://api.databolsa.com/v1/screener/fiis?cursor=string&limit=100&segment=string&paper=true&min_pl=0&include_stale=true&sort=string"
{
  "data": [
    {
      "ticker": "string",
      "name": "string",
      "segment": "string",
      "is_paper": true,
      "reference_date": "string",
      "preco": 0,
      "dy_12m": 0,
      "pvp": 0,
      "vacancia_fisica": 0,
      "patrimonio_liquido": 0
    }
  ],
  "meta": {
    "next_cursor": "string",
    "count": 0
  }
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}