DataBolsa docs
Referência da APIPlataformaObjects

Descobre como dois objetos se conectam

Descobre cadeias entre dois objetos; use `traverseObjectPath` quando a cadeia já for conhecida. Agrupa resultados por cadeia, traz intermediários em `examples` e conta sequências distintas em `path_count`, sem duplicar fontes. Cadeias curtas vêm primeiro. O padrão é dois saltos; o terceiro é mais caro.

GET
/v1/objects/paths
AuthorizationBearer <token>

In: header

Query Parameters

from_idstring

Objeto de origem (pub_…).

to_idstring

Objeto de destino (pub_…).

max_hops?integer

Comprimento máximo da cadeia (1–3, default 2). O terceiro salto custa segundos.

Default2
Range1 <= value <= 3
limit?integer

Cadeias distintas a devolver (1–25, default 10).

Default10
Range1 <= value <= 25
at?string

Aplica a data a cada salto. Sem ela, a ligação pode ser histórica. Relações static são excluídas de buscas passadas e informadas em meta.excluded_shapes. Corte temporal (AAAA-MM-DD). Sem at, usa o acervo histórico. Conforme o shape de listObjectRelations, event acumula até a data, snapshot escolhe o retrato aplicável e static pode ser recusada por não afirmar vigência passada.

Match^\d{4}-\d{2}-\d{2}$
resolve?string

Como interpretar o id: auto segue fusões e, em cisões, responde 409 com os sucessores; exact lê literalmente o objeto desse id. Use exact para acessar o ramo de uma cisão que preservou o identificador original ou para desativar o redirecionamento automático.

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

Response Body

curl -X GET "https://api.databolsa.com/v1/objects/paths?from_id=string&to_id=string&max_hops=2&limit=10&at=string&resolve=auto"
{
  "data": [
    {
      "hops": 0,
      "chain": "string",
      "path_count": 0,
      "paths": 0,
      "examples": [
        "string"
      ]
    }
  ],
  "meta": {
    "at": "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
  }
}