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.
In: header
Query Parameters
O tipo dos objetos que entram na coorte.
"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.
A medida, pelo nome do listFactCatalog.
value ordena pelo último valor até at; delta pela variação absoluta e pct_change pela relativa, as duas entre from e at. min, max, avg, sum e count reduzem TODAS as observações da medida entre since e at, as duas pontas inclusive: exigem since, recusam from, devolvem observations na linha e datam as_of pela última observação da janela. sum é recusado onde a régua não sustenta a soma, como em aggregateObjects; count sai em count.
"value""value" | "delta" | "pct_change" | "min" | "max" | "avg" | "sum" | "count"Teto da data-base do valor e vigência das relações. Com since, forma a janela aceita. Sem since, a cadência da medida define o piso; meta.since, since_policy e as_of_range informam o recorte efetivo. Verbo de estado no rel (manages, audits) é lido como vigente — a coorte é quem é hoje, o valor é o da data — e declarado em meta.current_state_rels.
^\d{4}-\d{2}-\d{2}$Ponta INICIAL. Obrigatória em delta e pct_change.
^\d{4}-\d{2}-\d{2}$Piso da data-base aceita na ponta inicial. Sem ele, o último valor anterior a from pode ser mais antigo que a janela pretendida. Confira meta.as_of_from_range.
^\d{4}-\d{2}-\d{2}$asc lista os menores primeiro; com delta, é a maior queda.
"desc""asc" | "desc"Linhas do ranking (1–200, default 20).
201 <= value <= 200Inclui em cada linha até três objetos ligados pelo verbo, com id, nome e chave pública. Para todos os vizinhos de um objeto, use listObjectLinks.
"issued" | "distributes" | "tokenized_as" | "registered_as" | "assigned_to" | "owes_under" | "holds" | "manages" | "administers" | "custodies" | "audits" | "same_owner" | "shareholder_of" | "indexed_to" | "rates" | "mentions" | "measures" | "forecasts" | "contains" | "member_of" | "exposed_to_issuer" | "succeeded_by" | "produces" | "covers" | "coordinates" | "offers" | "exposed_to_sector" | "regulated_by" | "amends" | "revokes"Lado do vizinho na aresta: in (default) é quem aponta para a linha, como o emissor de uma oferta.
"in""out" | "in"Restringe a coorte a quem tem esta relação com rel_to. Sem ela, a coorte é o tipo inteiro.
"issued" | "distributes" | "tokenized_as" | "registered_as" | "assigned_to" | "owes_under" | "holds" | "manages" | "administers" | "custodies" | "audits" | "same_owner" | "shareholder_of" | "indexed_to" | "rates" | "mentions" | "measures" | "forecasts" | "contains" | "member_of" | "exposed_to_issuer" | "succeeded_by" | "produces" | "covers" | "coordinates" | "offers" | "exposed_to_sector" | "regulated_by" | "amends" | "revokes"O outro lado da relação: o índice, o fundo, a empresa.
Lado da coorte na aresta. in (default): rel_to aponta para os membros, como o índice que contém papéis. out: os membros apontam para rel_to, como cedentes de um fundo.
"in""out" | "in"Data-base mínima aceita na ponta final. Sem ela, a cadência da medida define o piso relativo a at e meta.stale_excluded conta os objetos parados que ficaram fora. meta.since e since_policy informam o corte efetivo. Em min, max, avg, sum e count é o COMEÇO da janela agregada e passa a ser obrigatória.
^\d{4}-\d{2}-\d{2}$Exclui valores fora da faixa plausível declarada para a medida ordenada. meta.excluded_out_of_prior informa quantos saíram e fica nulo quando não houve teste. A validação não examina o denominador de uma razão; para isso, filtre a medida de tamanho em where.
Condições separadas por vírgula. Medidas usam <medida><operador><número>; delta(x) e pct_change(x) filtram variação e exigem from. Propriedades usam = ou !=; | representa alternativas no mesmo campo e valores com vírgula devem estar entre aspas. Confira a unidade em meta.applied_where. Objetos sem a medida não passam; em !=, objetos sem a propriedade passam.
Response Body
curl -X GET "https://api.databolsa.com/v1/objects/rank?kind=company&subkind=string&fact=string&measure=value&at=string&from=string&since_from=string&order=asc&limit=20&expand=issued&expand_direction=out&rel=issued&rel_to=string&rel_direction=out&since=string&exclude_out_of_prior=true&where=string"{
"data": [
{
"id": "string",
"name": "string",
"kind": "string",
"subkind": "string",
"value": 0,
"value_from": 0,
"value_to": 0,
"as_of": "string",
"statement_date": "string",
"statement_date_from": "string",
"as_of_from": "string",
"series": "string",
"out_of_prior": true,
"related": [
{
"rel": "string",
"direction": "out",
"id": "string",
"kind": "string",
"name": "string",
"key_type": "string",
"key": "string"
}
],
"observations": 0,
"where_values": [
{
"fact": "string",
"measure": "value",
"value": 0,
"as_of": "string"
}
]
}
],
"meta": {
"next_cursor": "string",
"count": 0,
"total": 0,
"subject": {
"property1": "string",
"property2": "string"
},
"fact": "string",
"unit": "brl",
"measure": "value",
"cadence": "daily",
"grain": "object",
"source": "string",
"availability": "filed",
"order": "asc",
"window_from": "string",
"window_to": "string",
"since": "string",
"since_policy": "caller",
"stale_excluded": 0,
"as_of_range": {
"min": "string",
"max": "string"
},
"mixed_vintage": true,
"vintage_spread_days": 0,
"current_state_rels": [
"string"
],
"as_of_from_range": {
"min": "string",
"max": "string"
},
"excluded_out_of_prior": 0,
"cohort_size": 0,
"filterable_facts": [
"string"
],
"filterable_properties": [
{
"name": "string",
"vocabulary": [
"string"
]
}
],
"applied_property_where": [
{
"property": "string",
"op": "eq",
"values": [
"string"
],
"matched": [
"string"
],
"source": "string"
}
],
"filtered_out": 0,
"applied_where": [
{
"fact": "string",
"op": "lt",
"value": 0,
"measure": "value",
"unit": "brl",
"description": "string",
"via_rel": "string",
"via_direction": "in",
"fact_kind": "string"
}
],
"description": "string"
}
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"details": {
"property1": null,
"property2": null
}
}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`.
Resolve ticker, CNPJ, ISIN, código ou nome
Retorna candidatos ordenados. `exact_key` identifica por chave; `fuzzy_name` exige confirmação. Prefira identificadores a nomes. Papéis e companhias são objetos distintos: por exemplo, `PETR4` resolve para o papel, ligado à emissora por `issued`.