GET
Listar investimentos

Authorizations

X-API-KEY
string
header
required

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

Query Parameters

itemId
string<uuid>
required

Identificador primário do item.

type
enum<string>

Filtra por tipo de investimento.

Available options:
COE,
EQUITY,
ETF,
FIXED_INCOME,
MUTUAL_FUND,
SECURITY,
OTHER
pageSize
integer
default:500

Tamanho da página. Padrão 500.

page
integer
default:1

Página (1-based). Padrão 1.

Response

Página de investimentos.

Envelope de paginação por página. Os campos são números (nunca strings). totalPages é 1 quando há uma única página.

page
integer
required

Página atual (1-based).

total
integer
required

Total de resultados em todas as páginas.

totalPages
integer
required

Número total de páginas.

results
object[]
required

Lista de recursos da página.