Openi DeveloperDeveloper
Investimentos

Listar Investimentos

Lista as posições de investimento da empresa, paginadas, com filtros por qualquer campo da posição, ordenação e totais consolidados.

Cada posição reflete o snapshot mais recente capturado até a data de referência (asOfDate) — filtros e ordenação também usam os valores desse snapshot. Investimentos totalmente resgatados (status: TOTAL_WITHDRAWAL) não são retornados.

Endpoint

Método e URL:

GET /api/v1/companies/:companyId/investments

Parâmetros da URL:

  • companyId (uuid, obrigatório): Identificador da empresa

Parâmetros de query:

  • asOfDate (data YYYY-MM-DD ou data-hora ISO 8601, opcional): Data de referência — retorna o último snapshot de cada investimento até o fim desse dia (padrão: agora)
  • filters (JSON, opcional): Condições sobre os campos abaixo — formato em Filtros, ordenação e busca
  • joinOperator (opcional): and (padrão) ou or
  • sort (JSON, opcional): Qualquer campo abaixo. Padrão: investimentos cadastrados mais recentemente primeiro
  • page, perPage (number, opcional): Paginação (padrão: 1 e 10; perPage máx. 500)

Não aceita search nem from/to: a posição é uma foto na data asOfDate. Para recortar por outras datas da posição (expiresAt, issuedAt...), use filters.

Campos filtráveis

Todos os campos abaixo também são ordenáveis.

CampoTipoObservação
nametexto
typeenumFIXED_INCOME, SECURITY, MUTUAL_FUND, EQUITY, ETF, COE ou OTHER
subtypeenumFIXED_INCOME: CRI, CRA, LCI, LCA, LC, TREASURY, DEBENTURES, CDB, LIG, LF, CORPORATE_DEBT · SECURITY: RETIREMENT, PGBL, VGBL · MUTUAL_FUND: INVESTMENT_FUND, STOCK_FUND, MULTIMARKET_FUND, EXCHANGE_FUND, FIXED_INCOME_FUND, FIP_FUND, OFFSHORE_FUND, ETF_FUND · EQUITY: STOCK, BDR, REAL_ESTATE_FUND, DERIVATIVES, OPTION · ETF: ETF · COE: STRUCTURED_NOTE · OTHER: OTHER
statusenumACTIVE, PENDING ou UNKNOWN
issuertexto
ownertexto
codetexto
numbertexto
isintexto
currencytextoex.: BRL
ratenúmero
rateTypeenumCDI, SELIC, DOLAR, EURO, IGPM ou IPCA
annualRatenúmero
lastMonthRatenúmero
lastTwelveMonthsRatenúmero
currentValuevalor
currentQuantitynúmero
currentGrossAmountvalor
currentNetAmountvalor
incomeTaxesvalor
financialTaxesvalor
amountProfitvalor
amountWithdrawalvalor
amountOriginalvalor
currentDatedata
issuedAtdata
expiresAtdata
iduuid
createdAtdata
updatedAtdatacaptura do snapshot

Exemplo

Renda fixa com vencimento em 2027 e saldo acima de R$ 10.000, ordenada por vencimento:

curl -G "https://api-business.openi.com.br/api/v1/companies/{companyId}/investments" \
  -H "Authorization: Bearer oak_368ba506f7b2_9f2c..." \
  --data-urlencode 'filters=[{"id":"type","operator":"eq","value":"FIXED_INCOME"},{"id":"expiresAt","operator":"isBetween","value":["2027-01-01","2027-12-31"]},{"id":"currentNetAmount","operator":"gt","value":10000}]' \
  --data-urlencode 'sort=[{"id":"expiresAt","desc":false}]' \
  --data-urlencode 'perPage=50'

Posição em uma data passada:

curl "https://api-business.openi.com.br/api/v1/companies/{companyId}/investments?asOfDate=2026-06-30" \
  -H "Authorization: Bearer oak_368ba506f7b2_9f2c..."

Resposta

{
  "status": "success",
  "data": {
    "investments": [
      {
        "id": "9e8d7c6b-5a4f-4e3d-2c1b-0a9f8e7d6c5b",
        "name": "CDB Banco Inter 110% CDI",
        "code": "CDB110CDI",
        "number": "00123456",
        "owner": "Openi Tecnologia LTDA",
        "type": "FIXED_INCOME",
        "subtype": "CDB",
        "status": "ACTIVE",
        "currency": "BRL",
        "isin": "BRINTRCDB001",
        "rate": "110.0000",
        "rateType": "CDI",
        "issuer": "Banco Inter S.A.",
        "lastMonthRate": "0.0090",
        "lastTwelveMonthsRate": "0.1120",
        "annualRate": "0.1180",
        "currentDate": "2026-08-01T00:00:00.000Z",
        "currentValue": "1.00",
        "currentQuantity": "10350.00000000",
        "currentGrossAmount": "10350.00",
        "currentNetAmount": "10271.25",
        "incomeTaxes": "78.75",
        "financialTaxes": "0.00",
        "amountProfit": "350.00",
        "amountWithdrawal": "0.00",
        "amountOriginal": "10000.00",
        "issuedAt": "2025-07-01T00:00:00.000Z",
        "expiresAt": "2027-07-01T00:00:00.000Z",
        "createdAt": "2025-07-01T12:00:00.000Z",
        "updatedAt": "2026-08-01T03:15:00.000Z"
      }
    ],
    "metadata": {
      "totalCurrentNetAmount": "10271.25",
      "totalAmountOriginal": "10000.00",
      "totalAmountWithdrawal": "0.00"
    },
    "meta": {
      "page": 1,
      "perPage": 20,
      "total": 1,
      "totalPages": 1
    }
  }
}
  • id: identificador do investimento na Openi — é o valor aceito em investmentId nos lançamentos de investimentos. O identificador do provedor (externalId) não é exposto pela API
  • type: FIXED_INCOME, SECURITY, MUTUAL_FUND, EQUITY, ETF, COE ou OTHER
  • subtype: subtipo dentro do type — ex. CDB, LCI, TREASURY, STOCK, REAL_ESTATE_FUND
  • status: ACTIVE, PENDING ou UNKNOWN — posições TOTAL_WITHDRAWAL são omitidas da listagem
  • rateType: índice de referência da taxa — CDI, SELIC, DOLAR, EURO, IGPM ou IPCA
  • Valores monetários são strings decimais com ponto e duas casas ("10271.25"), sem símbolo de moeda — a moeda vem em currency; as taxas (rate, annualRate, lastMonthRate, lastTwelveMonthsRate) e currentQuantity são strings numéricas
  • updatedAt: instante da captura do snapshot usado na resposta, não a data de alteração do cadastro
  • metadata consolida os totais de todas as posições que atendem aos filtros, não apenas as da página atual — somados com duas casas decimais independentemente do currency de cada posição, também como strings decimais

On this page