Документация API

Аутентификация

Как аутентифицировать ваши API-запросы к Statsnet.

Statsnet аутентифицирует API-запросы с помощью API-ключей. Ключ выглядит как sk_live_... и передаётся в одном из двух заголовков — они эквивалентны:

Заголовки аутентификации

x-api-key: sk_live_YOUR_KEY
# или
Authorization: Bearer sk_live_YOUR_KEY

Как получить ключ

Ключи создаются в личном кабинете — до 10 на аккаунт. Полное значение ключа показывается один раз при создании; сохраните его в надёжном месте. Ключи можно переименовывать и отзывать, а также смотреть расход по каждому ключу за текущий месяц.

Если у вас ещё нет аккаунта Statsnet, зарегистрируйтесь — это займёт несколько минут.

Что доступно по ключу

Ключ наследует подписку аккаунта, который его создал:

  • Без активного тарифа — ключ работает, но только на публичных эндпоинтах (карточка meta/beta, поиск, markdown-карточка).
  • Тарифы с отчётами (Basic, Premium, Enterprise) — платные эндпоинты списывают один отчёт за компанию; повторный просмотр той же компании в течение 2 недель бесплатен.
  • API-тарифы — каждый вызов метерится против месячного лимита с ограничением частоты. Текущий расход возвращается в каждом ответе в заголовках X-API-Calls-Used и X-API-Calls-Limit; превышение лимита возвращает 429.

Примеры кода

Пример API-запроса

import requests

url = 'https://statsnet.co/api/v1/companies/search'
headers = {
  'Authorization': 'Bearer sk_live_YOUR_KEY',
  'Content-Type': 'application/json'
}
body = {'query': 'kaspi', 'filters': {'jurisdiction': ['kz']}}

response = requests.post(url, json=body, headers=headers).json()
print(response)

Обработка ошибок

Неверный, отозванный или отсутствующий ключ на защищённом эндпоинте возвращает JSON-ошибку с соответствующим HTTP-статусом:

Error response

{
  "status": 403,
  "message": "access denied"
}
СтатусЗначение
401Сессия или учётные данные истекли.
402У аккаунта ключа нет активной подписки (отменена или истекла).
403Нет доступа — анонимный запрос к защищённому эндпоинту или недостаточный тариф.
429Исчерпан месячный лимит API-вызовов или превышена частота. Смотрите X-API-Calls-Used / X-API-Calls-Limit.