Listar Snapshots

Lista as posições históricas (snapshots) dos investimentos de um item. Cada snapshot é uma "foto" do investimento numa data de referência (currentDate), permitindo acompanhar a evolução da posição ao longo do tempo.

Os snapshots são retornados ordenados por investimento e, dentro de cada investimento, da data de referência mais recente para a mais antiga.

Endpoint

Método e URL:

GET /v1/items/:itemId/investments/snapshots

Parâmetros da URL:

• itemId (string, obrigatório): Identificador único do item

Parâmetros de consulta:

• from (data ISO 8601, opcional): Filtra snapshots com currentDate maior ou igual à data informada
• to (data ISO 8601, opcional): Filtra snapshots com currentDate menor ou igual à data informada

Campos da Resposta

• from: Data inicial do filtro aplicado (ou null quando não informada)
• to: Data final do filtro aplicado (ou null quando não informada)
• snapshots: Array contendo as posições históricas
  • id: Identificador único do snapshot
  • investmentId: Identificador do investimento associado
  • externalId: Identificador do investimento no provedor de dados
  • name: Nome do investimento
  • code: Código do investimento (CNPJ do fundo, quando aplicável). Pode ser null
  • isin: Identificador global ISIN. Pode ser null
  • number: Número do investimento. Pode ser null
  • owner: Titular/dono do investimento. Pode ser null
  • type: Tipo/categoria do investimento
  • subtype: Subtipo do investimento. Pode ser null
  • status: Status do investimento (ACTIVE, PENDING, TOTAL_WITHDRAWAL, UNKNOWN)
  • currency: Código da moeda do investimento (ex: "BRL")
  • lastMonthRate: Rentabilidade do último mês (percentual). Pode ser null
  • lastTwelveMonthsRate: Rentabilidade dos últimos 12 meses (percentual). Pode ser null
  • annualRate: Taxa anual (percentual). Pode ser null
  • currentDate: Data de referência da posição (data da cota)
  • currentValue: Valor da cota na data de referência. Pode ser null
  • currentQuantity: Quantidade de cotas. Pode ser null
  • currentGrossAmount: Valor bruto (com impostos). Pode ser null
  • currentNetAmount: Valor líquido (descontados taxas e impostos)
  • incomeTaxes: Imposto de renda aplicado. Pode ser null
  • financialTaxes: Imposto financeiro aplicado. Pode ser null
  • rate: Taxa contratada (percentual). Pode ser null
  • rateType: Tipo/indexador da taxa (CDI, SELIC, DOLAR, EURO, IGPM, IPCA). Pode ser null
  • fixedAnnualRate: Taxa anual fixa (percentual). Pode ser null
  • issuer: Emissor. Pode ser null
  • issuedAt: Data de emissão. Pode ser null
  • amountProfit: Lucro líquido até a data (pode ser negativo). Pode ser null
  • amountWithdrawal: Valor disponível para resgate. Pode ser null
  • amountOriginal: Valor originalmente investido. Pode ser null
  • expiresAt: Data de vencimento. Pode ser null
  • capturedAt: Data e hora em que o snapshot foi capturado

Resposta

Resposta de sucesso (200):

{
  "status": "success",
  "data": {
    "from": "timestamp | null",
    "to": "timestamp | null",
    "snapshots": [
      {
        "id": "uuid",
        "investmentId": "uuid",
        "externalId": "uuid",
        "name": "string",
        "code": "string | null",
        "isin": "string | null",
        "number": "string | null",
        "owner": "string | null",
        "type": "FIXED_INCOME | SECURITY | MUTUAL_FUND | EQUITY | ETF | COE | OTHER",
        "subtype": "string | null",
        "status": "ACTIVE | PENDING | TOTAL_WITHDRAWAL | UNKNOWN",
        "currency": "string",
        "lastMonthRate": "string | null",
        "lastTwelveMonthsRate": "string | null",
        "annualRate": "string | null",
        "currentDate": "timestamp",
        "currentValue": "string | null",
        "currentQuantity": "string | null",
        "currentGrossAmount": "string | null",
        "currentNetAmount": "string",
        "incomeTaxes": "string | null",
        "financialTaxes": "string | null",
        "rate": "string | null",
        "rateType": "CDI | SELIC | DOLAR | EURO | IGPM | IPCA | null",
        "fixedAnnualRate": "string | null",
        "issuer": "string | null",
        "issuedAt": "timestamp | null",
        "amountProfit": "string | null",
        "amountWithdrawal": "string | null",
        "amountOriginal": "string | null",
        "expiresAt": "timestamp | null",
        "capturedAt": "timestamp"
      }
    ]
  }
}