Funcionalidades Complementares

Aviso de novos dados (via API)

Informações Gerais

O ANBIMA Feed possui recursos que permitem que os assinantes sejam acionados com notificações em algumas situações específicas. Por exemplo, notificações serão enviadas através de API quando novos dados estiverem disponíveis na plataforma.

Para usufruir deste mecanismo, é necessário que o assinante do ANBIMA Feed exponha uma API RESTFul, que receberá os acionamentos dos Pacotes/Itens assinados.

Esta API deverá ser implementada de acordo com as seguintes especificações:

Método: POST

URL: Definida pelo assinante e informada à ANBIMA para cadastro (ex. https://endpoint-cliente.com/recurso-cliente/)

Body: Irá depender do pacote/Item a qual a notificação se refere.

Autenticação: “Basic Authentication”, conforme especificado em https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization.

Preços e Índices

As notificações terão o mesmo comportamento para todos os itens que fazem parte dos pacotes de APIs de Preços e Índices. O body, neste caso, será:

{
  "id_notificacao_cliente": "string",
  "tipo_evento": "string",
  "data_envio": "string",
  "nome_pacote": "string",
  "nome_item": "string",
  "descricao": "string",
  "data_referencia": "string"
  "url_api_feed": "string",
}

Detalhamento dos Campos:

Campos do BodyDescrição
id_notificacao_clienteIdentificador da mensagem enviada ao assinante
tipo_eventoEsta informação refere-se ao tipo do evento que gerou a
notificação. Possíveis valores:
– NOVO: Novos dados disponibilizados para o Pacote/Item e data de referência informados.
– ATUALIZACAO: Dados retificados para o Pacote/Item e data
de referência informados. Os dados que haviam sido
armazenados anteriormente para este Pacote/Item e data de
referência devem ser excluídos e substituídos pelos
disponibilizados após a notificação deste tipo.
– ATRASO: Os dados do Pacote/Item e data de referência
informados estão em atraso na sua geração.
data_envioData de envio da notificação.
nome_pacoteO nome do pacote para o qual foi gerada a notificação
nome_itemO nome do item do pacote para o qual foi gerada a notificação
descricaoTexto descritivo da notificação
data_referenciaData de referência dos dados do Pacote/Item
url_api_feedURL de referência para que os dados possam ser consultados
no Feed. Utilize esta informação para consultar as informações
atualizadas.
Observação: Os parâmetros de “data” ou “mês e ano” já
estarão preenchidos na URL.

O quadro abaixo resume os Pacotes, Itens e respectivas APIs disponíveis nesta funcionalidade:

Descriçãonome_pacotenome_itemurl_api_feed
Mercado Secundário de Títulos PúblicosTITULOS_PUBLICOSMERCADO_SECUNDARIO_TPFhttps://api.anbima.com.br/feed/precos-indices/v1/titulos-publicos/mercado-secundario-TPF
Valor Nominal Atualizado de Títulos PúblicosTITULOS_PUBLICOSVNAhttps://api.anbima.com.br/feed/precos-indices/v1/titulos-publicos/vna
Curvas de JurosTITULOS_PUBLICOSCURVAS_JUROShttps://api.anbima.com.br/feed/precos-indices/v1/titulos-publicos/curvas-juros
Curva IntradiáriaTITULOS_PUBLICOSCURVA_INTRADIARIAhttps://api.anbima.com.br/feed/precos-indices/v1/titulos-publicos/curva-intradiaria
Preço Unitário IntradiárioTITULOS_PUBLICOSPU_INTRADIARIOhttps://api.anbima.com.br/feed/precos-indices/v1/titulos-publicos/pu-intradiario
Difusão de TaxasTITULOS_PUBLICOSDIFUSAO_TAXAShttps://api.anbima.com.br/feed/precos-indices/v1/titulos-publicos/difusao-taxas
Estimativa SELICTITULOS_PUBLICOSESTIMATIVA_SELIChttps://api.anbima.com.br/feed/precos-indices/v1/titulos-publicos/estimativa-selic
Projeções IPCA e IGP-MTITULOS_PUBLICOSPROJECAO_IPCA_IGPMhttps://api.anbima.com.br/feed/precos-indices/v1/titulos-publicos/projecoes
Mercado Secundário de DebênturesDEBENTURESMERCADO_SECUNDARIO_DEBENTUREShttps://api.anbima.com.br/feed/precos-indices/v1/debentures/mercado-secundario
Curvas de CréditoDEBENTURESCURVAS_CREDITOhttps://api.anbima.com.br/feed/precos-indices/v1/debentures/curvas-credito
Projeções IPCA e IGP-MDEBENTURESPROJECAO_IPCA_IGPMhttps://api.anbima.com.br/feed/precos-indices/v1/debentures/projecoes
Mercado Secundário de CRI e CRACRI_CRAMERCADO_SECUNDARIO_CRICRAhttps://api.anbima.com.br/feed/precos-indices/v1/cri-cra/mercado-secundario
Projeções IPCA e IGP-MCRI_CRAPROJECAO_IPCA_IGPMhttps://api.anbima.com.br/feed/precos-indices/v1/cri-cra/projecoes
IDA Carteira TeóricaINDICES_MAISCARTEIRA_TEORICA_IDAhttps://api.anbima.com.br/feed/precos-indices/v1/indices-mais/carteira-teorica-ida
IDA Resultados e ComponentesINDICES_MAISRESULTADOS_COMPONENTE_IDAhttps://api.anbima.com.br/feed/precos-indices/v1/indices-mais/resultados-ida
IHFA Carteira TeóricaINDICES_MAISCARTEIRA_TEORICA_IHFAhttps://api.anbima.com.br/feed/precos-indices/v1/indices-mais/carteira-teorica-ihfa
IHFA Resultados e ComponentesINDICES_MAISRESULTADOS_COMPONENTE_IHFAhttps://api.anbima.com.br/feed/precos-indices/v1/indices-mais/resultados-ihfa
IDkA ResultadosINDICES_MAISRESULTADOS_IDKAhttps://api.anbima.com.br/feed/precos-indices/v1/indices-mais/resultados-idka
IMA Carteira TeóricaINDICES_MAISCARTEIRA_TEORICA_IMAhttps://api.anbima.com.br/feed/precos-indices/v1/indices-mais/carteira-teorica-ima
IMA Resultados e ComponentesINDICES_MAISRESULTADOS_COMPONENTE_IMAhttps://api.anbima.com.br/feed/precos-indices/v1/indices-mais/resultados-ima
IMA Resultado IntradiárioINDICES_MAISRESULTADO_INTRADIARIOhttps://api.anbima.com.br/feed/precos-indices/v1/indices/resultados-intradiarios-ima
IMA PU IntradiárioINDICES_MAISPU_INTRADIARIOhttps://api.anbima.com.br/feed/precos-indices/v1/indices-mais/pu-intradiario
IDA Carteira TeóricaINDICESCARTEIRA_TEORICA_IDAhttps://api.anbima.com.br/feed/precos-indices/v1/indices/carteira-teorica-ida
IDA ResultadosINDICESRESULTADOS_IDAhttps://api.anbima.com.br/feed/precos-indices/v1/indices/resultados-ida-fechado
IHFA Carteira TeóricaINDICESCARTEIRA_TEORICA_IHFAhttps://api.anbima.com.br/feed/precos-indices/v1/indices/carteira-teorica-ihfa
IHFA ResultadosINDICESRESULTADOS_IHFAhttps://api.anbima.com.br/feed/precos-indices/v1/indices/resultados-ihfa-fechado
IDkA ResultadosINDICESRESULTADOS_IDKAhttps://api.anbima.com.br/feed/precos-indices/v1/indices/resultados-idka
IMA Carteira TeóricaINDICESCARTEIRA_TEORICA_IMAhttps://api.anbima.com.br/feed/precos-indices/v1/indices/carteira-teorica-ima
IMA ResultadosINDICESRESULTADOS_IMAhttps://api.anbima.com.br/feed/precos-indices/v1/indices/resultados-ima
IMA Resultado IntradiárioINDICESRESULTADO_INTRADIARIOhttps://api.anbima.com.br/feed/precos-indices/v1/indices/resultados-intradiarios-ima
Prévia da Carteira TeóricaIMA_ETFPREVIA_CARTEIRA_TEORICA_IMAhttps://api.anbima.com.br/feed/precos-indices/v2/ima-etf/previa-carteira-teorica
Carteira TeóricaIMA_ETFCARTEIRA_TEORICA_IMAhttps://api.anbima.com.br/feed/precos-indices/v2/ima-etf/carteira-teorica
Resultado DiárioIMA_ETFRESULTADO_DIARIOhttps://api.anbima.com.br/feed/precos-indices/v2/ima-etf/resultado-diario
Composição DiáriaIMA_ETFCOMPOSICAO_DIARIAhttps://api.anbima.com.br/feed/precos-indices/v2/ima-etf/composicao-diaria
Resultado IntradiárioIMA_ETFRESULTADO_INTRADIARIOhttps://api.anbima.com.br/feed/precos-indices/v2/ima-etf/resultado-intradiario
PU IntradiárioIMA_ETFPU_INTRADIARIOhttps://api.anbima.com.br/feed/precos-indices/v2/ima-etf/pu-intradiario
Negócios ExtraIMA_ETFNEGOCIOS_EXTRAhttps://api.anbima.com.br/feed/precos-indices/v2/ima-etf/negocios-extra

Fundos

No caso de notificações de itens que fazem parte dos pacotes de Fundos, iremos agrupar todos os fundos que tiveram atualização de dados em determinada data. Quanto aos bodies, haverá algumas diferenças a depender do pacote, item e recurso, conforme especificado a seguir.

APIs de Detalhes do Fundo

Fundos ICVM 555 e Offshore:

  "id_notificacao_cliente": "string",
  "data_envio": "string",
  "nome_pacote": "string",
  "nome_item": "string",
  "descricao": "string",
  "total_registros": "int",
  "pagina": "int",
  "total_paginas": "int",
  "registros": [
    {
      "codigo_fundo": "string",
      "data_atualizacao": "string",
      "url_api_feed": [
        "string"
      ]
    }
  ]

Fundos Estruturados:

{
  "id_notificacao_cliente": "string",
  "data_envio": "string",
  "nome_pacote": "string",
  "nome_item": "string",
  "descricao": "string",
  "total_registros": "int",
  "pagina": "int",
  "total_paginas": "int",
  "registros": [
    {
      "cnpj": "string",
      "data_atualizacao": "string",
      "url_api_feed": [
        "string"
      ]
    }
  ]
}

APIs de Série Histórica do Fundo

Fundos ICVM 555 e Offshore:

{
  "id_notificacao_cliente": "string",
  "data_envio": "string",
  "nome_pacote": "string",
  "nome_item": "string",
  "descricao": "string",
  "total_registros": "int",
  "pagina": "int",
  "total_paginas": "int",
  "registros": [
    {
      "codigo_fundo": "string",
      "data_referencia_inicio": "string",
      "data_referencia_fim": "string",
      "url_api_feed": [
        "string"
      ]
    }
  ]
}

Fundos Estruturados:

{
  "id_notificacao_cliente": "string",
  "data_envio": "string",
  "nome_pacote": "string",
  "nome_item": "string",
  "descricao": "string",
  "total_registros": "int",
  "pagina": "int",
  "total_paginas": "int",
  "registros": [
    {
      "cnpj": "string",
      "data_referencia_inicio": "string",
      "data_referencia_fim": "string",
      "url_api_feed": [
        "string"
      ]
    }
  ]
}

APIs de Notas Explicativas do Fundo

Fundos ICVM 555:

{
  "id_notificacao_cliente": "string",
  "data_envio": "string",
  "nome_pacote": "string",
  "nome_item": "string",
  "descricao": "string",
  "total_registros": "int",
  "pagina": "int",
  "total_paginas": "int",
  "registros": [
    {
      "codigo_fundo": "string",
      "url_api_feed": [
        "string"
      ]
    }
  ]
}

Detalhamento dos campos:

Campos do BodyDescrição
id_notificacao_clienteIdentificador da mensagem enviada ao assinante.
data_envioData de envio da notificação.
nome_pacoteO nome do pacote para o qual foi gerada a notificação.
nome_itemO nome do item do pacote para o qual foi gerada a notificação.
descricaoTexto descritivo da notificação.
total_registrosTotal de fundos dentro da lista de registros.
paginaPágina atual da notificação.
total_paginasTotal de páginas que correspondem à notificação na determinada data_envio.
registrosLista de fundos atualizados que geraram a notificação.
codigo_fundoCódigo do fundo atualizado. (aplicável apenas para as APIs de Fundos ICVM 555 ou Offshore)
cnpjCNPJ do fundo atualizado. (aplicável apenas para as APIs de Fundos Estruturados)
data_atualizacaoData em que os dados cadastrais do fundo foram atualizados. (aplicável apenas para as APIs de Detalhes)
data_referencia_inicioData de referência inicial dos dados de série histórica atualizados. (aplicável apenas para as APIs de Série Histórica)
data_referencia_fimData de referência final dos dados de série histórica atualizados. (aplicável apenas para as APIs de Série Histórica)
url_api_feedURL de referência para que os dados possam ser consultados no Feed. Utilize esta informação para consultar as informações atualizadas. Observação: Os parâmetros de “data” já estarão preenchidos na URL, se aplicável.

O quadro abaixo resume os Pacotes, Itens e respectivas APIs disponíveis nesta funcionalidade:

Descriçãonome_pacotenome_itemurl_api_feed
Detalhes do Fundo ICVM 555FUNDOSFUNDOS_DETALHEShttps://api.anbima.com.br/feed/fundos/v1/fundos/{codigoFundo}
Notas Explicativas do Fundo ICVM 555FUNDOSFUNDOS_NOTA_EXPLICATIVAhttps://api.anbima.com.br/feed/fundos/v1/fundos/{codigoFundo}/notas-explicativas
Série Histórica do Fundo ICVM 555FUNDOSFUNDOS_SERIE_HISTORICAhttps://api.anbima.com.br/feed/v1/fundos/{codigoFundo}/serie-historica
Detalhes do Fundo EstruturadoFUNDOS_ESTRUTURADOSFUNDOS_ESTRUTURADOS_DETALHEShttps://api.anbima.com.br/feed/fundos/v1/fundos/{CNPJ}
Série Histórica do FundoFUNDOS_ESTRUTURADOSFUNDOS_ESTRUTURADOS_SERIE_HISTORICAhttps://api.anbima.com.br/feed/fundos/v1/fundos-estruturados/{CNPJ}/serie-historica
Detalhes do Fundo OffshoreFUNDOS_OFFSHOREFUNDOS_OFFSHORE_DETALHEShttps://api.anbima.com.br/feed/fundos/v1/fundos-offshore/{codigoFundo}
Série Histórica do Fundo OffshoreFUNDOS_OFFSHOREFUNDOS_OFFSHORE_SERIE_HISTORICAhttps://api.anbima.com.br/feed/v1/fundos-offshore/{codigoFundo}/serie-historica