notifications_api

Module Group: Accounts
Parsing Order: 355
Database Size: 5.581 GB

The notifications_api provides access to account notifications including votes, replies, mentions, follows, and resteems. Notifications are stored for 180 days.

Configuration

{
   "id": "notifications_api",
   "group_id": "accounts",
   "parsing_order": 355,
   "required_modules": ["chain_api", "accounts_api"],
   "referenced_modules": [
      "steem_requests_api",
      "followers_api",
      "mentions_api",
      "posts_api",
      "post_resteems_api",
      "post_votes_api"
   ],
   "parse_reversible": true,
   "store_days": 180,
   "parsed_ops": ["custom_json"],
   "event_handlers": [
      "chain_api.onCreatePost",
      "chain_api.onUpdatePost",
      "chain_api.onRemovePost",
      "posts_api.onSyncPost",
      "post_resteems_api.onResteemPost",
      "post_votes_api.onAddVote",
      "post_votes_api.onUpdateVote",
      "post_votes_api.onRemoveVote",
      "followers_api.onFollowAccount",
      "followers_api.onUnfollowAccount",
      "mentions_api.onMentionAccount",
      "mentions_api.onResetMentions"
   ]
}

Endpoints

getConfig

Returns this module's active configuration.

Endpoint

/notifications_api/getConfig

Unfiltered Endpoints

getUnreadCount

Returns the total count of unread notifications.

Endpoint

/notifications_api/getUnreadCount/:account

Example

/notifications_api/getUnreadCount/steemchiller

Example Response:

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

getUnreadSummary

Returns a summary of unread notifications by type.

Endpoint

/notifications_api/getUnreadSummary/:account

Example

/notifications_api/getUnreadSummary/steemchiller

Example Response:

{
   "code": 0,
   "result": {
      "total": 1836,
      "follow": 55,
      "mention": 1336,
      "reply": 63,
      "resteem": 13,
      "vote": 369
   }
}

@steemchiller's Unread Notifications:

Type	Count
mention	1,336
vote	369
reply	63
follow	55
resteem	13
Total	1,836

getNotificationsByStatus

Returns notifications filtered by read/unread status.

Endpoint

/notifications_api/getNotificationsByStatus/:account/:status/:limit?/:offset?

Example

/notifications_api/getNotificationsByStatus/steemchiller/new/10

Parameters

Name	Type	Optional	Allowed Values
`:account`	string	No	-
`:status`	string	No	`new`, `old`, `all`
`:limit`	int	Yes	Max results (default: 250, max: 2500)
`:offset`	int	Yes	Result offset (default: 0)

Note: Use new for unread notifications, old for read notifications, or all for both.

Example Response:

{
   "code": 0,
   "result": {
      "cols": {
         "id": 0,
         "time": 1,
         "type": 2,
         "is_read": 3,
         "is_update": 4,
         "account": 5,
         "author": 6,
         "permlink": 7,
         "link_depth": 8,
         "voted_rshares": 9
      },
      "rows": [
         [176780609, 1767628806, "mention", 0, 0, "whalesreport", "whalesreport", "whales-report-4-1-2026", 0, 0],
         [176770639, 1767619458, "mention", 0, 0, "shy-bot", "shy-bot", "boc-daily-activity-report...", 0, 0],
         [176765128, 1767614406, "mention", 0, 0, "whalesreport", "whalesreport", "whales-sp-report-4-1-2026", 0, 0],
         [176756283, 1767603741, "mention", 0, 0, "ulfatulrahmah", "ulfatulrahmah", "my-top-picks...", 0, 0],
         [176739838, 1767582027, "mention", 0, 0, "upvu.proxy", "upvu.proxy", "2026-01-05-daily-proxy", 0, 0]
      ]
   }
}

Column Definitions:

Column	Description
`id`	Notification ID
`time`	Unix timestamp
`type`	Notification type
`is_read`	0 = unread, 1 = read
`is_update`	0 = new, 1 = updated
`account`	Account that triggered notification
`author`	Post author
`permlink`	Post permlink
`link_depth`	0 = root post, 1+ = comment
`voted_rshares`	Rshares for vote notifications

getNotificationsByStatusType

Returns notifications filtered by status and notification type.

Endpoint

/notifications_api/getNotificationsByStatusType/:account/:status/:type/:limit?/:offset?

Example

/notifications_api/getNotificationsByStatusType/steemchiller/all/vote/10

Example Response:

{
   "code": 0,
   "result": {
      "cols": {"id": 0, "time": 1, "type": 2, "is_read": 3, "is_update": 4, "account": 5, "author": 6, "permlink": 7, "link_depth": 8, "voted_rshares": 9},
      "rows": [
         [175706871, 1766373501, "vote", 0, 0, "tangmo", "steemchiller", "t7kfix", 1, 231645840462],
         [175618385, 1766267535, "vote", 0, 0, "moecki", "steemchiller", "t7kfix", 1, 667926947010],
         [175590204, 1766234199, "vote", 0, 0, "lotto4you", "steemchiller", "t7kfix", 1, 17426963344],
         [175590159, 1766234067, "vote", 0, 0, "indextrader24", "steemchiller", "t7kfix", 1, 338364389196],
         [175587459, 1766230029, "vote", 0, 0, "blaze.apps", "steemchiller", "t7kfix", 1, 766986921058]
      ]
   }
}

Notification Types:

Type	Description
`vote`	Votes on your content
`reply`	Replies to your posts/comments
`mention`	@mentions of your account
`follow`	New followers
`resteem`	Resteems of your posts

Filtered Endpoints

These endpoints accept a JSON filter for advanced filtering.

getFilteredUnreadCount

Endpoint

/notifications_api/getFilteredUnreadCount/:account/:filter

Parameters

Name	Type	Optional	Description
`:account`	string	No	Account name
`:filter`	JSON	No	Filter criteria as JSON string

getFilteredUnreadSummary

Endpoint

/notifications_api/getFilteredUnreadSummary/:account/:filter

getFilteredNotificationsByStatus

Endpoint

/notifications_api/getFilteredNotificationsByStatus/:account/:status/:filter/:limit?/:offset?

getFilteredNotificationsByStatusType

Endpoint

/notifications_api/getFilteredNotificationsByStatusType/:account/:status/:type/:filter/:limit?/:offset?

Back to Main Index