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 Body | Descrição |
id_notificacao_cliente | Identificador da mensagem enviada ao assinante |
tipo_evento | Esta 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_envio | Data de envio da notificação. |
nome_pacote | O nome do pacote para o qual foi gerada a notificação |
nome_item | O nome do item do pacote para o qual foi gerada a notificação |
descricao | Texto descritivo da notificação |
data_referencia | Data de referência dos dados do Pacote/Item |
url_api_feed | URL 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ção | nome_pacote | nome_item | url_api_feed |
| Mercado Secundário de Títulos Públicos | TITULOS_PUBLICOS | MERCADO_SECUNDARIO_TPF | https://api.anbima.com.br/feed/precos-indices/v1/titulos-publicos/mercado-secundario-TPF |
| Valor Nominal Atualizado de Títulos Públicos | TITULOS_PUBLICOS | VNA | https://api.anbima.com.br/feed/precos-indices/v1/titulos-publicos/vna |
| Curvas de Juros | TITULOS_PUBLICOS | CURVAS_JUROS | https://api.anbima.com.br/feed/precos-indices/v1/titulos-publicos/curvas-juros |
| Curva Intradiária | TITULOS_PUBLICOS | CURVA_INTRADIARIA | https://api.anbima.com.br/feed/precos-indices/v1/titulos-publicos/curva-intradiaria |
| Preço Unitário Intradiário | TITULOS_PUBLICOS | PU_INTRADIARIO | https://api.anbima.com.br/feed/precos-indices/v1/titulos-publicos/pu-intradiario |
| Difusão de Taxas | TITULOS_PUBLICOS | DIFUSAO_TAXAS | https://api.anbima.com.br/feed/precos-indices/v1/titulos-publicos/difusao-taxas |
| Estimativa SELIC | TITULOS_PUBLICOS | ESTIMATIVA_SELIC | https://api.anbima.com.br/feed/precos-indices/v1/titulos-publicos/estimativa-selic |
| Projeções IPCA e IGP-M | TITULOS_PUBLICOS | PROJECAO_IPCA_IGPM | https://api.anbima.com.br/feed/precos-indices/v1/titulos-publicos/projecoes |
| Mercado Secundário de Debêntures | DEBENTURES | MERCADO_SECUNDARIO_DEBENTURES | https://api.anbima.com.br/feed/precos-indices/v1/debentures/mercado-secundario |
| Curvas de Crédito | DEBENTURES | CURVAS_CREDITO | https://api.anbima.com.br/feed/precos-indices/v1/debentures/curvas-credito |
| Projeções IPCA e IGP-M | DEBENTURES | PROJECAO_IPCA_IGPM | https://api.anbima.com.br/feed/precos-indices/v1/debentures/projecoes |
| Mercado Secundário de CRI e CRA | CRI_CRA | MERCADO_SECUNDARIO_CRICRA | https://api.anbima.com.br/feed/precos-indices/v1/cri-cra/mercado-secundario |
| Projeções IPCA e IGP-M | CRI_CRA | PROJECAO_IPCA_IGPM | https://api.anbima.com.br/feed/precos-indices/v1/cri-cra/projecoes |
| IDA Carteira Teórica | INDICES_MAIS | CARTEIRA_TEORICA_IDA | https://api.anbima.com.br/feed/precos-indices/v1/indices-mais/carteira-teorica-ida |
| IDA Resultados e Componentes | INDICES_MAIS | RESULTADOS_COMPONENTE_IDA | https://api.anbima.com.br/feed/precos-indices/v1/indices-mais/resultados-ida |
| IHFA Carteira Teórica | INDICES_MAIS | CARTEIRA_TEORICA_IHFA | https://api.anbima.com.br/feed/precos-indices/v1/indices-mais/carteira-teorica-ihfa |
| IHFA Resultados e Componentes | INDICES_MAIS | RESULTADOS_COMPONENTE_IHFA | https://api.anbima.com.br/feed/precos-indices/v1/indices-mais/resultados-ihfa |
| IDkA Resultados | INDICES_MAIS | RESULTADOS_IDKA | https://api.anbima.com.br/feed/precos-indices/v1/indices-mais/resultados-idka |
| IMA Carteira Teórica | INDICES_MAIS | CARTEIRA_TEORICA_IMA | https://api.anbima.com.br/feed/precos-indices/v1/indices-mais/carteira-teorica-ima |
| IMA Resultados e Componentes | INDICES_MAIS | RESULTADOS_COMPONENTE_IMA | https://api.anbima.com.br/feed/precos-indices/v1/indices-mais/resultados-ima |
| IMA Resultado Intradiário | INDICES_MAIS | RESULTADO_INTRADIARIO | https://api.anbima.com.br/feed/precos-indices/v1/indices/resultados-intradiarios-ima |
| IMA PU Intradiário | INDICES_MAIS | PU_INTRADIARIO | https://api.anbima.com.br/feed/precos-indices/v1/indices-mais/pu-intradiario |
| IDA Carteira Teórica | INDICES | CARTEIRA_TEORICA_IDA | https://api.anbima.com.br/feed/precos-indices/v1/indices/carteira-teorica-ida |
| IDA Resultados | INDICES | RESULTADOS_IDA | https://api.anbima.com.br/feed/precos-indices/v1/indices/resultados-ida-fechado |
| IHFA Carteira Teórica | INDICES | CARTEIRA_TEORICA_IHFA | https://api.anbima.com.br/feed/precos-indices/v1/indices/carteira-teorica-ihfa |
| IHFA Resultados | INDICES | RESULTADOS_IHFA | https://api.anbima.com.br/feed/precos-indices/v1/indices/resultados-ihfa-fechado |
| IDkA Resultados | INDICES | RESULTADOS_IDKA | https://api.anbima.com.br/feed/precos-indices/v1/indices/resultados-idka |
| IMA Carteira Teórica | INDICES | CARTEIRA_TEORICA_IMA | https://api.anbima.com.br/feed/precos-indices/v1/indices/carteira-teorica-ima |
| IMA Resultados | INDICES | RESULTADOS_IMA | https://api.anbima.com.br/feed/precos-indices/v1/indices/resultados-ima |
| IMA Resultado Intradiário | INDICES | RESULTADO_INTRADIARIO | https://api.anbima.com.br/feed/precos-indices/v1/indices/resultados-intradiarios-ima |
| Prévia da Carteira Teórica | IMA_ETF | PREVIA_CARTEIRA_TEORICA_IMA | https://api.anbima.com.br/feed/precos-indices/v2/ima-etf/previa-carteira-teorica |
| Carteira Teórica | IMA_ETF | CARTEIRA_TEORICA_IMA | https://api.anbima.com.br/feed/precos-indices/v2/ima-etf/carteira-teorica |
| Resultado Diário | IMA_ETF | RESULTADO_DIARIO | https://api.anbima.com.br/feed/precos-indices/v2/ima-etf/resultado-diario |
| Composição Diária | IMA_ETF | COMPOSICAO_DIARIA | https://api.anbima.com.br/feed/precos-indices/v2/ima-etf/composicao-diaria |
| Resultado Intradiário | IMA_ETF | RESULTADO_INTRADIARIO | https://api.anbima.com.br/feed/precos-indices/v2/ima-etf/resultado-intradiario |
| PU Intradiário | IMA_ETF | PU_INTRADIARIO | https://api.anbima.com.br/feed/precos-indices/v2/ima-etf/pu-intradiario |
| Negócios Extra | IMA_ETF | NEGOCIOS_EXTRA | https://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_fundo": "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_fundo": "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 Body | Descrição |
| id_notificacao_cliente | Identificador da mensagem enviada ao assinante. |
| data_envio | Data de envio da notificação. |
| nome_pacote | O nome do pacote para o qual foi gerada a notificação. |
| nome_item | O nome do item do pacote para o qual foi gerada a notificação. |
| descricao | Texto descritivo da notificação. |
| total_registros | Total de fundos dentro da lista de registros. |
| pagina | Página atual da notificação. |
| total_paginas | Total de páginas que correspondem à notificação na determinada data_envio. |
| registros | Lista de fundos atualizados que geraram a notificação. |
| codigo_fundo | Código do fundo atualizado. (aplicável apenas para as APIs de Fundos ICVM 555 ou Offshore) |
| cnpj | CNPJ do fundo atualizado. (aplicável apenas para as APIs de Fundos Estruturados) |
| data_atualizacao | Data em que os dados cadastrais do fundo foram atualizados. (aplicável apenas para as APIs de Detalhes) |
| data_referencia_inicio | Data 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_fim | Data 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_feed | URL 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ção | nome_pacote | nome_item | url_api_feed |
| Detalhes do Fundo ICVM 555 | FUNDOS | FUNDOS_DETALHES | https://api.anbima.com.br/feed/fundos/v1/fundos/{codigoFundo} |
| Notas Explicativas do Fundo ICVM 555 | FUNDOS | FUNDOS_NOTA_EXPLICATIVA | https://api.anbima.com.br/feed/fundos/v1/fundos/{codigoFundo}/notas-explicativas |
| Série Histórica do Fundo ICVM 555 | FUNDOS | FUNDOS_SERIE_HISTORICA | https://api.anbima.com.br/feed/v1/fundos/{codigoFundo}/serie-historica |
| Detalhes do Fundo Estruturado | FUNDOS_ESTRUTURADOS | FUNDOS_ESTRUTURADOS_DETALHES | https://api.anbima.com.br/feed/fundos/v1/fundos/{CNPJ} |
| Série Histórica do Fundo | FUNDOS_ESTRUTURADOS | FUNDOS_ESTRUTURADOS_SERIE_HISTORICA | https://api.anbima.com.br/feed/fundos/v1/fundos-estruturados/{CNPJ}/serie-historica |
| Detalhes do Fundo Offshore | FUNDOS_OFFSHORE | FUNDOS_OFFSHORE_DETALHES | https://api.anbima.com.br/feed/fundos/v1/fundos-offshore/{codigoFundo} |
| Série Histórica do Fundo Offshore | FUNDOS_OFFSHORE | FUNDOS_OFFSHORE_SERIE_HISTORICA | https://api.anbima.com.br/feed/v1/fundos-offshore/{codigoFundo}/serie-historica |