DataBolsa docs
Referência da APIPlataformaObjects

Lista relações do grafo inteiro

Pagina as relações de um verbo sem partir de um objeto, opcionalmente presas a um lado (`from_id`, `to_id`) ou a tipos (`from_kind`, `to_kind`). Para contagens e extremos, use `getObjectLinkStats`.

GET
/v1/objects/links
AuthorizationBearer <token>

In: header

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

Verbo da relação; from é quem pratica a ação e to quem a recebe. measures liga uma série ao conceito observado; forecasts, ao conceito projetado. manages identifica o gestor e administers o administrador fiduciário. Consulte listObjectRelations para forma temporal, tipos de origem e destino e semântica de magnitude de cada verbo.

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"
from_kind?string

Tipo do objeto que pratica o verbo.

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"
to_kind?string

Tipo do objeto que recebe o verbo.

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"
from_subkind?string

Subtipo na origem (fidc em vez de fund).

to_subkind?string

Subtipo no destino.

from_id?string

Prende a origem a um objeto (pub_…).

to_id?string

Prende o destino a um objeto (pub_…).

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}$

Response Body

curl -X GET "https://api.databolsa.com/v1/objects/links?cursor=string&limit=100&total=string&rel=issued&from_kind=company&to_kind=company&from_subkind=string&to_subkind=string&from_id=string&to_id=string&at=string"
{
  "data": [
    {
      "rel": "string",
      "shape": "event",
      "from_id": "string",
      "to_id": "string",
      "source": "string",
      "valid_from": "string",
      "valid_to": "string",
      "observations": 0,
      "magnitude": 0,
      "magnitude_as_of": "string",
      "magnitude_unit": "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"
    ]
  }
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "details": {
    "property1": null,
    "property2": null
  }
}

Lista as medidas e suas unidades

Lista os `fact` aceitos por `getObjectFacts` e `getObjectHistory`, com objetos aplicáveis e sua régua. Interprete o valor com `unit`, `dimension`, `scale` e `period`: `ratio` é fração, `pct` é percentual e escalas como `thousand` não são aplicadas ao valor servido. Em `unit=native`, a unidade varia por série; consulte o objeto da série para obter a unidade resolvida.

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.