O ANBIMA Feed possui recursos que permitem que os assinantes sejam acionados com notificações em algumas situações específicas. Por exemplo, exemplo quando existirem novas informações disponíveis, ou quando houver atraso para a disponibilização de determinadas informações.
Para que este mecanismo funcione corretamente, é necessário que o assinante exponha uma API RESTFul para que o ANBIMA Feed possa fazer os respectivos acionamentos. A API deverá ser implementada de acordo com a especificação abaixo:
Método: POST
URI: definida pelo assinante e informada à ANBIMA para cadastro (ex. https://endpoint-cliente.com/recurso-cliente/)
Body:
{
"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",
}
Autenticação
É necessário que o tipo de autenticação seja a “Basic Authentication”, conforme especificado em: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization.
Campos da API
Nome Campo | Descrição |
id_notificacao_cliente | Identificador da mensagem enviada ao assinante |
tipo_evento | Tipo do evento de notificação (ex. NOVO, ATRASO, ATUALIZACAO). Esta informação refere-se ao tipo do evento que gerou a notificação, por ex: novos dados de Pacote/Item disponibilizados pela API |
data_envio | Data em que a mensagem foi enviada |
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 | A data de referência dos dados disponibilizados |
url_api_feed | URL de Referência para que os dados possam ser consultados no Feed |
Tipos de Evento
NOVO
Dados disponibilizados para o Pacote/Item e Data de Referência informados
ATUALIZACAO
Dados corrigidos 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 de Pacote/Item e Data de Referência informados estão em atraso na sua geração.
URLs de Referência
Quando o ANBIMA Feed envia uma notificação, ele já possui novos dados para divulgar. Assim, logo após receber uma mensagem de notificação, seu sistema já poderá requisitar estes dados, invocando uma de nossas APIs. Utilize a informação contida no campo url_api_feed
para invocar a API correta. Os parâmetros de “data” ou “mês e ano” já vem preenchidos.
O quadro abaixo resume quais APIs devem ser chamadas para solicitar a atualização de dados para cada API do ANBIMA Feed:
Nome Pacote | Nome Item | Descrição | Sufixo Path API |
INDICES | CARTEIRA_TEORICA_IDA | Carteira Teórica IDA | indices/carteira-teorica-ida |
INDICES | RESULTADOS_IDA | Resultados IDA | indices/resultados-ida-fechado |
INDICES | CARTEIRA_TEORICA_IHFA | Carteira Teórica IHFA | indices/carteira-teorica-ihfa |
INDICES | RESULTADOS_IHFA | Resultados IHFA | indices/resultados-ihfa-fechado |
INDICES | RESULTADOS_IDKA | Resultados IDKA | indices/resultados-idka |
INDICES | RESULTADOS_IMA | Resultados IMA | indices/resultados-ima |
INDICES | CARTEIRA_TEORICA_IMA | Carteira Teórica IMA | indices/carteira-teorica-ima |
INDICES | RESULTADO_INTRADIARIO | Resultado Intradiário | indices/resultados-intradiarios-ima |
INDICES_MAIS | CARTEIRA_TEORICA_IDA | Carteira Teórica IDA | indices-mais/carteira-teorica-ida |
INDICES_MAIS | CARTEIRA_TEORICA_IHFA | Carteira Teórica IHFA | indices-mais/carteira-teorica-ihfa |
INDICES_MAIS | RESULTADOS_IDKA | Resultados IDKA | indices-mais/resultados-idka |
INDICES_MAIS | CARTEIRA_TEORICA_IMA | Carteira Teórica IMA | indices-mais/carteira-teorica-ima |
INDICES_MAIS | RESULTADO_INTRADIARIO | Resultado Intradiário | indices-mais/resultados-intradiarios-ima |
INDICES_MAIS | PU_INTRADIARIO | PU Intradiário | indices-mais/pu-intradiario |
INDICES_MAIS | RESULTADOS_COMPONENTE_IHFA | Resultados e Componentes IHFA | indices-mais/resultados-ihfa |
INDICES_MAIS | RESULTADOS_COMPONENTE_IMA | Resultados e Componentes IMA | indices-mais/resultados-ima |
INDICES_MAIS | RESULTADOS_COMPONENTE_IDA | Resultados e Componentes IDA | indices-mais/resultados-ida |
TITULOS_PUBLICOS | MERCADO_SECUNDARIO_TPF | Mercado Secundário | titulos-publicos/mercado-secundario-TPF |
TITULOS_PUBLICOS | VNA | VNA | titulos-publicos/vna |
TITULOS_PUBLICOS | CURVAS_JUROS | Curvas de Juros | titulos-publicos/curvas-juros |
TITULOS_PUBLICOS | DIFUSAO_TAXAS | Difusão de Taxas | titulos-publicos/difusao-taxas |
TITULOS_PUBLICOS | CURVA_INTRADIARIA | Curva Intradiária | titulos-publicos/curva-intradiaria |
TITULOS_PUBLICOS | PROJECAO_IPCA_IGPM | Projeções IGPM e IPCA | titulos-publicos/projecoes |
TITULOS_PUBLICOS | ESTIMATIVA_SELIC | Estimativa Selic | titulos-publicos/estimativa-selic |
TITULOS_PUBLICOS | PU_INTRADIARIO | PU Intradiário | titulos-publicos/pu-intradiario |
DEBENTURES | CURVAS_CREDITO | Curvas de Crédito | debentures/curvas-credito |
DEBENTURES | PROJECAO_IPCA_IGPM | Projeções IGPM e IPCA | debentures/projecoes |
DEBENTURES | MERCADO_SECUNDARIO_DEBENTURES | Mercado Secundário Deb | debentures/mercado-secundario |
CRI_CRA | PROJECAO_IPCA_IGPM | Projeções IGPM e IPCA | cri-cra/projecoes |
CRI_CRA | MERCADO_SECUNDARIO_CRICRA | Mercado Secundário CRI-CRA | cri-cra/mercado-secundario |
IMA_ETF | PREVIA_CARTEIRA_TEORICA_IMA | Prévia Carteira Teórica | ima-etf/previa-carteira-teorica |
IMA_ETF | CARTEIRA_TEORICA_IMA | Carteira Teórica IMA | ima-etf/carteira-teorica |
IMA_ETF | RESULTADO_DIARIO | Resultado Diário | ima-etf/resultado-diario |
IMA_ETF | COMPOSICAO_DIARIA | Composição Diária | ima-etf/composicao-diaria |
IMA_ETF | PU_INTRADIARIO | PU Intradiário | ima-etf/pu-intradiario |
IMA_ETF | RESULTADO_INTRADIARIO | Resultado Intradiário | ima-etf/resultado-intradiario |
IMA_ETF | NEGOCIOS_EXTRA | Negócios Extra | ima-etf/negocios-extra |
FUNDOS | FUNDOS_LISTA_COMPLETA | Lista Completa de Fundos | fundos |
FUNDOS | FUNDOS_DETALHES | Detalhes do Fundo | fundos/{codigoFundo} |
FUNDOS | FUNDOS_NOTA_EXPLICATIVA | Notas Explicativas do Fundo | fundos/{codigoFundo}/notas-explicativas |
FUNDOS* | FUNDOS_SERIE_HISTORICA* | Fundos Série Histórica* | fundos/{codigoFundo}/serie-historica* |
FUNDOS_ESTRUTURADOS | FUNDOS_ESTRUTURADOS_LISTA_COMPLETA | Lista completa de Fundos Estruturados | fundos-estruturados |
FUNDOS_ESTRUTURADOS | FUNDOS_ESTRUTURADOS_DETALHES | Detalhes do Fundo Estruturado | fundos-estruturados/{CNPJ} |
FUNDOS_ESTRUTURADOS* | FUNDOS_ESTRUTURADOS_SERIE_HISTORICA* | Fundos Estruturados Série Histórica* | fundos-estruturados/{CNPJ}/serie-historica* |
Códigos de Erro
Código HTTP | Descrição |
400 | Requisição malformada. Por favor, verifique a URI da requisição |
401 | Requisição requer autenticação. Provavelmente o “código base64” enviado pela ANBIMA pode ter sido criado com credenciais inválidas, ou pode estar ausente no header da chamada. |
405 | Método não permitido. O método da chamada deve ser POST, por favor, verificar |
406 | Conteúdo ou Content-Type inválido. Por favor verificar o conteúdo enviado no Body da chamada (esperamos um json contendo os campos referentes à notificação) |
5XX | Erro interno inesperado no servidor |
Códigos de Sucesso
Código HTTP | Descrição |
200 | Notificação recebida com sucesso |