Skip to main content

Paginated query of quotaholder positions by fund class

A paginated query endpoint that returns the positions by investor and issuance series in a fund class: quotaholders with a quota balance in the financial application, with the quota value taken from the most recent closing of the series. Use document_number to filter a specific quotaholder.

Request​

ENDPOINT
/quota/fund_class/{fund_class_key}/investor_positions
METHOD
GET

Query params​

ParameterTypeRequiredDescription
pageintegeroptionalPage number (starts at 0). Default: 0.
limitintegeroptionalNumber of records per page. Default: 20. Maximum: 100.
document_numberstringoptionalFilters by the investor's document (with punctuation).
Example call
GET /quota/fund_class/{fund_class_key}/investor_positions?page=0&limit=20&document_number=123.456.789-00

Response​

STATUS
200
Response Body
{
  "data": [
    {
      "investor": {
        "distributor": {
          "distributor_key": "3571e292-3a83-4011-904d-20ee963022ef",
          "document_number": "12.345.678/0001-90",
          "name": "Distribuidora Exemplo S.A.",
          "account_data": {
            "owner": {
              "name": "Distribuidora Exemplo S.A.",
              "document_number": "12.345.678/0001-90"
            },
            "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": "123.456.789-00",
        "external_id": "ext-inv-001",
        "external_distribution_key": null
      },
      "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": "12.345.678/0001-90",
            "fund_class_key": "e5f6a7b8-c9d0-1234-ef01-345678901234",
            "accounting_date": "2024-06-01",
            "sub_type": "fidc",
            "tax_classification_id": "long_term",
            "condominum_type_id": "open_ended",
            "investment_category_id": "fidc",
            "prevent_payment": false,
            "integralization_account_key": null,
            "manager": {
              "manager_key": "f6a7b8c9-d0e1-2345-f012-456789012345",
              "document_number": "98.765.432/0001-10",
              "manager_name": "Gestora Exemplo S.A."
            }
          }
        },
        "status": "active",
        "internal_code": "INT-FEX-01",
        "processing_method": "standard",
        "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",
        "external_id": null,
        "specific_interest_rate_data": null
      },
      "number_of_quotas": 10000.0,
      "quota_value": 1.05234567
    }
  ],
  "limit": 20,
  "page": 0,
  "is_last_page": true
}

Response attributes​

FieldTypeDescription
dataarrayList of positions. Each item aggregates the investor, the issuance series, the number of quotas and the quota value (quota_value when a closing exists).
pageintegerCurrent page.
limitintegerRequested page size.
is_last_pagebooleanIndicates whether there are no more records after this page.

Object in data​

FieldTypeDescription
investorobjectData of the quotaholder and of the distributor.
issuance_serieobjectIssuance series of the position, including the nested sub_class and fund_class.
number_of_quotasnumberSum of the quotas of the financial application for that investor and series.
quota_valuenumberQuota value of the most recent closing of the series; omitted if there is no closing available.

Optional or null fields in issuance_serie (such as pre_fixed, external_id, integralization_account_key) may vary according to the registration of the series.

For more context about series, see Paginated query of issuance series.

Possible errors​

STATUS
404
Fund class not found
{
  "title": " Fund Class not Found",
  "description": "Fund Class with key {fund_class_key} was not found.",
  "translation": "A classe com chave {fund_class_key} não foi encontrado.",
  "code": "QTA000002"
}
STATUS
404
Manager not found
{
  "title": "Manager not Found",
  "description": "Manager with Key {manager_key} was not found",
  "translation": "O gestor com chave {manager_key} nao foi encontrado",
  "code": "QTA00053"
}