communities_api

Module Group: Posts
Parsing Order: 240
Database Size: 0.183 GB

The communities_api provides access to Steem community data including subscribers, roles, activity logs, and community rankings.

Configuration

{
   "id": "communities_api",
   "group_id": "posts",
   "parsing_order": 240,
   "required_modules": ["chain_api"],
   "optional_modules": ["accounts_api"],
   "referenced_modules": ["feeds_api"],
   "parse_reversible": true,
   "from_block": 37500000,
   "parsed_ops": ["custom_json"],
   "event_handlers": [
      "chain_api.onCreateAccount",
      "chain_api.onRemovePost"
   ]
}

Endpoints

getConfig

Returns this module's active configuration.

Endpoint

/communities_api/getConfig

Community Data

getCommunity

Returns detailed community information.

Endpoint

/communities_api/getCommunity/:community/:observer?

Example

/communities_api/getCommunity/hive-180106

Example Response (Steem For Pakistan):

{
   "code": 0,
   "result": {
      "id": 2626,
      "type": "topic",
      "account": "hive-180106",
      "account_reputation": 74.365,
      "created": 1645778757,
      "rank": 21,
      "sum_pending": 367.782,
      "count_pending": 401,
      "count_authors": 95,
      "count_subs": 3696,
      "lang": "en",
      "title": "Steem For Pakistan",
      "about": "Community to support all pakistan's users",
      "roles": {...}
   }
}

getCommunityRoles

Returns all role assignments in a community.

Endpoint

/communities_api/getCommunityRoles/:community

Role Types:

Role Description
owner Community owner
admin Administrator
mod Moderator
member Verified member
guest Guest user
muted Muted user

getCommunitySubscribers

Returns all subscribers of a community.

Endpoint

/communities_api/getCommunitySubscribers/:community

getCommunitySubscriptions

Returns communities a user is subscribed to.

Endpoint

/communities_api/getCommunitySubscriptions/:community

getCommunityPinnedPosts

Returns pinned posts in a community.

Endpoint

/communities_api/getCommunityPinnedPosts/:community/:observer?/:bodyLength?

Community Activities

getCommunityActivityLogs

Returns activity logs for a community.

Endpoint

/communities_api/getCommunityActivityLogs/:community/:limit?/:offset?

Example Response:

{
   "code": 0,
   "result": {
      "cols": {"id": 0, "created": 1, "type": 2, "account": 3, "data": 4},
      "rows": [
         [1723153, 1767645810, "subscribe", "donkhally", "{}"],
         [1723053, 1767626451, "subscribe", "qasim-ummati", "{}"],
         [1722876, 1767548229, "setRole", "sadaf02", "{\"target\":\"mohammad1076\",\"role\":\"member\"}"]
      ]
   }
}

Activity Types: subscribe, unsubscribe, setRole, updateProps, setUserTitle, etc.

getCommunityActivityLogsByType

Returns activities filtered by type.

Endpoint

/communities_api/getCommunityActivityLogsByType/:community/:type/:limit?/:offset?

List Communities

getCommunitiesByCreated

Returns communities ordered by creation date.

Endpoint

/communities_api/getCommunitiesByCreated/:observer?/:limit?/:offset?

getCommunitiesByRank

Returns communities ordered by rank.

Endpoint

/communities_api/getCommunitiesByRank/:observer?/:limit?/:offset?

Top 10 Communities by Rank (Live):

Rank Community Title Subscribers
1 hive-129948 আমার বাংলা ব্লগ 9,072
2 hive-196917 Korea • 한국 12,955
3 hive-150122 Steem Alliance 4,017
4 hive-180932 STEEM CN/中文 8,344
5 hive-188619 Comunidad Latina 13,700
6 hive-166405 Steem POD Team 8,736
7 hive-183959 AVLE 일상 1,748
8 hive-144064 Beauty of Creativity 12,138
9 hive-183397 Tron Fan Club 4,137
10 hive-185836 WORLD OF XPILAR 26,765

getCommunitiesByTotalPayout

Returns communities ordered by total payout.

Endpoint

/communities_api/getCommunitiesByTotalPayout/:observer?/:limit?/:offset?

getCommunitiesByCountActivePosts

Returns communities ordered by active post count.

Endpoint

/communities_api/getCommunitiesByCountActivePosts/:observer?/:limit?/:offset?

getCommunitiesByCountActiveAuthors

Returns communities ordered by active author count.

Endpoint

/communities_api/getCommunitiesByCountActiveAuthors/:observer?/:limit?/:offset?

getCommunitiesByCountSubscribers

Returns communities ordered by subscriber count.

Endpoint

/communities_api/getCommunitiesByCountSubscribers/:observer?/:limit?/:offset?

Top 10 by Subscribers (Live):

Rank Community Title Subscribers
1 hive-172186 Newcomers' Community 42,078
2 hive-196037 DTube 27,522
3 hive-185836 WORLD OF XPILAR 26,765
4 hive-108451 SteemitCryptoAcademy 22,146
5 hive-148497 SteemFoods 19,006
6 hive-101145 SCT.암호화폐.Crypto 18,262
7 hive-109286 StockPhotos 16,406
8 hive-193637 Steem Venezuela 16,047
9 hive-188619 Comunidad Latina 13,700
10 hive-152587 Steem Schools 13,092

getCommunitiesBySubscriber

Returns communities a user has subscribed to.

Endpoint

/communities_api/getCommunitiesBySubscriber/:subscriber/:observer?/:limit?/:offset?

Example

/communities_api/getCommunitiesBySubscriber/steemchiller

@steemchiller is subscribed to 23 communities including:

Column Definitions

Column Description
id Internal community ID
type Community type (topic, journal)
account Community account name
rank Current community rank
sum_pending Total pending rewards
count_pending Number of pending posts
count_authors Number of active authors
count_subs Number of subscribers
lang Primary language
title Display title
observer_subscribed Whether observer is subscribed
observer_role Observer's role in community

Back to Main Index