DataBolsa docs
Referência da APIDados de mercadoObjects

Que MEDIDAS existem no grafo, e em que escala cada uma

O catálogo, independente de objeto: todo `fact` que `getObjectFacts` pode devolver e `getObjectHistory` pode servir, com a régua e os tipos de objeto a que se aplica. Leia a coluna `unit` antes de comparar duas medidas. `ratio` é fração (0,08 é 8%) e `pct` é percentual (8,0 é 8%): `dy_12m` de ação é fração e `fii_dy_12m` de FII é percentual, então comparar os dois crus erra por 100×. **`dimension`, `scale` e `period` são a régua completa, e `period` é o eixo que `unit` não tem como dizer.** `dy_12m` cobre DOZE MESES, `fii_dividend_yield_month` cobre UM e `revenue_cagr_3y` é anualizado sobre TRÊS ANOS — três janelas que chegam na mesma resposta e que nenhuma unidade distingue. É a mesma armadilha do IPCA na `bcb_sgs:433` (o mês, ~0,4) contra a `bcb_sgs:13522` (doze meses, ~4,7). **O valor é servido AS-FILED e `scale` diz como lê-lo — ela não foi aplicada.** `portfolio_value_kbrl` é `currency` em `thousand`: os 508.272.696 da mediana são 508 BILHÕES de reais, não 508 milhões. E `scale` desmente sufixo de coluna quando a fonte mente: `fidc_acquired_impaired_pct` termina em `_pct` e vem em `unit` (fração, mediana 0,0204), enquanto `fidc_collateral_pct`, na MESMA tabela, é percentual de verdade. **`unit: native` não é uma escala — é a ausência de uma.** Diz que a escala não é do FATO, é de cada SÉRIE: `value` e `indicator_value` cobrem 431 séries macro em que a mesma medida sai em percentual numa e em fração decimal noutra — o IPCA acumulado em 12 meses é 4,44 na `bcb_sgs:13522` e 0,0444 em `macro:ipca_12m`. O catálogo não tem como resolver isso sem saber de QUE série se fala; quem resolve é `getObjectFacts` no objeto da série, que devolve a `unit` já resolvida e os eixos declarados em `axes`. Tratar `native` como unidade é o erro de 100× outra vez, agora sem nada na resposta para acusá-lo.

GET
/v1/objects/facts/catalog
AuthorizationBearer <token>

In: header

Query Parameters

kind?string

Recorta o catálogo a um tipo de objeto. meta.kinds lista os que têm medida.

Value in"company" | "equity_security" | "fund" | "service_provider" | "instrument" | "index" | "crypto_asset" | "commodity" | "country" | "indicator" | "data_series" | "offering" | "fund_share_class" | "market_event"

Response Body

curl -X GET "https://api.databolsa.com/v1/objects/facts/catalog?kind=company"
{
  "meta": {
    "next_cursor": "string",
    "count": 0,
    "total": 0,
    "subject": {
      "property1": "string",
      "property2": "string"
    },
    "kinds": [
      "string"
    ]
  },
  "data": [
    {
      "name": "string",
      "kind": "string",
      "unit": "brl",
      "dimension": "string",
      "scale": "string",
      "period": "string",
      "cadence": "daily",
      "grain": "object",
      "expected_range": {
        "min": 0,
        "max": 0
      },
      "concept": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

ÁLGEBRA DE CONJUNTOS sobre relações: interseção, união e diferença

Responde a classe de pergunta que dois montes separados não respondem. `op` escolhe a operação e o resto dos parâmetros é o mesmo nas três: - `op=intersect` (default) — quem está nos DOIS. Ex.: `a=assigned_to&b=issued` são as empresas que vendem recebível para FIDC **e** têm debênture emitida. - `op=union` — quem está em QUALQUER um dos dois. - `op=difference` — quem está em A e NÃO em B. É a pergunta de concentração: cedente EXCLUSIVO é risco que não aparece em média nenhuma. EXEMPLO COMPLETO da diferença, com os parâmetros exatos: cedentes do FIDC X que não cedem para o FIDC Y é `a=assigned_to&a_to_id=<X>&b=assigned_to&b_to_id=<Y>&op=difference&total=true`. Note que o VERBO é o mesmo nos dois lados — o que muda é a outra ponta. Comparar dois objetos concretos é para isso que `a_to_id`/`b_to_id` existem; sem eles você compara dois verbos, que é outra pergunta. E reporte `meta.total`, não o tamanho da página. `a_to_id`/`b_to_id` prendem a OUTRA ponta de cada relação — é o que permite comparar dois objetos concretos (cedentes do FIDC A contra os do FIDC B) em vez de dois verbos. Use `?total=true` para o tamanho do conjunto sem paginar.

Consulta relações no grafo inteiro, sem partir de um objeto

A travessia por objeto responde 'com quem ESTE se relaciona'. Esta responde sobre o conjunto: todas as relações de um tipo, opcionalmente presas a um lado (`from_id`/`to_id`) ou restritas por tipo de objeto (`from_kind`/`to_kind`). Para contagem e extremos, prefira `/links/stats` — não pagina.