DataBolsa docs
Referência da APIPlataformaObjects

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.

GET
/v1/objects/{id}/links
AuthorizationBearer <token>

In: header

Path Parameters

idstring

Identificador canônico do objeto (pub_…). Operações em lote aceitam vários ids separados por vírgula.

Query Parameters

cursor?string

Cursor opaco de meta.next_cursor da página anterior; omita na primeira página.

limit?integer

Itens por página (1–1000, default 100).

Default100
Range1 <= value <= 1000
total?string

true = inclui meta.total (contagem do universo filtrado). Custa uma consulta a mais.

rel?string

Omitir = todas as relações desta direção.

Value in"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"
direction?string

out: este objeto pratica o verbo (fundo holds ativo); in: recebe (ativo é detido por fundo).

Default"out"
Value in"out" | "in"
series?string

Camada avaliada, em rates: a classe de cota como classe:número:tranche:emissão (senior:1::, mezzanine::I:), ou vazio para a nota do sujeito inteiro. Sem ela, a resposta traz uma aresta por contraparte, na ordem sênior → sujeito inteiro → ação mais recente. Os valores existentes de um sujeito estão em getObjectLinkHistory(rel=rates). Verbo sem camada ignora o parâmetro.

other_kind?string

Recorta pelo TIPO da contraparte, antes da paginação e do total. Um cedente pratica assigned_to contra série de CRI e contra FIDC no mesmo verbo — other_kind=fund responde só o segundo grupo.

Value in"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"
other_subkind?string

Recorta pelo SUBTIPO da contraparte (fidc em vez de fund, cota_fundo_fechado em vez de instrument).

at?string

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/string/links?cursor=string&limit=100&total=string&rel=issued&direction=out&series=string&other_kind=company&other_subkind=string&at=string&resolve=auto"
{
  "data": [
    {
      "rel": "string",
      "shape": "event",
      "direction": "out",
      "other_id": "string",
      "other_kind": "string",
      "other_subkind": "string",
      "other_name": "string",
      "other_code": "string",
      "other_key_type": "string",
      "other_key": "string",
      "source": "string",
      "valid_from": "string",
      "valid_to": "string",
      "observations": 0,
      "magnitude": 0,
      "magnitude_as_of": "string",
      "magnitude_unit": "string",
      "quantity": 0,
      "quantity_unit": "string",
      "quantity_as_of": "string",
      "rank": 0,
      "event_type": "rename",
      "origin_block": "with_risk",
      "weight_reason": "sem_pl_no_informe",
      "risk_retained": true,
      "series": "string",
      "label": "string",
      "outlook": "string",
      "watch": "string",
      "action": "string",
      "evidence": 0,
      "evidence_unit": "string",
      "confidence": "high"
    }
  ],
  "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"
    ],
    "coverage": {
      "status": "partial",
      "as_of": "string",
      "denominator_brl": 0,
      "covered_brl": 0,
      "ratio": 0,
      "excluded": [
        {
          "category": "string",
          "value_brl": 0
        }
      ],
      "source": "string",
      "scope": "cda_blc4"
    }
  }
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "details": {
    "property1": null,
    "property2": null
  }
}