Recuperando Informações da Posição do Investidor

Retorna, de forma paginada, a posição do investidor em cada série de emissão em que ele tem cotas.

Disponível em

Perfil	Host	Permissão exigida
Gestora	`manager-api`	Leitura

URL base de cada host: Ambientes (Hosts).

Request

ENDPOINT

/quota/investor/INVESTOR_KEY/investor_positions

MÉTODO

GET

Query Params

Parâmetro	Tipo	Descrição
`issuance_serie_key`	string	Filtra pela série de emissão
`fund_class_document_number`	string	Filtra pelo CNPJ da classe de fundo
`only_active_funds`	boolean	`true` retorna só as séries em que o investidor tem cotas (quantidade maior que zero). Default: `false`
`number_of_quotas_str`	boolean	`true` devolve as quantidades de cotas como string, sem perda de precisão. Default: `false`
`page`	integer	Página, a partir de `0`. Default: `0`
`limit`	integer	Itens por página. Default: `20`; máximo: `100`

Percorra as páginas incrementando page enquanto is_last_page for false.

Responses

STATUS

200

Caso 01: Investidor com Posição em somente uma série de 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
}

Caso 02: Investidor com Posição em somente uma série de 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
}

Caso 03: Investidor com Posição em duas séries, uma COTA SÊNIOR e uma 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
}

Response Fields

Campo	Tipo	Descrição
`data`	array	Lista de objetos de Investor Position
`limit`	int	Limite de objetos recuperados por página
`page`	int	Número da página recuperada
`is_last_page`	boolean	Informação que indica se a página recuperada é a última

Investor Position

Campo	Tipo	Descrição
`investor`	JSON	Objeto de Investor
`number_of_quotas`	float	Número de cotas do investidor na série
`number_of_quotas_str`	string	O mesmo valor, como string. Só vem com `number_of_quotas_str=true`
`quota_value`	float	Valor da cota no fechamento mais recente da série. Ausente se a série ainda não tem fechamento
`issuance_serie`	JSON	Objeto de Issuance Serie
`investor_position_key`	string	Chave única de identificação da posição do investidor

Investor

Campo	Tipo	Descrição	Caracteres
`name`	string	Nome do investidor	até 255
`investor_key`	string	Chave única de identificação do investidor	36
`document_number`	string	CPF/CNPJ do investidor	14 ou 18
`person_type`	string	Pessoa Física / Pessoa Jurídica / Classe de Fundo	até 50
`investor_sub_type`	string	Default / Instituição Financeira	até 50
`distributor`	JSON	Objeto de Distributor	-
`account_data`	JSON	Objeto de Account Data	-

Distributor

Campo	Tipo	Descrição	Caracteres
`name`	string	Nome do distribuidor	até 255
`distributor_key`	string	Chave única de identificação do distribuidor	-
`document_number`	string	CPF/CNPJ do distribuidor	14 ou 18
`account_data`	JSON	Objeto de Account Data	-

Account Data

Campo	Tipo	Descrição
`account_digit`	string	Dígito da conta bancária
`account_branch`	string	N° da agência da conta bancária
`account_number`	string	N° da conta bancária
`financial_institution_code`	string	Código da instituição financeira
`financial_institution_ispb`	string	Identificador no Sistema de Pagamento Brasileiro da instituição financeira

Issuance Serie

Campo	Tipo	Descrição	Caracteres
`name`	string	Nome da série de emissão	até 255
`issuance_serie_key`	string	Chave única de identificação da série de emissão	36
`cetip_code`	string	Código da série de emissão como ativo na CETIP	10
`start_date`	string	Data de início da série de emissão	10
`maturity_date`	string	Data de vencimento da série de emissão	10
`original_quota_value`	float	Valor de cota original	-
`remuneration_type`	string	Curva de rendimento / Residual	até 50
`investment_category`	string	FIDC / Multimercado	até 50
`condominum_type`	string	Aberto / Fechado	até 50
`tax_classification`	string	Curto prazo / Longo prazo	até 50
`investment_restriction_type`	string	Sem restrição / Qualificado / Profissional	até 50
`minimum_share_capital`	float	Valor mínimo para aplicação	-
`accounting_date`	string	Data contábil da série de emissão	10
`sub_class`	JSON	Objeto de Sub Class	-

Sub Class

Campo	Tipo	Descrição	Caracteres
`name`	string	Nome da sub classe	até 255
`sub_class_key`	string	Chave única de identificação da sub classe	36
`subordination_level`	int	Nível de subordinação da sub classe	-
`fund_class`	JSON	Objeto de Fund Class	-

Fund Class

Campo	Tipo	Descrição	Caracteres
`name`	string	Nome da classe de fundo	até 255
`fund_class_key`	string	Chave única de identificação da classe de fundo	36
`document_number`	string	CNPJ da classe de fundo	-

Erros

Status	Código	Quando acontece
400	—	`limit` acima de 100 ou `page` negativo

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

Request​

Query Params​

Responses​

Response Fields​

Investor Position​

Investor​

Distributor​

Account Data​

Issuance Serie​

Sub Class​

Fund Class​

Erros​