DataBolsa docs
Referência da APIPlataformaObjects

Lista o vocabulário de relações do grafo

Catálogo fechado dos verbos, inclusive os ainda sem arestas. Leia `note` para a semântica, `domain_kinds` e `range_kinds` para as pontas válidas, e `shape` para o tempo: `event` acumula eventos, `snapshot` representa retratos e `static` só admite o vigente.

GET
/v1/objects/relations
AuthorizationBearer <token>

In: header

Response Body

curl -X GET "https://api.databolsa.com/v1/objects/relations"
{
  "meta": {
    "next_cursor": "string",
    "count": 0,
    "total": 0,
    "subject": {
      "property1": "string",
      "property2": "string"
    }
  },
  "data": [
    {
      "rel": "string",
      "shape": "event",
      "max_gap_days": 0,
      "last_valid_to": "string",
      "domain_kinds": [
        "string"
      ],
      "range_kinds": [
        "string"
      ],
      "forward_name": "string",
      "inverse_name": "string",
      "note": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "details": {
    "property1": null,
    "property2": null
  }
}

Lista relações de um objeto

Retorna uma linha por afirmação, com a contraparte resolvida. A mesma relação pode aparecer por mais de uma fonte ou período; conte objetos por `other_id`. `magnitude` nula significa não publicada, não zero. A ordem é `magnitude` decrescente, portanto `limit=5` já produz o top 5. Com `at`, usa a última observação válida até a data; sem `at`, inclui relações históricas. Em `rates` a aresta é por CAMADA avaliada: um FIDC tem uma nota por classe de cota. Sem `series`, a resposta traz a camada default de cada contraparte (sênior, depois a nota do sujeito inteiro, depois a ação mais recente) e `series` diz qual saiu; com `series`, apenas aquela camada. Por isso a contagem aqui pode ser menor que `assertion_count` de `getObjectLinkStats`, que conta todas as camadas. `other_kind` e `other_subkind` recortam pelo OUTRO lado da aresta, antes da paginação e do `total`: um cedente com 331 arestas `assigned_to` exigia cinco páginas para achar o FIDC entre as séries de CRI. Com o recorte, `coverage` sai do `meta` — a fração é do verbo inteiro contra a folha autoritativa e não descreve a fatia.

Lista objetos por tipo e propriedades

Enumera a coorte do cadastro sem exigir uma medida. `kind`, `subkind`, relações e propriedades usam o mesmo recorte de `rankObjects` e `aggregateObjects`. Use `rankObjects` para filtros numéricos, `q` para nome dentro da coorte e `resolveObject` para localizar uma identidade. `props` projeta propriedades do catálogo em cada linha (`properties`), para o catálogo sair numa página. Com `total=true`, leia o total em `meta.cohort_size`.