跳到主要内容

Consulta paginada de posições de cotistas por classe de fundo

Endpoint de consulta paginada que retorna as posições por investidor e série de emissão em uma classe de fundo: cotistas com saldo de cotas na aplicação financeira, com valor de cota obtido do fechamento mais recente da série. Utilize document_number para filtrar um cotista específico.

Disponível em
PerfilHostPermissão exigida
Gestoramanager-apiLeitura

URL base de cada host: Ambientes (Hosts).

Request​

ENDPOINT
/quota/fund_class/{fund_class_key}/investor_positions
MÉTODO
GET

Query params​

ParâmetroTipoObrigatoriedadeDescrição
pageintegeropcionalNúmero da página (começa em 0). Padrão: 0.
limitintegeropcionalQuantidade de registros por página. Padrão: 20. Máximo: 100.
document_numberstringopcionalFiltra pelo documento do investidor (com pontuação).
Exemplo de chamada
GET /quota/fund_class/{fund_class_key}/investor_positions?page=0&limit=20&document_number=969.698.790-03

Response​

STATUS
200
Response Body
{
"data": [
{
"investor": {
"distributor": {
"distributor_key": "3571e292-3a83-4011-904d-20ee963022ef",
"document_number": "11.222.333/0001-81",
"name": "Distribuidora Exemplo S.A.",
"account_data": {
"owner": {
"name": "Distribuidora Exemplo S.A.",
"document_number": "11.222.333/0001-81"
},
"account_digit": "1",
"account_branch": "0001",
"account_number": "12345",
"financial_institution_code": "341",
"financial_institution_ispb": "60746948"
}
},
"investor_key": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "Maria Cotista Silva",
"person_type": "natural_person",
"document_number": "969.698.790-03",
"external_id": "ext-inv-001"
},
"issuance_serie": {
"issuance_serie_key": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"original_quota_value": 1.0,
"current_number_of_quotas": 500000.0,
"current_net_worth": 525000.75,
"current_principal_value": 500000.0,
"performance_fee_current_value": 0.0,
"remuneration_type": "yield_curve",
"minimum_share_capital": 1000.0,
"interest_rate_type": "post_fixed",
"name": "Série Única",
"serie": 1,
"sub_class": {
"name": "Cota Sênior",
"sub_class_key": "d4e5f6a7-b8c9-0123-def0-234567890123",
"subordination_level": 1,
"fund_class": {
"name": "Fundo Exemplo FIDC",
"short_name": "FEX",
"document_number": "11.222.333/0001-81",
"fund_class_key": "e5f6a7b8-c9d0-1234-ef01-345678901234",
"accounting_date": "2024-06-01",
"sub_type": "regular",
"tax_classification": "long_term",
"condominum_type": "open_ended",
"prevent_payment": false,
"manager": {
"manager_key": "f6a7b8c9-d0e1-2345-f012-456789012345",
"document_number": "11.222.333/0001-81",
"manager_name": "Gestora Exemplo S.A."
}
}
},
"status": "active",
"internal_code": "INT-FEX-01",
"operation_period_configuration": {
"subscription": {},
"redemption": {}
},
"current_quota_value": 1.0500015,
"post_fixed": {
"calendar_base": "calendar_252",
"indexer": "cdi",
"rate": 1.0,
"lag": {
"reference": "daily",
"amount": 1
}
},
"isin_code": "BRSTREXTFID6",
"water_mark_events": []
},
"number_of_quotas": 10000.0,
"quota_value": 1.05234567
}
],
"limit": 20,
"page": 0,
"is_last_page": true
}

Atributos da resposta​

CampoTipoDescrição
dataarrayLista de posições. Cada item agrega investidor, série de emissão, quantidade de cotas e valor de cota (quota_value quando existir fechamento).
pageintegerPágina atual.
limitintegerTamanho da página solicitado.
is_last_pagebooleanIndica se não há mais registros após esta página.

Objeto em data​

CampoTipoDescrição
investorobjectDados do cotista e da distribuidora.
issuance_serieobjectSérie de emissão da posição, incluindo sub_class e fund_class aninhados.
number_of_quotasnumberSoma das cotas da aplicação financeira para aquele investidor e série.
quota_valuenumberValor de cota do fechamento mais recente da série; omitido se não houver fechamento disponível.

Campos opcionais de issuance_serie (como pre_fixed, post_fixed, isin_code, external_id) só aparecem quando preenchidos no cadastro da série.

Só entram posições com saldo de cotas maior que zero, em fundos da gestora da integração. Um fundo de outra gestora devolve lista vazia.

Para mais contexto sobre séries, consulte Consulta paginada de séries de emissão.

Erros​

StatusCódigoQuando acontece
404QTA000002Classe de fundo não encontrada
404QTA00053Gestora da integração não encontrada

Erros de autenticação, permissão e host: veja Erros da API.