GET
Recuperar investimento

Authorizations

X-API-KEY
string
header
required

Chave de API obrigatória em todos os endpoints. Envie no header X-API-KEY: <apiKey>.

Path Parameters

id
string<uuid>
required

Identificador primário do investimento.

Response

Objeto Investment.

Posição de investimento coletada para um item.

id
string
required

Identificador primário.

itemId
string<uuid>
required

Item ao qual a posição pertence.

type
enum<string>
required

Tipo do investimento. MUTUAL_FUND = fundos (FIM, FIA, FIC); EQUITY = ações e equivalentes; ETF; FIXED_INCOME = CDB, LCI, LCA, debêntures, Tesouro; COE = notas estruturadas; SECURITY = previdência (PGBL/VGBL); OTHER = demais.

Available options:
COE,
EQUITY,
ETF,
FIXED_INCOME,
MUTUAL_FUND,
SECURITY,
OTHER
name
string
required

Nome no provedor.

balance
number
required

Saldo líquido atual (valor de mercado) da posição.

currencyCode
string
required

Código ISO 4217.

date
string<date-time>
required

Data da cota/referência.

subtype
enum<string> | null

Subtipo do investimento.

Available options:
STRUCTURED_NOTE,
STOCK,
ETF,
REAL_ESTATE_FUND,
BDR,
DERIVATIVES,
OPTION,
TREASURY,
LCI,
LCA,
LF,
CDB,
CRI,
CRA,
CORPORATE_DEBT,
LC,
DEBENTURES,
INVESTMENT_FUND,
MULTIMARKET_FUND,
FIXED_INCOME_FUND,
STOCK_FUND,
ETF_FUND,
OFFSHORE_FUND,
FIP_FUND,
EXCHANGE_FUND,
FI_INFRA,
FI_AGRO,
RETIREMENT,
OTHER,
null
number
string | null

Número de referência do ativo do titular.

code
string | null

Código associado — para fundos é o CNPJ.

isin
string | null

ISIN de 12 caracteres.

amount
number | null

Valor bruto.

value
number | null

Valor da cota em date.

quantity
number | null

Cotas disponíveis.

taxes
number | null

Imposto de renda (IR).

taxes2
number | null

Imposto financeiro (IOF).

owner
string | null

Titular.

amountProfit
number | null

Lucro/prejuízo até a data.

amountWithdrawal
number | null

Valor disponível para resgate.

amountOriginal
number | null

Valor originalmente investido.

lastMonthRate
number | null

Performance do último mês.

lastTwelveMonthsRate
number | null

Performance dos últimos 12 meses.

annualRate
number | null

Performance do último ano.

rate
number | null

Taxa fixa percentual aplicada (ex.: 30 = 30% do CDI).

rateType
string | null

Tipo da taxa fixa (ex.: CDI).

fixedAnnualRate
number | null

Taxa anual de renda fixa.

dueDate
string<date-time> | null

Data de vencimento.

issueDate
string<date-time> | null

Data de emissão.

purchaseDate
string<date-time> | null

Data de compra.

gracePeriodDate
string<date-time> | null

Fim do período de carência (apenas renda fixa).

issuer
string | null

Entidade emissora.

issuerCNPJ
string | null

CNPJ do emissor.

status
enum<string> | null

ACTIVE (aberto, em posse), PENDING (solicitado, não liquidado), TOTAL_WITHDRAWAL (totalmente resgatado; saldo zero).

Available options:
ACTIVE,
PENDING,
TOTAL_WITHDRAWAL,
null
metadata
object | null

Detalhes de previdência/portabilidade.