跳到主要内容

获取投资者持仓信息

分页返回投资者在其持有份额的每个发行系列中的持仓。

适用范围
角色主机所需权限
管理人manager-api读取

各主机的 Base URL：环境（主机）。

Request​

ENDPOINT
/quota/investor/INVESTOR_KEY/investor_positions
MÉTODO
GET

Query Params​

参数类型描述
issuance_serie_keystring按发行系列筛选
fund_class_document_numberstring按基金类别 CNPJ 筛选
only_active_fundsbooleantrue 时仅返回投资者持有份额（数量大于零）的系列。默认：false
number_of_quotas_strbooleantrue 时以字符串返回份额数量，不损失精度。默认：false
pageinteger页码，从 0 开始。默认：0
limitinteger每页条数。默认：20；最大：100

当 is_last_page 为 false 时，递增 page 以遍历各页。

Responses​

STATUS
200
案例 01：投资者仅持有一个单一份额（COTA ÚNICA）系列的持仓
{
    "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
}
案例 02：投资者仅持有一个优先份额（COTA SÊNIOR）系列的持仓
{
    "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
}
案例 03：投资者持有两个系列的持仓，一个优先份额（COTA SÊNIOR）和一个次级份额（COTA SUBORDINADA）
{
   "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
}

响应字段​

字段类型描述
dataarrayInvestor Position 对象列表
limitint每页返回的对象数量上限
pageint返回的页码
is_last_pageboolean表示返回的页是否为最后一页

Investor Position​

字段类型描述
investorJSONInvestor 对象
number_of_quotasfloat投资者在该系列中的份额数量
number_of_quotas_strstring同一数值的字符串形式。仅在 number_of_quotas_str=true 时返回
quota_valuefloat该系列最近一次结算的份额价值。若该系列尚无结算则不返回
issuance_serieJSONIssuance Serie 对象
investor_position_keystring投资者持仓唯一标识键

Investor​

字段类型描述字符数
namestring投资者姓名最多 255
investor_keystring投资者唯一标识键36
document_numberstring投资者 CPF/CNPJ14 或 18
person_typestring自然人 / 法人 / 基金类别最多 50
investor_sub_typestring默认 / 金融机构最多 50
distributorJSONDistributor 对象-
account_dataJSONAccount Data 对象-

Distributor​

字段类型描述字符数
namestring分销商名称最多 255
distributor_keystring分销商唯一标识键-
document_numberstring分销商 CPF/CNPJ14 或 18
account_dataJSONAccount Data 对象-

Account Data​

字段类型描述
account_digitstring银行账号校验位
account_branchstring银行账户支行号
account_numberstring银行账号
financial_institution_codestring金融机构代码
financial_institution_ispbstring金融机构在巴西支付系统中的标识符

Issuance Serie​

字段类型描述字符数
namestring发行系列名称最多 255
issuance_serie_keystring发行系列唯一标识键36
cetip_codestring发行系列在 CETIP 中的资产代码10
start_datestring发行系列起始日期10
maturity_datestring发行系列到期日期10
original_quota_valuefloat原始份额价值-
remuneration_typestring收益曲线 / 剩余最多 50
investment_categorystringFIDC / 多市场最多 50
condominum_typestring开放式 / 封闭式最多 50
tax_classificationstring短期 / 长期最多 50
investment_restriction_typestring无限制 / 合格投资者 / 专业投资者最多 50
minimum_share_capitalfloat最低申购金额-
accounting_datestring发行系列会计日期10
sub_classJSONSub Class 对象-

Sub Class​

字段类型描述字符数
namestring子类别名称最多 255
sub_class_keystring子类别唯一标识键36
subordination_levelint子类别的次级层级-
fund_classJSONFund Class 对象-

Fund Class​

字段类型描述字符数
namestring基金类别名称最多 255
fund_class_keystring基金类别唯一标识键36
document_numberstring基金类别 CNPJ-

错误​

状态代码发生情形
400—limit 超过 100 或 page 为负数

认证、权限和主机相关错误：参见 API 错误。