PluggyDocs
GET/investments/{id}

Retrieve

Recovers the investment resource by its id

Parameters

Path Parameters

NameType
idrequired
string (uuid)

Responses

200Retrieve an investment.
object

Investment representing a specific asset

idrequiredstring

Primary identifier

itemIdrequiredstring (uuid)

Identifier of the item linked to the investment

typerequiredstring

Investment asset class. - `MUTUAL_FUND`: actively managed pooled investment funds (FIM, FIA, FIC). - `EQUITY`: stocks and equity-like assets traded on a stock exchange. - `ETF`: Exchange Traded Funds. - `FIXED_INCOME`: fixed income products such as CDB, LCI, LCA, debentures, Tesouro Direto. - `COE`: Certificado de Operações Estruturadas (structured notes). - `SECURITY`: private pension / previdência products (PGBL, VGBL). - `OTHER`: any asset not covered by the categories above.

COEEQUITYETFFIXED_INCOMEMUTUAL_FUNDSECURITYOTHER
subtypestring

Specific instrument within a `type`. Possible groupings: **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_AGRORETIREMENTOTHER
numberstring

Reference number for this holder's asset

balancerequirednumber (double)

The current net balance amount of the investment

namerequiredstring

Name on the provider

lastMonthRatenumber (double)

The performance rate of the investment in the last month

lastTwelveMonthsRatenumber (double)

The performance rate of the investment in the last 12 months

annualRatenumber (double)

The performance rate of the investment in the last year

currencyCoderequiredstring

Currency ISO code for the amounts

codestring

Associated Code for the investment. For example, the code for a mutual fund is the CNPJ

isinstring

12-character ISIN, a globally unique identifier

valuenumber (double)

Quota's current value at "date"

quantitynumber (double)

Quantity of quota at disposal

amountnumber (double)

Gross amount of the investment

taxesnumber (double)

Income taxes applied to the investment

taxes2number (double)

Financial taxes applied to the investment

daterequiredstring (date-time)

Value's quota date

ownerstring

Owner/beneficiary associated with the investment

amountProfitnumber (double)

Profit/Loss to date over the investment

amountWithdrawalnumber (double)

The amount available to withdraw

amountOriginalnumber (double)

Amount originally invested

metadataobject

Security Portability details

All of:
part 1object

Investment metadata for Previdencia migrations

dueDatestring (date-time)

Expiration Date

issuerstring

The entity that issued the investment

issuerCNPJstring

The entity CNPJ that issued the investment

issueDatestring (date-time)

The date that the investment was issued

purchaseDatestring (date-time)

The date that the investment was purchased

gracePeriodDatestring (date-time) | null

The date when the grace period ends (fixed-income investments only)

ratenumber (double)

Fixed rate percentage applied to the investment

rateTypestring

Type of fixed-rate

fixedAnnualRatenumber (double)

Fixed income annual rate

taxExemptboolean

Whether the product is tax-exempt (LCI, LCA, CRI, CRA, debêntures incentivadas)

ratePeriodicitystring

Periodicity of the remuneration rate (DAILY, MONTHLY, SEMESTERLY, YEARLY)

indexerAdditionalInfostring

Free-text indexer description when the indexer is non-standard

priceFactornumber (double)

B3 lot/price conversion factor (variable income)

debtorobject

Underlying debtor of receivables-backed paper (CRI / CRA)

namestring

Name of the underlying debtor

couponPaymentobject

Coupon-payment schedule for coupon-bearing fixed income / Treasury bonds

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

Current lifecycle status of the investment. - `ACTIVE`: the investment is open and currently held by the owner. - `PENDING`: the operation has been requested but is not yet settled (e.g. a fund subscription within the settlement window). - `TOTAL_WITHDRAWAL`: the position has been fully redeemed/withdrawn; balance is zero.

ACTIVEPENDINGTOTAL_WITHDRAWAL

Example response

json
{
  "id": "f77eccf4-7714-498e-92a9-1bebe70335d9",
  "code": "12.345.678/0001-00",
  "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"
    }
  ]
}

Code Examples

bash
curl -X GET 'https://api.pluggy.ai/investments/{id}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY'

Try It

Path Parameters