followers_api

Module Group: Accounts
Parsing Order: 180
Database Size: 5.232 GB

The followers_api provides access to follower and following relationships, including mutes/ignores and historical follow activity.

---

Configuration

{
   "id": "followers_api",
   "group_id": "accounts",
   "parsing_order": 180,
   "required_modules": ["chain_api"],
   "parse_reversible": true,
   "parsed_ops": ["custom_json"],
   "available_events": ["onFollowAccount", "onUnfollowAccount"],
   "store_history": true,
   "store_history_days": 90
}

---

Endpoints

getConfig

Returns this module's active configuration.

Endpoint

/followers_api/getConfig

---

Followers

getFollowers

Returns the list of accounts following a given account.

Endpoint

/followers_api/getFollowers/:target/:limit?/:offset?

Example

/followers_api/getFollowers/steemchiller/10

Example Response:

{
   "code": 0,
   "result": [
      "a-0-0",
      "a-0-0-0",
      "a-0-0-0-a",
      "a-2",
      "a-7",
      "a-a-0",
      "a-a-a",
      "a-a-a-a",
      "a-a-lifemix",
      "a-angel"
   ]
}

---

getFollowing

Returns the list of accounts that a given account follows.

Endpoint

/followers_api/getFollowing/:source/:limit?/:offset?

Example

/followers_api/getFollowing/steemchiller/10

Example Response:

{
   "code": 0,
   "result": [
      "adeljose",
      "afzalqamar",
      "aiyumi",
      "akdx",
      "andyjaypowell",
      "angel76",
      "angelahbl",
      "anneadam",
      "anusha96",
      "anyiglobal"
   ]
}

---

getKnownFollowers

Returns followers of the target that are also followed by the source (mutual connections).

Endpoint

/followers_api/getKnownFollowers/:source/:target/:limit?/:offset?

Example

/followers_api/getKnownFollowers/blocktrades/steemchiller/10

Example Response:

{
   "code": 0,
   "result": [
      "abigail-dantes",
      "acidyo",
      "creativetruth",
      "zest"
   ]
}

These 4 accounts follow @steemchiller AND are followed by @blocktrades.

---

getIgnorers

Returns accounts that have muted/ignored the target.

Endpoint

/followers_api/getIgnorers/:target/:limit?/:offset?

Example

/followers_api/getIgnorers/steemchiller/10

Example Response:

{
   "code": 0,
   "result": [
      "angeltirado",
      "anonymous-09",
      "ayra-stark",
      "blankfish",
      "conformity",
      "dalaunge",
      "jnetsworld",
      "johnpatrick12",
      "johnpm75",
      "kemsa"
   ]
}

---

getIgnored

Returns accounts that the source has muted/ignored.

Endpoint

/followers_api/getIgnored/:source/:limit?/:offset?

Example

/followers_api/getIgnored/steemchiller/10

Example Response:

{
   "code": 0,
   "result": []
}

Empty result means @steemchiller hasn't muted anyone.

---

Counts

getCounts

Returns both follower and following counts for an account.

Endpoint

/followers_api/getCounts/:account

Example

/followers_api/getCounts/steemchiller

Example Response:

{
   "code": 0,
   "result": {
      "followers": 6432,
      "following": 295
   }
}

---

getFollowerCount

Returns the number of followers for an account.

Endpoint

/followers_api/getFollowerCount/:target

Example

/followers_api/getFollowerCount/steemchiller

Example Response:

{
   "code": 0,
   "result": 6432
}

---

getFollowingCount

Returns the number of accounts a user is following.

Endpoint

/followers_api/getFollowingCount/:source

Example

/followers_api/getFollowingCount/steemchiller

Example Response:

{
   "code": 0,
   "result": 295
}

---

History

History is stored for the last 90 days.

getFollowedHistory

Returns historical follow events where accounts followed the target.

Endpoint

/followers_api/getFollowedHistory/:target/:fromTime-:toTime/:limit?/:offset?

Example

/followers_api/getFollowedHistory/steemchiller/1767000000-1767640000/10

Parameters

Name	Type	Optional	Description
:target	string	No	Account that was followed
:fromTime	int	No	Start time (Unix timestamp)
:toTime	int	No	End time (Unix timestamp)
:limit	int	Yes	Max results
:offset	int	Yes	Result offset

---

getFollowHistory

Returns historical follow events where the source followed other accounts.

Endpoint

/followers_api/getFollowHistory/:source/:fromTime-:toTime/:limit?/:offset?

---

getUnfollowedHistory

Returns historical unfollow events where accounts unfollowed the target.

Endpoint

/followers_api/getUnfollowedHistory/:target/:fromTime-:toTime/:limit?/:offset?

---

getUnfollowHistory

Returns historical unfollow events where the source unfollowed other accounts.

Endpoint

/followers_api/getUnfollowHistory/:source/:fromTime-:toTime/:limit?/:offset?

---

Summary

Metric	@steemchiller
Followers	6,432
Following	295
Known followers with @blocktrades	4
Accounts muted	0

---

Back to Main Index