DataBolsa docs
Referência da APIPlataformaObjects

Combina conjuntos definidos por duas relações

Aplica `intersect`, `union` ou `difference` a conjuntos definidos por duas relações. `a_to_id` e `b_to_id` prendem a contraparte e permitem comparar dois objetos concretos. Use `total=true` e leia `meta.total` para obter o tamanho sem paginar.

GET
/v1/objects/intersect
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.

astring

Primeira relaçã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"
bstring

Segunda relaçã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"
a_direction?string

Direção da relação a a partir do objeto da coorte (default out).

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

Direção da relação b a partir do objeto da coorte (default out).

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

Prende a outra ponta da relação A.

b_to_id?string

Prende a outra ponta da relação B.

a_to_kind?string

Tipo da outra ponta de A. issued alcança instrument e equity_security; recorte para separar dívida de ação.

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

Tipo da outra ponta de B.

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

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.

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

Recorta dentro do tipo: fidc, fii, debenture.

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}$
order?string

name é alfabética. a_count, b_count e total ordenam pelo número de contrapartes distintas; em union e differencea_count se aplica.

Default"name"
Value in"name" | "a_count" | "b_count" | "total"
op?string

intersect = nos dois; union = em qualquer um; difference = em A e não em B.

Default"intersect"
Value in"intersect" | "union" | "difference"

Response Body

curl -X GET "https://api.databolsa.com/v1/objects/intersect?cursor=string&limit=100&total=string&a=issued&b=issued&a_direction=out&b_direction=out&a_to_id=string&b_to_id=string&a_to_kind=company&b_to_kind=company&kind=company&subkind=string&at=string&order=name&op=intersect"
{
  "data": [
    {
      "id": "string",
      "kind": "string",
      "subkind": "string",
      "name": "string",
      "cnpj": "string",
      "tickers": [
        "string"
      ],
      "a_count": 0,
      "b_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"
    ],
    "order": "name"
  }
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "details": {
    "property1": null,
    "property2": null
  }
}