Informações gerais
O ANBIMA Feed Fundos é composto por APIs RESTFul baseadas no protocolo HTTP, utilizadas para a disponibilização de dados de fundos de investimento.
Atualmente, temos padronizado o formato de entrega dos principais dados de Fundos ICVM 555, Fundos Estruturados (FIDC, FII e FIP) e Fundos Offshore.
Demonstração (Swagger)
As nossas APIs foram desenvolvidas utilizando o OpenAPI Specification, o que dará a você desenvolvedor uma maior flexibilidade no consumo.
Vantagens do uso do Swagger:
- Try it out: permite a realização de testes iniciais diretamente em nossa plataforma.
- REST: padrão de fácil integração
Acesse já o Portal Swagger – ANBIMA Feed Fundos
Primeiros passos
Conheça nossos ambientes
Nossas APIs podem ser acessadas através de dois ambientes: Sandbox e Produção.
O ambiente de Sandbox pode ser utilizado para testes gerais do serviço, tal como verificar o formato de resposta de um recurso específico da API. Neste momento os dados retornados serão fixos e fictícios.
Já as informações oficiais poderão ser obtidas apenas através do ambiente de produção.
Como realizar chamadas aos recursos de nossa API?
Na prática, uma chamada a esta API considera sempre o modelo de uri abaixo
https://[ambiente]/[produto]/[versão]/[pacote]/[recursos]/[parâmetros]
sendo:
protocolo: https
ambiente: api.anbima.com.br
(Produção) ou api-sandbox.anbima.com.br/mocks
(Sandbox)
produto: feed/fundos
versão: v1
Logo, a URI a ser utilizada para acesso a qualquer uma das APIs do ANBIMA Feed seria:
https://[ambiente]/feed/fundos/v1/fundos/[recursos]
ou
https://[ambiente]/feed/fundos/v1/fundos-estruturados/[recursos]
ou
https://[ambiente]/feed/fundos/v1/fundos-offshore/[recursos]
Lembrando que todos recursos desta API são privados e apenas podem ser acessados em ambientes de Sandbox e Produção através do padrão de autenticação OAuth2 (explicado em detalhes na seção Autenticação).
Códigos de Erro
Código HTTP | Descrição |
400 | Requisição malformada. Por favor, verifique a URI da requisição e os parâmetros informados |
401 | Requisição não foi devidamente autenticada. Os valores informados de client_id e/ou access_token não são válidos |
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 | Consulta com sucesso. Dados disponíveis e informados no body da resposta. |