Steem LogoSDS API Reference0.1.10


notifications_api

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


Description

Returns :status notifications for the given :account, :type, and :filter ordered by time descending.

Filters can be set for all notification types at once with ':filter.default' or for each type
individually. For example, if you want to use specific filters for vote notifications,
you can define them with ':filter.vote'.

The vote amount filter uses absolute values. So, when setting 'minVoteAmount' to '0.1',
the results will also include downvotes with an amount equal to or lower than '-0.1'.

Example

/notifications_api/getFilteredNotificationsByStatusType/steemchiller/new/follow/{"default":{"minSP":1000,"minReputation":50}}

Parameters

NameTypeOptionalDefaultMin.Max.Allowed Values
:accountaccount_nameNo
:statusfixed_valueNo
- all
- new
- old
:typefixed_valueNo
- vote
- reply
- follow
- mention
- resteem
:filterjson_objectNoSee details
:limitintYes25012500
:offsetintYes00

Max. Limit

2500

Result

JSON Object


:filter ( json_object )

NameTypeOptionalAllowed Values
.defaultjson_objectYesSee details
.followjson_objectYesSee details
.mentionjson_objectYesSee details
.replyjson_objectYesSee details
.resteemjson_objectYesSee details
.votejson_objectYesSee details

:filter.default ( json_object )

NameTypeOptionalDefaultAllowed Values
.excludeboolYesfalse
- true
- false
- 1
- 0
.minSPfloatYes0
.minReputationfloatYes-100
.minVoteAmountfloatYes0

:filter.follow ( json_object )

NameTypeOptionalDefaultAllowed Values
.excludeboolYesfalse
- true
- false
- 1
- 0
.minSPfloatYes0
.minReputationfloatYes-100

:filter.mention ( json_object )

NameTypeOptionalDefaultAllowed Values
.excludeboolYesfalse
- true
- false
- 1
- 0
.minSPfloatYes0
.minReputationfloatYes-100

:filter.reply ( json_object )

NameTypeOptionalDefaultAllowed Values
.excludeboolYesfalse
- true
- false
- 1
- 0
.minSPfloatYes0
.minReputationfloatYes-100

:filter.resteem ( json_object )

NameTypeOptionalDefaultAllowed Values
.excludeboolYesfalse
- true
- false
- 1
- 0
.minSPfloatYes0
.minReputationfloatYes-100

:filter.vote ( json_object )

NameTypeOptionalDefaultAllowed Values
.excludeboolYesfalse
- true
- false
- 1
- 0
.minSPfloatYes0
.minReputationfloatYes-100
.minVoteAmountfloatYes0