Notification Mechanism via API

ANBIMA Feed has resources that allow subscribers to receive notifications in some situations, such as when new information is available in a specific context, or when there is a delay to provide specific information. 

For this mechanism to work properly, the subscriber needs to expose a RESTFul API so that ANBIMA Feed can make the requests. This exposed API must be implemented following the specification below:

Method: POST

URI: defined by the subscriber and informed to ANBIMA for registration (ex. https://endpoint-subscriber.com/resource-subscriber/)

Body:

{
  "tipo_evento": "string",
  "nome_pacote": "string",
  "nome_item": "string",
  "descricao": "string",
  "data_referencia": "string"
}

Authentication 

The authentication type must be “Basic Authentication”, as specified in: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization.

API Fields

Field NameDescription
id_notificacao_clienteIdentifier of the message sent to the subscriber
tipo_eventoType of notification event (ex. NEW, DELAY, UPDATING). This information refers to the event type that generated the notification, for example: new Package/Item data provided by the API
data_envioDate the message was sent
nome_pacoteName of package for which the notification was generated
nome_itemName of package item for which the notification was generated
descricaoDescriptive text of notification
data_referenciaReference date of the data provided
url_api_feedReference URL for data to be verified on Feed

Event Types

NOVO (new) Data made available to the Package/Item and Reference Date informed.

ATUALIZACAO (updating) Data updated for the Package/Item and Reference Date informed Previously stored data for this Package/Item and Reference Date must be deleted and replaced with the new data when this type of notification occurs.

ATRASO (delay) The generation of the Package/Item data and Reference Date informed is delayed.

APIs Path

field to request the correct API. Parameters “date” or “month and year” are already filled out.

The next table summarizes which APIs must be called to request updating of data for each API of the ANBIMA Feed:

Package NameItem NameDescriptionAPI Path Suffix
INDICESCARTEIRA_TEORICA_IDAIDA Theoretical Portfolioindices/carteira-teorica-ida
INDICESRESULTADOS_IDAIDA Resultsindices/resultados-ida-fechado
INDICESCARTEIRA_TEORICA_IHFAIHFA Theoretical Portfolioindices/carteira-teorica-ihfa
INDICESRESULTADOS_IHFAIHFA Resultsindices/resultados-ihfa-fechado
INDICESRESULTADOS_IDKAIDkA Resultsindices/resultados-idka
INDICESRESULTADOS_IMAIMA Resultsindices/resultados-ima
INDICESCARTEIRA_TEORICA_IMAIMA Theoretical Portfolioindices/carteira-teorica-ima
INDICESRESULTADO_INTRADIARIOIMA Intraday Resultsindices/resultados-intradiarios-ima
INDICES_MAISCARTEIRA_TEORICA_IDAIDA Theoretical Portfolioindices-mais/carteira-teorica-ida
INDICES_MAISCARTEIRA_TEORICA_IHFAIHFA Theoretical Portfolioindices-mais/carteira-teorica-ihfa
INDICES_MAISRESULTADOS_IDKAIDkA Resultsindices-mais/resultados-idka
INDICES_MAISCARTEIRA_TEORICA_IMAIMA Theoretical Portfolioindices-mais/carteira-teorica-ima
INDICES_MAISRESULTADO_INTRADIARIOIMA Intraday Resultsindices-mais/resultados-intradiarios-ima
INDICES_MAISPU_INTRADIARIOIMA Intraday Unit Pricesindices-mais/pu-intradiario
INDICES_MAISRESULTADOS_COMPONENTE_IHFAIHFA Results and Componentsindices-mais/resultados-ihfa
INDICES_MAISRESULTADOS_COMPONENTE_IMAIMA Results and Componentsindices-mais/resultados-ima
INDICES_MAISRESULTADOS_COMPONENTE_IDAIDA Results and Componentsindices-mais/resultados-ida
TITULOS_PUBLICOSMERCADO_SECUNDARIO_TPFSecondary Markettitulos-publicos/mercado-secundario-TPF
TITULOS_PUBLICOSVNAFace Value (VNA)titulos-publicos/vna
TITULOS_PUBLICOSCURVAS_JUROSTerm Structure of Interest Ratetitulos-publicos/curvas-juros
TITULOS_PUBLICOSDIFUSAO_TAXASANBIMA’s Bond Market Reporting Systemtitulos-publicos/difusao-taxas
TITULOS_PUBLICOSCURVA_INTRADIARIAIntraday Curvetitulos-publicos/curva-intradiaria
TITULOS_PUBLICOSPROJECAO_IPCA_IGPMIPCA and IGP-M Projectionstitulos-publicos/projecoes
TITULOS_PUBLICOSESTIMATIVA_SELICSELIC Estimatetitulos-publicos/estimativa-selic
TITULOS_PUBLICOSPU_INTRADIARIOIntraday Unit Pricestitulos-publicos/pu-intradiario
DEBENTURESCURVAS_CREDITOCredit Curvesdebentures/curvas-credito
DEBENTURESPROJECAO_IPCA_IGPMIPCA and IGP-M Projectionsdebentures/projecoes
DEBENTURESMERCADO_SECUNDARIO_DEBENTURESSecondary Marketdebentures/mercado-secundario
CRI_CRAPROJECAO_IPCA_IGPMIPCA and IGP-M Projectionscri-cra/projecoes
CRI_CRAMERCADO_SECUNDARIO_CRICRASecondary Marketcri-cra/mercado-secundario
IMA_ETFPREVIA_CARTEIRA_TEORICA_IMAForward-looking Index Constituentsima-etf/previa-carteira-teorica
IMA_ETFCARTEIRA_TEORICA_IMATheoretical Portfolioima-etf/carteira-teorica
IMA_ETFRESULTADO_DIARIODaily Resultima-etf/resultado-diario
IMA_ETFCOMPOSICAO_DIARIADaily Compositionima-etf/composicao-diaria
IMA_ETFPU_INTRADIARIOIntraday Unit Pricesima-etf/pu-intradiario
IMA_ETFRESULTADO_INTRADIARIOIntraday Resultsima-etf/resultado-intradiario
IMA_ETFNEGOCIOS_EXTRAExtragroup Trading Dataima-etf/negocios-extra
FUNDOSFUNDOS_LISTA_COMPLETATotal List of Fundsfundos
FUNDOSFUNDOS_DETALHESFund Detailsfundos/{codigoFundo}
FUNDOSFUNDOS_NOTA_EXPLICATIVAFund Explanatory Notesfundos/{codigoFundo}/notas-explicativas
FUNDOSFUNDOS_SERIE_HISTORICAFund Historical Seriefundos/{codigoFundo}/serie-historica

Error Codes

HTTP CodeDescription
400Bad request. Please, verify the request URI
401Request needs authentication. Probably, “base64 code” sent by ANBIMA may have been created with invalid credentials or may be missing in the request header.
405Method not allowed. The request method must be POST. Please verify.
406Invalid Content or Content-Type. Please, verify the content in the request body (it is expected a JSON containing the notification fields)
5XXUnexpected server internal error

Success Codes

Código HTTPDescrição
200Notification received successfully