Procurando a documentação anterior?Acesse v1.docs.pluggy.ai
PluggyDocs
GET/investments/{id}

Recuperar

Recupera o recurso de investimento pelo seu id

Parameters

Path Parameters

NameType
idrequired
string (uuid)

Responses

200Recuperar um investimento.
object

Investimento representando um ativo específico

idrequiredstring

Identificador principal

itemIdrequiredstring (uuid)

Identificador do item vinculado ao investimento

typerequiredstring

Classe de ativos de investimento. - `MUTUAL_FUND`: fundos de investimento em grupo geridos ativamente (FIM, FIA, FIC). - `EQUITY`: ações e ativos semelhantes a ações negociados em uma bolsa de valores. - `ETF`: Fundos de Índice Negociados em Bolsa. - `FIXED_INCOME`: produtos de renda fixa, como CDB, LCI, LCA, debêntures, Tesouro Direto. - `COE`: Certificado de Operações Estruturadas (notas estruturadas). - `SECURITY`: produtos de previdência privada (PGBL, VGBL). - `OTHER`: qualquer ativo não coberto pelas categorias acima.

COEEQUITYETFFIXED_INCOMEMUTUAL_FUNDSECURITYOTHER
subtypestring | null

Instrumento específico dentro de um `type`. Agrupamentos possíveis: **EQUITY**: `STOCK` (ação), `BDR` (Brazilian Depositary Receipt), `REAL_ESTATE_FUND` (FII), `DERIVATIVES`, `OPTION`. **ETF**: `ETF`. **FIXED_INCOME**: `TREASURY` (Tesouro Direto), `CDB`, `LCI`, `LCA`, `LC`, `LF`, `CRI`, `CRA`, `DEBENTURES`, `CORPORATE_DEBT`. **MUTUAL_FUND**: `INVESTMENT_FUND`, `MULTIMARKET_FUND`, `FIXED_INCOME_FUND`, `STOCK_FUND`, `ETF_FUND`, `OFFSHORE_FUND`, `FIP_FUND`, `EXCHANGE_FUND`, `FI_INFRA`, `FI_AGRO`. **COE**: `STRUCTURED_NOTE`. **SECURITY**: `RETIREMENT` (PGBL/VGBL). **OTHER**: `OTHER`.

STRUCTURED_NOTESTOCKETFREAL_ESTATE_FUNDBDRDERIVATIVESOPTIONTREASURYLCILCALFCDBCRICRACORPORATE_DEBTLCDEBENTURESINVESTMENT_FUNDMULTIMARKET_FUNDFIXED_INCOME_FUNDSTOCK_FUNDETF_FUNDOFFSHORE_FUNDFIP_FUNDEXCHANGE_FUNDFI_INFRAFI_AGRORETIREMENTOTHERnull
numberstring | null

Número de referência para o ativo deste titular

balancerequirednumber (double)

O valor atual do saldo líquido do investimento

namerequiredstring

Nome no provedor

lastMonthRatenumber (double) | null

A taxa de desempenho do investimento no último mês

lastTwelveMonthsRatenumber (double) | null

A taxa de desempenho do investimento nos últimos 12 meses

annualRatenumber (double) | null

A taxa de desempenho do investimento no último ano

currencyCoderequiredstring

Código ISO da moeda para os valores

codestring | null

Código associado para o investimento. Por exemplo, o código de um fundo mútuo é o CNPJ.

isinstring | null

ISIN de 12 caracteres, um identificador globalmente único

valuenumber (double) | null

Valor atual da cota em "data"

quantitynumber (double) | null

Quantidade de cota disponível

amountnumber (double) | null

Valor bruto do investimento

taxesnumber (double) | null

Impostos sobre a renda aplicados ao investimento

taxes2number (double) | null

Impostos financeiros aplicados ao investimento

daterequiredstring (date-time)

Data da cota do valor

ownerstring | null

Proprietário/beneficiário associado ao investimento

amountProfitnumber (double) | null

Lucro/Prejuízo até a data sobre o investimento

amountWithdrawalnumber (double) | null

O valor disponível para saque

amountOriginalnumber (double) | null

Valor originalmente investido

metadataobject | null

Detalhes sobre Portabilidade de Segurança

Any of:
option 1object

Metadados de investimento para migrações de Previdência

option 2null | null
dueDatestring (date-time) | null

Data de Expiração

issuerstring | null

A entidade que emitiu o investimento

issuerCNPJstring | null

A entidade CNPJ que emitiu o investimento

issueDatestring (date-time) | null

A data em que o investimento foi emitido

purchaseDatestring (date-time) | null

A data em que o investimento foi adquirido

gracePeriodDatestring (date-time) | null

A data em que o período de carência termina (apenas para investimentos de renda fixa)

ratenumber (double) | null

Percentual de taxa fixa aplicado ao investimento

rateTypestring | null

Tipo de taxa fixa

fixedAnnualRatenumber (double) | null

Taxa anual de renda fixa

taxExemptboolean | null

Se o produto é isento de impostos (LCI, LCA, CRI, CRA, debêntures incentivadas)

ratePeriodicitystring | null

Periodicidade da taxa de remuneração (DIÁRIA, MENSAL, SEMESTRAL, ANUAL)

indexerAdditionalInfostring | null

Descrição do indexador de texto livre quando o indexador é não padrão

priceFactornumber (double) | null

Fator de conversão de lote/preço B3 (renda variável)

debtorobject | null

Devedor subjacente de papel lastreado em recebíveis (CRI / CRA)

namestring

Name of the underlying debtor

couponPaymentobject | null

Cronograma de pagamento de cupons para títulos de renda fixa / títulos do Tesouro com pagamento de cupons

hasCouponboolean

Whether the paper pays periodic coupons

periodicitystring

Frequency of coupon payments (MONTHLY, QUARTERLY, SEMESTERLY, YEARLY, IRREGULAR)

additionalInfostring

Free-text detail when periodicity is IRREGULAR

statusstring | null

Status atual do ciclo de vida do investimento. - `ACTIVE`: o investimento está aberto e atualmente é mantido pelo proprietário. - `PENDING`: a operação foi solicitada, mas ainda não foi liquidada (por exemplo, uma assinatura de fundo dentro da janela de liquidação). - `TOTAL_WITHDRAWAL`: a posição foi totalmente resgatada/retirada; o saldo é zero.

ACTIVEPENDINGTOTAL_WITHDRAWALnull
createdAtstring (date-time)

Data em que o investimento foi inicialmente registrado pelo Pluggy.

updatedAtstring (date-time)

Data da última atualização dos dados de investimento.

institutionobject | null

Instituição financeira que detém o investimento.

Any of:
option 1object

Instituição financeira que detém o investimento

option 2null | null
transactionsobject[]

Movimentações do investimento. Presente apenas em endpoints que retornam transações inline; use `GET /investments/{id}/transactions` caso contrário.

itemsobject

Movimentação do investimento

Example response

json
{
  "id": "f77eccf4-7714-498e-92a9-1bebe70335d9",
  "code": "22.222.222/0001-22",
  "name": "Bahia AM Advisory FIC de FIM",
  "balance": 1359.39,
  "currencyCode": "BRL",
  "type": "MUTUAL_FUND",
  "subtype": "MULTIMARKET_FUND",
  "lastMonthRate": 0.24,
  "annualRate": 3.24,
  "lastTwelveMonthsRate": 3,
  "itemId": "207f5bcd-312a-439c-abbe-166b6632c980",
  "value": 500,
  "quantity": 3,
  "amount": 1500,
  "taxes": 40.61,
  "taxes2": 100,
  "date": "2020-07-19T18:27:41.802Z",
  "owner": "John Doe",
  "number": null,
  "amountProfit": 310.5,
  "amountWithdrawal": 1310.5,
  "amountOriginal": 1000,
  "status": "ACTIVE",
  "transactions": [
    {
      "tradeDate": "2020-10-01T00:00:00.000Z",
      "date": "2020-10-01T00:00:00.000Z",
      "description": "Aplicação Fondo de Investimento Premium",
      "quantity": 1.25,
      "value": 2,
      "amount": 5,
      "type": "BUY",
      "movementType": "CREDIT"
    }
  ]
}
curl -X GET \
  'https://api.pluggy.ai/investments/{id}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY'
Resposta de exemplo
{
  "id": "f77eccf4-7714-498e-92a9-1bebe70335d9",
  "code": "22.222.222/0001-22",
  "name": "Bahia AM Advisory FIC de FIM",
  "balance": 1359.39,
  "currencyCode": "BRL",
  "type": "MUTUAL_FUND",
  "subtype": "MULTIMARKET_FUND",
  "lastMonthRate": 0.24,
  "annualRate": 3.24,
  "lastTwelveMonthsRate": 3,
  "itemId": "207f5bcd-312a-439c-abbe-166b6632c980",
  "value": 500,
  "quantity": 3,
  "amount": 1500,
  "taxes": 40.61,
  "taxes2": 100,
  "date": "2020-07-19T18:27:41.802Z",
  "owner": "John Doe",
  "number": null,
  "amountProfit": 310.5,
  "amountWithdrawal": 1310.5,
  "amountOriginal": 1000,
  "status": "ACTIVE",
  "transactions": [
    {
      "tradeDate": "2020-10-01T00:00:00.000Z",
      "date": "2020-10-01T00:00:00.000Z",
      "description": "Aplicação Fondo de Investimento Premium",
      "quantity": 1.25,
      "value": 2,
      "amount": 5,
      "type": "BUY",
      "movementType": "CREDIT"
    }
  ]
}