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

Связи (граф)

Получение связей и аффилированности компании в виде графа.

Возвращает связи и аффилированность компании в формате графа с узлами и связями.

Эндпоинт

GET /api/v1/companies/:company_id/relations

Параметры

ПараметрТипГдеОписание
company_idintegerpathУникальный идентификатор компании.
pageintegerqueryНомер страницы (по умолчанию: 1).
limitintegerqueryЗаписей на странице (по умолчанию: 100).

Примеры кода

Получение связей (граф)

import requests

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

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

Ответ

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

{
  "node": [
    { "id": 12345, "name": "Компания А", "type": "company", "is_person": false, "key": 12345 },
    { "id": 777001, "name": "Иванов И.И.", "type": "person", "is_person": true, "key": 777001 }
  ],
  "links": [
    {
      "id": 777001,
      "name": "Иванов И.И.",
      "source_key": 777001,
      "type": "person",
      "connection_type": "officers",
      "connection_id": 12345,
      "connection_name": "Компания А",
      "root_company_id": 12345,
      "connection_hash_identifier": "5f4dcc3b5aa765d61d8327deb882cf99",
      "connection_key": 12345,
      "is_person": true
    }
  ],
  "meta": {
    "officers": 1,
    "shareholders": 0
  },
  "total": 1
}

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

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

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

Это платный эндпоинт. Возможны также ответы 402 — {"status": 402, "message": "payment required"} — если подписка истекла, отменена или просрочена, и 429 — {"status": 429, "message": "quota exhausted"} — когда квота отчётов тарифа за текущий период исчерпана.