Autenticação
A API da CoinBoss é pública. Você não precisa de conta nem de chave de API para chamar qualquer endpoint de dados.
Sem necessidade de chave
Chame qualquer endpoint do catálogo com um simples GET por HTTPS. As requisições anônimas são limitadas por endereço IP: 1200 requisições por minuto.
curl -s "https://www.coinboss.com/api/sd/oi?coin=BTC"Chave de API opcional
Se vários dos seus serviços compartilham um mesmo endereço IP, ou se você chama a API de uma rede cujo endereço muda, é possível criar uma chave na sua conta e enviá-la no cabeçalho CB-API-KEY. Uma requisição com chave válida é contabilizada na chave, e não no endereço IP.
- As chaves são criadas e revogadas na página de chaves de API da sua conta. É necessário ter um endereço de e-mail verificado.
- A chave completa é exibida uma única vez, na criação. Apenas um hash é armazenado, portanto ela não pode ser exibida novamente.
- Cada conta pode ter até cinco chaves ativas.
- Uma chave desconhecida ou revogada é ignorada: a requisição é atendida como anônima e contabilizada no endereço IP.
Requisição com chave
curl -s "https://www.coinboss.com/api/sd/oi?coin=BTC" \
-H "CB-API-KEY: $COINBOSS_API_KEY"Níveis de limite de requisições
Todos os níveis retornam os mesmos dados. Durante o atual período gratuito, o tráfego anônimo e todas as chaves são atendidos no nível mais alto.
| Nível | Requisições por minuto | |
|---|---|---|
| hobbyist | 30 | |
| startup | 80 | |
| standard | 300 | |
| professional | 1200 | vigente para todos |
Como manter as chaves seguras
- Trate a chave como uma senha. Guarde-a em uma variável de ambiente ou em um cofre de segredos, não no código-fonte.
- Não inclua a chave em uma página web, em uma extensão de navegador nem em um aplicativo móvel. Tudo o que é distribuído a um cliente pode ser lido pelos seus usuários. Chame a API a partir do seu servidor, ou chame-a anonimamente a partir do navegador.
- Revogue a chave assim que suspeitar de vazamento e crie uma nova.
- A CoinBoss nunca pede chaves de API de corretoras. Os dados são coletados de endpoints públicos das corretoras, e esta API não exige nem aceita nenhuma credencial de corretora.
Chamadas a partir do navegador
As respostas incluem Access-Control-Allow-Origin: *, portanto os endpoints de dados podem ser chamados de qualquer origem web. Os cabeçalhos X-Request-Id, X-Cache e X-RateLimit-* ficam expostos aos scripts.
Endpoints de conta
Os endpoints em /api/user e /api/auth pertencem à experiência autenticada do site (listas de favoritos, preferências, gerenciamento de chaves). Eles usam a sessão do site, não fazem parte da API pública de dados e não constam do catálogo.