DataBolsa docs
Referência da APIPlataformaObjects

Resume um conjunto de relações

Conta relações, afirmações e objetos distintos, além do período e da maior magnitude. `relationship_count` conta relações distintas; `assertion_count`, fontes e períodos que as sustentam. `magnitude_max` é máximo, não soma. Prefira recortar por `from_id` ou `to_id` quando a pergunta partir de um objeto.

GET
/v1/objects/links/stats
AuthorizationBearer <token>

In: header

Query Parameters

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, relações snapshot usam a última competência, diferente de listObjectLinks, que usa o histórico. meta.as_of informa a competência. Com at, aplica as regras temporais do verbo.

Match^\d{4}-\d{2}-\d{2}$

Response Body

curl -X GET "https://api.databolsa.com/v1/objects/links/stats?rel=issued&from_kind=company&to_kind=company&from_subkind=string&to_subkind=string&from_id=string&to_id=string&at=string"
{
  "shape": "event",
  "as_of": "string",
  "relationship_count": 0,
  "assertion_count": 0,
  "edges": 0,
  "from_count": 0,
  "to_count": 0,
  "source_count": 0,
  "magnitude_max": 0,
  "magnitude_unit": "string",
  "evidence_max": 0,
  "evidence_unit": "string",
  "valid_from_min": "string",
  "valid_to_max": "string"
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "details": {
    "property1": null,
    "property2": null
  }
}