Percorre uma cadeia de relações
Percorre de uma a três relações declaradas como `verbo:direção` e ordena por objetos distintos alcançados. `return_at` escolhe a posição listada; `count_at`, a contada. `end_id` e `end_kind` restringem a ponta. `at` aplica a mesma data a todos os passos. Com `total=true`, leia o total em `meta.total`.
In: header
Query Parameters
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.
Cadeia verbo:direção separada por vírgula, 1 a 3 passos. Ex.: contains:out,issued:out
Objeto de partida (pub_…); sem ele, parte de todos os objetos de start_kind.
Tipo canônico do objeto. equity_security é o papel, separado de company; securitization é a emissão, separada da série negociável (instrument); e fund_share_class é a subclasse, separada da classe com CNPJ (fund). indicator representa o conceito medido, enquanto data_series representa uma publicação ou cálculo específico. offering, market_event e norm são objetos porque possuem identidade, atributos e relações próprias.
"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"Subtipo na partida (fidc em vez de fund).
Prende a ponta final a um objeto.
Tipo canônico do objeto. equity_security é o papel, separado de company; securitization é a emissão, separada da série negociável (instrument); e fund_share_class é a subclasse, separada da classe com CNPJ (fund). indicator representa o conceito medido, enquanto data_series representa uma publicação ou cálculo específico. offering, market_event e norm são objetos porque possuem identidade, atributos e relações próprias.
"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"Subtipo na ponta final (debenture em vez de instrument).
Posição contada na cadeia; 0 é a partida. Omitido conta a ponta final.
0 <= value <= 3Posição listada; 0 (default) é a partida.
0 <= value <= 3Corte temporal aplicado a todos os saltos. Sem at, cada relação snapshot usa o retrato vigente do próprio sujeito, static usa o vigente e event inclui todos os eventos. Para consultar o acervo histórico, use listObjectLinks ou findObjectPaths sem at.
^\d{4}-\d{2}-\d{2}$Response Body
curl -X GET "https://api.databolsa.com/v1/objects/path?cursor=string&limit=100&total=string&steps=string&start_id=string&start_kind=company&start_subkind=string&end_id=string&end_kind=company&end_subkind=string&count_at=3&return_at=3&at=string"{
"data": [
{
"id": "string",
"kind": "string",
"name": "string",
"reached_count": 0,
"count": 0
}
],
"meta": {
"next_cursor": "string",
"count": 0,
"total": 0,
"subject": {
"property1": "string",
"property2": "string"
},
"as_of": "string",
"as_of_by_rel": {
"property1": "string",
"property2": "string"
},
"excluded_shapes": [
"event"
]
}
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"details": {
"property1": null,
"property2": null
}
}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`.
Executa uma Function
Executa a Function no sujeito informado (`entity_id` ou `resolve`) com o `input` do spec. `at` aplica o corte temporal no campo que o spec declara; `series` escolhe o papel quando o grão é por papel. Recusas trazem `details.code`: `subject_required`, `subject_ambiguous` com `candidates`, `function_not_applicable` com `kinds`, `series_required` com `options`, `temporal_cut_unsupported`, `invalid_input`.