openapi: 3.0.0 info: title: API Investments - Open Finance Brasil description: | Estas APIs visam o compartilhamento de dados sobre Investimentos e suas características entre as Instituições Financeiras participantes do Open Finance Brasil version: 1.0.0-rc2.0 license: name: Apache 2.0 url: 'https://www.apache.org/licenses/LICENSE-2.0' contact: name: Governança do Open Finance Brasil – Especificações email: gt-interfaces@openbankingbr.org url: 'https://openbanking-brasil.github.io/areadesenvolvedor/' servers: - url: 'https://api.banco.com.br/open-banking/opendata-investments/v1' description: Servidor de Produção - url: 'https://apih.banco.com.br/open-banking/opendata-investments/v1' description: Servidor de Homologação tags: - name: Funds description: Método para obter a lista de Fundos de Investimentos - name: Bank Fixed Incomes description: 'Método para obter a lista de produtos de Renda Fixa Bancária (CDB, RDB, LCI e LCA)' - name: Credit Fixed Incomes description: 'Método para obter a lista de produtos de Renda Fixa Crédito (Debênture, CRI e CRA)' - name: Variable Incomes description: Método para obter a lista de informações de produtos de Renda Variável (Ações e Fundos de Índices) - name: Treasure Titles description: Método para obter informações de Títulos do Tesouro Direto paths: /funds: get: tags: - Funds summary: Conjunto de informações dos Fundos de Investimentos operationId: investmentsGetFunds description: Método para obter a lista de Fundos de Investimentos parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/pageSize' responses: '200': $ref: '#/components/responses/OKResponseInvestmentsFund' '400': $ref: '#/components/responses/BadRequest' '404': $ref: '#/components/responses/NotFound' '405': $ref: '#/components/responses/MethodNotAllowed' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' /bank-fixed-incomes: get: tags: - Bank Fixed Incomes summary: 'Conjunto de informações de produtos de Renda Fixa Bancária (CDB, RDB, LCI e LCA)' operationId: investmentsGetFixedIncomeBank description: 'Método para obter a lista de produtos de Renda Fixa Bancária (CDB, RDB, LCI e LCA)' parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/pageSize' responses: '200': $ref: '#/components/responses/OKResponseInvestmentsFixedIncomeBank' '400': $ref: '#/components/responses/BadRequest' '404': $ref: '#/components/responses/NotFound' '405': $ref: '#/components/responses/MethodNotAllowed' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' /credit-fixed-incomes: get: tags: - Credit Fixed Incomes summary: 'Conjunto de informações de produtos de Renda Fixa Crédito (Debênture, CRI e CRA)' operationId: investmentsGetFixedIncomeCredit description: 'Método para obter a lista de produtos de Renda Fixa Crédito (Debênture, CRI e CRA)' parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/pageSize' responses: '200': $ref: '#/components/responses/OKResponseInvestmentsFixedIncomeCredit' '400': $ref: '#/components/responses/BadRequest' '404': $ref: '#/components/responses/NotFound' '405': $ref: '#/components/responses/MethodNotAllowed' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' /variable-incomes: get: tags: - Variable Incomes summary: Conjunto de informações de produtos de Renda Variável (Ações e Fundos de Índices) operationId: investmentsGetVariableIncome description: Método para obter a lista de informações de produtos de Renda Variável (Ações e Fundos de Índices) parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/pageSize' responses: '200': $ref: '#/components/responses/OKResponseInvestmentsVariableIncome' '400': $ref: '#/components/responses/BadRequest' '404': $ref: '#/components/responses/NotFound' '405': $ref: '#/components/responses/MethodNotAllowed' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' /treasure-titles: get: tags: - Treasure Titles summary: Conjunto de informações de Títulos do Tesouro Direto operationId: investmentsGetTreasure description: Método para obter informações de Títulos do Tesouro Direto parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/pageSize' responses: '200': $ref: '#/components/responses/OKResponseInvestmentsTreasure' '400': $ref: '#/components/responses/BadRequest' '404': $ref: '#/components/responses/NotFound' '405': $ref: '#/components/responses/MethodNotAllowed' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' components: schemas: OKResponseInvestmentsFund: type: object required: - data - links - meta properties: data: type: array items: $ref: '#/components/schemas/InvestmentsFund' links: $ref: '#/components/schemas/Links' meta: $ref: '#/components/schemas/OpenDataMeta' additionalProperties: false OKResponseInvestmentsFixedIncomeBank: type: object required: - data - links - meta properties: data: type: array items: $ref: '#/components/schemas/InvestmentsFixedIncomeBank' links: $ref: '#/components/schemas/Links' meta: $ref: '#/components/schemas/OpenDataMeta' additionalProperties: false OKResponseInvestmentsFixedIncomeCredit: type: object required: - data - links - meta properties: data: type: array items: $ref: '#/components/schemas/InvestmentsFixedIncomeCredit' links: $ref: '#/components/schemas/Links' meta: $ref: '#/components/schemas/OpenDataMeta' additionalProperties: false OKResponseInvestmentsVariableIncome: type: object required: - data - links - meta properties: data: type: array items: $ref: '#/components/schemas/InvestmentsVariableIncome' example: - participant: brand: Organização name: Organização A1 cnpjNumber: '13456789000112' urlComplementaryList: 'https://empresaa1.com/companies' investmentType: ACOES custodyFee: prices: - interval: 1_FAIXA value: '0.020300' operationRate: '0.500000' - interval: 2_FAIXA value: '0.030600' operationRate: '0.100000' - interval: 3_FAIXA value: '0.034300' operationRate: '0.300000' - interval: 4_FAIXA value: '0.246800' operationRate: '0.100000' minimum: '0.010000' maximum: '0.300000' loadingRate: prices: - interval: 1_FAIXA value: '0.020300' operationRate: '0.500000' - interval: 2_FAIXA value: '0.030600' operationRate: '0.100000' - interval: 3_FAIXA value: '0.034300' operationRate: '0.300000' - interval: 4_FAIXA value: '0.246800' operationRate: '0.100000' minimum: '0.010000' maximum: '0.300000' targetAudience: PESSOA_JURIDICA - participant: brand: Organização name: Organização A1 cnpjNumber: '13456789000112' urlComplementaryList: 'https://empresaa1.com/companies' investmentType: FUNDO_INDICES custodyFee: prices: - interval: 1_FAIXA value: '0.020300' operationRate: '0.500000' - interval: 2_FAIXA value: '0.030600' operationRate: '0.100000' - interval: 3_FAIXA value: '0.034300' operationRate: '0.300000' - interval: 4_FAIXA value: '0.246800' operationRate: '0.100000' minimum: '0.010000' maximum: '0.300000' loadingRate: prices: - interval: 1_FAIXA value: '0.020300' operationRate: '0.500000' - interval: 2_FAIXA value: '0.030600' operationRate: '0.100000' - interval: 3_FAIXA value: '0.034300' operationRate: '0.300000' - interval: 4_FAIXA value: '0.246800' operationRate: '0.100000' minimum: '0.010000' maximum: '0.300000' targetAudience: PESSOA_JURIDICA links: $ref: '#/components/schemas/Links' meta: $ref: '#/components/schemas/OpenDataMeta2Records' additionalProperties: false OKResponseInvestmentsTreasure: type: object required: - data - links - meta properties: data: type: array items: $ref: '#/components/schemas/InvestmentsTreasure' links: $ref: '#/components/schemas/Links' meta: $ref: '#/components/schemas/OpenDataMeta' additionalProperties: false NoIdentificationFrequencyDistribution: type: object description: Distribuição por frequência. required: - prices - minimum - maximum properties: prices: type: array description: Distribuição dos preços. items: $ref: '#/components/schemas/DistributionFrequencyPrice' minItems: 4 maxItems: 4 example: - interval: 1_FAIXA value: '0.020300' operationRate: '0.500000' - interval: 2_FAIXA value: '0.030600' operationRate: '0.100000' - interval: 3_FAIXA value: '0.034300' operationRate: '0.300000' - interval: 4_FAIXA value: '0.246800' operationRate: '0.100000' minimum: type: string description: Valor mínimo. minLength: 8 maxLength: 8 pattern: '^\d{1}\.\d{6}$' example: '0.010000' maximum: type: string description: Valor máximo. minLength: 8 maxLength: 8 pattern: '^\d{1}\.\d{6}$' example: '0.300000' additionalProperties: false InvestmentsNoIdentificationFrequencyDistribution: type: object description: Distribuição por frequência. required: - prices - minimum - maximum properties: prices: type: array description: Distribuição dos preços. items: $ref: '#/components/schemas/DistributionFrequencyPrice' minItems: 4 maxItems: 4 example: - interval: 1_FAIXA value: '0.020300' operationRate: '0.500000' - interval: 2_FAIXA value: '0.030600' operationRate: '0.100000' - interval: 3_FAIXA value: '0.034300' operationRate: '0.300000' - interval: 4_FAIXA value: '0.246800' operationRate: '0.100000' minimum: type: string description: Valor mínimo. minLength: 8 maxLength: 8 pattern: '^\d{1}\.\d{6}$' example: '0.019800' maximum: type: string description: Valor máximo. maxLength: 8 minLength: 8 pattern: '^\d{1}\.\d{6}$' example: '0.019800' additionalProperties: false DistributionFrequencyPrice: type: object required: - interval - value - operationRate properties: interval: $ref: '#/components/schemas/EnumInterval' value: type: string description: Mediana. example: '0.019800' minLength: 8 maxLength: 8 pattern: '^\d{1}\.\d{6}$' operationRate: type: string description: Percentual de operação. example: '0.019800' minLength: 8 maxLength: 8 pattern: '^\d{1}\.\d{6}$' additionalProperties: false EnumDistinctTargetAudience: type: string description: Público alvo (PESSOA_NATURAL ou PESSOA_JURIDICA). enum: - PESSOA_NATURAL - PESSOA_JURIDICA example: PESSOA_JURIDICA InvestmentsFixedIncomeBank: type: object required: - participant - issuerInstitutionCnpjNumber - issuerInstitutionName - investmentType - index - investmentConditions - targetAudience properties: participant: $ref: '#/components/schemas/InvestmentsParticipant' issuerInstitutionCnpjNumber: type: string description: CNPJ da instituição emissora. maxLength: 14 pattern: '^\d{14}$' example: '45086338000178' issuerInstitutionName: type: string maxLength: 250 minLength: 1 pattern: \w+\W* example: Organização A1 description: Nome da instituição emissora. investmentType: $ref: '#/components/schemas/EnumInvestmentsFixedIncomeBankProductType' index: $ref: '#/components/schemas/InvestmentsFixedIncomeBankIndex' investmentConditions: $ref: '#/components/schemas/InvestmentsFixedIncomeBankInvestmentConditions' targetAudience: $ref: '#/components/schemas/EnumDistinctTargetAudience' additionalProperties: false InvestmentsFixedIncomeBankIndex: type: object required: - indexer - issueRemunerationRate properties: indexer: $ref: '#/components/schemas/EnumInvestmentsFixedIncomeBankIndexer' indexerAdditionalInfo: type: string description: | Campo livre para preenchimento das informações adicionais referente ao encargo. [Restrição] Obrigatório quando "indexer" for igual 'OUTROS'. maxLength: 140 example: Informações adicionais pattern: '[\w\W\s]*' issueRemunerationRate: $ref: '#/components/schemas/InvestmentsNoIdentificationFrequencyDistribution' additionalProperties: false InvestmentFundMinimumAmount: type: object required: - value - currency properties: value: type: string description: Valor mínimo do primeiro aporte. minLength: 4 maxLength: 19 pattern: '^\d{1,16}\.\d{2}$' example: '100000.12' currency: type: string pattern: '^[A-Z]{3}$' maxLength: 3 description: 'Moeda referente ao valor monetário, seguindo o modelo ISO-4217.' example: BRL additionalProperties: false InvestmentsFixedIncomeBankInvestmentConditions: type: object required: - minimumAmount - redemptionTerm - expirationPeriod - gracePeriod properties: minimumAmount: type: string description: Valor mínimo de aplicação no ativo. minLength: 4 maxLength: 19 pattern: '^\d{1,16}\.\d{2}$' example: '100.00' redemptionTerm: $ref: '#/components/schemas/EnumInvestmentsFixedIncomeBankRedemptionTerm' expirationPeriod: $ref: '#/components/schemas/EnumExpirationGracePeriod' gracePeriod: $ref: '#/components/schemas/EnumExpirationGracePeriod' additionalProperties: false InvestmentsFixedIncomeCredit: type: object required: - participant - investmentType - custodyFee - loadingRate - targetAudience properties: participant: $ref: '#/components/schemas/InvestmentsParticipant' investmentType: $ref: '#/components/schemas/EnumInvestmentsFixedIncomeCreditInvestmentType' custodyFee: $ref: '#/components/schemas/NoIdentificationFrequencyDistribution' loadingRate: $ref: '#/components/schemas/NoIdentificationFrequencyDistribution' targetAudience: $ref: '#/components/schemas/EnumDistinctTargetAudience' additionalProperties: false InvestmentsFund: type: object required: - participant - name - cnpjNumber - admin - fundManager - anbimaCategory - generalConditions - taxation - fees properties: participant: $ref: '#/components/schemas/InvestmentsParticipant' name: type: string description: Nome oficial do fundo de investimento. pattern: '[\w\W\s]*' maxLength: 250 example: FUNDO DE INVESTIMENTO EM COTAS DE FUNDOS DE INVESTIMENTO cnpjNumber: type: string description: CNPJ do fundo de investimento. maxLength: 14 pattern: '^\d{14}$' example: '64108803000191' isinCode: type: string description: 'Código universal que identifica cada valor mobiliário ou instrumento financeiro, conforme Norma ISO 6166.

DEFINIÇÃO:O ISIN (International Securities Identification Number) é um código que identifica um valor mobiliário, conforme a norma ISO 6166.
ESTRUTURA
O ISIN é um código alfanumérico que possui 12 caracteres com a seguinte estrutura:' maxLength: 12 minLength: 12 pattern: '^[A-Z]{2}([A-Z0-9]){9}\d{1}$' example: BRAAAAAAA000 admin: $ref: '#/components/schemas/InvestmentsFundAdmin' fundManager: $ref: '#/components/schemas/InvestmentsFundFundManager' anbimaCategory: $ref: '#/components/schemas/EnumInvestmentsFundProductAnbimaCategory' fees: $ref: '#/components/schemas/InvestmentsFundFees' generalConditions: $ref: '#/components/schemas/InvestmentsFundGeneralConditions' taxation: $ref: '#/components/schemas/EnumInvestmentsFundTaxation' additionalProperties: false InvestmentsFundAdmin: type: object required: - name - cnpjNumber properties: name: type: string description: Razão social da pessoa jurídica autorizada pela CVM para o exercício de administrador de carteiras de valores mobiliários e responsável pela administração do fundo. maxLength: 100 pattern: '[\w\W\s]*' example: ADM OPEN FINANCE DTVM S.A. cnpjNumber: type: string description: CNPJ do administrador. maxLength: 14 pattern: '^\d{14}$' example: '14511732000150' additionalProperties: false InvestmentsFundFundManager: type: object required: - name - cnpjNumber properties: name: type: string description: Pessoa natural ou jurídica responsável pela gestão profissional dos ativos da carteira de valores mobiliários autorizado pela CVM. maxLength: 100 pattern: '[\w\W\s]*' example: GESTOR OPEN FINANCE DTVM S.A. cnpjNumber: type: string description: CNPJ do gestor do fundo de investimento. maxLength: 14 pattern: '^\d{14}$' example: '16332711000101' additionalProperties: false InvestmentsFundFees: type: object required: - maxAdminFee properties: maxAdminFee: type: string description: 'Taxa máxima cobrada para remunerar o administrador e os demais prestadores de serviços do fundo. Caso não haja a difererença de Máximo e Mínimo, considerar a taxa de administração do fundo.' minLength: 8 maxLength: 8 pattern: '^\d{1}\.\d{6}$' example: '0.020000' entryFee: type: string description: 'Taxa cobrada no momento da aplicação, que incide sobre o valor investido no fundo.' minLength: 8 maxLength: 8 pattern: '^\d{1}\.\d{6}$' example: '0.010000' performanceFee: $ref: '#/components/schemas/InvestmentsFundFeesPerformanceFee' exitFee: type: string description: Taxa paga pelo cotista ao resgatar recursos de um fundo. minLength: 8 maxLength: 8 pattern: '^\d{1}\.\d{6}$' example: '0.030000' additionalProperties: false InvestmentsFundFeesPerformanceFee: type: object properties: method: $ref: '#/components/schemas/EnumInvestmentsFundFeesPerformanceFeeMethod' benchmark: $ref: '#/components/schemas/EnumInvestmentsFundFeesPerformanceFeeBenchmark' benchmarkAdditionalInfo: type: string description: Campo a ser preenchido pelas participantes quando houver ‘Outros’ no campo ‘Taxa de Performance - Benchmark’. amount: type: string description: Taxa cobrada do fundo em função de resultado conforme regras dispostas no regulamento do fundo. minLength: 3 maxLength: 8 pattern: '^\d{1}\.\d{1,6}$' example: '0.050000' additionalProperties: false InvestmentsFundGeneralConditionsRedemption: type: object required: - quotationDays - quotationTerm - paymentDays - paymentTerm properties: quotationDays: type: integer format: int32 description: Prazo máximo em dias indicado no regulamento do fundo para a conversão das cotas em dinheiro. example: 3 minimum: 0 maximum: 2147483647 quotationTerm: $ref: '#/components/schemas/EnumInvestmentsFundGeneralConditionsTermType' paymentDays: type: integer format: int32 description: 'Prazo máximo em dias do efetivo pagamento, pelo fundo, do valor líquido devido ao cotista que efetuou pedido de resgate.' example: 3 minimum: 0 maximum: 2147483647 paymentTerm: $ref: '#/components/schemas/EnumInvestmentsFundGeneralConditionsTermType' graceDays: type: integer format: int32 description: 'Estabelece um período em quantidade de dias corridos em que o investidor não pode resgatar os recursos aplicados no fundo. Caso ocorra resgate antes do período, o investidor perderá a rentabilidade do período. Caso não exista, não informe o campo.' example: 365 minimum: 0 maximum: 2147483647 additionalProperties: false InvestmentsFundGeneralConditionsApplication: type: object required: - quotationDays - quotationTerm properties: quotationDays: type: integer format: int32 description: Prazo em dias indicado no regulamento do fundo para a conversão do dinheiro em cotas do fundo. example: 60 minimum: 0 maximum: 2147483647 quotationTerm: $ref: '#/components/schemas/EnumInvestmentsFundGeneralConditionsTermType' additionalProperties: false InvestmentsFundGeneralConditions: type: object required: - minimumAmount - redemption - application - fundQuotaType properties: minimumAmount: $ref: '#/components/schemas/InvestmentFundMinimumAmount' redemption: $ref: '#/components/schemas/InvestmentsFundGeneralConditionsRedemption' application: $ref: '#/components/schemas/InvestmentsFundGeneralConditionsApplication' fundQuotaType: $ref: '#/components/schemas/EnumInvestmentsFundGeneralConditionsFundQuotaType' additionalProperties: false InvestmentsTreasure: type: object required: - investmentType - custodyFee - loadingRate - participant properties: participant: $ref: '#/components/schemas/InvestmentsParticipant' investmentType: $ref: '#/components/schemas/EnumInvestmentsTreasureInvestmentType' custodyFee: $ref: '#/components/schemas/InvestmentsNoIdentificationFrequencyDistribution' loadingRate: $ref: '#/components/schemas/InvestmentsNoIdentificationFrequencyDistribution' additionalProperties: false InvestmentsVariableIncome: type: object required: - participant - investmentType - custodyFee - loadingRate - targetAudience properties: participant: $ref: '#/components/schemas/InvestmentsParticipant' investmentType: $ref: '#/components/schemas/EnumInvestmentsVariableIncomeInvestmentType' custodyFee: $ref: '#/components/schemas/NoIdentificationFrequencyDistribution' loadingRate: $ref: '#/components/schemas/NoIdentificationFrequencyDistribution' targetAudience: $ref: '#/components/schemas/EnumDistinctTargetAudience' additionalProperties: false EnumInvestmentsFixedIncomeBankIndexer: type: string description: 'Índice utilizado como referência para a correção da rentabilidade e/ou rendimentos do ativo (p.ex. CDI).

Pré-fixado, em linha com padronização da B3:

  1. CDI
  2. DI
  3. TR
  4. IPCA
  5. IGP-M
  6. IGP-DI
  7. INPC
  8. BCP
  9. TLC
  10. Selic
  11. PRE_FIXADO
  12. Outros
' enum: - CDI - DI - TR - IPCA - IGP_M - IGP_DI - INPC - BCP - TLC - SELIC - PRE_FIXADO - OUTROS example: CDI EnumInvestmentsFixedIncomeBankProductType: type: string description: Especificação do ativo em questão.
  1. CDB
  2. RDB
  3. LCI
  4. LCA
enum: - CDB - RDB - LCI - LCA example: CDB EnumInvestmentsFixedIncomeBankRedemptionTerm: type: string description: Capacidade de conversão do título em dinheiro (resgate ou recompra).

  1. diária
  2. na data de vencimento
  3. diária após prazo de carência
enum: - DIARIA - DATA_VENCIMENTO - DIARIA_PRAZO_CARENCIA example: DIARIA EnumInvestmentsFixedIncomeCreditInvestmentType: type: string description: Especifica o tipo de ativo negociado:

  1. Debêntures
  2. CRI
  3. CRA
enum: - DEBENTURES - CRI - CRA example: CRI EnumInvestmentsFundFeesPerformanceFeeBenchmark: type: string description: 'Índice utilizado como referência para avaliação de desempenho do fundo de investimento.

Em linha com padronização na listagem de fundos da ANBIMA, com opção “outros”, permitindo campo livre caso a opção não seja previamente fornecida. Listagem de benchmark disponível no link https://data.anbima.com.br/fundos , opção Características > Benchmark' enum: - CDI - IBOVESPA_FECHAMENTO - IBOVESPA - IMA_B - IBRX - IPCA - IMA_B_5 - DOLAR_PTAX - IBRX_100 - TAXA_SELIC - IMA_B_5_PLUS - IBOVESPA_MEDIO - IRF_M - IMA_GERAL - INPC - IGP_M - SMLL_SMALL_CAP - IDA_IPCA - ISE - IRF_M_1 - IBRX_50 - IDIV_DIVIDENDOS - IFIX - GLOBAL_BDRX - IMA_S - IDKA_IPCA_2A - IRF_M_1_PLUS - OUTROS example: CDI EnumInvestmentsFundFeesPerformanceFeeMethod: type: string description: Metodologia do campo para taxa de performance.
  1. Passivo
  2. Ativo
  3. Ajuste
enum: - PASSIVO - ATIVO - AJUSTE example: PASSIVO EnumInvestmentsFundGeneralConditionsFundQuotaType: type: string description: Referente a incidência de tributos sobre o produto de investimento:

  1. Cota de abertura
  2. Cota de fechamento
enum: - COTA_ABERTURA - COTA_FECHAMENTO example: COTA_ABERTURA EnumInvestmentsFundGeneralConditionsTermType: type: string description: Período em dias corridos ou dias úteis do prazo de cotização.

  1. Dias corridos
  2. Dias úteis
enum: - DIAS_CORRIDOS - DIAS_UTEIS example: DIAS_CORRIDOS EnumInvestmentsFundProductAnbimaCategory: type: string description: | Conforme classificação ANBIMA – Renda Fixa – Ações – Multimercado – Cambial enum: - RENDA_FIXA - ACOES - MULTIMERCADO - CAMBIAL example: MULTIMERCADO EnumInvestmentsFundTaxation: type: string description: 'Indica o tipo de tributação, podendo ser:
  1. Curto prazo
  2. Longo prazo
  3. Variável
' enum: - CURTO_PRAZO - LONGO_PRAZO - VARIAVEL example: CURTO_PRAZO EnumInvestmentsTreasureInvestmentType: type: string description: Especifica o tipo de ativo negociado:

  1. Tesouro direto
enum: - TESOURO_DIRETO example: TESOURO_DIRETO EnumInvestmentsVariableIncomeInvestmentType: type: string description: Especifica o tipo de ativo negociado:

  1. Ações
  2. Fundo de índices
enum: - ACOES - FUNDO_INDICES example: ACOES InvestmentsParticipant: type: object description: Conjunto de informações relativas ao participante do produto de Open Finance required: - brand - name - cnpjNumber properties: brand: type: string description: 'Nome da marca reportada pelo participante do Open Finance. O conceito a que se refere a ''marca'' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.' maxLength: 80 pattern: '[\w\W\s]*' example: Organização name: type: string description: Nome do participante do Open Finance. maxLength: 80 pattern: '[\w\W\s]*' example: Organização A1 cnpjNumber: $ref: '#/components/schemas/CnpjNumber' urlComplementaryList: type: string description: | Array de objeto com a estrutura abaixo: - 'name' com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório; - 'cnpjNumber' com o valor contido no campo CNPJ (‘RegistrationNumber’) correspondente a esta instituição; \- Ambos do tipo string; \- Ambos obrigatórios. maxLength: 1024 pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$' example: 'https://empresaa1.com/companies' additionalProperties: false EnumInterval: type: string description: Faixas de frequência enum: - 1_FAIXA - 2_FAIXA - 3_FAIXA - 4_FAIXA example: 1_FAIXA CnpjNumber: type: string description: 'O CNPJ corresponde ao número de inscrição no Cadastro de Pessoa Jurídica. Deve-se ter apenas os números do CNPJ, sem máscara.' maxLength: 14 pattern: '^\d{14}$' example: '13456789000112' Links: type: object description: Referências para outros recusos da API requisitada. required: - self properties: self: type: string format: uri maxLength: 2000 description: URI completo que gerou a resposta atual. example: 'https://api.banco.com.br/open-banking/api/v1/resource' pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$' first: type: string format: uri maxLength: 2000 description: URI da primeira página que originou essa lista de resultados. Restrição - Obrigatório quando não for a primeira página da resposta example: 'https://api.banco.com.br/open-banking/api/v1/resource' pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$' prev: type: string format: uri maxLength: 2000 description: "URI da página anterior dessa lista de resultados. Restrição - \tObrigatório quando não for a primeira página da resposta" example: 'https://api.banco.com.br/open-banking/api/v1/resource' pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$' next: type: string format: uri maxLength: 2000 description: URI da próxima página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta example: 'https://api.banco.com.br/open-banking/api/v1/resource' pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$' last: type: string format: uri maxLength: 2000 description: URI da última página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta example: 'https://api.banco.com.br/open-banking/api/v1/resource' pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$' additionalProperties: false OpenDataMeta: type: object description: Meta informações referente à API requisitada. required: - totalRecords - totalPages properties: totalRecords: type: integer format: int32 description: Número total de registros no resultado example: 1 totalPages: type: integer format: int32 description: Número total de páginas no resultado example: 1 additionalProperties: false OpenDataMeta2Records: type: object description: Meta informações referente à API requisitada. required: - totalRecords - totalPages properties: totalRecords: type: integer format: int32 description: Número total de registros no resultado example: 2 totalPages: type: integer format: int32 description: Número total de páginas no resultado example: 1 additionalProperties: false OpenDataResponseError: type: object required: - errors properties: errors: type: array minItems: 1 maxItems: 13 items: type: object required: - code - title - detail properties: code: description: Código de erro específico do endpoint type: string pattern: '[\w\W\s]*' maxLength: 255 title: description: Título legível por humanos deste erro específico type: string pattern: '[\w\W\s]*' maxLength: 255 detail: description: Descrição legível por humanos deste erro específico type: string pattern: '[\w\W\s]*' maxLength: 2048 additionalProperties: false meta: $ref: '#/components/schemas/OpenDataMeta' additionalProperties: false EnumExpirationGracePeriod: type: string enum: - '1_360' - '361_1080' - 1081+ example: 1081+ description: | Faixa de valores para prazos de vencimento e carência. parameters: page: name: page in: query description: Número da página que está sendo requisitada (o valor da primeira página é 1). schema: type: integer default: 1 minimum: 1 maximum: 2147483647 format: int32 pageSize: name: page-size in: query description: Quantidade total de registros por páginas. schema: type: integer default: 25 minimum: 1 format: int32 maximum: 1000 responses: OKResponseInvestmentsFund: description: Dados de fundos de investimentos obtidos com sucesso. content: application/json: schema: $ref: '#/components/schemas/OKResponseInvestmentsFund' OKResponseInvestmentsFixedIncomeBank: description: Dados de produtos de renda fixa bancária obtidos com sucesso. content: application/json: schema: $ref: '#/components/schemas/OKResponseInvestmentsFixedIncomeBank' OKResponseInvestmentsFixedIncomeCredit: description: Dados de produtos de renda fixa crédito obtidos com sucesso. content: application/json: schema: $ref: '#/components/schemas/OKResponseInvestmentsFixedIncomeCredit' OKResponseInvestmentsVariableIncome: description: Dados de produtos de renda variável obtidos com sucesso. content: application/json: schema: $ref: '#/components/schemas/OKResponseInvestmentsVariableIncome' OKResponseInvestmentsTreasure: description: Dados de títulos do tesouro direto obtidos com sucesso. content: application/json: schema: $ref: '#/components/schemas/OKResponseInvestmentsTreasure' BadRequest: description: 'A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL.' content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OpenDataResponseError' InternalServerError: description: Ocorreu um erro no gateway da API ou no microsserviço content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OpenDataResponseError' MethodNotAllowed: description: O consumidor tentou acessar o recurso com um método não suportado content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OpenDataResponseError' NotFound: description: O recurso solicitado não existe ou não foi implementado content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OpenDataResponseError' TooManyRequests: description: 'A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido' content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OpenDataResponseError'