Ir para o conteúdo

Usar a API

A API é gratuita e só de leitura. Não há chave nem conta. Todas as respostas são JSON.

curl https://api.thebgdb.org/v1/search?q=azul

Descrição OpenAPI

A descrição completa, legível por máquinas, de cada rota, parâmetro e resposta é publicada com cada versão em api.thebgdb.org/v1/openapi.json. Pode ser carregada em qualquer ferramenta OpenAPI para explorar a API ou gerar um cliente. Cobre também contas, fotos e listas.

A mesma descrição pode ser lida como página: a referência da API.

Os pedidos principais

PedidoDevolve
GET /v1/search?q=catanOs jogos cujo nome contém todas as palavras de q. Ignora maiúsculas e acentos; não corrige erros de escrita. q precisa de pelo menos dois caracteres.
GET /v1/games/{id}Um jogo, pelo id que cada objeto de jogo traz: descrição, jogadores, duração, créditos e fotos.
GET /v1/games?limit=50O catálogo, uma página de cada vez. Para obter a página seguinte, passe como cursor o nextCursor recebido.
GET /v1/healthSe a API está a funcionar.

Conectar um assistente de IA (MCP)

Os assistentes que usam o Model Context Protocol podem consultar o catálogo diretamente. Adicione este endereço de servidor ao assistente:

https://mcp.thebgdb.org/mcp

Não é preciso entrar numa conta. Para um assistente poder ver e editar as suas listas, use antes https://mcp.thebgdb.org/member: pede primeiro para entrar na conta e aprovar. Um token da API criado na página da conta também funciona no primeiro endereço.

Limites

Sem token: 300 pedidos por minuto por endereço. Com um token da API criado na página da conta: 1.200 por minuto, ou 6.000 no plano pago. Acima do limite, a API responde 429; espere um minuto e continue. As respostas ficam em cache até cinco minutos, por isso uma alteração pode demorar esse tempo a aparecer.