Obtém séries de medidas de um ou vários objetos

Aceita até 50 IDs e 10 medidas separados por vírgula; retorna uma série por par objeto-medida. `meta.subjects` informa IDs ausentes ou sem dados, e uma medida incompatível retorna `error`, não série vazia. `series` escolhe o recorte — a classe do papel, ou o escopo contábil da demonstração (`consolidado` | `individual`); sem ela, `meta.series` informa a usada. `limit` seleciona os pontos mais recentes. O limite total é 100 séries e 100.000 pontos; excesso responde 422. `transform` calcula acumulados (`compound_12m`, `sum_12m`, `ytd`), médias e variações sobre a série, guardado pela classe `axes.aggregation` que a série declara; `transform.served_from` diz quando a resposta é a série que a fonte já publica.

Authorization

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

factsstring

Nomes de medida separados por vírgula (até 10), como em getObjectFacts.

series?string

Qualificador da medida dentro do objeto: a classe de ação (PETR4), quando a medida é por papel, ou o escopo contábil da demonstração (consolidado | individual). Sem ele, a demonstração responde o consolidado, que é o que o contrato promete.

from?string

Início do período (AAAA-MM-DD, inclusive).

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

to?string

Fim do período (AAAA-MM-DD, inclusive).

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

limit?integer

Pontos mais recentes por série (1–2000, default 500).

Default500

Range1 <= value <= 2000

transform?string

Transformação calculada sobre a série, guardada pela classe axes.aggregation: sum_12m e ytd somam fluxos; compound_12m e compound_ytd compõem variações percentuais (IPCA em 12 meses); mean_3m e mean_12m tiram a média; pct_change é a variação % contra o ponto anterior (níveis e fluxos); diff é a diferença contra o ponto anterior, em p.p. para taxas. Classe que não sustenta a conta responde error na série com o motivo e as aceitas. Quando a fonte já publica o acumulado, a série servida é a dela (transform.served_from). Janelas por calendário; ponto com janela descoberta é omitido.

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/history?facts=string&series=string&from=string&to=string&limit=500&transform=sum_12m&resolve=auto"

curl -X GET "https://api.databolsa.com/v1/objects/string/history?facts=string&series=string&from=string&to=string&limit=500&transform=sum_12m&resolve=auto"

{
  "data": [
    {
      "entity_id": "string",
      "fact": "string",
      "label": "string",
      "axes": {
        "dimension": "string",
        "scale": "string",
        "period": "string",
        "seasonal_adjustment": "string",
        "expected_range": {
          "min": 0,
          "max": 0
        },
        "concept": "string",
        "aggregation": "string"
      },
      "series": "string",
      "unit": "brl",
      "cadence": "daily",
      "grain": "object",
      "source": "string",
      "lineage": "string",
      "availability": "filed",
      "description": "string",
      "provenance": {
        "adjust_type": "string",
        "adjust_quality": "string"
      },
      "points": [
        {
          "date": "string",
          "value": 0
        }
      ],
      "count": 0,
      "first_date": "string",
      "last_date": "string",
      "truncated": true,
      "transform": {
        "name": "sum_12m",
        "window": "string",
        "points_used": 0,
        "served_from": "string"
      },
      "error": "string"
    }
  ],
  "meta": {
    "next_cursor": "string",
    "count": 0,
    "total": 0,
    "subject": {
      "property1": "string",
      "property2": "string"
    },
    "subjects": [
      {
        "id": "string",
        "resolved_id": "string",
        "redirected_from": "string",
        "status": "ok",
        "reason": "string",
        "successors": [
          "string"
        ]
      }
    ],
    "truncated": true,
    "warnings": [
      {
        "code": "mixed_scales",
        "message": "string",
        "series": [
          {
            "entity_id": "string",
            "fact": "string"
          }
        ]
      }
    ]
  }
}

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "details": {
    "property1": null,
    "property2": null
  }
}