x/
community

Получайте публичные сведения о сообществах X по ссылкам на них, включая описания, число участников и правила, с возможностью запросить несколько сообществ сразу.

X Community API

Сведения о сообществе
Число участников и модераторов
Правила и условия вступления
0,5 кредита за результат
Готово
Готово

Введите параметры и отправьте запрос. Здесь появятся статус задачи и нормализованные результаты.

README

Автор: SocQ · Обновлено

X Community

Сообщество X — это тематическое пространство для обсуждений с названием, описанием, числом участников и правилами участия. Эти сведения помогают понять тематику сообщества, сравнить его размер с другими и проверить правила участия, прежде чем переходить к обсуждениям.

Возможности X Community API

  • Понятно, о чем сообществоПолучайте вместе название сообщества, публичное описание, ссылку, обложку и данные о создателе, чтобы определить пространство и прочитать заявленную тему еще до поиска постов.
  • Размер сообщества и правила вступленияПолучайте число участников и модераторов вместе с join_policy и invites_policy, которые описывают, как устроены вступление и приглашение участников.
  • Собственные правила сообществаСписок rules содержит названия и описания правил, поэтому требования к участию можно хранить рядом с основными сведениями о сообществе.

Параметры X Community API

ПараметрыОбязательныйОписание
urlsОбязательныйОбязательный список ссылок на публичные сообщества X с числовым ID сообщества, например https://x.com/i/communities/1493446837214187523; в песочнице указывайте по одной ссылке на строку, а в коде используйте JSON-массив urls, но не ссылки на профиль, поиск или отдельный пост.

Как использовать X Community API

Запрос запускает фоновую задачу сбора, поэтому первый ответ содержит ID задачи, а не готовые данные; по этому ID проверяйте ход выполнения и получайте результаты.

  1. Откройте публичную страницу сообщества и скопируйте ее ссылку с /i/communities/; подготовьте по одной ссылке на каждое сообщество, которое нужно запросить.
  2. Перед запуском примера замените $SOCQ_API_KEY своим API-ключом или задайте эту переменную окружения. Отправьте входной JSON на POST /v1/x/community с заголовком Authorization, как показано ниже, и сохраните task_id из ответа.
  3. Проверяйте ход выполнения через GET /v1/tasks/{task_id} с сохраненным ID. queued означает ожидание, running — идет сбор, retrying — выполняется повторная попытка. Читайте результаты только после succeeded; если задача в статусе failed, причину смотрите в error_message.
  4. После успешного завершения читайте data.results.items: каждый элемент этого списка описывает сведения об одном сообществе. Пустой список означает, что задача завершилась, не вернув ни одной записи.
  5. Если data.results.has_more равно true, значение next_cursor указывает на следующую страницу сохраненных результатов. Скопируйте его без изменений в параметр cursor запроса GET /v1/tasks/{task_id}?cursor=... и продолжайте, пока has_more не станет false.
curl -X POST "https://api.socq.ai/v1/x/community" \
  -H "Authorization: Bearer $SOCQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"urls":["https://x.com/i/communities/1493446837214187523"]}'

Сценарии использования X Community API

  • Каталог сообществ для изучения: Сведите названия сообществ, описания, ссылки и число участников в таблицу, чтобы можно было сравнить переданные сообщества по теме и размеру, прежде чем решать, какие обсуждения читать.
  • Правила участия рядом с разбором обсуждений: Сохраняйте правила и условия членства под ID сообщества, а затем отдельно используйте X Community Posts, чтобы привязать нужные для разбора посты к этим сведениям о сообществе.

Практические советы по X Community API

  • Если вы начинаете с поста, а не со страницы сообщества, сначала найдите публичную ссылку на сообщество: этот запрос не определяет сообщество поста по его URL.
  • Если одно и то же сообщество встречается в ссылках x.com и twitter.com, используйте числовой ID после /i/communities/ как ключ сопоставления, чтобы не создавать дубли в каталоге.
  • При сравнении сообществ используйте число участников как меру размера, а не как свидетельство того, насколько активно участники публикуют посты; в этом результате нет истории активности и списка отдельных участников.

Помимо X Community API, используйте эти API, когда нужен другой тип публичных данных X.

  • Twitter Profile Scraper API — Получайте по имени пользователя публичные данные аккаунта, описание, аватар, обложку, статус аккаунта и видимую статистику аудитории.
  • X Followers List API — Собирайте данные публичных аккаунтов подписчиков и видимые метрики профиля для одного или нескольких имен пользователей X.
  • X Following List API — Собирайте профили, на которые подписаны публичные аккаунты X: данные аккаунта, описания, признаки аккаунта, видимые счетчики и исходные имена пользователей.
  • X Community Posts API — Получайте публичные посты сообщества: текст, авторы и счетчики взаимодействий.
  • X Community Members API — Выгружайте участников сообщества в виде полных профилей с описанием и числом подписчиков.
  • X Community Moderators API — Получайте полные профили администраторов и модераторов, которые ведут сообщество.

Другие платформы

Объединяйте данные X с публичными данными других поддерживаемых соцсетей.

X Community API — FAQ

X Community API — это программный интерфейс для получения публичной информации о сообществах X по списку ссылок на них. Он возвращает названия сообществ, описания, число участников и модераторов, правила и условия вступления, чтобы вы могли составить представление о каждом сообществе, прежде чем изучать его посты.

Ссылка на сообщество содержит /i/communities/ и числовой ID после него. Ссылка на профиль ведет на аккаунт, а ссылка с /status/ — на пост, поэтому ни та, ни другая не подходят для этого запроса.

Нет. Счетчик показывает, сколько в сообществе участников, но не кто они; ответ не содержит списка участников.

Нет. Этот запрос возвращает описание сообщества, правила и другие метаданные. Если нужны сами обсуждения, используйте ту же ссылку на сообщество с X Community Posts.

Нет. Сообщества X — это пространства, организованные вокруг общих тем для обсуждения. Community Notes — это примечания к постам, и такие примечания этот эндпоинт не возвращает.

Каждая возвращенная запись сообщества стоит 0,5 кредита без базовой платы. Например, для четырех переданных ссылок на сообщества оценка составит 2 кредита, и четыре возвращенные записи сообществ стоят 2 кредита.