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`.
In: header
Query Parameters
O tipo dos objetos a listar.
"company" | "equity_security" | "fund" | "service_provider" | "instrument" | "index" | "crypto_asset" | "commodity" | "country" | "indicator" | "data_series" | "offering" | "fund_share_class" | "market_event" | "role" | "sector" | "securitization" | "norm"Recorte dentro do tipo.
Restringe a quem tem esta relação com rel_to, a mesma coorte de rankObjects.
O outro lado de rel.
Lado da coorte na aresta de rel.
"in""in" | "out"Vigência das relações do recorte por rel. Sem at, usa o acervo histórico, como listObjectLinks.
^\d{4}-\d{2}-\d{2}$Cortes por palavra (sector=Bancos, situation!=Em Liquidação), com a sintaxe de rankObjects. Corte por número responde 422; use rankObjects.
Busca por nome dentro da coorte, sem acento nem caixa. Para resolver uma identidade por chave ou apelido, use resolveObject.
2 <= length <= 120Propriedades a projetar em cada linha, separadas por vírgula (até 8), pelos nomes de meta.filterable_properties — bdr_kind,last_traded. Saem em properties, como texto; nulo é folha sem a linha. É o catálogo numa página, sem uma chamada de getObjectProperties por objeto.
Cursor opaco de meta.next_cursor da página anterior; omita na primeira página.
Itens por página (1–1000, default 100).
1001 <= value <= 1000true = inclui meta.total (contagem do universo filtrado). Custa uma consulta a mais.
Response Body
curl -X GET "https://api.databolsa.com/v1/objects?kind=company&subkind=string&rel=string&rel_to=string&rel_direction=in&at=string&where=string&q=string&props=string&cursor=string&limit=100&total=string"{
"data": [
{
"id": "string",
"kind": "string",
"subkind": "string",
"name": "string",
"anchor_type": "string",
"anchor_value": "string",
"tickers": [
"string"
],
"properties": {
"property1": "string",
"property2": "string"
}
}
],
"meta": {
"next_cursor": "string",
"count": 0,
"total": 0,
"subject": {
"property1": "string",
"property2": "string"
},
"cohort_size": 0,
"applied_property_where": [
{
"property": "string",
"op": "eq",
"values": [
"string"
],
"matched": [
"string"
],
"source": "string"
}
],
"filterable_properties": [
{
"name": "string",
"vocabulary": [
"string"
]
}
]
}
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"details": {
"property1": null,
"property2": null
}
}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.
Filtra e ordena uma coorte por medidas
Ordena uma coorte por uma medida e permite filtrá-la por outras em `where`; cada linha traz os valores usados nos cortes. `expand` inclui o objeto ligado indicado, evitando uma consulta adicional. Para períodos, `at` é o teto da data-base e `since` o piso. Em `delta` e `pct_change`, `since_from` limita a observação inicial. Use `delta` para medidas que podem cruzar zero e confira `unit` antes de comparar medidas. `measure=min|max|avg|sum|count` ordena pela redução de TODAS as observações entre `since` e `at`, e não por uma leitura: é como responder qual título teve a menor fração aceita nos leilões do mês. `since` é obrigatório nesses casos, `observations` diz quantos pontos entraram em cada linha e `exclude_out_of_prior` descarta a observação implausível antes de reduzir. Objetos sem valor nas pontas necessárias ficam fora; `cohort_size` informa o denominador. `as_of` e `as_of_from` mostram as competências efetivamente comparadas. Com `availability=unknown`, o recorte histórico usa somente a data-base; com `filed`, também respeita a data de publicação.