DataBolsa docs
Referência da APIPlataformaObjects

Converte uma consulta de objetos em tabela

Executa `getObjectHistory`, `getObjectFacts`, `rankObjects` ou `aggregateObjects` e retorna `{ schema.columns, rows, meta }`. As colunas declaram tipo, papel e unidade; os valores não são recalculados. Passe os parâmetros da operação em `input`; `meta.query` devolve a consulta reexecutável. Lotes com unidades diferentes informam a unidade por linha e deixam a unidade da coluna nula.

GET
/v1/objects/table
AuthorizationBearer <token>

In: header

Query Parameters

operationstring

Operação com projeção tabular.

Value in"getObjectHistory" | "rankObjects" | "getObjectFacts" | "aggregateObjects"
id?string

Ids do sujeito, separados por vírgula. Obrigatório em getObjectHistory e getObjectFacts; ausente em rankObjects e aggregateObjects.

input?string

Parâmetros de query da operação em JSON, pelo nome do contrato: {"facts":"close","from":"2025-01-01"}.

Default"{}"

Response Body

curl -X GET "https://api.databolsa.com/v1/objects/table?operation=getObjectHistory&id=string&input=%7B%7D"
{
  "schema": {
    "columns": [
      {
        "name": "string",
        "type": "string",
        "role": "identity",
        "label": "string",
        "semantic": "string",
        "unit": "brl",
        "nullable": true
      }
    ],
    "primary_key": [
      "string"
    ]
  },
  "rows": [
    [
      "string"
    ]
  ],
  "meta": {
    "ontology_version": 0,
    "query": {
      "operation": "resolveObject",
      "subject": {
        "entity_id": "string",
        "label": "string"
      },
      "input": {
        "property1": null,
        "property2": null
      },
      "description": "string"
    },
    "as_of": "string",
    "count": 0,
    "warnings": [
      {
        "code": "mixed_scales",
        "message": "string"
      }
    ],
    "lineage": [
      {
        "source": "string",
        "lineage": "string"
      }
    ]
  }
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "details": {
    "property1": null,
    "property2": null
  }
}