Retrieving Investor Position Information

Returns, in paginated form, the investor's position in each issuance series in which they hold quotas.

Available on

Profile	Host	Required permission
Manager	`manager-api`	Read

Base URL for each host: Environments (Hosts).

Request

ENDPOINT

/quota/investor/INVESTOR_KEY/investor_positions

METHOD

GET

Query Params

Parameter	Type	Description
`issuance_serie_key`	string	Filters by issuance series
`fund_class_document_number`	string	Filters by the fund class CNPJ
`only_active_funds`	boolean	`true` returns only the series in which the investor holds quotas (quantity greater than zero). Default: `false`
`number_of_quotas_str`	boolean	`true` returns the quota quantities as a string, without loss of precision. Default: `false`
`page`	integer	Page, starting at `0`. Default: `0`
`limit`	integer	Items per page. Default: `20`; maximum: `100`

Go through the pages by incrementing page while is_last_page is false.

Responses

STATUS

200

Case 01: Investor with a Position in only one SINGLE QUOTA series

{
    "data": [
        {
            "investor_position_key":"UUID",
            "investor": {
                "distributor": {
                    "distributor_key": "UUID",
                    "document_number": "33.444.555/0001-81",
                    "name": "SAMPLE DISTRIBUTOR NAME",
                    "account_data": {
                        "owner": {
                            "name": "SAMPLE DISTRIBUTOR NAME",
                            "document_number": "33.444.555/0001-81"
                        },
                        "account_digit": "0",
                        "account_branch": "0000",
                        "account_number": "00000",
                        "financial_institution_code": "000",
                        "financial_institution_ispb": "00000000"
                    }
                },
                "investor_key": "UUID",
                "document_number": "969.698.790-03",
                "name": "SAMPLE INVESTOR NAME",
                "person_type": "natural_person / legal_person / fund_class",
                "account_data": {
                    "account_digit": "0",
                    "account_branch": "0000",
                    "account_number": "00000",
                    "financial_institution_code": "000",
                    "financial_institution_ispb": "00000000"
                },
                "investor_sub_type": "person / financial_institution"
            },
            "number_of_quotas": 1000.0,
            "quota_value": 1.05,
            "issuance_serie": {
                "name": "1",
                "cetip_code": "0000000UN1",
                "start_date": "YYYY-MM-DD",
                "maturity_date": "YYYY-MM-DD",
                "original_quota_value": 0.00000000000000,
                "remuneration_type": "residual",
                "investment_category": "fidc / multi_market",
                "condominum_type": "open_ended / close_ended",
                "tax_classification": "short_term / long_term",
                "investment_restriction_type": "just_professional",
                "issuance_serie_key": "UUID",
                "minimum_share_capital": 0.0,
                "accounting_date": "YYYY-MM-DD",
                "sub_class": {
                    "name": "COTA ÚNICA",
                    "sub_class_key": "UUID",
                    "subordination_level": 0,
                    "fund_class": {
                        "name": "SAMPLE FUND CLASS NAME",
                        "fund_class_key": "UUID",
                        "document_number": "44.555.666/0001-81"
                    }
                }
            }
        }
    ],
    "limit": 20,
    "page": 0,
    "is_last_page": true
}

Case 02: Investor with a Position in only one SENIOR QUOTA series

{
    "data": [
        {
            "investor_position_key":"UUID",
            "investor": {
                "distributor": {
                    "distributor_key": "UUID",
                    "document_number": "33.444.555/0001-81",
                    "name": "SAMPLE DISTRIBUTOR NAME",
                    "account_data": {
                        "owner": {
                            "name": "SAMPLE DISTRIBUTOR NAME",
                            "document_number": "33.444.555/0001-81"
                        },
                        "account_digit": "0",
                        "account_branch": "0000",
                        "account_number": "00000",
                        "financial_institution_code": "000",
                        "financial_institution_ispb": "00000000"
                    }
                },
                "investor_key": "UUID",
                "document_number": "969.698.790-03",
                "name": "SAMPLE INVESTOR NAME",
                "person_type": "natural_person / legal_person / fund_class",
                "account_data": {
                    "account_digit": "0",
                    "account_branch": "0000",
                    "account_number": "00000",
                    "financial_institution_code": "000",
                    "financial_institution_ispb": "00000000"
                },
                "investor_sub_type": "person / financial_institution"
            },
            "number_of_quotas": 1000.0,
            "quota_value": 1.05,
            "issuance_serie": {
                "name": "1",
                "cetip_code": "0000000SN1",
                "start_date": "YYYY-MM-DD",
                "maturity_date": "YYYY-MM-DD",
                "original_quota_value": 0.00000000000000,
                "remuneration_type": "yield_curve",
                "interest_rate_type": "post_fixed",
                "pre_fixed": {
                    "calendar_base": "workdays / calendar_360 / calendar_365",
                    "monthly_rate": 0.00000000000000
                },
                "post_fixed": {
                    "calendar_base": "workdays / calendar_360 / calendar_365",
                    "indexer": "di / ipca",
                    "rate": 1,
                    "lag": {"reference": "daily / monthly", "amount": 1}
                },
                "investment_category": "fidc / multi_market",
                "condominum_type": "open_ended / close_ended",
                "tax_classification": "short_term / long_term",
                "investment_restriction_type": "just_professional",
                "issuance_serie_key": "UUID",
                "minimum_share_capital": 0.0,
                "accounting_date": "YYYY-MM-DD",
                "sub_class": {
                    "name": "COTA SÊNIOR",
                    "sub_class_key": "UUID",
                    "subordination_level": 1,
                    "fund_class": {
                        "name": "SAMPLE FUND CLASS NAME",
                        "fund_class_key": "UUID",
                        "document_number": "44.555.666/0001-81"
                    }
                }
            }
        }
    ],
    "limit": 20,
    "page": 0,
    "is_last_page": true
}

Case 03: Investor with a Position in two series, one SENIOR QUOTA and one SUBORDINATED QUOTA

{
   "data":[
      {
         "investor_position_key":"UUID",
         "investor":{
            "distributor":{
               "distributor_key":"UUID",
               "document_number":"33.444.555/0001-81",
               "name":"SAMPLE DISTRIBUTOR NAME",
               "account_data":{
                  "owner":{
                     "name":"SAMPLE DISTRIBUTOR NAME",
                     "document_number":"33.444.555/0001-81"
                  },
                  "account_digit":"0",
                  "account_branch":"0000",
                  "account_number":"00000",
                  "financial_institution_code":"000",
                  "financial_institution_ispb":"00000000"
               }
            },
            "investor_key":"UUID",
            "document_number":"969.698.790-03",
            "name":"SAMPLE INVESTOR NAME",
            "person_type":"natural_person / legal_person / fund_class",
            "account_data":{
               "account_digit":"0",
               "account_branch":"0000",
               "account_number":"00000",
               "financial_institution_code":"000",
               "financial_institution_ispb":"00000000"
            },
            "investor_sub_type":"person / financial_institution"
         },
         "number_of_quotas": 1000.0,
         "quota_value": 1.05,
         "issuance_serie":{
            "name":"1",
            "cetip_code":"0000000SN1",
            "start_date":"YYYY-MM-DD",
            "maturity_date":"YYYY-MM-DD",
            "original_quota_value":0.00000000000000,
            "remuneration_type":"yield_curve",
            "interest_rate_type":"post_fixed",
            "pre_fixed":{
               "calendar_base":"workdays / calendar_360 / calendar_365",
               "monthly_rate":0.00000000000000
            },
            "post_fixed":{
               "calendar_base":"workdays / calendar_360 / calendar_365",
               "indexer":"di / ipca",
               "rate":1,
               "lag":{
                  "reference":"daily / monthly",
                  "amount":1
               }
            },
            "investment_category":"fidc / multi_market",
            "condominum_type":"open_ended / close_ended",
            "tax_classification":"short_term / long_term",
            "investment_restriction_type":"just_professional",
            "issuance_serie_key":"UUID",
            "minimum_share_capital":0.0,
            "accounting_date":"YYYY-MM-DD",
            "sub_class":{
               "name":"COTA SÊNIOR",
               "sub_class_key":"UUID",
               "subordination_level":1,
               "fund_class":{
                  "name":"SAMPLE FUND CLASS NAME",
                  "fund_class_key":"UUID",
                  "document_number":"44.555.666/0001-81"
               }
            }
         }
      },
      {
         "investor_position_key":"UUID",
         "investor":{
            "distributor":{
               "distributor_key":"UUID",
               "document_number":"33.444.555/0001-81",
               "name":"SAMPLE DISTRIBUTOR NAME",
               "account_data":{
                  "owner":{
                     "name":"SAMPLE DISTRIBUTOR NAME",
                     "document_number":"33.444.555/0001-81"
                  },
                  "account_digit":"0",
                  "account_branch":"0000",
                  "account_number":"00000",
                  "financial_institution_code":"000",
                  "financial_institution_ispb":"00000000"
               }
            },
            "investor_key":"UUID",
            "document_number":"969.698.790-03",
            "name":"SAMPLE INVESTOR NAME",
            "person_type":"natural_person / legal_person / fund_class",
            "account_data":{
               "account_digit":"0",
               "account_branch":"0000",
               "account_number":"00000",
               "financial_institution_code":"000",
               "financial_institution_ispb":"00000000"
            },
            "investor_sub_type":"person / financial_institution"
         },
         "number_of_quotas": 1000.0,
         "quota_value": 1.05,
         "issuance_serie":{
            "name":"1",
            "cetip_code":"0000000JR1",
            "start_date":"YYYY-MM-DD",
            "maturity_date":"YYYY-MM-DD",
            "original_quota_value":0.00000000000000,
            "remuneration_type":"residual",
            "investment_category":"fidc / multi_market",
            "condominum_type":"open_ended / close_ended",
            "tax_classification":"short_term / long_term",
            "investment_restriction_type":"just_professional",
            "issuance_serie_key":"UUID",
            "minimum_share_capital":0.0,
            "accounting_date":"YYYY-MM-DD",
            "sub_class":{
               "name":"COTA SUBORDINADA",
               "sub_class_key":"UUID",
               "subordination_level":0,
               "fund_class":{
                  "name":"SAMPLE FUND CLASS NAME",
                  "fund_class_key":"UUID",
                  "document_number":"44.555.666/0001-81"
               }
            }
         }
      }
   ],
   "limit": 20,
   "page":0,
   "is_last_page":true
}

Response Fields

Field	Type	Description
`data`	array	List of Investor Position objects
`limit`	int	Limit of objects retrieved per page
`page`	int	Number of the retrieved page
`is_last_page`	boolean	Indicates whether the retrieved page is the last one

Investor Position

Field	Type	Description
`investor`	JSON	Investor object
`number_of_quotas`	float	Number of the investor's quotas in the series
`number_of_quotas_str`	string	The same value, as a string. Only returned with `number_of_quotas_str=true`
`quota_value`	float	Quota value at the series' most recent closing. Absent if the series has no closing yet
`issuance_serie`	JSON	Issuance Serie object
`investor_position_key`	string	Unique identification key of the investor position

Investor

Field	Type	Description	Characters
`name`	string	Investor name	up to 255
`investor_key`	string	Unique identification key of the investor	36
`document_number`	string	Investor CPF/CNPJ	14 or 18
`person_type`	string	Natural Person / Legal Entity / Fund Class	up to 50
`investor_sub_type`	string	Default / Financial Institution	up to 50
`distributor`	JSON	Distributor object	-
`account_data`	JSON	Account Data object	-

Distributor

Field	Type	Description	Characters
`name`	string	Distributor name	up to 255
`distributor_key`	string	Unique identification key of the distributor	-
`document_number`	string	Distributor CPF/CNPJ	14 or 18
`account_data`	JSON	Account Data object	-

Account Data

Field	Type	Description
`account_digit`	string	Bank account digit
`account_branch`	string	Bank account branch number
`account_number`	string	Bank account number
`financial_institution_code`	string	Financial institution code
`financial_institution_ispb`	string	Financial institution identifier in the Brazilian Payment System

Issuance Serie

Field	Type	Description	Characters
`name`	string	Issuance series name	up to 255
`issuance_serie_key`	string	Unique identification key of the issuance series	36
`cetip_code`	string	Issuance series code as a CETIP asset	10
`start_date`	string	Issuance series start date	10
`maturity_date`	string	Issuance series maturity date	10
`original_quota_value`	float	Original quota value	-
`remuneration_type`	string	Yield curve / Residual	up to 50
`investment_category`	string	FIDC / Multi-market	up to 50
`condominum_type`	string	Open / Closed	up to 50
`tax_classification`	string	Short term / Long term	up to 50
`investment_restriction_type`	string	No restriction / Qualified / Professional	up to 50
`minimum_share_capital`	float	Minimum investment amount	-
`accounting_date`	string	Issuance series accounting date	10
`sub_class`	JSON	Sub Class object	-

Sub Class

Field	Type	Description	Characters
`name`	string	Sub class name	up to 255
`sub_class_key`	string	Unique identification key of the sub class	36
`subordination_level`	int	Sub class subordination level	-
`fund_class`	JSON	Fund Class object	-

Fund Class

Field	Type	Description	Characters
`name`	string	Fund class name	up to 255
`fund_class_key`	string	Unique identification key of the fund class	36
`document_number`	string	Fund class CNPJ	-

Errors

Status	Code	When it happens
400	—	`limit` above 100 or negative `page`

Authentication, permission and host errors: see API Errors.

Request​

Query Params​

Responses​

Response Fields​

Investor Position​

Investor​

Distributor​

Account Data​

Issuance Serie​

Sub Class​

Fund Class​

Errors​