Pular para o conteúdo principal

CDB escalonado

Agora você pode criar títulos bancários pós-fixados com rentabilidade progressiva (CDB escalonado), em que o percentual do CDI muda em datas predefinidas.

O endpoint Create Security aceita dois novos campos opcionais para ativos do tipo FLOATING_RATE_BANKING_BOND:

  • scaleType: INCREMENTAL (a nova taxa vale apenas a partir da data da mudança) ou RETROACTIVE (ao atingir a data da mudança, a nova taxa passa a valer desde o início do título). O padrão é NONE.
  • scaling: a lista de mudanças de taxa, cada uma com a sua data (date) e o novo multiplier.

O campo multiplier continua indicando a taxa vigente na emissão. Os dois campos devem ser enviados juntos, e o escalonamento só é aceito para títulos indexados ao CDI, sem spread e com interestPaymentPeriod igual a BULLET. Os endpoints List Securities e Read Security by ID também retornam scaleType e scaling.

// REQUEST
// POST https://core.gorila.com.br/securities

{
"type": "FLOATING_RATE_BANKING_BOND",
"bankingBondType": "CDB",
"initialDate": "2025-01-01",
"maturityDate": "2030-01-01",
"issuerId": "30306294000145",
"issuanceFaceValue": 1000,
"index": "CDI",
"multiplier": 1.0,
"scaleType": "INCREMENTAL",
"scaling": [
{ "date": "2026-01-01", "multiplier": 1.05 },
{ "date": "2027-01-01", "multiplier": 1.10 }
]
}

Saiba mais na seção "CDB escalonado" de Ativo.

Classificação na criação de ativo personalizado

Agora você pode definir a classificação de um ativo personalizado já na sua criação, com o novo campo opcional classificationId.

No endpoint Create Security, com o tipo CUSTOM, informe em classificationId o identificador da classificação desejada, que pode ser obtido no List Securities Classifications. Sem o campo, o ativo é classificado a partir da sua classe de ativo (assetClass).

//REQUEST
//POST https://core.gorila.com.br/securities

{
"type": "CUSTOM",
"name": "Fazenda Boa Vista",
"description": "Fazenda Boa Vista - MG",
"assetClass": "TANGIBLE",
"initialDate": "2022-04-04",
"classificationId": "TANGIBLE_GENERIC"
}

Saiba mais em Ativo Personalizado.

Métricas pela ótica da exposição

O Valor Patrimonial (NAV), o valor de mercado e a TWR de portfólios e grupos econômicos agora podem ser calculados pela ótica da exposição. Isso evita rentabilidades distorcidas em carteiras alavancadas com Futuros e Termos.

O novo parâmetro opcional marketValueType aceita dois valores:

  • AUTO (padrão): mantém o comportamento anterior. A NAV e o valor de mercado seguem a ótica do patrimônio, em que Futuros e Termos têm valor de mercado zero.
  • EXPOSURE: Futuros e Termos passam a ser sempre calculados pela ótica da exposição (quantidade × preço de fechamento × multiplicador do contrato). Na NAV e no valor de mercado, eles contribuem com o valor total dos contratos (com sinal), e a TWR passa a ser medida sobre a exposição.

O parâmetro está disponível em:

Saiba mais em Exposição.

Contratos futuros de criptoativos

Os portfólios passam a suportar contratos futuros de criptoativos, incluindo os futuros de Bitcoin (BIT), Ethereum (ETR) e Solana (SOL).

Esses contratos podem ser registrados nas transações dos portfólios e entram no cálculo das métricas do portfólio, assim como os demais contratos futuros. Veja como registrar uma transação de contrato futuro em Transações - Exemplos.

Gestão das chaves de API no GorilaVIEW

Owners e admins de organizações empresariais agora podem listar, criar e excluir as chaves de API da organização diretamente no GorilaVIEW, sem precisar acionar o suporte do Gorila. As chaves de API da organização passam a se chamar OATs.

Na página de gerenciamento da organização no GorilaVIEW, disponível para usuários com o papel de Owner ou Admin, é possível:

  • listar, criar e excluir as chaves de API da organização (OATs);
  • definir se os usuários da organização podem criar Personal Access Tokens (PATs).

O novo nome é apenas uma mudança de nomenclatura: as chaves existentes continuam funcionando e são enviadas da mesma forma, no cabeçalho Authorization. Os PATs continuam sendo as chaves pessoais, vinculadas a um usuário.

As chaves emitidas pelo time do Gorila passam a ser entregues por um link de uso único, sem que os colaboradores do Gorila tenham acesso à sua chave.

Saiba mais sobre as chaves de API em Organização.

Novo título: CDCA

Os Certificados de Direitos Creditórios do Agronegócio (CDCA) passam a ser suportados, com o tipo de ativo CORPORATE_BONDS_CDCA. Eles são tratados como debêntures, CRIs e CRAs, com preços e eventos integrados.

Assim como nos demais títulos de crédito privado, não é preciso criar o ativo: encontre-o pelo List Securities e registre as transações pelo Create Transaction, identificando o CDCA pelo securityId ou pelo ISIN.

Saiba mais em Transações - Exemplos.

Controle de PATs pela organização

As organizações passam a ter mais controle sobre os Personal Access Tokens (PATs) dos seus usuários: requisições feitas com o PAT de um usuário desativado, ou de uma organização que desabilitou os PATs, são recusadas.

A API passa a verificar duas condições em toda requisição autenticada com um PAT:

  • Usuário ativo: se o usuário dono do PAT foi desativado no Gorila, a requisição retorna 401 com a mensagem inactive user.
  • PATs habilitados na organização: as organizações podem desabilitar o uso de PATs pelos seus usuários. Enquanto os PATs estiverem desabilitados, não é possível criar novos PATs, e as requisições com os PATs já existentes da organização retornam 401:
{
"code": 401,
"message": "Personal Access Tokens are disabled for this organization"
}

As chaves de API da organização não são afetadas por essas verificações.

Nova classificação de ativos

O GorilaCORE passa a oferecer a nova classificação de ativos do Gorila: uma árvore hierárquica de classes e subclasses com até 4 níveis, que você pode usar para filtrar e agrupar as métricas de portfólios e grupos econômicos.

Na árvore, um título público indexado à inflação, por exemplo, está em "Renda Fixa > Indexado a Inflação > Título Público". Os níveis vão de CLASSIFICATION_L0 (o mais amplo) a CLASSIFICATION_L3 (o mais detalhado). As novidades são:

  • Árvore de classificação: o novo endpoint List Securities Classifications lista as classificações, com filtros por nível (classificationLevel) e por classificação pai (parentId).
  • Classificação de cada ativo: os objetos de ativo, como os retornados pelo List Securities e pelo Read Security by ID, passam a trazer o campo classifications, com a classificação do ativo em cada nível.
  • Filtro: a maioria dos endpoints de métricas de portfólios e grupos econômicos aceita o filtro securityClassification, com o identificador de uma classificação.
  • Agrupamento: os endpoints por posição que aceitam groupBy, como o List Position Market Values, passam a aceitar o agrupamento do resultado por nível de classificação: CLASSIFICATION_L0, CLASSIFICATION_L1, CLASSIFICATION_L2 ou CLASSIFICATION_L3.

Saiba mais em Classificação de Ativos.

Apelido e portfólios conectados

O objeto de portfólio passa a ter dois novos campos: alias, um apelido definido pela sua organização, e connected, que indica se o portfólio pertence a outra pessoa e foi compartilhado com a sua organização.

Os dois campos são retornados por endpoints como List Portfolios e Read Portfolio by ID:

  • connected: true quando o portfólio foi compartilhado com (conectado à) sua organização e não pertence a ela.
  • alias: o apelido que a sua organização dá ao portfólio, ou null quando não há. O nome original (name) não muda, e o dono do portfólio não vê o apelido.

O apelido é útil, por exemplo, para identificar portfólios conectados com os códigos internos da sua organização. Para criar, alterar ou remover o apelido, use o Update Portfolio by ID, enviando alias com o novo valor ou null:

{
"alias": "ID-0042"
}

Saiba mais em Portfólio.

Novo título bancário: LCD

Títulos bancários agora podem ser criados com o novo tipo LCD, para representar Letras de Crédito do Desenvolvimento.

No endpoint Create Security, envie bankingBondType igual a LCD ao criar um título bancário prefixado (FIXED_RATE_BANKING_BOND) ou pós-fixado (FLOATING_RATE_BANKING_BOND). O ativo resultante tem o tipo CORPORATE_BONDS_LCD e, como os demais títulos bancários, pode então ser usado em transações pelo securityId retornado.

Saiba mais em Ativo.

Dividend Yield por posição

Agora você pode consultar o dividend yield das posições de um portfólio: quanto cada ativo pagou em proventos, por unidade, em relação ao seu preço em um período.

O novo endpoint List Position Dividend Yield retorna, para cada ativo do portfólio:

  • dividendYield: o dividend yield no período, em formato decimal (0.05 = 5%);
  • hasOpenPositionAllDays: se havia posição em todos os dias do período;
  • currency: a moeda de pagamento do ativo;
  • security: os dados básicos do ativo.

O dividend yield é a soma dos proventos por unidade com data "ex" no período, dividida pelo preço de fechamento do ativo. O período é definido por startDate e endDate; quando o endDate não é informado, é usada a data de hoje. O endpoint também permite filtrar por ativo, classe de ativo, tipo de ativo e custodiante.

Saiba mais em Dividend Yield.

Busca por símbolo mais precisa

A busca de ativos por símbolo (symbol) ficou mais precisa: ela passa a retornar apenas ativos cujo símbolo é exatamente o termo buscado ou começa com ele.

A mudança afeta o parâmetro search do endpoint List Securities. Antes, a correspondência com o símbolo era aproximada, o que podia retornar resultados incorretos, por exemplo, em buscas por CNPJ. As buscas pelo nome descritivo do ativo não mudam e continuam aproximadas.

Saiba mais em Ativo.

Novos filtros na listagem de transações

As listagens de transações de portfólios e de grupos econômicos passam a aceitar novos filtros, para que você busque apenas as transações de que precisa em vez de filtrar a lista completa do seu lado.

Os endpoints List Transactions e List Economic Group Transactions aceitam os seguintes parâmetros opcionais de consulta:

  • brokerId: o CNPJ do custodiante.
  • securityId: o identificador do ativo no Gorila.
  • type: o tipo da transação, como REGULAR ou CUSTODY_TRANSFER.
  • side: a direção da transação, BUY (compra) ou SELL (venda).

Os filtros podem ser combinados entre si e com os filtros de período (startDate e endDate). Por exemplo, para listar apenas as vendas de um ativo:

GET /portfolios/{portfolioId}/transactions?securityId=1651&side=SELL

Saiba mais em Transação.

Fundos administrados

Fundos administrados agora podem ser criados como ativos no GorilaCORE, com o novo tipo MANAGED_FUND, e receber transações nos portfólios.

No endpoint Create Security, envie type igual a MANAGED_FUND. O cadastro segue o mesmo modelo dos clubes de investimento (INVESTMENT_CLUB): nome (name), descrição (description), classe de ativo (assetClass) e data inicial (initialDate) são obrigatórios, e o cnpj é opcional.

Assim como nos clubes de investimento, o valor da cota é informado pela sua organização. Use o Upsert Security Prices para enviar a série de preços, o List Security Prices para consultá-la e o Delete Security Prices para remover o preço de uma data.

Saiba mais em Ativo.

Valor investido de grupos econômicos

Agora você pode consultar o valor investido de grupos econômicos, consolidado e por posição, com as mesmas visões já disponíveis para portfólios.

Foram adicionados dois endpoints:

O valor investido do grupo é a soma do valor investido das posições dos seus portfólios. Os dois endpoints aceitam os mesmos filtros da versão para portfólios (ativo, classe de ativo, tipo de ativo e custodiante), e os valores são expressos em reais (BRL).

Saiba mais em Valor Investido.

Grupos econômicos

O GorilaCORE passa a oferecer grupos econômicos: agrupamentos nomeados de até 10 portfólios que você pode analisar em conjunto, como se fossem um único portfólio consolidado.

Um grupo econômico é definido por um nome (name) e pela lista de IDs dos portfólios que o compõem (portfolios). Cada grupo retorna um status (PROCESSING, COMPLETED ou INVALID), que só fica COMPLETED quando todos os seus portfólios já foram processados. Os novos endpoints são:

Essas visões seguem os mesmos conceitos e parâmetros dos endpoints equivalentes de portfólio.

Saiba mais em Grupo Econômico.

Novos títulos bancários: RDB, RDC, DPGE e compromissadas

Quatro novos tipos de título bancário já podem ser criados: RDB, RDC, DPGE e operações compromissadas.

No endpoint Create Security, o campo bankingBondType passa a aceitar os valores abaixo, tanto para títulos prefixados (FIXED_RATE_BANKING_BOND) quanto pós-fixados (FLOATING_RATE_BANKING_BOND). A criação segue o mesmo fluxo dos CDBs:

bankingBondTypeTítuloTipo de ativo
RDBRecibo de Depósito BancárioCORPORATE_BONDS_RDB
RDCRecibo de Depósito CooperativoCORPORATE_BONDS_RDC
DPGEDepósito a Prazo com Garantia EspecialCORPORATE_BONDS_DPGE
REPOOperação CompromissadaREPO

Saiba mais em Ativo.

Pagamento periódico de juros em títulos bancários

Títulos bancários agora podem ser cadastrados com pagamento periódico de juros (cupom), por meio de dois novos campos opcionais na criação do ativo.

Ao criar títulos bancários prefixados (FIXED_RATE_BANKING_BOND) ou pós-fixados (FLOATING_RATE_BANKING_BOND) com o endpoint Create Security, você agora pode informar:

  • interestPaymentPeriod: periodicidade do pagamento de juros. Valores aceitos: BULLET (padrão, sem pagamentos intermediários), MONTHLY, EVERY_2_MONTHS, EVERY_3_MONTHS, EVERY_4_MONTHS, EVERY_6_MONTHS ou YEARLY.
  • issuanceFaceValue: valor de face na emissão.

Os dois campos também são retornados por List Securities e Read Security by ID.

Exemplo de um CDB prefixado com pagamento semestral de juros:

// REQUEST
// POST https://core.gorila.com.br/securities

{
"type": "FIXED_RATE_BANKING_BOND",
"bankingBondType": "CDB",
"initialDate": "2024-12-02",
"maturityDate": "2027-12-02",
"issuerId": "03215790000110",
"issuanceFaceValue": 1000,
"interestPaymentPeriod": "EVERY_6_MONTHS",
"yield": 0.12
}

Saiba mais em Ativo.

Valor investido

Dois novos endpoints retornam o valor investido de portfólios e posições: o custo de aquisição das unidades que o investidor ainda tem em carteira, que não acompanha a oscilação dos preços.

  • Read Invested Amount: série temporal do valor investido de um portfólio, com escolha de frequência (frequency).
  • List Position Invested Amount: valor investido de cada posição de um portfólio, com opção de agrupar o resultado (groupBy).

Comparado com o valor de mercado, o valor investido mostra o ganho ou a perda ainda não realizados de uma posição. Comparado com o Valor Patrimonial (NAV), coloca o valor do portfólio lado a lado com o custo de aquisição das unidades em carteira.

Saiba mais em Valor Investido.

Novos títulos bancários: LIG, LFS e LFSN

Três novos tipos de título bancário já podem ser criados: LIG (Letra Imobiliária Garantida) e as Letras Financeiras subordinadas LFS e LFSN.

No endpoint Create Security, o campo bankingBondType passa a aceitar os valores abaixo, tanto para títulos prefixados (FIXED_RATE_BANKING_BOND) quanto pós-fixados (FLOATING_RATE_BANKING_BOND):

bankingBondTypeTítuloTipo de ativo
LIGLetra Imobiliária GarantidaCORPORATE_BONDS_LIG
LFS e LFSNLetras Financeiras subordinadasCORPORATE_BONDS_LFS e CORPORATE_BONDS_LFSN

Assim como nos demais títulos bancários, use o securityId retornado para criar transações com o novo ativo.

Saiba mais em Ativo.