Аутентификация
API CoinBoss общедоступен. Для вызова любого эндпоинта данных не нужны ни учётная запись, ни API-ключ.
Ключ не требуется
Любой эндпоинт из каталога вызывается обычным запросом HTTPS GET. Анонимные запросы ограничиваются по IP-адресу; лимит запросов в минуту: 1200.
curl -s "https://www.coinboss.com/api/sd/oi?coin=BTC"Необязательный API-ключ
Если несколько ваших сервисов используют один IP-адрес или вызовы идут из сети с меняющимся адресом, создайте ключ в своей учётной записи и передавайте его в заголовке CB-API-KEY. Запрос с действительным ключом учитывается в лимите ключа, а не IP-адреса.
- Ключи создаются и отзываются на странице API-ключей учётной записи. Требуется подтверждённый адрес электронной почты.
- Ключ показывается целиком один раз — при создании. Хранится только его хеш, поэтому показать ключ повторно невозможно.
- У одной учётной записи может быть не более пяти активных ключей.
- Неизвестный или отозванный ключ игнорируется: запрос обрабатывается как анонимный и учитывается в лимите IP-адреса.
Запрос с ключом
curl -s "https://www.coinboss.com/api/sd/oi?coin=BTC" \
-H "CB-API-KEY: $COINBOSS_API_KEY"Тарифы и лимиты запросов
Все тарифы возвращают одни и те же данные. В течение текущего бесплатного периода анонимный трафик и все ключи обслуживаются по высшему тарифу.
| Тариф | Запросов в минуту | |
|---|---|---|
| hobbyist | 30 | |
| startup | 80 | |
| standard | 300 | |
| professional | 1200 | сейчас действует для всех |
Безопасное хранение ключей
- Обращайтесь с ключом как с паролем. Храните его в переменной окружения или в хранилище секретов, а не в исходном коде.
- Не встраивайте ключ в веб-страницу, браузерное расширение или мобильное приложение. Всё, что передано клиенту, могут прочитать его пользователи. Вызывайте API со своего сервера либо анонимно из браузера.
- При первом подозрении на утечку отзовите ключ и создайте новый.
- CoinBoss никогда не запрашивает API-ключи бирж. Данные собираются из публичных эндпоинтов бирж; учётные данные бирж этому API не нужны, и он их не принимает.
Вызов из браузера
Ответы содержат заголовок Access-Control-Allow-Origin: *, поэтому эндпоинты данных можно вызывать с любого веб-источника. Заголовки X-Request-Id, X-Cache и X-RateLimit-* доступны скриптам.
Эндпоинты учётной записи
Эндпоинты /api/user и /api/auth обслуживают функции сайта для авторизованных пользователей (списки наблюдения, настройки, управление ключами). Они используют сессию сайта, не входят в публичный API данных и не указаны в каталоге.