DataBolsa docs
Referência da APIDados de mercadoObjects

As PROPRIEDADES do objeto — o que ele é, em palavras

A terceira forma de dizer algo sobre uma coisa. `getObjectFacts` serve NÚMERO (tem unidade, escala, data-base, anda no tempo); `listObjectLinks` serve LIGAÇÃO (aponta para outro objeto); esta rota serve PALAVRA de vocabulário fechado — situação, forma de condomínio, público-alvo, segmento de listagem, rito da oferta. **Leia `vocabulary` antes de concluir qualquer coisa de um valor.** Ele traz os valores POSSÍVEIS quando a fonte tem lista fechada, e é o que separa 'existem cinco situações' de 'existem vinte'. Um exemplo que morde: a situação de fundo tem cinco valores e NENHUM deles é 'Encerrado' — referência de mercado que exibe isso está derivando de outro lugar. Onde a lista é grande e viva (70 setores, 66 classificações ANBIMA), `vocabulary` é nulo de propósito: vocabulário declarado e desatualizado é pior que vocabulário ausente. **O valor sai como a tabela o tem**, sempre texto — booleano vem `"true"`/`"false"`, e onde a CVM publica `S`/`N` é `S`/`N` que sai. Esta rota não traduz, porque traduzir aqui faria ela discordar da rota de domínio sobre a mesma coluna. **Propriedade nula não vira linha.** Publicá-la diria 'esta coisa não tem público-alvo' quando o que houve foi a fonte não declarar — 475 das 9.119 subclasses não declaram previdência, e isso não as torna não-previdenciárias. **O que NÃO está aqui, e por quê:** administrador, gestor, auditor e custodiante de um fundo, e o coordenador líder de uma oferta, parecem propriedade e são ARESTA — apontam para outro objeto. Hoje ainda são texto na tabela de origem; publicá-los como propriedade normalizaria o erro em vez de resolvê-lo.

GET
/v1/objects/{id}/properties
AuthorizationBearer <token>

In: header

Path Parameters

idstring

Query Parameters

resolve?string

Como interpretar o id recebido.

  • auto (default) — como REFERÊNCIA publicada: id fundido resolve sozinho para o sucessor (com redirected_from preenchido) e id cindido responde 409 com a lista.
  • exact — como o id do objeto que existe HOJE: nenhum histórico é consultado, e o id ou responde ou é 404.

Quando você precisa de exact: numa cisão, um dos sucessores é o PRÓPRIO id pedido — o ramo que ficou com a chave de nascimento herda o identificador. O 409 manda consultar cada sucessor, e consultar esse cairia no mesmo 409. exact é o endereço dele. Serve também para desligar o redirect automático de fusão quando você quer saber se o id que guardou ainda é o id de alguma coisa.

Default"auto"
Value in"auto" | "exact"

Response Body

curl -X GET "https://api.databolsa.com/v1/objects/string/properties?resolve=auto"
{
  "data": [
    {
      "name": "string",
      "value": "string",
      "description": "string",
      "source": "string",
      "as_of": "string",
      "vocabulary": [
        "string"
      ]
    }
  ],
  "meta": {
    "next_cursor": "string",
    "count": 0,
    "total": 0,
    "subject": {
      "property1": "string",
      "property2": "string"
    }
  },
  "uncovered_reason": "string"
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

O resumo de um conjunto de relações, sem paginar nada

Responde perguntas sobre o CONJUNTO em uma chamada: quantas relações existem, quantos objetos distintos de cada lado, desde quando, e a maior magnitude observada. `relationship_count` conta relações DISTINTAS e é o número a reportar; `assertion_count` conta as afirmações que as sustentam, uma por (fonte, período contíguo), e é sempre maior ou igual — a diferença é redundância de fonte, não tamanho. `magnitude_max` é MÁXIMO e nunca soma: somar magnitude ao longo de competências produz número sem sentido. Use quando a pergunta for 'quantos/qual o maior/desde quando', em vez de percorrer as arestas uma a uma. CUSTO, medido contra produção em 16/08/2026: com `from_id` ou `to_id` responde em ~12ms, porque o recorte é indexado. SEM recorte, ou só com `rel`, a contagem de objetos distintos varre o conjunto inteiro e leva de 4 a 6 segundos. Prefira sempre recortar por objeto quando a pergunta for sobre um objeto.

Á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.