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

Доступные данные

Список доступных категорий данных для компании.

Возвращает количество доступных записей по различным категориям данных для указанной компании.

Эндпоинт

GET /api/v1/companies/:company_id/data

Параметры

ПараметрТипГдеОписание
company_idintegerpathУникальный идентификатор компании.

Примеры кода

Получение доступных данных

import requests

url = 'https://statsnet.co/api/v1/companies/12345/data'
headers = {
  'Authorization': 'Bearer sk_live_YOUR_KEY',
  'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers).json()
print(response)

Ответ

Тело ответа без обёртки {"ok": ...}: на верхнем уровне — массивы записей по категориям и объект meta со счётчиками. Массивы заполняются только после покупки карточки компании (иначе приходят пустыми/null); счётчики в meta доступны всегда.

Успешный ответ

{
  "bank_accounts": [],
  "stores": [],
  "certs": [],
  "debtors": [],
  "jobs": [],
  "quasi_contracts": [],
  "places": [],
  "states": [],
  "pos_terminals": [],
  "domains": [],
  "scoring": [],
  "gov_loans": [],
  "trademarks": [],
  "counterparties": [],
  "kaspi_shops": [],
  "assets": [{ "type": "Транспортное средство" }],
  "rights": [],
  "farmers": [],
  "fields": [],
  "counterparties_count": 12,
  "meta": {
    "bank_accounts_count": 3,
    "stores_count": 0,
    "certs_count": 2,
    "debtors_count": 1,
    "quasi_contracts_count": 0,
    "jobs_count": 5,
    "places_count": 0,
    "states_count": 0,
    "pos_terminals_count": 0,
    "domains_count": 1,
    "scoring_count": 0,
    "assets_count": 1,
    "rights_count": 0,
    "farmers_count": 0,
    "fields_count": 0,
    "gov_loans_count": 0,
    "trademarks_count": 0,
    "counterparties_count": 12,
    "kaspi_count": 0
  }
}
ПолеТипОписание
bank_accounts, stores, certs, debtors, jobs, quasi_contracts, places, states, pos_terminals, domains, scoring, gov_loans, trademarks, counterparties, kaspi_shops, rights, farmers, fieldsarrayСписки записей по категориям данных.
assetsarrayТипы активов из налоговых данных (транспорт, недвижимость, земельный участок).
counterparties_countintegerКоличество записей о контрагентах.
metaobjectСчётчики записей по категориям (*_count).

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

Ошибки возвращаются в формате {"status": <HTTP-код>, "message": "<текст>"}.

Ответ с ошибкой

{
  "status": 403,
  "message": "access denied"
}