@steempro/sds 0.0.0-stage → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +328 -2
- package/dist/index.cjs +13997 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +8599 -0
- package/dist/index.d.ts +8599 -0
- package/dist/index.js +13959 -0
- package/dist/index.js.map +1 -0
- package/docs/METHODS.md +4468 -0
- package/documentation.md +14814 -0
- package/package.json +65 -4
package/docs/METHODS.md
ADDED
|
@@ -0,0 +1,4468 @@
|
|
|
1
|
+
# SDS Method Reference
|
|
2
|
+
|
|
3
|
+
Generated from [`https://sds0.steemworld.org`](https://sds0.steemworld.org) — reference version `0.1.10`, 22 modules, 285 methods.
|
|
4
|
+
|
|
5
|
+
| Module | Namespace | Group | Methods |
|
|
6
|
+
| --- | --- | --- | --- |
|
|
7
|
+
| [`blocks_api`](#blocks_api) | `sds.blocks` | Base | 14 |
|
|
8
|
+
| [`chain_api`](#chain_api) | `sds.chain` | Base | 10 |
|
|
9
|
+
| [`steem_requests_api`](#steem_requests_api) | `sds.steemRequests` | Base | 14 |
|
|
10
|
+
| [`transactions_api`](#transactions_api) | `sds.transactions` | Base | 4 |
|
|
11
|
+
| [`accounts_api`](#accounts_api) | `sds.accounts` | Accounts | 15 |
|
|
12
|
+
| [`account_history_api`](#account_history_api) | `sds.accountHistory` | Accounts | 6 |
|
|
13
|
+
| [`authorities_api`](#authorities_api) | `sds.authorities` | Accounts | 8 |
|
|
14
|
+
| [`delegations_api`](#delegations_api) | `sds.delegations` | Accounts | 5 |
|
|
15
|
+
| [`followers_api`](#followers_api) | `sds.followers` | Accounts | 13 |
|
|
16
|
+
| [`mentions_api`](#mentions_api) | `sds.mentions` | Accounts | 2 |
|
|
17
|
+
| [`notifications_api`](#notifications_api) | `sds.notifications` | Accounts | 9 |
|
|
18
|
+
| [`rewards_api`](#rewards_api) | `sds.rewards` | Accounts | 7 |
|
|
19
|
+
| [`transfers_api`](#transfers_api) | `sds.transfers` | Accounts | 7 |
|
|
20
|
+
| [`witnesses_api`](#witnesses_api) | `sds.witnesses` | Accounts | 15 |
|
|
21
|
+
| [`communities_api`](#communities_api) | `sds.communities` | Posts | 15 |
|
|
22
|
+
| [`content_history_api`](#content_history_api) | `sds.contentHistory` | Posts | 2 |
|
|
23
|
+
| [`content_search_api`](#content_search_api) | `sds.contentSearch` | Posts | 21 |
|
|
24
|
+
| [`feeds_api`](#feeds_api) | `sds.feeds` | Posts | 83 |
|
|
25
|
+
| [`posts_api`](#posts_api) | `sds.posts` | Posts | 14 |
|
|
26
|
+
| [`post_resteems_api`](#post_resteems_api) | `sds.postResteems` | Posts | 3 |
|
|
27
|
+
| [`post_tags_api`](#post_tags_api) | `sds.postTags` | Posts | 13 |
|
|
28
|
+
| [`system_api`](#system_api) | `sds.system` | System | 5 |
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## `blocks_api`
|
|
33
|
+
|
|
34
|
+
Namespace: `sds.blocks` · Group: Base · 14 methods
|
|
35
|
+
|
|
36
|
+
### `sds.blocks.getConfig()`
|
|
37
|
+
|
|
38
|
+
Returns this module's active configuration.
|
|
39
|
+
|
|
40
|
+
- Route: `/blocks_api/getConfig`
|
|
41
|
+
- Result: JSON Object
|
|
42
|
+
- Example: `/blocks_api/getConfig`
|
|
43
|
+
|
|
44
|
+
_No parameters._
|
|
45
|
+
|
|
46
|
+
### `sds.blocks.getBlock()`
|
|
47
|
+
|
|
48
|
+
Returns the block for the given :blockNum.
|
|
49
|
+
|
|
50
|
+
- Route: `/blocks_api/getBlock/:blockNum/:withTransactions?/:withVirtualOps?`
|
|
51
|
+
- Result: JSON Object
|
|
52
|
+
- Example: `/blocks_api/getBlock/50000001`
|
|
53
|
+
|
|
54
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
55
|
+
| --- | --- | --- | --- | --- | --- |
|
|
56
|
+
| `blockNum` | int | yes | — | 1 – 110139661 | — |
|
|
57
|
+
| `withTransactions` | bool | no | `true` | — | true | false | 1 | 0 |
|
|
58
|
+
| `withVirtualOps` | bool | no | `true` | — | true | false | 1 | 0 |
|
|
59
|
+
|
|
60
|
+
### `sds.blocks.getBlockById()`
|
|
61
|
+
|
|
62
|
+
Returns the block for the given :blockId.
|
|
63
|
+
|
|
64
|
+
- Route: `/blocks_api/getBlockById/:blockId/:withTransactions?/:withVirtualOps?`
|
|
65
|
+
- Result: JSON Object
|
|
66
|
+
- Example: `/blocks_api/getBlockById/02faf0817156fbe4752dd8de2b22b7a52dd37e2d`
|
|
67
|
+
|
|
68
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
69
|
+
| --- | --- | --- | --- | --- | --- |
|
|
70
|
+
| `blockId` | hex_string (40) | yes | — | — | — |
|
|
71
|
+
| `withTransactions` | bool | no | `true` | — | true | false | 1 | 0 |
|
|
72
|
+
| `withVirtualOps` | bool | no | `true` | — | true | false | 1 | 0 |
|
|
73
|
+
|
|
74
|
+
### `sds.blocks.getBlocksInRange()`
|
|
75
|
+
|
|
76
|
+
Returns the blocks for the given range (:fromBlockNum to :toBlockNum).
|
|
77
|
+
**Ranges**: [ { "from": "fromBlockNum", "to": "toBlockNum", "limit": 250 } ]
|
|
78
|
+
|
|
79
|
+
- Route: `/blocks_api/getBlocksInRange/:fromBlockNum-:toBlockNum/:withTransactions?/:withVirtualOps?`
|
|
80
|
+
- Result: JSON Array
|
|
81
|
+
- Max. limit: 250
|
|
82
|
+
- Example: `/blocks_api/getBlocksInRange/50000001-50000100`
|
|
83
|
+
|
|
84
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
85
|
+
| --- | --- | --- | --- | --- | --- |
|
|
86
|
+
| `fromBlockNum` | int | yes | — | 1 – 110139661 | — |
|
|
87
|
+
| `toBlockNum` | int | yes | — | 1 – 110139661 | — |
|
|
88
|
+
| `withTransactions` | bool | no | `true` | — | true | false | 1 | 0 |
|
|
89
|
+
| `withVirtualOps` | bool | no | `true` | — | true | false | 1 | 0 |
|
|
90
|
+
|
|
91
|
+
### `sds.blocks.getTransactionsInBlock()`
|
|
92
|
+
|
|
93
|
+
Returns all transactions for the given :blockNum.
|
|
94
|
+
|
|
95
|
+
- Route: `/blocks_api/getTransactionsInBlock/:blockNum`
|
|
96
|
+
- Result: JSON Array
|
|
97
|
+
- Example: `/blocks_api/getTransactionsInBlock/50000001`
|
|
98
|
+
|
|
99
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
100
|
+
| --- | --- | --- | --- | --- | --- |
|
|
101
|
+
| `blockNum` | int | yes | — | 1 – 110139661 | — |
|
|
102
|
+
|
|
103
|
+
### `sds.blocks.getTransactionsInBlockRange()`
|
|
104
|
+
|
|
105
|
+
Returns all transactions for the given block range (:fromBlockNum to :toBlockNum).
|
|
106
|
+
**Ranges**: [ { "from": "fromBlockNum", "to": "toBlockNum", "limit": 250 } ]
|
|
107
|
+
|
|
108
|
+
- Route: `/blocks_api/getTransactionsInBlockRange/:fromBlockNum-:toBlockNum`
|
|
109
|
+
- Result: JSON Array
|
|
110
|
+
- Max. limit: 250
|
|
111
|
+
- Example: `/blocks_api/getTransactionsInBlockRange/50000001-50000100`
|
|
112
|
+
|
|
113
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
114
|
+
| --- | --- | --- | --- | --- | --- |
|
|
115
|
+
| `fromBlockNum` | int | yes | — | 1 – 110139661 | — |
|
|
116
|
+
| `toBlockNum` | int | yes | — | 1 – 110139661 | — |
|
|
117
|
+
|
|
118
|
+
### `sds.blocks.getOpsInBlock()`
|
|
119
|
+
|
|
120
|
+
Returns all operations for the given :blockNum.
|
|
121
|
+
|
|
122
|
+
- Route: `/blocks_api/getOpsInBlock/:blockNum/:withVirtualOps?/:opTypes?`
|
|
123
|
+
- Result: JSON Array
|
|
124
|
+
- Example: `/blocks_api/getOpsInBlock/50000001`
|
|
125
|
+
|
|
126
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
127
|
+
| --- | --- | --- | --- | --- | --- |
|
|
128
|
+
| `blockNum` | int | yes | — | 1 – 110139661 | — |
|
|
129
|
+
| `withVirtualOps` | bool | no | `true` | — | true | false | 1 | 0 |
|
|
130
|
+
| `opTypes` | fixed_csv | no | `*` | — | account_create | account_create_with_delegation | account_update | account_update2 | account_witness_proxy | account_witness_vote | author_reward | cancel_transfer_from_savings | … (59 values) |
|
|
131
|
+
|
|
132
|
+
### `sds.blocks.getOpsInBlockRange()`
|
|
133
|
+
|
|
134
|
+
Returns an array (one element per block) with all operations for the given block range (:fromBlockNum to :toBlockNum).
|
|
135
|
+
**Ranges**: [ { "from": "fromBlockNum", "to": "toBlockNum", "limit": 250 } ]
|
|
136
|
+
|
|
137
|
+
- Route: `/blocks_api/getOpsInBlockRange/:fromBlockNum-:toBlockNum/:withVirtualOps?/:opTypes?`
|
|
138
|
+
- Result: JSON Array
|
|
139
|
+
- Max. limit: 250
|
|
140
|
+
- Example: `/blocks_api/getOpsInBlockRange/50000001-50000100`
|
|
141
|
+
|
|
142
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
143
|
+
| --- | --- | --- | --- | --- | --- |
|
|
144
|
+
| `fromBlockNum` | int | yes | — | 1 – 110139661 | — |
|
|
145
|
+
| `toBlockNum` | int | yes | — | 1 – 110139661 | — |
|
|
146
|
+
| `withVirtualOps` | bool | no | `true` | — | true | false | 1 | 0 |
|
|
147
|
+
| `opTypes` | fixed_csv | no | `*` | — | account_create | account_create_with_delegation | account_update | account_update2 | account_witness_proxy | account_witness_vote | author_reward | cancel_transfer_from_savings | … (59 values) |
|
|
148
|
+
|
|
149
|
+
### `sds.blocks.getOpsInBlockRangeAsArray()`
|
|
150
|
+
|
|
151
|
+
Returns an array including all operations for the given block range (:fromBlockNum to :toBlockNum).
|
|
152
|
+
**Ranges**: [ { "from": "fromBlockNum", "to": "toBlockNum", "limit": 250 } ]
|
|
153
|
+
|
|
154
|
+
- Route: `/blocks_api/getOpsInBlockRangeAsArray/:fromBlockNum-:toBlockNum/:withVirtualOps?/:opTypes?`
|
|
155
|
+
- Result: JSON Array
|
|
156
|
+
- Max. limit: 250
|
|
157
|
+
- Example: `/blocks_api/getOpsInBlockRangeAsArray/50000001-50000100/0/comment`
|
|
158
|
+
|
|
159
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
160
|
+
| --- | --- | --- | --- | --- | --- |
|
|
161
|
+
| `fromBlockNum` | int | yes | — | 1 – 110139661 | — |
|
|
162
|
+
| `toBlockNum` | int | yes | — | 1 – 110139661 | — |
|
|
163
|
+
| `withVirtualOps` | bool | no | `true` | — | true | false | 1 | 0 |
|
|
164
|
+
| `opTypes` | fixed_csv | no | `*` | — | account_create | account_create_with_delegation | account_update | account_update2 | account_witness_proxy | account_witness_vote | author_reward | cancel_transfer_from_savings | … (59 values) |
|
|
165
|
+
|
|
166
|
+
### `sds.blocks.getOpsInBlockRangeGrouped()`
|
|
167
|
+
|
|
168
|
+
Returns an object including all operations for the given block range (:fromBlockNum to :toBlockNum) grouped by type.
|
|
169
|
+
**Ranges**: [ { "from": "fromBlockNum", "to": "toBlockNum", "limit": 250 } ]
|
|
170
|
+
|
|
171
|
+
- Route: `/blocks_api/getOpsInBlockRangeGrouped/:fromBlockNum-:toBlockNum/:withVirtualOps?/:opTypes?`
|
|
172
|
+
- Result: JSON Object
|
|
173
|
+
- Max. limit: 250
|
|
174
|
+
- Example: `/blocks_api/getOpsInBlockRangeGrouped/50000001-50000100`
|
|
175
|
+
|
|
176
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
177
|
+
| --- | --- | --- | --- | --- | --- |
|
|
178
|
+
| `fromBlockNum` | int | yes | — | 1 – 110139661 | — |
|
|
179
|
+
| `toBlockNum` | int | yes | — | 1 – 110139661 | — |
|
|
180
|
+
| `withVirtualOps` | bool | no | `true` | — | true | false | 1 | 0 |
|
|
181
|
+
| `opTypes` | fixed_csv | no | `*` | — | account_create | account_create_with_delegation | account_update | account_update2 | account_witness_proxy | account_witness_vote | author_reward | cancel_transfer_from_savings | … (59 values) |
|
|
182
|
+
|
|
183
|
+
### `sds.blocks.getVirtualOpsInBlock()`
|
|
184
|
+
|
|
185
|
+
Returns all virtual operations for the given :blockNum.
|
|
186
|
+
|
|
187
|
+
- Route: `/blocks_api/getVirtualOpsInBlock/:blockNum`
|
|
188
|
+
- Result: JSON Array
|
|
189
|
+
- Example: `/blocks_api/getVirtualOpsInBlock/50000001`
|
|
190
|
+
|
|
191
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
192
|
+
| --- | --- | --- | --- | --- | --- |
|
|
193
|
+
| `blockNum` | int | yes | — | 1 – 110139661 | — |
|
|
194
|
+
|
|
195
|
+
### `sds.blocks.getVirtualOpsInBlockRange()`
|
|
196
|
+
|
|
197
|
+
Returns the virtual operations for the given block range (:fromBlockNum to :toBlockNum).
|
|
198
|
+
**Ranges**: [ { "from": "fromBlockNum", "to": "toBlockNum", "limit": 250 } ]
|
|
199
|
+
|
|
200
|
+
- Route: `/blocks_api/getVirtualOpsInBlockRange/:fromBlockNum-:toBlockNum`
|
|
201
|
+
- Result: JSON Array
|
|
202
|
+
- Max. limit: 250
|
|
203
|
+
- Example: `/blocks_api/getVirtualOpsInBlockRange/50000001-50000100`
|
|
204
|
+
|
|
205
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
206
|
+
| --- | --- | --- | --- | --- | --- |
|
|
207
|
+
| `fromBlockNum` | int | yes | — | 1 – 110139661 | — |
|
|
208
|
+
| `toBlockNum` | int | yes | — | 1 – 110139661 | — |
|
|
209
|
+
|
|
210
|
+
### `sds.blocks.getLastIrreversibleBlockNum()`
|
|
211
|
+
|
|
212
|
+
Returns the last (highest) available irreversible block number.
|
|
213
|
+
|
|
214
|
+
- Route: `/blocks_api/getLastIrreversibleBlockNum`
|
|
215
|
+
- Result: Integer
|
|
216
|
+
- Example: `/blocks_api/getLastIrreversibleBlockNum`
|
|
217
|
+
|
|
218
|
+
_No parameters._
|
|
219
|
+
|
|
220
|
+
### `sds.blocks.getLastReversibleBlockNum()`
|
|
221
|
+
|
|
222
|
+
Returns the last (highest) available reversible block number.
|
|
223
|
+
|
|
224
|
+
- Route: `/blocks_api/getLastReversibleBlockNum`
|
|
225
|
+
- Result: Integer
|
|
226
|
+
- Example: `/blocks_api/getLastReversibleBlockNum`
|
|
227
|
+
|
|
228
|
+
_No parameters._
|
|
229
|
+
|
|
230
|
+
---
|
|
231
|
+
|
|
232
|
+
## `chain_api`
|
|
233
|
+
|
|
234
|
+
Namespace: `sds.chain` · Group: Base · 10 methods
|
|
235
|
+
|
|
236
|
+
### `sds.chain.getConfig()`
|
|
237
|
+
|
|
238
|
+
Returns this module's active configuration.
|
|
239
|
+
|
|
240
|
+
- Route: `/chain_api/getConfig`
|
|
241
|
+
- Result: JSON Object
|
|
242
|
+
- Example: `/chain_api/getConfig`
|
|
243
|
+
|
|
244
|
+
_No parameters._
|
|
245
|
+
|
|
246
|
+
### `sds.chain.getChainStats()`
|
|
247
|
+
|
|
248
|
+
Returns general chain statistics.
|
|
249
|
+
|
|
250
|
+
- Route: `/chain_api/getChainStats`
|
|
251
|
+
- Result: JSON Object
|
|
252
|
+
- Example: `/chain_api/getChainStats`
|
|
253
|
+
|
|
254
|
+
_No parameters._
|
|
255
|
+
|
|
256
|
+
### `sds.chain.getOperationStats()`
|
|
257
|
+
|
|
258
|
+
Returns some statistics about the parsed Steem operations.
|
|
259
|
+
|
|
260
|
+
- Route: `/chain_api/getOperationStats`
|
|
261
|
+
- Result: JSON Object
|
|
262
|
+
- Example: `/chain_api/getOperationStats`
|
|
263
|
+
|
|
264
|
+
_No parameters._
|
|
265
|
+
|
|
266
|
+
### `sds.chain.getBlockInfoByTime()`
|
|
267
|
+
|
|
268
|
+
Returns general block information for :blockTime's nearest block.
|
|
269
|
+
|
|
270
|
+
- Route: `/chain_api/getBlockInfoByTime/:blockTime`
|
|
271
|
+
- Result: JSON Object
|
|
272
|
+
- Example: `/chain_api/getBlockInfoByTime/1789588074`
|
|
273
|
+
|
|
274
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
275
|
+
| --- | --- | --- | --- | --- | --- |
|
|
276
|
+
| `blockTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
277
|
+
|
|
278
|
+
### `sds.chain.getAccountNames()`
|
|
279
|
+
|
|
280
|
+
Returns a list of all account names.
|
|
281
|
+
|
|
282
|
+
- Route: `/chain_api/getAccountNames/:limit?/:offset?`
|
|
283
|
+
- Result: JSON Array
|
|
284
|
+
- Max. limit: 10000
|
|
285
|
+
- Example: `/chain_api/getAccountNames`
|
|
286
|
+
|
|
287
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
288
|
+
| --- | --- | --- | --- | --- | --- |
|
|
289
|
+
| `limit` | int | no | `1000` | 1 – 10000 | — |
|
|
290
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
291
|
+
|
|
292
|
+
### `sds.chain.getAccountNamesByPrefix()`
|
|
293
|
+
|
|
294
|
+
Returns a list of all account names starting with :prefix.
|
|
295
|
+
|
|
296
|
+
- Route: `/chain_api/getAccountNamesByPrefix/:prefix/:limit?/:offset?`
|
|
297
|
+
- Result: JSON Array
|
|
298
|
+
- Max. limit: 1000
|
|
299
|
+
- Example: `/chain_api/getAccountNamesByPrefix/steemchil`
|
|
300
|
+
|
|
301
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
302
|
+
| --- | --- | --- | --- | --- | --- |
|
|
303
|
+
| `prefix` | string | yes | — | — | — |
|
|
304
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
305
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
306
|
+
|
|
307
|
+
### `sds.chain.getLink()`
|
|
308
|
+
|
|
309
|
+
Returns general link information for :author / :permlink.
|
|
310
|
+
|
|
311
|
+
- Route: `/chain_api/getLink/:author/:permlink`
|
|
312
|
+
- Result: JSON Object
|
|
313
|
+
- Example: `/chain_api/getLink/steemit/firstpost`
|
|
314
|
+
|
|
315
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
316
|
+
| --- | --- | --- | --- | --- | --- |
|
|
317
|
+
| `author` | account_name | yes | — | — | — |
|
|
318
|
+
| `permlink` | string | yes | — | — | — |
|
|
319
|
+
|
|
320
|
+
### `sds.chain.getLinkById()`
|
|
321
|
+
|
|
322
|
+
Returns general link information for :linkId.
|
|
323
|
+
|
|
324
|
+
- Route: `/chain_api/getLinkById/:linkId`
|
|
325
|
+
- Result: JSON Object
|
|
326
|
+
- Example: `/chain_api/getLinkById/1`
|
|
327
|
+
|
|
328
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
329
|
+
| --- | --- | --- | --- | --- | --- |
|
|
330
|
+
| `linkId` | int | yes | — | ≥ 1 | — |
|
|
331
|
+
|
|
332
|
+
### `sds.chain.getPostingPlatforms()`
|
|
333
|
+
|
|
334
|
+
Returns a list of all used posting platforms.
|
|
335
|
+
|
|
336
|
+
- Route: `/chain_api/getPostingPlatforms/:limit?/:offset?`
|
|
337
|
+
- Result: JSON Array
|
|
338
|
+
- Max. limit: 10000
|
|
339
|
+
- Example: `/chain_api/getPostingPlatforms`
|
|
340
|
+
|
|
341
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
342
|
+
| --- | --- | --- | --- | --- | --- |
|
|
343
|
+
| `limit` | int | no | `1000` | 1 – 10000 | — |
|
|
344
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
345
|
+
|
|
346
|
+
### `sds.chain.getDailyAverageShareRates()`
|
|
347
|
+
|
|
348
|
+
Returns a list of all historical vesting share rates (daily average STEEM per VEST), grouped by day.
|
|
349
|
+
|
|
350
|
+
- Route: `/chain_api/getDailyAverageShareRates`
|
|
351
|
+
- Result: JSON Array
|
|
352
|
+
- Example: `/chain_api/getDailyAverageShareRates`
|
|
353
|
+
|
|
354
|
+
_No parameters._
|
|
355
|
+
|
|
356
|
+
---
|
|
357
|
+
|
|
358
|
+
## `steem_requests_api`
|
|
359
|
+
|
|
360
|
+
Namespace: `sds.steemRequests` · Group: Base · 14 methods
|
|
361
|
+
|
|
362
|
+
### `sds.steemRequests.getConfig()`
|
|
363
|
+
|
|
364
|
+
Returns this module's active configuration.
|
|
365
|
+
|
|
366
|
+
- Route: `/steem_requests_api/getConfig`
|
|
367
|
+
- Result: JSON Object
|
|
368
|
+
- Example: `/steem_requests_api/getConfig`
|
|
369
|
+
|
|
370
|
+
_No parameters._
|
|
371
|
+
|
|
372
|
+
### `sds.steemRequests.getSteemProps()`
|
|
373
|
+
|
|
374
|
+
Returns most important Steem properties in one set.
|
|
375
|
+
|
|
376
|
+
- Route: `/steem_requests_api/getSteemProps`
|
|
377
|
+
- Result: JSON Object
|
|
378
|
+
- Example: `/steem_requests_api/getSteemProps`
|
|
379
|
+
|
|
380
|
+
_No parameters._
|
|
381
|
+
|
|
382
|
+
### `sds.steemRequests.getAll()`
|
|
383
|
+
|
|
384
|
+
Returns all cached Steem requests.
|
|
385
|
+
|
|
386
|
+
- Route: `/steem_requests_api/getAll`
|
|
387
|
+
- Result: JSON Object
|
|
388
|
+
- Example: `/steem_requests_api/getAll`
|
|
389
|
+
|
|
390
|
+
_No parameters._
|
|
391
|
+
|
|
392
|
+
### `sds.steemRequests.getById()`
|
|
393
|
+
|
|
394
|
+
Returns the cached Steem requests for the given :ids
|
|
395
|
+
|
|
396
|
+
- Route: `/steem_requests_api/getById/:ids`
|
|
397
|
+
- Result: JSON Object
|
|
398
|
+
- Example: `/steem_requests_api/getById/1,3`
|
|
399
|
+
|
|
400
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
401
|
+
| --- | --- | --- | --- | --- | --- |
|
|
402
|
+
| `ids` | fixed_csv | yes | — | — | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | … (9 values) |
|
|
403
|
+
|
|
404
|
+
### `sds.steemRequests.condenser_api.get_account_count()`
|
|
405
|
+
|
|
406
|
+
See: developers.steem.io/apidefinitions/#condenser_api.get_account_count
|
|
407
|
+
|
|
408
|
+
- Route: `/steem_requests_api/condenser_api.get_account_count`
|
|
409
|
+
- Result: Integer
|
|
410
|
+
- Example: `/steem_requests_api/condenser_api.get_account_count`
|
|
411
|
+
|
|
412
|
+
_No parameters._
|
|
413
|
+
|
|
414
|
+
### `sds.steemRequests.condenser_api.get_chain_properties()`
|
|
415
|
+
|
|
416
|
+
See: developers.steem.io/apidefinitions/#condenser_api.get_chain_properties
|
|
417
|
+
|
|
418
|
+
- Route: `/steem_requests_api/condenser_api.get_chain_properties`
|
|
419
|
+
- Result: JSON Object
|
|
420
|
+
- Example: `/steem_requests_api/condenser_api.get_chain_properties`
|
|
421
|
+
|
|
422
|
+
_No parameters._
|
|
423
|
+
|
|
424
|
+
### `sds.steemRequests.condenser_api.get_current_median_history_price()`
|
|
425
|
+
|
|
426
|
+
See: developers.steem.io/apidefinitions/#condenser_api.get_current_median_history_price
|
|
427
|
+
|
|
428
|
+
- Route: `/steem_requests_api/condenser_api.get_current_median_history_price`
|
|
429
|
+
- Result: JSON Object
|
|
430
|
+
- Example: `/steem_requests_api/condenser_api.get_current_median_history_price`
|
|
431
|
+
|
|
432
|
+
_No parameters._
|
|
433
|
+
|
|
434
|
+
### `sds.steemRequests.condenser_api.get_dynamic_global_properties()`
|
|
435
|
+
|
|
436
|
+
See: developers.steem.io/apidefinitions/#condenser_api.get_dynamic_global_properties
|
|
437
|
+
|
|
438
|
+
- Route: `/steem_requests_api/condenser_api.get_dynamic_global_properties`
|
|
439
|
+
- Result: JSON Object
|
|
440
|
+
- Example: `/steem_requests_api/condenser_api.get_dynamic_global_properties`
|
|
441
|
+
|
|
442
|
+
_No parameters._
|
|
443
|
+
|
|
444
|
+
### `sds.steemRequests.condenser_api.get_hardfork_version()`
|
|
445
|
+
|
|
446
|
+
See: developers.steem.io/apidefinitions/#condenser_api.get_hardfork_version
|
|
447
|
+
|
|
448
|
+
- Route: `/steem_requests_api/condenser_api.get_hardfork_version`
|
|
449
|
+
- Result: String
|
|
450
|
+
- Example: `/steem_requests_api/condenser_api.get_hardfork_version`
|
|
451
|
+
|
|
452
|
+
_No parameters._
|
|
453
|
+
|
|
454
|
+
### `sds.steemRequests.condenser_api.get_next_scheduled_hardfork()`
|
|
455
|
+
|
|
456
|
+
See: developers.steem.io/apidefinitions/#condenser_api.get_next_scheduled_hardfork
|
|
457
|
+
|
|
458
|
+
- Route: `/steem_requests_api/condenser_api.get_next_scheduled_hardfork`
|
|
459
|
+
- Result: JSON Object
|
|
460
|
+
- Example: `/steem_requests_api/condenser_api.get_next_scheduled_hardfork`
|
|
461
|
+
|
|
462
|
+
_No parameters._
|
|
463
|
+
|
|
464
|
+
### `sds.steemRequests.condenser_api.get_reward_fund()`
|
|
465
|
+
|
|
466
|
+
See: developers.steem.io/apidefinitions/#condenser_api.get_reward_fund
|
|
467
|
+
|
|
468
|
+
- Route: `/steem_requests_api/condenser_api.get_reward_fund/:params`
|
|
469
|
+
- Result: JSON Object
|
|
470
|
+
|
|
471
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
472
|
+
| --- | --- | --- | --- | --- | --- |
|
|
473
|
+
| `params` | string | yes | — | — | — |
|
|
474
|
+
|
|
475
|
+
### `sds.steemRequests.condenser_api.get_ticker()`
|
|
476
|
+
|
|
477
|
+
See: developers.steem.io/apidefinitions/#condenser_api.get_ticker
|
|
478
|
+
|
|
479
|
+
- Route: `/steem_requests_api/condenser_api.get_ticker`
|
|
480
|
+
- Result: JSON Object
|
|
481
|
+
- Example: `/steem_requests_api/condenser_api.get_ticker`
|
|
482
|
+
|
|
483
|
+
_No parameters._
|
|
484
|
+
|
|
485
|
+
### `sds.steemRequests.condenser_api.get_witness_count()`
|
|
486
|
+
|
|
487
|
+
See: developers.steem.io/apidefinitions/#condenser_api.get_witness_count
|
|
488
|
+
|
|
489
|
+
- Route: `/steem_requests_api/condenser_api.get_witness_count`
|
|
490
|
+
- Result: Integer
|
|
491
|
+
- Example: `/steem_requests_api/condenser_api.get_witness_count`
|
|
492
|
+
|
|
493
|
+
_No parameters._
|
|
494
|
+
|
|
495
|
+
### `sds.steemRequests.request()`
|
|
496
|
+
|
|
497
|
+
Returns the result of a direct request to the configured Steem node.
|
|
498
|
+
|
|
499
|
+
- Route: `/steem_requests_api/request/:apiName/:methodName/:methodParams?`
|
|
500
|
+
- Result: JSON Object
|
|
501
|
+
- Example: `/steem_requests_api/request/condenser_api/get_block/1`
|
|
502
|
+
|
|
503
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
504
|
+
| --- | --- | --- | --- | --- | --- |
|
|
505
|
+
| `apiName` | string | yes | — | — | — |
|
|
506
|
+
| `methodName` | string | yes | — | — | — |
|
|
507
|
+
| `methodParams` | string | no | — | — | — |
|
|
508
|
+
|
|
509
|
+
---
|
|
510
|
+
|
|
511
|
+
## `transactions_api`
|
|
512
|
+
|
|
513
|
+
Namespace: `sds.transactions` · Group: Base · 4 methods
|
|
514
|
+
|
|
515
|
+
### `sds.transactions.getConfig()`
|
|
516
|
+
|
|
517
|
+
Returns this module's active configuration.
|
|
518
|
+
|
|
519
|
+
- Route: `/transactions_api/getConfig`
|
|
520
|
+
- Result: JSON Object
|
|
521
|
+
- Example: `/transactions_api/getConfig`
|
|
522
|
+
|
|
523
|
+
_No parameters._
|
|
524
|
+
|
|
525
|
+
### `sds.transactions.getTransactionById()`
|
|
526
|
+
|
|
527
|
+
Returns the transaction for the given :transactionId.
|
|
528
|
+
|
|
529
|
+
- Route: `/transactions_api/getTransactionById/:transactionId`
|
|
530
|
+
- Result: JSON Object
|
|
531
|
+
- Example: `/transactions_api/getTransactionById/2c3a64cba781a163842d7d831f9cfbc69471517d`
|
|
532
|
+
|
|
533
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
534
|
+
| --- | --- | --- | --- | --- | --- |
|
|
535
|
+
| `transactionId` | hex_string (40) | yes | — | — | — |
|
|
536
|
+
|
|
537
|
+
### `sds.transactions.getBlockByTransactionId()`
|
|
538
|
+
|
|
539
|
+
Returns the block that contains the given :transactionId.
|
|
540
|
+
|
|
541
|
+
- Route: `/transactions_api/getBlockByTransactionId/:transactionId/:withVirtualOps?`
|
|
542
|
+
- Result: JSON Object
|
|
543
|
+
- Example: `/transactions_api/getBlockByTransactionId/2c3a64cba781a163842d7d831f9cfbc69471517d`
|
|
544
|
+
|
|
545
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
546
|
+
| --- | --- | --- | --- | --- | --- |
|
|
547
|
+
| `transactionId` | hex_string (40) | yes | — | — | — |
|
|
548
|
+
| `withVirtualOps` | bool | no | `false` | — | true | false | 1 | 0 |
|
|
549
|
+
|
|
550
|
+
### `sds.transactions.getBlockNumByTransactionId()`
|
|
551
|
+
|
|
552
|
+
Returns the block number of the block that contains the given :transactionId.
|
|
553
|
+
|
|
554
|
+
- Route: `/transactions_api/getBlockNumByTransactionId/:transactionId`
|
|
555
|
+
- Result: Integer
|
|
556
|
+
- Example: `/transactions_api/getBlockNumByTransactionId/2c3a64cba781a163842d7d831f9cfbc69471517d`
|
|
557
|
+
|
|
558
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
559
|
+
| --- | --- | --- | --- | --- | --- |
|
|
560
|
+
| `transactionId` | hex_string (40) | yes | — | — | — |
|
|
561
|
+
|
|
562
|
+
---
|
|
563
|
+
|
|
564
|
+
## `accounts_api`
|
|
565
|
+
|
|
566
|
+
Namespace: `sds.accounts` · Group: Accounts · 15 methods
|
|
567
|
+
|
|
568
|
+
### `sds.accounts.getConfig()`
|
|
569
|
+
|
|
570
|
+
Returns this module's active configuration.
|
|
571
|
+
|
|
572
|
+
- Route: `/accounts_api/getConfig`
|
|
573
|
+
- Result: JSON Object
|
|
574
|
+
- Example: `/accounts_api/getConfig`
|
|
575
|
+
|
|
576
|
+
_No parameters._
|
|
577
|
+
|
|
578
|
+
### `sds.accounts.getAccount()`
|
|
579
|
+
|
|
580
|
+
Returns the Steem account data for :account.
|
|
581
|
+
|
|
582
|
+
- Route: `/accounts_api/getAccount/:account/:fields?`
|
|
583
|
+
- Result: JSON Object
|
|
584
|
+
- Example: `/accounts_api/getAccount/steemchiller`
|
|
585
|
+
|
|
586
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
587
|
+
| --- | --- | --- | --- | --- | --- |
|
|
588
|
+
| `account` | account_name | yes | — | — | — |
|
|
589
|
+
| `fields` | fixed_csv | no | `*` | — | name | recovery_account | reset_account | proxy | json_metadata | posting_json_metadata | created | last_root_post | … (56 values) |
|
|
590
|
+
|
|
591
|
+
### `sds.accounts.getAccounts()`
|
|
592
|
+
|
|
593
|
+
Returns the Steem account data for :accounts.
|
|
594
|
+
|
|
595
|
+
- Route: `/accounts_api/getAccounts/:accounts/:fields?`
|
|
596
|
+
- Result: JSON Object
|
|
597
|
+
- Max. limit: 1000
|
|
598
|
+
- Example: `/accounts_api/getAccounts/steemchiller,steemit`
|
|
599
|
+
|
|
600
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
601
|
+
| --- | --- | --- | --- | --- | --- |
|
|
602
|
+
| `accounts` | account_name_csv | yes | — | — | — |
|
|
603
|
+
| `fields` | fixed_csv | no | `*` | — | name | recovery_account | reset_account | proxy | json_metadata | posting_json_metadata | created | last_root_post | … (56 values) |
|
|
604
|
+
|
|
605
|
+
### `sds.accounts.getAccountExt()`
|
|
606
|
+
|
|
607
|
+
Returns the extended Steem account data for :account.
|
|
608
|
+
|
|
609
|
+
- Route: `/accounts_api/getAccountExt/:account/:observer?/:fields?`
|
|
610
|
+
- Result: JSON Object
|
|
611
|
+
- Example: `/accounts_api/getAccountExt/steemchiller`
|
|
612
|
+
|
|
613
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
614
|
+
| --- | --- | --- | --- | --- | --- |
|
|
615
|
+
| `account` | account_name | yes | — | — | — |
|
|
616
|
+
| `observer` | account_name | no | — | — | — |
|
|
617
|
+
| `fields` | fixed_csv | no | `*` | — | id | name | creator | recovery_account | reset_account | proxy | json_metadata | posting_json_metadata | … (84 values) |
|
|
618
|
+
|
|
619
|
+
### `sds.accounts.getAccountsExt()`
|
|
620
|
+
|
|
621
|
+
Returns the extended Steem account data for :accounts.
|
|
622
|
+
|
|
623
|
+
- Route: `/accounts_api/getAccountsExt/:accounts/:observer?/:fields?`
|
|
624
|
+
- Result: JSON Object
|
|
625
|
+
- Max. limit: 1000
|
|
626
|
+
- Example: `/accounts_api/getAccountsExt/steemchiller,steemit`
|
|
627
|
+
|
|
628
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
629
|
+
| --- | --- | --- | --- | --- | --- |
|
|
630
|
+
| `accounts` | account_name_csv | yes | — | — | — |
|
|
631
|
+
| `observer` | account_name | no | — | — | — |
|
|
632
|
+
| `fields` | fixed_csv | no | `*` | — | id | name | creator | recovery_account | reset_account | proxy | json_metadata | posting_json_metadata | … (84 values) |
|
|
633
|
+
|
|
634
|
+
### `sds.accounts.getVestingWithdrawRoutes()`
|
|
635
|
+
|
|
636
|
+
Returns the installed vesting withdraw routes for :account.
|
|
637
|
+
|
|
638
|
+
- Route: `/accounts_api/getVestingWithdrawRoutes/:account`
|
|
639
|
+
- Result: JSON Object
|
|
640
|
+
- Example: `/accounts_api/getVestingWithdrawRoutes/steemchiller`
|
|
641
|
+
|
|
642
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
643
|
+
| --- | --- | --- | --- | --- | --- |
|
|
644
|
+
| `account` | account_name | yes | — | — | — |
|
|
645
|
+
|
|
646
|
+
### `sds.accounts.getAccountById()`
|
|
647
|
+
|
|
648
|
+
Returns the Steem account data for :accountId.
|
|
649
|
+
|
|
650
|
+
- Route: `/accounts_api/getAccountById/:accountId/:fields?`
|
|
651
|
+
- Result: JSON Object
|
|
652
|
+
- Example: `/accounts_api/getAccountById/1`
|
|
653
|
+
|
|
654
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
655
|
+
| --- | --- | --- | --- | --- | --- |
|
|
656
|
+
| `accountId` | int | yes | — | ≥ 1 | — |
|
|
657
|
+
| `fields` | fixed_csv | no | `*` | — | name | recovery_account | reset_account | proxy | json_metadata | posting_json_metadata | created | last_root_post | … (56 values) |
|
|
658
|
+
|
|
659
|
+
### `sds.accounts.getAccountsById()`
|
|
660
|
+
|
|
661
|
+
Returns the Steem account data for :accountIds.
|
|
662
|
+
|
|
663
|
+
- Route: `/accounts_api/getAccountsById/:accountIds/:fields?`
|
|
664
|
+
- Result: JSON Object
|
|
665
|
+
- Max. limit: 1000
|
|
666
|
+
- Example: `/accounts_api/getAccountsById/1,2`
|
|
667
|
+
|
|
668
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
669
|
+
| --- | --- | --- | --- | --- | --- |
|
|
670
|
+
| `accountIds` | int_csv | yes | — | — | — |
|
|
671
|
+
| `fields` | fixed_csv | no | `*` | — | name | recovery_account | reset_account | proxy | json_metadata | posting_json_metadata | created | last_root_post | … (56 values) |
|
|
672
|
+
|
|
673
|
+
### `sds.accounts.getAccountExtById()`
|
|
674
|
+
|
|
675
|
+
Returns the extended Steem account data for :accountId.
|
|
676
|
+
|
|
677
|
+
- Route: `/accounts_api/getAccountExtById/:accountId/:observer?/:fields?`
|
|
678
|
+
- Result: JSON Object
|
|
679
|
+
- Example: `/accounts_api/getAccountExtById/1`
|
|
680
|
+
|
|
681
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
682
|
+
| --- | --- | --- | --- | --- | --- |
|
|
683
|
+
| `accountId` | int | yes | — | ≥ 1 | — |
|
|
684
|
+
| `observer` | account_name | no | — | — | — |
|
|
685
|
+
| `fields` | fixed_csv | no | `*` | — | id | name | creator | recovery_account | reset_account | proxy | json_metadata | posting_json_metadata | … (84 values) |
|
|
686
|
+
|
|
687
|
+
### `sds.accounts.getAccountsExtById()`
|
|
688
|
+
|
|
689
|
+
Returns the extended Steem account data for :accountIds.
|
|
690
|
+
|
|
691
|
+
- Route: `/accounts_api/getAccountsExtById/:accountIds/:observer?/:fields?`
|
|
692
|
+
- Result: JSON Object
|
|
693
|
+
- Max. limit: 1000
|
|
694
|
+
- Example: `/accounts_api/getAccountsExtById/1,2`
|
|
695
|
+
|
|
696
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
697
|
+
| --- | --- | --- | --- | --- | --- |
|
|
698
|
+
| `accountIds` | int_csv | yes | — | — | — |
|
|
699
|
+
| `observer` | account_name | no | — | — | — |
|
|
700
|
+
| `fields` | fixed_csv | no | `*` | — | id | name | creator | recovery_account | reset_account | proxy | json_metadata | posting_json_metadata | … (84 values) |
|
|
701
|
+
|
|
702
|
+
### `sds.accounts.getVestingWithdrawRoutesById()`
|
|
703
|
+
|
|
704
|
+
Returns the installed vesting withdraw routes for :accountId.
|
|
705
|
+
|
|
706
|
+
- Route: `/accounts_api/getVestingWithdrawRoutesById/:accountId`
|
|
707
|
+
- Result: JSON Object
|
|
708
|
+
- Example: `/accounts_api/getVestingWithdrawRoutesById/1`
|
|
709
|
+
|
|
710
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
711
|
+
| --- | --- | --- | --- | --- | --- |
|
|
712
|
+
| `accountId` | int | yes | — | ≥ 1 | — |
|
|
713
|
+
|
|
714
|
+
### `sds.accounts.getAccountsByPrefix()`
|
|
715
|
+
|
|
716
|
+
Returns the extended Steem account data for accounts whose name starts with :prefix.
|
|
717
|
+
|
|
718
|
+
- Route: `/accounts_api/getAccountsByPrefix/:prefix/:observer?/:fields?/:limit?/:offset?`
|
|
719
|
+
- Result: JSON Object
|
|
720
|
+
- Max. limit: 250
|
|
721
|
+
- Example: `/accounts_api/getAccountsByPrefix/steemchil/null/name,reputation`
|
|
722
|
+
|
|
723
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
724
|
+
| --- | --- | --- | --- | --- | --- |
|
|
725
|
+
| `prefix` | string | yes | — | — | — |
|
|
726
|
+
| `observer` | account_name | no | — | — | — |
|
|
727
|
+
| `fields` | fixed_csv | no | `*` | — | id | name | creator | recovery_account | reset_account | proxy | json_metadata | posting_json_metadata | … (84 values) |
|
|
728
|
+
| `limit` | int | no | `100` | 1 – 250 | — |
|
|
729
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
730
|
+
|
|
731
|
+
### `sds.accounts.getAccountsSortedBy()`
|
|
732
|
+
|
|
733
|
+
Returns the extended Steem account data for all accounts ordered by :sortField, :sortDir.
|
|
734
|
+
|
|
735
|
+
- Route: `/accounts_api/getAccountsSortedBy/:sortField/:sortDir/:observer?/:fields?/:limit?/:offset?`
|
|
736
|
+
- Result: JSON Object
|
|
737
|
+
- Max. limit: 1000
|
|
738
|
+
- Example: `/accounts_api/getAccountsSortedBy/vests_own/DESC`
|
|
739
|
+
|
|
740
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
741
|
+
| --- | --- | --- | --- | --- | --- |
|
|
742
|
+
| `sortField` | fixed_value | yes | — | — | name | creator | proxy | recovery_account | created | last_action | last_comment | last_root_post | … (42 values) |
|
|
743
|
+
| `sortDir` | fixed_value | yes | — | — | ASC | DESC |
|
|
744
|
+
| `observer` | account_name | no | — | — | — |
|
|
745
|
+
| `fields` | fixed_csv | no | `*` | — | id | name | creator | recovery_account | reset_account | proxy | json_metadata | posting_json_metadata | … (84 values) |
|
|
746
|
+
| `limit` | int | no | `250` | 1 – 1000 | — |
|
|
747
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
748
|
+
|
|
749
|
+
### `sds.accounts.getAccountCountByVESTSRange()`
|
|
750
|
+
|
|
751
|
+
Returns the number of accounts that :type between :fromVESTS and :toVESTS vesting shares.
|
|
752
|
+
**Ranges**: [ { "from": "fromVESTS", "to": "toVESTS" } ]
|
|
753
|
+
|
|
754
|
+
- Route: `/accounts_api/getAccountCountByVESTSRange/:type/:fromVESTS-:toVESTS`
|
|
755
|
+
- Result: Integer
|
|
756
|
+
- Example: `/accounts_api/getAccountCountByVESTSRange/own/1000-100000`
|
|
757
|
+
|
|
758
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
759
|
+
| --- | --- | --- | --- | --- | --- |
|
|
760
|
+
| `type` | fixed_value | yes | — | — | own | delegated | received | effective |
|
|
761
|
+
| `fromVESTS` | float | yes | — | ≥ 0 | — |
|
|
762
|
+
| `toVESTS` | float | yes | — | ≥ 0 | — |
|
|
763
|
+
|
|
764
|
+
### `sds.accounts.getVestingStats()`
|
|
765
|
+
|
|
766
|
+
Returns vesting statistics like number of whales, orcas, dolphins, minnows and redfishes.
|
|
767
|
+
|
|
768
|
+
- Route: `/accounts_api/getVestingStats`
|
|
769
|
+
- Result: JSON Object
|
|
770
|
+
- Example: `/accounts_api/getVestingStats`
|
|
771
|
+
|
|
772
|
+
_No parameters._
|
|
773
|
+
|
|
774
|
+
---
|
|
775
|
+
|
|
776
|
+
## `account_history_api`
|
|
777
|
+
|
|
778
|
+
Namespace: `sds.accountHistory` · Group: Accounts · 6 methods
|
|
779
|
+
|
|
780
|
+
### `sds.accountHistory.getConfig()`
|
|
781
|
+
|
|
782
|
+
Returns this module's active configuration.
|
|
783
|
+
|
|
784
|
+
- Route: `/account_history_api/getConfig`
|
|
785
|
+
- Result: JSON Object
|
|
786
|
+
- Example: `/account_history_api/getConfig`
|
|
787
|
+
|
|
788
|
+
_No parameters._
|
|
789
|
+
|
|
790
|
+
### `sds.accountHistory.getHistoryByTime()`
|
|
791
|
+
|
|
792
|
+
Returns the account history for :account in the given time range.
|
|
793
|
+
**Ranges**: [ { "from": "fromTime", "to": "toTime" } ]
|
|
794
|
+
|
|
795
|
+
- Route: `/account_history_api/getHistoryByTime/:account/:fromTime-:toTime/:limit?/:offset?`
|
|
796
|
+
- Result: JSON Object
|
|
797
|
+
- Max. limit: 10000
|
|
798
|
+
- Example: `/account_history_api/getHistoryByTime/steemchiller/1788983274-1789588074`
|
|
799
|
+
|
|
800
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
801
|
+
| --- | --- | --- | --- | --- | --- |
|
|
802
|
+
| `account` | account_name | yes | — | — | — |
|
|
803
|
+
| `fromTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
804
|
+
| `toTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
805
|
+
| `limit` | int | no | `1000` | 1 – 10000 | — |
|
|
806
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
807
|
+
|
|
808
|
+
### `sds.accountHistory.getHistoryByOpTypesTime()`
|
|
809
|
+
|
|
810
|
+
Returns the account history for :account and :opTypes in the given time range.
|
|
811
|
+
**Ranges**: [ { "from": "fromTime", "to": "toTime" } ]
|
|
812
|
+
|
|
813
|
+
- Route: `/account_history_api/getHistoryByOpTypesTime/:account/:opTypes/:fromTime-:toTime/:limit?/:offset?`
|
|
814
|
+
- Result: JSON Object
|
|
815
|
+
- Max. limit: 10000
|
|
816
|
+
- Example: `/account_history_api/getHistoryByOpTypesTime/steemchiller/vote,comment/1788983274-1789588074`
|
|
817
|
+
|
|
818
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
819
|
+
| --- | --- | --- | --- | --- | --- |
|
|
820
|
+
| `account` | account_name | yes | — | — | — |
|
|
821
|
+
| `opTypes` | fixed_csv | yes | — | — | account_create | account_create_with_delegation | account_update | account_update2 | account_witness_proxy | account_witness_vote | author_reward | cancel_transfer_from_savings | … (59 values) |
|
|
822
|
+
| `fromTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
823
|
+
| `toTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
824
|
+
| `limit` | int | no | `1000` | 1 – 10000 | — |
|
|
825
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
826
|
+
|
|
827
|
+
### `sds.accountHistory.getHistoryFromStartId()`
|
|
828
|
+
|
|
829
|
+
Returns the account history for :account starting from :startId.
|
|
830
|
+
|
|
831
|
+
- Route: `/account_history_api/getHistoryFromStartId/:account/:startId/:limit?/:offset?`
|
|
832
|
+
- Result: JSON Object
|
|
833
|
+
- Max. limit: 10000
|
|
834
|
+
- Example: `/account_history_api/getHistoryFromStartId/steemchiller/1418590154`
|
|
835
|
+
|
|
836
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
837
|
+
| --- | --- | --- | --- | --- | --- |
|
|
838
|
+
| `account` | account_name | yes | — | — | — |
|
|
839
|
+
| `startId` | int | yes | — | — | — |
|
|
840
|
+
| `limit` | int | no | `1000` | 1 – 10000 | — |
|
|
841
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
842
|
+
|
|
843
|
+
### `sds.accountHistory.getLastOpId()`
|
|
844
|
+
|
|
845
|
+
Returns the last non-virtual operation's id for :account.
|
|
846
|
+
|
|
847
|
+
- Route: `/account_history_api/getLastOpId/:account`
|
|
848
|
+
- Result: Integer
|
|
849
|
+
- Example: `/account_history_api/getLastOpId/steemchiller`
|
|
850
|
+
|
|
851
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
852
|
+
| --- | --- | --- | --- | --- | --- |
|
|
853
|
+
| `account` | account_name | yes | — | — | — |
|
|
854
|
+
|
|
855
|
+
### `sds.accountHistory.getLastOpIds()`
|
|
856
|
+
|
|
857
|
+
Returns the last virtual and last non-virtual operation's id for :account.
|
|
858
|
+
|
|
859
|
+
- Route: `/account_history_api/getLastOpIds/:account`
|
|
860
|
+
- Result: Integer
|
|
861
|
+
- Example: `/account_history_api/getLastOpIds/steemchiller`
|
|
862
|
+
|
|
863
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
864
|
+
| --- | --- | --- | --- | --- | --- |
|
|
865
|
+
| `account` | account_name | yes | — | — | — |
|
|
866
|
+
|
|
867
|
+
---
|
|
868
|
+
|
|
869
|
+
## `authorities_api`
|
|
870
|
+
|
|
871
|
+
Namespace: `sds.authorities` · Group: Accounts · 8 methods
|
|
872
|
+
|
|
873
|
+
### `sds.authorities.getConfig()`
|
|
874
|
+
|
|
875
|
+
Returns this module's active configuration.
|
|
876
|
+
|
|
877
|
+
- Route: `/authorities_api/getConfig`
|
|
878
|
+
- Result: JSON Object
|
|
879
|
+
- Example: `/authorities_api/getConfig`
|
|
880
|
+
|
|
881
|
+
_No parameters._
|
|
882
|
+
|
|
883
|
+
### `sds.authorities.getAccountAuths()`
|
|
884
|
+
|
|
885
|
+
Returns :role 'account_auths' for :account.
|
|
886
|
+
|
|
887
|
+
- Route: `/authorities_api/getAccountAuths/:account/:role`
|
|
888
|
+
- Result: JSON Object
|
|
889
|
+
- Example: `/authorities_api/getAccountAuths/steemchiller/posting`
|
|
890
|
+
|
|
891
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
892
|
+
| --- | --- | --- | --- | --- | --- |
|
|
893
|
+
| `account` | account_name | yes | — | — | — |
|
|
894
|
+
| `role` | fixed_value | yes | — | — | posting | active | owner |
|
|
895
|
+
|
|
896
|
+
### `sds.authorities.getKeyAuths()`
|
|
897
|
+
|
|
898
|
+
Returns :role 'key_auths' for :account.
|
|
899
|
+
|
|
900
|
+
- Route: `/authorities_api/getKeyAuths/:account/:role`
|
|
901
|
+
- Result: JSON Object
|
|
902
|
+
- Example: `/authorities_api/getKeyAuths/steemchiller/posting`
|
|
903
|
+
|
|
904
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
905
|
+
| --- | --- | --- | --- | --- | --- |
|
|
906
|
+
| `account` | account_name | yes | — | — | — |
|
|
907
|
+
| `role` | fixed_value | yes | — | — | posting | active | owner |
|
|
908
|
+
|
|
909
|
+
### `sds.authorities.getAccountAuthsByTarget()`
|
|
910
|
+
|
|
911
|
+
Returns a list of accounts (with role details) that authorized :account.
|
|
912
|
+
|
|
913
|
+
- Route: `/authorities_api/getAccountAuthsByTarget/:account`
|
|
914
|
+
- Result: JSON Object
|
|
915
|
+
- Example: `/authorities_api/getAccountAuthsByTarget/steemauto.app`
|
|
916
|
+
|
|
917
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
918
|
+
| --- | --- | --- | --- | --- | --- |
|
|
919
|
+
| `account` | account_name | yes | — | — | — |
|
|
920
|
+
|
|
921
|
+
### `sds.authorities.getAccountAuthsByTargetRole()`
|
|
922
|
+
|
|
923
|
+
Returns a list of accounts that authorized :account to use :role.
|
|
924
|
+
|
|
925
|
+
- Route: `/authorities_api/getAccountAuthsByTargetRole/:account/:role`
|
|
926
|
+
- Result: JSON Object
|
|
927
|
+
- Example: `/authorities_api/getAccountAuthsByTargetRole/steemauto.app/posting`
|
|
928
|
+
|
|
929
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
930
|
+
| --- | --- | --- | --- | --- | --- |
|
|
931
|
+
| `account` | account_name | yes | — | — | — |
|
|
932
|
+
| `role` | fixed_value | yes | — | — | posting | active | owner |
|
|
933
|
+
|
|
934
|
+
### `sds.authorities.getAuthorizedAccounts()`
|
|
935
|
+
|
|
936
|
+
Returns a grouped list of authorized accounts with at least :minCount authorizations.
|
|
937
|
+
|
|
938
|
+
- Route: `/authorities_api/getAuthorizedAccounts/:minCount`
|
|
939
|
+
- Result: JSON Object
|
|
940
|
+
- Example: `/authorities_api/getAuthorizedAccounts/1000`
|
|
941
|
+
|
|
942
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
943
|
+
| --- | --- | --- | --- | --- | --- |
|
|
944
|
+
| `minCount` | int | yes | — | 0 – 100000000 | — |
|
|
945
|
+
|
|
946
|
+
### `sds.authorities.getAccountAuthsHistory()`
|
|
947
|
+
|
|
948
|
+
Returns the :role 'account_auths' history for :account.
|
|
949
|
+
|
|
950
|
+
- Route: `/authorities_api/getAccountAuthsHistory/:account/:role`
|
|
951
|
+
- Result: JSON Object
|
|
952
|
+
- Example: `/authorities_api/getAccountAuthsHistory/steemchiller/posting`
|
|
953
|
+
|
|
954
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
955
|
+
| --- | --- | --- | --- | --- | --- |
|
|
956
|
+
| `account` | account_name | yes | — | — | — |
|
|
957
|
+
| `role` | fixed_value | yes | — | — | posting | active | owner |
|
|
958
|
+
|
|
959
|
+
### `sds.authorities.getKeyAuthsHistory()`
|
|
960
|
+
|
|
961
|
+
Returns the :role 'key_auths' history for :account.
|
|
962
|
+
|
|
963
|
+
- Route: `/authorities_api/getKeyAuthsHistory/:account/:role`
|
|
964
|
+
- Result: JSON Object
|
|
965
|
+
- Example: `/authorities_api/getKeyAuthsHistory/steemchiller/posting`
|
|
966
|
+
|
|
967
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
968
|
+
| --- | --- | --- | --- | --- | --- |
|
|
969
|
+
| `account` | account_name | yes | — | — | — |
|
|
970
|
+
| `role` | fixed_value | yes | — | — | posting | active | owner |
|
|
971
|
+
|
|
972
|
+
---
|
|
973
|
+
|
|
974
|
+
## `delegations_api`
|
|
975
|
+
|
|
976
|
+
Namespace: `sds.delegations` · Group: Accounts · 5 methods
|
|
977
|
+
|
|
978
|
+
### `sds.delegations.getConfig()`
|
|
979
|
+
|
|
980
|
+
Returns this module's active configuration.
|
|
981
|
+
|
|
982
|
+
- Route: `/delegations_api/getConfig`
|
|
983
|
+
- Result: JSON Object
|
|
984
|
+
- Example: `/delegations_api/getConfig`
|
|
985
|
+
|
|
986
|
+
_No parameters._
|
|
987
|
+
|
|
988
|
+
### `sds.delegations.getOutgoingDelegations()`
|
|
989
|
+
|
|
990
|
+
Returns the outgoing delegations for the given :account.
|
|
991
|
+
|
|
992
|
+
- Route: `/delegations_api/getOutgoingDelegations/:account/:limit?/:offset?`
|
|
993
|
+
- Result: JSON Object
|
|
994
|
+
- Max. limit: 100000
|
|
995
|
+
- Example: `/delegations_api/getOutgoingDelegations/steemchiller`
|
|
996
|
+
|
|
997
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
998
|
+
| --- | --- | --- | --- | --- | --- |
|
|
999
|
+
| `account` | account_name | yes | — | — | — |
|
|
1000
|
+
| `limit` | int | no | `1000` | 1 – 100000 | — |
|
|
1001
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1002
|
+
|
|
1003
|
+
### `sds.delegations.getIncomingDelegations()`
|
|
1004
|
+
|
|
1005
|
+
Returns the incoming delegations for the given :account.
|
|
1006
|
+
|
|
1007
|
+
- Route: `/delegations_api/getIncomingDelegations/:account/:limit?/:offset?`
|
|
1008
|
+
- Result: JSON Object
|
|
1009
|
+
- Max. limit: 100000
|
|
1010
|
+
- Example: `/delegations_api/getIncomingDelegations/steemchiller`
|
|
1011
|
+
|
|
1012
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1013
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1014
|
+
| `account` | account_name | yes | — | — | — |
|
|
1015
|
+
| `limit` | int | no | `1000` | 1 – 100000 | — |
|
|
1016
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1017
|
+
|
|
1018
|
+
### `sds.delegations.getExpiringDelegations()`
|
|
1019
|
+
|
|
1020
|
+
Returns the expiring delegations for the given :account.
|
|
1021
|
+
|
|
1022
|
+
- Route: `/delegations_api/getExpiringDelegations/:account/:limit?/:offset?`
|
|
1023
|
+
- Result: JSON Object
|
|
1024
|
+
- Max. limit: 100000
|
|
1025
|
+
- Example: `/delegations_api/getExpiringDelegations/steemchiller`
|
|
1026
|
+
|
|
1027
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1028
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1029
|
+
| `account` | account_name | yes | — | — | — |
|
|
1030
|
+
| `limit` | int | no | `1000` | 1 – 100000 | — |
|
|
1031
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1032
|
+
|
|
1033
|
+
### `sds.delegations.getDelegationHistory()`
|
|
1034
|
+
|
|
1035
|
+
Returns the delegation history for the given :query.
|
|
1036
|
+
|
|
1037
|
+
- Route: `/delegations_api/getDelegationHistory/:query/:limit?/:offset?`
|
|
1038
|
+
- Result: JSON Object
|
|
1039
|
+
- Max. limit: 1000
|
|
1040
|
+
- Example: `/delegations_api/getDelegationHistory/{"from":"steemchiller"}`
|
|
1041
|
+
|
|
1042
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1043
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1044
|
+
| `query` | json_object | yes | — | — | — |
|
|
1045
|
+
| `limit` | int | no | `1000` | 1 – 1000 | — |
|
|
1046
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1047
|
+
|
|
1048
|
+
---
|
|
1049
|
+
|
|
1050
|
+
## `followers_api`
|
|
1051
|
+
|
|
1052
|
+
Namespace: `sds.followers` · Group: Accounts · 13 methods
|
|
1053
|
+
|
|
1054
|
+
### `sds.followers.getConfig()`
|
|
1055
|
+
|
|
1056
|
+
Returns this module's active configuration.
|
|
1057
|
+
|
|
1058
|
+
- Route: `/followers_api/getConfig`
|
|
1059
|
+
- Result: JSON Object
|
|
1060
|
+
- Example: `/followers_api/getConfig`
|
|
1061
|
+
|
|
1062
|
+
_No parameters._
|
|
1063
|
+
|
|
1064
|
+
### `sds.followers.getFollowers()`
|
|
1065
|
+
|
|
1066
|
+
Returns the followers of the given account (:target).
|
|
1067
|
+
|
|
1068
|
+
- Route: `/followers_api/getFollowers/:target/:limit?/:offset?`
|
|
1069
|
+
- Result: JSON Array
|
|
1070
|
+
- Max. limit: 100000
|
|
1071
|
+
- Example: `/followers_api/getFollowers/steemchiller`
|
|
1072
|
+
|
|
1073
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1074
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1075
|
+
| `target` | account_name | yes | — | — | — |
|
|
1076
|
+
| `limit` | int | no | `10000` | 1 – 100000 | — |
|
|
1077
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1078
|
+
|
|
1079
|
+
### `sds.followers.getFollowing()`
|
|
1080
|
+
|
|
1081
|
+
Returns the followed accounts of the given account (:source).
|
|
1082
|
+
|
|
1083
|
+
- Route: `/followers_api/getFollowing/:source/:limit?/:offset?`
|
|
1084
|
+
- Result: JSON Array
|
|
1085
|
+
- Max. limit: 100000
|
|
1086
|
+
- Example: `/followers_api/getFollowing/steemchiller`
|
|
1087
|
+
|
|
1088
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1089
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1090
|
+
| `source` | account_name | yes | — | — | — |
|
|
1091
|
+
| `limit` | int | no | `10000` | 1 – 100000 | — |
|
|
1092
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1093
|
+
|
|
1094
|
+
### `sds.followers.getKnownFollowers()`
|
|
1095
|
+
|
|
1096
|
+
Returns the followers of :target that are followed by :source.
|
|
1097
|
+
|
|
1098
|
+
- Route: `/followers_api/getKnownFollowers/:source/:target/:limit?/:offset?`
|
|
1099
|
+
- Result: JSON Array
|
|
1100
|
+
- Max. limit: 100000
|
|
1101
|
+
- Example: `/followers_api/getKnownFollowers/steemchiller/faisalamin`
|
|
1102
|
+
|
|
1103
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1104
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1105
|
+
| `source` | account_name | yes | — | — | — |
|
|
1106
|
+
| `target` | account_name | yes | — | — | — |
|
|
1107
|
+
| `limit` | int | no | `10000` | 1 – 100000 | — |
|
|
1108
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1109
|
+
|
|
1110
|
+
### `sds.followers.getIgnorers()`
|
|
1111
|
+
|
|
1112
|
+
Returns the ignores of the given account (:target).
|
|
1113
|
+
|
|
1114
|
+
- Route: `/followers_api/getIgnorers/:target/:limit?/:offset?`
|
|
1115
|
+
- Result: JSON Array
|
|
1116
|
+
- Max. limit: 100000
|
|
1117
|
+
- Example: `/followers_api/getIgnorers/steemchiller`
|
|
1118
|
+
|
|
1119
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1120
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1121
|
+
| `target` | account_name | yes | — | — | — |
|
|
1122
|
+
| `limit` | int | no | `10000` | 1 – 100000 | — |
|
|
1123
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1124
|
+
|
|
1125
|
+
### `sds.followers.getIgnored()`
|
|
1126
|
+
|
|
1127
|
+
Returns the ignored accounts of the given account (:source).
|
|
1128
|
+
|
|
1129
|
+
- Route: `/followers_api/getIgnored/:source/:limit?/:offset?`
|
|
1130
|
+
- Result: JSON Array
|
|
1131
|
+
- Max. limit: 100000
|
|
1132
|
+
- Example: `/followers_api/getIgnored/steemchiller`
|
|
1133
|
+
|
|
1134
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1135
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1136
|
+
| `source` | account_name | yes | — | — | — |
|
|
1137
|
+
| `limit` | int | no | `10000` | 1 – 100000 | — |
|
|
1138
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1139
|
+
|
|
1140
|
+
### `sds.followers.getCounts()`
|
|
1141
|
+
|
|
1142
|
+
Returns the number of followers and followed accounts of the given account (:account).
|
|
1143
|
+
|
|
1144
|
+
- Route: `/followers_api/getCounts/:account`
|
|
1145
|
+
- Result: JSON Object
|
|
1146
|
+
- Example: `/followers_api/getCounts/steemchiller`
|
|
1147
|
+
|
|
1148
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1149
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1150
|
+
| `account` | account_name | yes | — | — | — |
|
|
1151
|
+
|
|
1152
|
+
### `sds.followers.getFollowerCount()`
|
|
1153
|
+
|
|
1154
|
+
Returns the number of followers of the given account (:target).
|
|
1155
|
+
|
|
1156
|
+
- Route: `/followers_api/getFollowerCount/:target`
|
|
1157
|
+
- Result: Integer
|
|
1158
|
+
- Example: `/followers_api/getFollowerCount/steemchiller`
|
|
1159
|
+
|
|
1160
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1161
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1162
|
+
| `target` | account_name | yes | — | — | — |
|
|
1163
|
+
|
|
1164
|
+
### `sds.followers.getFollowingCount()`
|
|
1165
|
+
|
|
1166
|
+
Returns the number of followed accounts of the given account (:source).
|
|
1167
|
+
|
|
1168
|
+
- Route: `/followers_api/getFollowingCount/:source`
|
|
1169
|
+
- Result: Integer
|
|
1170
|
+
- Example: `/followers_api/getFollowingCount/steemchiller`
|
|
1171
|
+
|
|
1172
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1173
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1174
|
+
| `source` | account_name | yes | — | — | — |
|
|
1175
|
+
|
|
1176
|
+
### `sds.followers.getFollowedHistory()`
|
|
1177
|
+
|
|
1178
|
+
Returns the followed history of the given account (:target) in the given time range (:fromTime to :toTime).
|
|
1179
|
+
**Ranges**: [ { "from": "fromTime", "to": "toTime" } ]
|
|
1180
|
+
|
|
1181
|
+
- Route: `/followers_api/getFollowedHistory/:target/:fromTime-:toTime/:limit?/:offset?`
|
|
1182
|
+
- Result: JSON Object
|
|
1183
|
+
- Max. limit: 10000
|
|
1184
|
+
- Example: `/followers_api/getFollowedHistory/steemchiller/1788983274-1789588074`
|
|
1185
|
+
|
|
1186
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1187
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1188
|
+
| `target` | account_name | yes | — | — | — |
|
|
1189
|
+
| `fromTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
1190
|
+
| `toTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
1191
|
+
| `limit` | int | no | `10000` | 1 – 10000 | — |
|
|
1192
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1193
|
+
|
|
1194
|
+
### `sds.followers.getFollowHistory()`
|
|
1195
|
+
|
|
1196
|
+
Returns the follow history of the given account (:source) in the given time range (:fromTime to :toTime).
|
|
1197
|
+
|
|
1198
|
+
- Route: `/followers_api/getFollowHistory/:source/:fromTime-:toTime/:limit?/:offset?`
|
|
1199
|
+
- Result: JSON Object
|
|
1200
|
+
- Max. limit: 10000
|
|
1201
|
+
- Example: `/followers_api/getFollowHistory/steemchiller/1788983274-1789588074`
|
|
1202
|
+
|
|
1203
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1204
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1205
|
+
| `source` | account_name | yes | — | — | — |
|
|
1206
|
+
| `fromTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
1207
|
+
| `toTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
1208
|
+
| `limit` | int | no | `10000` | 1 – 10000 | — |
|
|
1209
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1210
|
+
|
|
1211
|
+
### `sds.followers.getUnfollowedHistory()`
|
|
1212
|
+
|
|
1213
|
+
Returns the unfollowed history of the given account (:target) in the given time range (:fromTime to :toTime).
|
|
1214
|
+
|
|
1215
|
+
- Route: `/followers_api/getUnfollowedHistory/:target/:fromTime-:toTime/:limit?/:offset?`
|
|
1216
|
+
- Result: JSON Object
|
|
1217
|
+
- Max. limit: 10000
|
|
1218
|
+
- Example: `/followers_api/getUnfollowedHistory/steemchiller/1788983274-1789588074`
|
|
1219
|
+
|
|
1220
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1221
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1222
|
+
| `target` | account_name | yes | — | — | — |
|
|
1223
|
+
| `fromTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
1224
|
+
| `toTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
1225
|
+
| `limit` | int | no | `10000` | 1 – 10000 | — |
|
|
1226
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1227
|
+
|
|
1228
|
+
### `sds.followers.getUnfollowHistory()`
|
|
1229
|
+
|
|
1230
|
+
Returns the unfollow history of the given account (:source) in the given time range (:fromTime to :toTime).
|
|
1231
|
+
|
|
1232
|
+
- Route: `/followers_api/getUnfollowHistory/:source/:fromTime-:toTime/:limit?/:offset?`
|
|
1233
|
+
- Result: JSON Object
|
|
1234
|
+
- Max. limit: 10000
|
|
1235
|
+
- Example: `/followers_api/getUnfollowHistory/steemchiller/1788983274-1789588074`
|
|
1236
|
+
|
|
1237
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1238
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1239
|
+
| `source` | account_name | yes | — | — | — |
|
|
1240
|
+
| `fromTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
1241
|
+
| `toTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
1242
|
+
| `limit` | int | no | `10000` | 1 – 10000 | — |
|
|
1243
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1244
|
+
|
|
1245
|
+
---
|
|
1246
|
+
|
|
1247
|
+
## `mentions_api`
|
|
1248
|
+
|
|
1249
|
+
Namespace: `sds.mentions` · Group: Accounts · 2 methods
|
|
1250
|
+
|
|
1251
|
+
### `sds.mentions.getConfig()`
|
|
1252
|
+
|
|
1253
|
+
Returns this module's active configuration.
|
|
1254
|
+
|
|
1255
|
+
- Route: `/mentions_api/getConfig`
|
|
1256
|
+
- Result: JSON Object
|
|
1257
|
+
- Example: `/mentions_api/getConfig`
|
|
1258
|
+
|
|
1259
|
+
_No parameters._
|
|
1260
|
+
|
|
1261
|
+
### `sds.mentions.getMentions()`
|
|
1262
|
+
|
|
1263
|
+
Returns the mentions for the given :account and time range.
|
|
1264
|
+
**Ranges**: [ { "from": "fromTime", "to": "toTime" } ]
|
|
1265
|
+
|
|
1266
|
+
- Route: `/mentions_api/getMentions/:account/:fromTime-:toTime/:limit?/:offset?`
|
|
1267
|
+
- Result: JSON Object
|
|
1268
|
+
- Max. limit: 10000
|
|
1269
|
+
- Example: `/mentions_api/getMentions/steemchiller/1788983274-1789588074`
|
|
1270
|
+
|
|
1271
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1272
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1273
|
+
| `account` | account_name | yes | — | — | — |
|
|
1274
|
+
| `fromTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
1275
|
+
| `toTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
1276
|
+
| `limit` | int | no | `1000` | 1 – 10000 | — |
|
|
1277
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1278
|
+
|
|
1279
|
+
---
|
|
1280
|
+
|
|
1281
|
+
## `notifications_api`
|
|
1282
|
+
|
|
1283
|
+
Namespace: `sds.notifications` · Group: Accounts · 9 methods
|
|
1284
|
+
|
|
1285
|
+
### `sds.notifications.getConfig()`
|
|
1286
|
+
|
|
1287
|
+
Returns this module's active configuration.
|
|
1288
|
+
|
|
1289
|
+
- Route: `/notifications_api/getConfig`
|
|
1290
|
+
- Result: JSON Object
|
|
1291
|
+
- Example: `/notifications_api/getConfig`
|
|
1292
|
+
|
|
1293
|
+
_No parameters._
|
|
1294
|
+
|
|
1295
|
+
### `sds.notifications.getFilteredUnreadCount()`
|
|
1296
|
+
|
|
1297
|
+
Returns the number of new (unread) notifications for the given :account and :filter.
|
|
1298
|
+
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'.
|
|
1299
|
+
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'.
|
|
1300
|
+
|
|
1301
|
+
- Route: `/notifications_api/getFilteredUnreadCount/:account/:filter`
|
|
1302
|
+
- Result: Integer
|
|
1303
|
+
- Example: `/notifications_api/getFilteredUnreadCount/steemchiller/{"default":{"minReputation":25},"mention":{"minSP":1000,"minReputation":50},"vote":{"minVoteAmount":0.1}}`
|
|
1304
|
+
|
|
1305
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1306
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1307
|
+
| `account` | account_name | yes | — | — | — |
|
|
1308
|
+
| `filter` | json_object | yes | — | — | — |
|
|
1309
|
+
|
|
1310
|
+
### `sds.notifications.getFilteredUnreadSummary()`
|
|
1311
|
+
|
|
1312
|
+
Returns the number of new (unread) notifications grouped by type for the given :account and :filter.
|
|
1313
|
+
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'.
|
|
1314
|
+
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'.
|
|
1315
|
+
|
|
1316
|
+
- Route: `/notifications_api/getFilteredUnreadSummary/:account/:filter`
|
|
1317
|
+
- Result: JSON Object
|
|
1318
|
+
- Example: `/notifications_api/getFilteredUnreadSummary/steemchiller/{"mention":{"minSP":1000,"minReputation":50},"vote":{"minVoteAmount":0.1,"minReputation":50}}`
|
|
1319
|
+
|
|
1320
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1321
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1322
|
+
| `account` | account_name | yes | — | — | — |
|
|
1323
|
+
| `filter` | json_object | yes | — | — | — |
|
|
1324
|
+
|
|
1325
|
+
### `sds.notifications.getFilteredNotificationsByStatus()`
|
|
1326
|
+
|
|
1327
|
+
Returns :status notifications for the given :account and :filter ordered by time descending.
|
|
1328
|
+
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'.
|
|
1329
|
+
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'.
|
|
1330
|
+
|
|
1331
|
+
- Route: `/notifications_api/getFilteredNotificationsByStatus/:account/:status/:filter/:limit?/:offset?`
|
|
1332
|
+
- Result: JSON Object
|
|
1333
|
+
- Max. limit: 2500
|
|
1334
|
+
- Example: `/notifications_api/getFilteredNotificationsByStatus/steemchiller/new/{"mention":{"minSP":1000,"minReputation":50},"vote":{"minVoteAmount":0.1,"minReputation":50}}`
|
|
1335
|
+
|
|
1336
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1337
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1338
|
+
| `account` | account_name | yes | — | — | — |
|
|
1339
|
+
| `status` | fixed_value | yes | — | — | all | new | old |
|
|
1340
|
+
| `filter` | json_object | yes | — | — | — |
|
|
1341
|
+
| `limit` | int | no | `250` | 1 – 2500 | — |
|
|
1342
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1343
|
+
|
|
1344
|
+
### `sds.notifications.getFilteredNotificationsByStatusType()`
|
|
1345
|
+
|
|
1346
|
+
Returns :status notifications for the given :account, :type, and :filter ordered by time descending.
|
|
1347
|
+
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'.
|
|
1348
|
+
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'.
|
|
1349
|
+
|
|
1350
|
+
- Route: `/notifications_api/getFilteredNotificationsByStatusType/:account/:status/:type/:filter/:limit?/:offset?`
|
|
1351
|
+
- Result: JSON Object
|
|
1352
|
+
- Max. limit: 2500
|
|
1353
|
+
- Example: `/notifications_api/getFilteredNotificationsByStatusType/steemchiller/new/follow/{"default":{"minSP":1000,"minReputation":50}}`
|
|
1354
|
+
|
|
1355
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1356
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1357
|
+
| `account` | account_name | yes | — | — | — |
|
|
1358
|
+
| `status` | fixed_value | yes | — | — | all | new | old |
|
|
1359
|
+
| `type` | fixed_value | yes | — | — | vote | reply | follow | mention | resteem |
|
|
1360
|
+
| `filter` | json_object | yes | — | — | — |
|
|
1361
|
+
| `limit` | int | no | `250` | 1 – 2500 | — |
|
|
1362
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1363
|
+
|
|
1364
|
+
### `sds.notifications.getUnreadCount()`
|
|
1365
|
+
|
|
1366
|
+
Returns the number of new (unread) notifications for the given :account.
|
|
1367
|
+
|
|
1368
|
+
- Route: `/notifications_api/getUnreadCount/:account`
|
|
1369
|
+
- Result: Integer
|
|
1370
|
+
- Example: `/notifications_api/getUnreadCount/steemchiller`
|
|
1371
|
+
|
|
1372
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1373
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1374
|
+
| `account` | account_name | yes | — | — | — |
|
|
1375
|
+
|
|
1376
|
+
### `sds.notifications.getUnreadSummary()`
|
|
1377
|
+
|
|
1378
|
+
Returns the number of new (unread) notifications grouped by type for the given :account.
|
|
1379
|
+
|
|
1380
|
+
- Route: `/notifications_api/getUnreadSummary/:account`
|
|
1381
|
+
- Result: JSON Object
|
|
1382
|
+
- Example: `/notifications_api/getUnreadSummary/steemchiller`
|
|
1383
|
+
|
|
1384
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1385
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1386
|
+
| `account` | account_name | yes | — | — | — |
|
|
1387
|
+
|
|
1388
|
+
### `sds.notifications.getNotificationsByStatus()`
|
|
1389
|
+
|
|
1390
|
+
Returns :status notifications for the given :account ordered by time descending.
|
|
1391
|
+
|
|
1392
|
+
- Route: `/notifications_api/getNotificationsByStatus/:account/:status/:limit?/:offset?`
|
|
1393
|
+
- Result: JSON Object
|
|
1394
|
+
- Max. limit: 2500
|
|
1395
|
+
- Example: `/notifications_api/getNotificationsByStatus/steemchiller/new`
|
|
1396
|
+
|
|
1397
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1398
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1399
|
+
| `account` | account_name | yes | — | — | — |
|
|
1400
|
+
| `status` | fixed_value | yes | — | — | all | new | old |
|
|
1401
|
+
| `limit` | int | no | `250` | 1 – 2500 | — |
|
|
1402
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1403
|
+
|
|
1404
|
+
### `sds.notifications.getNotificationsByStatusType()`
|
|
1405
|
+
|
|
1406
|
+
Returns :status notifications for the given :account and :type ordered by time descending.
|
|
1407
|
+
|
|
1408
|
+
- Route: `/notifications_api/getNotificationsByStatusType/:account/:status/:type/:limit?/:offset?`
|
|
1409
|
+
- Result: JSON Object
|
|
1410
|
+
- Max. limit: 2500
|
|
1411
|
+
- Example: `/notifications_api/getNotificationsByStatusType/steemchiller/new/follow`
|
|
1412
|
+
|
|
1413
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1414
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1415
|
+
| `account` | account_name | yes | — | — | — |
|
|
1416
|
+
| `status` | fixed_value | yes | — | — | all | new | old |
|
|
1417
|
+
| `type` | fixed_value | yes | — | — | vote | reply | follow | mention | resteem |
|
|
1418
|
+
| `limit` | int | no | `250` | 1 – 2500 | — |
|
|
1419
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1420
|
+
|
|
1421
|
+
---
|
|
1422
|
+
|
|
1423
|
+
## `rewards_api`
|
|
1424
|
+
|
|
1425
|
+
Namespace: `sds.rewards` · Group: Accounts · 7 methods
|
|
1426
|
+
|
|
1427
|
+
### `sds.rewards.getConfig()`
|
|
1428
|
+
|
|
1429
|
+
Returns this module's active configuration.
|
|
1430
|
+
|
|
1431
|
+
- Route: `/rewards_api/getConfig`
|
|
1432
|
+
- Result: JSON Object
|
|
1433
|
+
- Example: `/rewards_api/getConfig`
|
|
1434
|
+
|
|
1435
|
+
_No parameters._
|
|
1436
|
+
|
|
1437
|
+
### `sds.rewards.getRewards()`
|
|
1438
|
+
|
|
1439
|
+
Returns the rewards for the given :op and :account in the given time range.
|
|
1440
|
+
**Ranges**: [ { "from": "fromTime", "to": "toTime" } ]
|
|
1441
|
+
|
|
1442
|
+
- Route: `/rewards_api/getRewards/:op/:account/:fromTime-:toTime/:limit?/:offset?`
|
|
1443
|
+
- Result: JSON Object
|
|
1444
|
+
- Max. limit: 10000
|
|
1445
|
+
- Example: `/rewards_api/getRewards/curation_reward/steemchiller/1788983274-1789588074`
|
|
1446
|
+
|
|
1447
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1448
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1449
|
+
| `op` | fixed_value | yes | — | — | author_reward | comment_benefactor_reward | curation_reward | liquidity_reward | producer_reward | interest | proposal_pay |
|
|
1450
|
+
| `account` | account_name | yes | — | — | — |
|
|
1451
|
+
| `fromTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
1452
|
+
| `toTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
1453
|
+
| `limit` | int | no | `1000` | 1 – 10000 | — |
|
|
1454
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1455
|
+
|
|
1456
|
+
### `sds.rewards.getRewardsSums()`
|
|
1457
|
+
|
|
1458
|
+
Returns the rewards sums for the given :op and :account in the given time range.
|
|
1459
|
+
**Ranges**: [ { "from": "fromTime", "to": "toTime" } ]
|
|
1460
|
+
|
|
1461
|
+
- Route: `/rewards_api/getRewardsSums/:op/:account/:fromTime-:toTime`
|
|
1462
|
+
- Result: JSON Array
|
|
1463
|
+
- Example: `/rewards_api/getRewardsSums/curation_reward/steemchiller/1788983274-1789588074`
|
|
1464
|
+
|
|
1465
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1466
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1467
|
+
| `op` | fixed_value | yes | — | — | author_reward | comment_benefactor_reward | curation_reward | liquidity_reward | producer_reward | interest | proposal_pay |
|
|
1468
|
+
| `account` | account_name | yes | — | — | — |
|
|
1469
|
+
| `fromTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
1470
|
+
| `toTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
1471
|
+
|
|
1472
|
+
### `sds.rewards.getAllRewardsSums()`
|
|
1473
|
+
|
|
1474
|
+
Returns all rewards sums for :account in the given time range.
|
|
1475
|
+
**Ranges**: [ { "from": "fromTime", "to": "toTime" } ]
|
|
1476
|
+
|
|
1477
|
+
- Route: `/rewards_api/getAllRewardsSums/:account/:fromTime-:toTime`
|
|
1478
|
+
- Result: JSON Object
|
|
1479
|
+
- Example: `/rewards_api/getAllRewardsSums/steemchiller/1788983274-1789588074`
|
|
1480
|
+
|
|
1481
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1482
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1483
|
+
| `account` | account_name | yes | — | — | — |
|
|
1484
|
+
| `fromTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
1485
|
+
| `toTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
1486
|
+
|
|
1487
|
+
### `sds.rewards.getComingAuthorRewardsSummary()`
|
|
1488
|
+
|
|
1489
|
+
Returns a summary of the coming author rewards for the given :account.
|
|
1490
|
+
|
|
1491
|
+
- Route: `/rewards_api/getComingAuthorRewardsSummary/:account`
|
|
1492
|
+
- Result: JSON Object
|
|
1493
|
+
- Example: `/rewards_api/getComingAuthorRewardsSummary/steemchiller`
|
|
1494
|
+
|
|
1495
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1496
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1497
|
+
| `account` | account_name | yes | — | — | — |
|
|
1498
|
+
|
|
1499
|
+
### `sds.rewards.getComingBeneficiaryRewardsSummary()`
|
|
1500
|
+
|
|
1501
|
+
Returns a summary of the coming beneficiary rewards for the given :account.
|
|
1502
|
+
|
|
1503
|
+
- Route: `/rewards_api/getComingBeneficiaryRewardsSummary/:account`
|
|
1504
|
+
- Result: JSON Object
|
|
1505
|
+
- Example: `/rewards_api/getComingBeneficiaryRewardsSummary/steemchiller`
|
|
1506
|
+
|
|
1507
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1508
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1509
|
+
| `account` | account_name | yes | — | — | — |
|
|
1510
|
+
|
|
1511
|
+
### `sds.rewards.getComingCurationRewardsSummary()`
|
|
1512
|
+
|
|
1513
|
+
Returns a summary of the coming curation rewards for the given :account.
|
|
1514
|
+
|
|
1515
|
+
- Route: `/rewards_api/getComingCurationRewardsSummary/:account`
|
|
1516
|
+
- Result: JSON Object
|
|
1517
|
+
- Example: `/rewards_api/getComingCurationRewardsSummary/steemchiller`
|
|
1518
|
+
|
|
1519
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1520
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1521
|
+
| `account` | account_name | yes | — | — | — |
|
|
1522
|
+
|
|
1523
|
+
---
|
|
1524
|
+
|
|
1525
|
+
## `transfers_api`
|
|
1526
|
+
|
|
1527
|
+
Namespace: `sds.transfers` · Group: Accounts · 7 methods
|
|
1528
|
+
|
|
1529
|
+
### `sds.transfers.getConfig()`
|
|
1530
|
+
|
|
1531
|
+
Returns this module's active configuration.
|
|
1532
|
+
|
|
1533
|
+
- Route: `/transfers_api/getConfig`
|
|
1534
|
+
- Result: JSON Object
|
|
1535
|
+
- Example: `/transfers_api/getConfig`
|
|
1536
|
+
|
|
1537
|
+
_No parameters._
|
|
1538
|
+
|
|
1539
|
+
### `sds.transfers.getTransfers()`
|
|
1540
|
+
|
|
1541
|
+
Returns the transfers for the search criteria given in :query.
|
|
1542
|
+
|
|
1543
|
+
- Route: `/transfers_api/getTransfers/:query/:limit?/:offset?`
|
|
1544
|
+
- Result: JSON Object
|
|
1545
|
+
- Max. limit: 1000
|
|
1546
|
+
- Example: `/transfers_api/getTransfers/{"type":"transfer","to":"steemchiller","unit":"SBD"}`
|
|
1547
|
+
|
|
1548
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1549
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1550
|
+
| `query` | json_object | yes | — | — | — |
|
|
1551
|
+
| `limit` | int | no | `250` | 1 – 1000 | — |
|
|
1552
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1553
|
+
|
|
1554
|
+
### `sds.transfers.getTransfersByTypeFrom()`
|
|
1555
|
+
|
|
1556
|
+
Returns the transfers of :type for the given :from account.
|
|
1557
|
+
|
|
1558
|
+
- Route: `/transfers_api/getTransfersByTypeFrom/:type/:from/:orderBy?/:orderDir?/:limit?/:offset?`
|
|
1559
|
+
- Result: JSON Object
|
|
1560
|
+
- Max. limit: 1000
|
|
1561
|
+
- Example: `/transfers_api/getTransfersByTypeFrom/transfer/steemchiller`
|
|
1562
|
+
|
|
1563
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1564
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1565
|
+
| `type` | fixed_value | yes | — | — | transfer | transfer_to_vesting | withdraw_vesting | transfer_to_savings | transfer_from_savings | cancel_transfer_from_savings |
|
|
1566
|
+
| `from` | account_name | yes | — | — | — |
|
|
1567
|
+
| `orderBy` | fixed_value | no | `time` | — | time | amount |
|
|
1568
|
+
| `orderDir` | fixed_value | no | `DESC` | — | ASC | DESC |
|
|
1569
|
+
| `limit` | int | no | `250` | 1 – 1000 | — |
|
|
1570
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1571
|
+
|
|
1572
|
+
### `sds.transfers.getTransfersByTypeTo()`
|
|
1573
|
+
|
|
1574
|
+
Returns the transfers of :type for the given :to account.
|
|
1575
|
+
|
|
1576
|
+
- Route: `/transfers_api/getTransfersByTypeTo/:type/:to/:orderBy?/:orderDir?/:limit?/:offset?`
|
|
1577
|
+
- Result: JSON Object
|
|
1578
|
+
- Max. limit: 1000
|
|
1579
|
+
- Example: `/transfers_api/getTransfersByTypeTo/transfer/steemchiller`
|
|
1580
|
+
|
|
1581
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1582
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1583
|
+
| `type` | fixed_value | yes | — | — | transfer | transfer_to_vesting | withdraw_vesting | transfer_to_savings | transfer_from_savings | cancel_transfer_from_savings |
|
|
1584
|
+
| `to` | account_name | yes | — | — | — |
|
|
1585
|
+
| `orderBy` | fixed_value | no | `time` | — | time | amount |
|
|
1586
|
+
| `orderDir` | fixed_value | no | `DESC` | — | ASC | DESC |
|
|
1587
|
+
| `limit` | int | no | `250` | 1 – 1000 | — |
|
|
1588
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1589
|
+
|
|
1590
|
+
### `sds.transfers.getTransfersByTypeFromTo()`
|
|
1591
|
+
|
|
1592
|
+
Returns the transfers of :type for the given :from and :to account.
|
|
1593
|
+
|
|
1594
|
+
- Route: `/transfers_api/getTransfersByTypeFromTo/:type/:from/:to/:orderBy?/:orderDir?/:limit?/:offset?`
|
|
1595
|
+
- Result: JSON Object
|
|
1596
|
+
- Max. limit: 1000
|
|
1597
|
+
- Example: `/transfers_api/getTransfersByTypeFromTo/transfer/steemchiller/rfdax`
|
|
1598
|
+
|
|
1599
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1600
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1601
|
+
| `type` | fixed_value | yes | — | — | transfer | transfer_to_vesting | withdraw_vesting | transfer_to_savings | transfer_from_savings | cancel_transfer_from_savings |
|
|
1602
|
+
| `from` | account_name | yes | — | — | — |
|
|
1603
|
+
| `to` | account_name | yes | — | — | — |
|
|
1604
|
+
| `orderBy` | fixed_value | no | `time` | — | time | amount |
|
|
1605
|
+
| `orderDir` | fixed_value | no | `DESC` | — | ASC | DESC |
|
|
1606
|
+
| `limit` | int | no | `250` | 1 – 1000 | — |
|
|
1607
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1608
|
+
|
|
1609
|
+
### `sds.transfers.getTransfersByTypeTime()`
|
|
1610
|
+
|
|
1611
|
+
Returns the transfers of :type for the given time range.
|
|
1612
|
+
**Ranges**: [ { "from": "fromTime", "to": "toTime" } ]
|
|
1613
|
+
|
|
1614
|
+
- Route: `/transfers_api/getTransfersByTypeTime/:type/:fromTime-:toTime/:orderBy?/:orderDir?/:limit?/:offset?`
|
|
1615
|
+
- Result: JSON Object
|
|
1616
|
+
- Max. limit: 1000
|
|
1617
|
+
- Example: `/transfers_api/getTransfersByTypeTime/transfer/1646578362-1646664762`
|
|
1618
|
+
|
|
1619
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1620
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1621
|
+
| `type` | fixed_value | yes | — | — | transfer | transfer_to_vesting | withdraw_vesting | transfer_to_savings | transfer_from_savings | cancel_transfer_from_savings |
|
|
1622
|
+
| `fromTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
1623
|
+
| `toTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
1624
|
+
| `orderBy` | fixed_value | no | `time` | — | time |
|
|
1625
|
+
| `orderDir` | fixed_value | no | `DESC` | — | ASC | DESC |
|
|
1626
|
+
| `limit` | int | no | `250` | 1 – 1000 | — |
|
|
1627
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1628
|
+
|
|
1629
|
+
### `sds.transfers.getTransfersByMemoId()`
|
|
1630
|
+
|
|
1631
|
+
Returns the transfers for the given :memoId.
|
|
1632
|
+
|
|
1633
|
+
- Route: `/transfers_api/getTransfersByMemoId/:memoId/:orderBy?/:orderDir?/:limit?/:offset?`
|
|
1634
|
+
- Result: JSON Object
|
|
1635
|
+
- Max. limit: 1000
|
|
1636
|
+
- Example: `/transfers_api/getTransfersByMemoId/7e817990-dae3-47cb-8d6f-5a6dc3eefad3`
|
|
1637
|
+
|
|
1638
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1639
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1640
|
+
| `memoId` | string | yes | — | — | — |
|
|
1641
|
+
| `orderBy` | fixed_value | no | `time` | — | time | amount |
|
|
1642
|
+
| `orderDir` | fixed_value | no | `DESC` | — | ASC | DESC |
|
|
1643
|
+
| `limit` | int | no | `250` | 1 – 1000 | — |
|
|
1644
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1645
|
+
|
|
1646
|
+
---
|
|
1647
|
+
|
|
1648
|
+
## `witnesses_api`
|
|
1649
|
+
|
|
1650
|
+
Namespace: `sds.witnesses` · Group: Accounts · 15 methods
|
|
1651
|
+
|
|
1652
|
+
### `sds.witnesses.getConfig()`
|
|
1653
|
+
|
|
1654
|
+
Returns this module's active configuration.
|
|
1655
|
+
|
|
1656
|
+
- Route: `/witnesses_api/getConfig`
|
|
1657
|
+
- Result: JSON Object
|
|
1658
|
+
- Example: `/witnesses_api/getConfig`
|
|
1659
|
+
|
|
1660
|
+
_No parameters._
|
|
1661
|
+
|
|
1662
|
+
### `sds.witnesses.getWitness()`
|
|
1663
|
+
|
|
1664
|
+
Returns general data about the specified :witness.
|
|
1665
|
+
|
|
1666
|
+
- Route: `/witnesses_api/getWitness/:witness/:observer?`
|
|
1667
|
+
- Result: JSON Object
|
|
1668
|
+
- Example: `/witnesses_api/getWitness/steemchiller`
|
|
1669
|
+
|
|
1670
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1671
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1672
|
+
| `witness` | account_name | yes | — | — | — |
|
|
1673
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
1674
|
+
|
|
1675
|
+
### `sds.witnesses.getWitnessRank()`
|
|
1676
|
+
|
|
1677
|
+
Returns the current rank of the specified :witness.
|
|
1678
|
+
|
|
1679
|
+
- Route: `/witnesses_api/getWitnessRank/:witness`
|
|
1680
|
+
- Result: Integer
|
|
1681
|
+
- Example: `/witnesses_api/getWitnessRank/steemchiller`
|
|
1682
|
+
|
|
1683
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1684
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1685
|
+
| `witness` | account_name | yes | — | — | — |
|
|
1686
|
+
|
|
1687
|
+
### `sds.witnesses.getWitnessStats()`
|
|
1688
|
+
|
|
1689
|
+
Returns statistics for the specified :witness.
|
|
1690
|
+
|
|
1691
|
+
- Route: `/witnesses_api/getWitnessStats/:witness`
|
|
1692
|
+
- Result: JSON Object
|
|
1693
|
+
- Example: `/witnesses_api/getWitnessStats/steemchiller`
|
|
1694
|
+
|
|
1695
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1696
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1697
|
+
| `witness` | account_name | yes | — | — | — |
|
|
1698
|
+
|
|
1699
|
+
### `sds.witnesses.getWitnessesByRank()`
|
|
1700
|
+
|
|
1701
|
+
Returns a list of witnesses ordered by witness rank descending (calculated by received votes).
|
|
1702
|
+
|
|
1703
|
+
- Route: `/witnesses_api/getWitnessesByRank/:observer?/:limit?/:offset?`
|
|
1704
|
+
- Result: JSON Object
|
|
1705
|
+
- Max. limit: 1000
|
|
1706
|
+
- Example: `/witnesses_api/getWitnessesByRank`
|
|
1707
|
+
|
|
1708
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1709
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1710
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
1711
|
+
| `limit` | int | no | `250` | 1 – 1000 | — |
|
|
1712
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1713
|
+
|
|
1714
|
+
### `sds.witnesses.getWitnessProxyByAccount()`
|
|
1715
|
+
|
|
1716
|
+
Returns the witness proxy for :account.
|
|
1717
|
+
|
|
1718
|
+
- Route: `/witnesses_api/getWitnessProxyByAccount/:account`
|
|
1719
|
+
- Result: String
|
|
1720
|
+
- Example: `/witnesses_api/getWitnessProxyByAccount/steemchiller`
|
|
1721
|
+
|
|
1722
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1723
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1724
|
+
| `account` | account_name | yes | — | — | — |
|
|
1725
|
+
|
|
1726
|
+
### `sds.witnesses.getAccountsByWitnessProxy()`
|
|
1727
|
+
|
|
1728
|
+
Returns all accounts with witness proxy set to :proxy.
|
|
1729
|
+
|
|
1730
|
+
- Route: `/witnesses_api/getAccountsByWitnessProxy/:proxy/:limit?/:offset?`
|
|
1731
|
+
- Result: JSON Array
|
|
1732
|
+
- Max. limit: 10000
|
|
1733
|
+
- Example: `/witnesses_api/getAccountsByWitnessProxy/steemchiller`
|
|
1734
|
+
|
|
1735
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1736
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1737
|
+
| `proxy` | account_name | yes | — | — | — |
|
|
1738
|
+
| `limit` | int | no | `10000` | 1 – 10000 | — |
|
|
1739
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1740
|
+
|
|
1741
|
+
### `sds.witnesses.getWitnessProxyChainForwards()`
|
|
1742
|
+
|
|
1743
|
+
Returns the witness proxy chain starting from :account.
|
|
1744
|
+
|
|
1745
|
+
- Route: `/witnesses_api/getWitnessProxyChainForwards/:account`
|
|
1746
|
+
- Result: JSON Object
|
|
1747
|
+
- Example: `/witnesses_api/getWitnessProxyChainForwards/steemchiller`
|
|
1748
|
+
|
|
1749
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1750
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1751
|
+
| `account` | account_name | yes | — | — | — |
|
|
1752
|
+
|
|
1753
|
+
### `sds.witnesses.getWitnessProxyChainBackwards()`
|
|
1754
|
+
|
|
1755
|
+
Returns the witness proxy chain (backwards) starting from :proxy.
|
|
1756
|
+
|
|
1757
|
+
- Route: `/witnesses_api/getWitnessProxyChainBackwards/:proxy`
|
|
1758
|
+
- Result: JSON Object
|
|
1759
|
+
- Example: `/witnesses_api/getWitnessProxyChainBackwards/steemchiller`
|
|
1760
|
+
|
|
1761
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1762
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1763
|
+
| `proxy` | account_name | yes | — | — | — |
|
|
1764
|
+
|
|
1765
|
+
### `sds.witnesses.getWitnessVotesByAccount()`
|
|
1766
|
+
|
|
1767
|
+
Returns all witnesses that were approved by :account.
|
|
1768
|
+
|
|
1769
|
+
- Route: `/witnesses_api/getWitnessVotesByAccount/:account`
|
|
1770
|
+
- Result: JSON Array
|
|
1771
|
+
- Example: `/witnesses_api/getWitnessVotesByAccount/steemchiller`
|
|
1772
|
+
|
|
1773
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1774
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1775
|
+
| `account` | account_name | yes | — | — | — |
|
|
1776
|
+
|
|
1777
|
+
### `sds.witnesses.getWitnessVotesByWitness()`
|
|
1778
|
+
|
|
1779
|
+
Returns all accounts that (directly) approved :witness.
|
|
1780
|
+
|
|
1781
|
+
- Route: `/witnesses_api/getWitnessVotesByWitness/:witness/:limit?/:offset?`
|
|
1782
|
+
- Result: JSON Array
|
|
1783
|
+
- Max. limit: 10000
|
|
1784
|
+
- Example: `/witnesses_api/getWitnessVotesByWitness/steemchiller`
|
|
1785
|
+
|
|
1786
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1787
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1788
|
+
| `witness` | account_name | yes | — | — | — |
|
|
1789
|
+
| `limit` | int | no | `10000` | 1 – 10000 | — |
|
|
1790
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1791
|
+
|
|
1792
|
+
### `sds.witnesses.getWitnessVotesSummary()`
|
|
1793
|
+
|
|
1794
|
+
Returns a list of all incoming witness votes for :witness (including the total proxied vesting shares per voter) ordered by influence descending.
|
|
1795
|
+
|
|
1796
|
+
- Route: `/witnesses_api/getWitnessVotesSummary/:witness`
|
|
1797
|
+
- Result: JSON Object
|
|
1798
|
+
- Example: `/witnesses_api/getWitnessVotesSummary/steemchiller`
|
|
1799
|
+
|
|
1800
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1801
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1802
|
+
| `witness` | account_name | yes | — | — | — |
|
|
1803
|
+
|
|
1804
|
+
### `sds.witnesses.getRecentlyMissedBlocks()`
|
|
1805
|
+
|
|
1806
|
+
Returns the detection time, block number and witness name of recently missed blocks (currently contains data for the last 28 days).
|
|
1807
|
+
|
|
1808
|
+
- Route: `/witnesses_api/getRecentlyMissedBlocks/:limit?/:offset?`
|
|
1809
|
+
- Result: JSON Object
|
|
1810
|
+
- Max. limit: 1000
|
|
1811
|
+
- Example: `/witnesses_api/getRecentlyMissedBlocks`
|
|
1812
|
+
|
|
1813
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1814
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1815
|
+
| `limit` | int | no | `250` | 1 – 1000 | — |
|
|
1816
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1817
|
+
|
|
1818
|
+
### `sds.witnesses.getRecentlyMissedBlocksSummary()`
|
|
1819
|
+
|
|
1820
|
+
Returns a summary of all recently missed blocks (currently contains data for the last 28 days).
|
|
1821
|
+
|
|
1822
|
+
- Route: `/witnesses_api/getRecentlyMissedBlocksSummary`
|
|
1823
|
+
- Result: JSON Object
|
|
1824
|
+
- Example: `/witnesses_api/getRecentlyMissedBlocksSummary`
|
|
1825
|
+
|
|
1826
|
+
_No parameters._
|
|
1827
|
+
|
|
1828
|
+
### `sds.witnesses.getRecentlyMissedCountByWitnessTime()`
|
|
1829
|
+
|
|
1830
|
+
Returns the number of recently missed blocks for :witness / :fromTime (currently contains data for the last 28 days).
|
|
1831
|
+
|
|
1832
|
+
- Route: `/witnesses_api/getRecentlyMissedCountByWitnessTime/:witness/:fromTime?`
|
|
1833
|
+
- Result: Integer
|
|
1834
|
+
- Example: `/witnesses_api/getRecentlyMissedCountByWitnessTime/steemchiller`
|
|
1835
|
+
|
|
1836
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1837
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1838
|
+
| `witness` | account_name | yes | — | — | — |
|
|
1839
|
+
| `fromTime` | int (Date / date string / seconds) | no | — | — | — |
|
|
1840
|
+
|
|
1841
|
+
---
|
|
1842
|
+
|
|
1843
|
+
## `communities_api`
|
|
1844
|
+
|
|
1845
|
+
Namespace: `sds.communities` · Group: Posts · 15 methods
|
|
1846
|
+
|
|
1847
|
+
### `sds.communities.getConfig()`
|
|
1848
|
+
|
|
1849
|
+
Returns this module's active configuration.
|
|
1850
|
+
|
|
1851
|
+
- Route: `/communities_api/getConfig`
|
|
1852
|
+
- Result: JSON Object
|
|
1853
|
+
- Example: `/communities_api/getConfig`
|
|
1854
|
+
|
|
1855
|
+
_No parameters._
|
|
1856
|
+
|
|
1857
|
+
### `sds.communities.getCommunity()`
|
|
1858
|
+
|
|
1859
|
+
Returns general :community data.
|
|
1860
|
+
|
|
1861
|
+
- Route: `/communities_api/getCommunity/:community/:observer?`
|
|
1862
|
+
- Result: JSON Object
|
|
1863
|
+
- Example: `/communities_api/getCommunity/hive-172186`
|
|
1864
|
+
|
|
1865
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1866
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1867
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
1868
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
1869
|
+
|
|
1870
|
+
### `sds.communities.getCommunityRoles()`
|
|
1871
|
+
|
|
1872
|
+
Returns :community's defined roles.
|
|
1873
|
+
|
|
1874
|
+
- Route: `/communities_api/getCommunityRoles/:community`
|
|
1875
|
+
- Result: JSON Object
|
|
1876
|
+
- Example: `/communities_api/getCommunityRoles/hive-172186`
|
|
1877
|
+
|
|
1878
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1879
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1880
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
1881
|
+
|
|
1882
|
+
### `sds.communities.getCommunitySubscribers()`
|
|
1883
|
+
|
|
1884
|
+
Returns a list with all to :community subscribed accounts ordered by name ascending.
|
|
1885
|
+
|
|
1886
|
+
- Route: `/communities_api/getCommunitySubscribers/:community`
|
|
1887
|
+
- Result: JSON Array
|
|
1888
|
+
- Example: `/communities_api/getCommunitySubscribers/hive-172186`
|
|
1889
|
+
|
|
1890
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1891
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1892
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
1893
|
+
|
|
1894
|
+
### `sds.communities.getCommunitySubscriptions()`
|
|
1895
|
+
|
|
1896
|
+
Returns all :community subscriptions (including details) ordered by time ascending.
|
|
1897
|
+
|
|
1898
|
+
- Route: `/communities_api/getCommunitySubscriptions/:community`
|
|
1899
|
+
- Result: JSON Object
|
|
1900
|
+
- Example: `/communities_api/getCommunitySubscriptions/hive-172186`
|
|
1901
|
+
|
|
1902
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1903
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1904
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
1905
|
+
|
|
1906
|
+
### `sds.communities.getCommunityPinnedPosts()`
|
|
1907
|
+
|
|
1908
|
+
Returns a feed list with :community's pinned posts ordered by created time descending.
|
|
1909
|
+
|
|
1910
|
+
- Route: `/communities_api/getCommunityPinnedPosts/:community/:observer?/:bodyLength?`
|
|
1911
|
+
- Result: JSON Object
|
|
1912
|
+
- Example: `/communities_api/getCommunityPinnedPosts/hive-172186`
|
|
1913
|
+
|
|
1914
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1915
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1916
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
1917
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
1918
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
1919
|
+
|
|
1920
|
+
### `sds.communities.getCommunityActivityLogs()`
|
|
1921
|
+
|
|
1922
|
+
Returns the activity logs for :community ordered by time descending.
|
|
1923
|
+
|
|
1924
|
+
- Route: `/communities_api/getCommunityActivityLogs/:community/:limit?/:offset?`
|
|
1925
|
+
- Result: JSON Object
|
|
1926
|
+
- Max. limit: 1000
|
|
1927
|
+
- Example: `/communities_api/getCommunityActivityLogs/hive-172186`
|
|
1928
|
+
|
|
1929
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1930
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1931
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
1932
|
+
| `limit` | int | no | `250` | 1 – 1000 | — |
|
|
1933
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1934
|
+
|
|
1935
|
+
### `sds.communities.getCommunityActivityLogsByType()`
|
|
1936
|
+
|
|
1937
|
+
Returns the activity logs of :type for :community ordered by time descending.
|
|
1938
|
+
|
|
1939
|
+
- Route: `/communities_api/getCommunityActivityLogsByType/:community/:type/:limit?/:offset?`
|
|
1940
|
+
- Result: JSON Object
|
|
1941
|
+
- Max. limit: 1000
|
|
1942
|
+
- Example: `/communities_api/getCommunityActivityLogsByType/hive-172186/setRole`
|
|
1943
|
+
|
|
1944
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1945
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1946
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
1947
|
+
| `type` | fixed_value | yes | — | — | subscribe | unsubscribe | setRole | setUserTitle | updateProps | pinPost | unpinPost | flagPost | … (10 values) |
|
|
1948
|
+
| `limit` | int | no | `250` | 1 – 1000 | — |
|
|
1949
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1950
|
+
|
|
1951
|
+
### `sds.communities.getCommunitiesByCreated()`
|
|
1952
|
+
|
|
1953
|
+
Returns a list of communities ordered by created time descending.
|
|
1954
|
+
|
|
1955
|
+
- Route: `/communities_api/getCommunitiesByCreated/:observer?/:limit?/:offset?`
|
|
1956
|
+
- Result: JSON Object
|
|
1957
|
+
- Max. limit: 1000
|
|
1958
|
+
- Example: `/communities_api/getCommunitiesByCreated`
|
|
1959
|
+
|
|
1960
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1961
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1962
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
1963
|
+
| `limit` | int | no | `250` | 1 – 1000 | — |
|
|
1964
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1965
|
+
|
|
1966
|
+
### `sds.communities.getCommunitiesByRank()`
|
|
1967
|
+
|
|
1968
|
+
Returns a list of communities ordered by rank ascending.
|
|
1969
|
+
|
|
1970
|
+
- Route: `/communities_api/getCommunitiesByRank/:observer?/:limit?/:offset?`
|
|
1971
|
+
- Result: JSON Object
|
|
1972
|
+
- Max. limit: 1000
|
|
1973
|
+
- Example: `/communities_api/getCommunitiesByRank`
|
|
1974
|
+
|
|
1975
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1976
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1977
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
1978
|
+
| `limit` | int | no | `250` | 1 – 1000 | — |
|
|
1979
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1980
|
+
|
|
1981
|
+
### `sds.communities.getCommunitiesByTotalPayout()`
|
|
1982
|
+
|
|
1983
|
+
Returns a list of communities ordered by total pending payout descending.
|
|
1984
|
+
|
|
1985
|
+
- Route: `/communities_api/getCommunitiesByTotalPayout/:observer?/:limit?/:offset?`
|
|
1986
|
+
- Result: JSON Object
|
|
1987
|
+
- Max. limit: 1000
|
|
1988
|
+
- Example: `/communities_api/getCommunitiesByTotalPayout`
|
|
1989
|
+
|
|
1990
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
1991
|
+
| --- | --- | --- | --- | --- | --- |
|
|
1992
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
1993
|
+
| `limit` | int | no | `250` | 1 – 1000 | — |
|
|
1994
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
1995
|
+
|
|
1996
|
+
### `sds.communities.getCommunitiesByCountActivePosts()`
|
|
1997
|
+
|
|
1998
|
+
Returns a list of communities ordered by number of active posts descending.
|
|
1999
|
+
|
|
2000
|
+
- Route: `/communities_api/getCommunitiesByCountActivePosts/:observer?/:limit?/:offset?`
|
|
2001
|
+
- Result: JSON Object
|
|
2002
|
+
- Max. limit: 1000
|
|
2003
|
+
- Example: `/communities_api/getCommunitiesByCountActivePosts`
|
|
2004
|
+
|
|
2005
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2006
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2007
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2008
|
+
| `limit` | int | no | `250` | 1 – 1000 | — |
|
|
2009
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2010
|
+
|
|
2011
|
+
### `sds.communities.getCommunitiesByCountActiveAuthors()`
|
|
2012
|
+
|
|
2013
|
+
Returns a list of communities ordered by number of active authors descending.
|
|
2014
|
+
|
|
2015
|
+
- Route: `/communities_api/getCommunitiesByCountActiveAuthors/:observer?/:limit?/:offset?`
|
|
2016
|
+
- Result: JSON Object
|
|
2017
|
+
- Max. limit: 1000
|
|
2018
|
+
- Example: `/communities_api/getCommunitiesByCountActiveAuthors`
|
|
2019
|
+
|
|
2020
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2021
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2022
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2023
|
+
| `limit` | int | no | `250` | 1 – 1000 | — |
|
|
2024
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2025
|
+
|
|
2026
|
+
### `sds.communities.getCommunitiesByCountSubscribers()`
|
|
2027
|
+
|
|
2028
|
+
Returns a list of communities ordered by number of subscribers descending.
|
|
2029
|
+
|
|
2030
|
+
- Route: `/communities_api/getCommunitiesByCountSubscribers/:observer?/:limit?/:offset?`
|
|
2031
|
+
- Result: JSON Object
|
|
2032
|
+
- Max. limit: 1000
|
|
2033
|
+
- Example: `/communities_api/getCommunitiesByCountSubscribers`
|
|
2034
|
+
|
|
2035
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2036
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2037
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2038
|
+
| `limit` | int | no | `250` | 1 – 1000 | — |
|
|
2039
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2040
|
+
|
|
2041
|
+
### `sds.communities.getCommunitiesBySubscriber()`
|
|
2042
|
+
|
|
2043
|
+
Returns a list of communities that :subscriber subscribed to, ordered by title ascending.
|
|
2044
|
+
|
|
2045
|
+
- Route: `/communities_api/getCommunitiesBySubscriber/:subscriber/:observer?/:limit?/:offset?`
|
|
2046
|
+
- Result: JSON Object
|
|
2047
|
+
- Max. limit: 1000
|
|
2048
|
+
- Example: `/communities_api/getCommunitiesBySubscriber/steemchiller`
|
|
2049
|
+
|
|
2050
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2051
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2052
|
+
| `subscriber` | account_name | yes | — | — | — |
|
|
2053
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2054
|
+
| `limit` | int | no | `250` | 1 – 1000 | — |
|
|
2055
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2056
|
+
|
|
2057
|
+
---
|
|
2058
|
+
|
|
2059
|
+
## `content_history_api`
|
|
2060
|
+
|
|
2061
|
+
Namespace: `sds.contentHistory` · Group: Posts · 2 methods
|
|
2062
|
+
|
|
2063
|
+
### `sds.contentHistory.getConfig()`
|
|
2064
|
+
|
|
2065
|
+
Returns this module's active configuration.
|
|
2066
|
+
|
|
2067
|
+
- Route: `/content_history_api/getConfig`
|
|
2068
|
+
- Result: JSON Object
|
|
2069
|
+
- Example: `/content_history_api/getConfig`
|
|
2070
|
+
|
|
2071
|
+
_No parameters._
|
|
2072
|
+
|
|
2073
|
+
### `sds.contentHistory.getContentHistory()`
|
|
2074
|
+
|
|
2075
|
+
Returns the content history for :author / :permlink.
|
|
2076
|
+
|
|
2077
|
+
- Route: `/content_history_api/getContentHistory/:author/:permlink`
|
|
2078
|
+
- Result: JSON Object
|
|
2079
|
+
- Example: `/content_history_api/getContentHistory/steemit/firstpost`
|
|
2080
|
+
|
|
2081
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2082
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2083
|
+
| `author` | account_name | yes | — | — | — |
|
|
2084
|
+
| `permlink` | string | yes | — | — | — |
|
|
2085
|
+
|
|
2086
|
+
---
|
|
2087
|
+
|
|
2088
|
+
## `content_search_api`
|
|
2089
|
+
|
|
2090
|
+
Namespace: `sds.contentSearch` · Group: Posts · 21 methods
|
|
2091
|
+
|
|
2092
|
+
### `sds.contentSearch.getConfig()`
|
|
2093
|
+
|
|
2094
|
+
Returns this module's active configuration.
|
|
2095
|
+
|
|
2096
|
+
- Route: `/content_search_api/getConfig`
|
|
2097
|
+
- Result: JSON Object
|
|
2098
|
+
- Example: `/content_search_api/getConfig`
|
|
2099
|
+
|
|
2100
|
+
_No parameters._
|
|
2101
|
+
|
|
2102
|
+
### `sds.contentSearch.getPostsByText()`
|
|
2103
|
+
|
|
2104
|
+
Returns a feed list with posts that contain :searchText in :searchIn.
|
|
2105
|
+
|
|
2106
|
+
- Route: `/content_search_api/getPostsByText/:searchText/:searchIn?/:observer?/:bodyLength?/:orderBy?/:orderDir?/:limit?/:offset?`
|
|
2107
|
+
- Result: JSON Object
|
|
2108
|
+
- Max. limit: 1000
|
|
2109
|
+
- Example: `/content_search_api/getPostsByText/search`
|
|
2110
|
+
|
|
2111
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2112
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2113
|
+
| `searchText` | string | yes | — | — | — |
|
|
2114
|
+
| `searchIn` | fixed_value | no | `any` | — | body | title | any |
|
|
2115
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2116
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2117
|
+
| `orderBy` | fixed_value | no | `time` | — | time |
|
|
2118
|
+
| `orderDir` | fixed_value | no | `DESC` | — | ASC | DESC |
|
|
2119
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2120
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2121
|
+
|
|
2122
|
+
### `sds.contentSearch.getPostsByTagsText()`
|
|
2123
|
+
|
|
2124
|
+
Returns a feed list with posts that contain :searchTags in tags and :searchText in :searchIn.
|
|
2125
|
+
|
|
2126
|
+
- Route: `/content_search_api/getPostsByTagsText/:searchTags/:searchText/:searchIn?/:observer?/:bodyLength?/:orderBy?/:orderDir?/:limit?/:offset?`
|
|
2127
|
+
- Result: JSON Object
|
|
2128
|
+
- Max. limit: 1000
|
|
2129
|
+
- Example: `/content_search_api/getPostsByTagsText/steem/search`
|
|
2130
|
+
|
|
2131
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2132
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2133
|
+
| `searchTags` | string | yes | — | — | — |
|
|
2134
|
+
| `searchText` | string | yes | — | — | — |
|
|
2135
|
+
| `searchIn` | fixed_value | no | `any` | — | body | title | any |
|
|
2136
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2137
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2138
|
+
| `orderBy` | fixed_value | no | `time` | — | time |
|
|
2139
|
+
| `orderDir` | fixed_value | no | `DESC` | — | ASC | DESC |
|
|
2140
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2141
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2142
|
+
|
|
2143
|
+
### `sds.contentSearch.getPostsByTimeTagsText()`
|
|
2144
|
+
|
|
2145
|
+
Returns a feed list with posts in the given time range that contain :searchTags in tags and :searchText in :searchIn.
|
|
2146
|
+
**Ranges**: [ { "from": "fromTime", "to": "toTime" } ]
|
|
2147
|
+
|
|
2148
|
+
- Route: `/content_search_api/getPostsByTimeTagsText/:fromTime-:toTime/:searchTags/:searchText/:searchIn?/:observer?/:bodyLength?/:orderBy?/:orderDir?/:limit?/:offset?`
|
|
2149
|
+
- Result: JSON Object
|
|
2150
|
+
- Max. limit: 1000
|
|
2151
|
+
- Example: `/content_search_api/getPostsByTimeTagsText/1496948307-1596948307/steem/search`
|
|
2152
|
+
|
|
2153
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2154
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2155
|
+
| `fromTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
2156
|
+
| `toTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
2157
|
+
| `searchTags` | string | yes | — | — | — |
|
|
2158
|
+
| `searchText` | string | yes | — | — | — |
|
|
2159
|
+
| `searchIn` | fixed_value | no | `any` | — | body | title | any |
|
|
2160
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2161
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2162
|
+
| `orderBy` | fixed_value | no | `time` | — | time |
|
|
2163
|
+
| `orderDir` | fixed_value | no | `DESC` | — | ASC | DESC |
|
|
2164
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2165
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2166
|
+
|
|
2167
|
+
### `sds.contentSearch.getPostsByAuthorText()`
|
|
2168
|
+
|
|
2169
|
+
Returns a feed list with :author's posts that contain :searchText in :searchIn.
|
|
2170
|
+
|
|
2171
|
+
- Route: `/content_search_api/getPostsByAuthorText/:author/:searchText/:searchIn?/:observer?/:bodyLength?/:orderBy?/:orderDir?/:limit?/:offset?`
|
|
2172
|
+
- Result: JSON Object
|
|
2173
|
+
- Max. limit: 1000
|
|
2174
|
+
- Example: `/content_search_api/getPostsByAuthorText/author/search`
|
|
2175
|
+
|
|
2176
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2177
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2178
|
+
| `author` | account_name | yes | — | — | — |
|
|
2179
|
+
| `searchText` | string | yes | — | — | — |
|
|
2180
|
+
| `searchIn` | fixed_value | no | `any` | — | body | title | any |
|
|
2181
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2182
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2183
|
+
| `orderBy` | fixed_value | no | `time` | — | time |
|
|
2184
|
+
| `orderDir` | fixed_value | no | `DESC` | — | ASC | DESC |
|
|
2185
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2186
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2187
|
+
|
|
2188
|
+
### `sds.contentSearch.getPostsByAuthorTagsText()`
|
|
2189
|
+
|
|
2190
|
+
Returns a feed list with :author's posts that contain :searchTags in tags and :searchText in :searchIn.
|
|
2191
|
+
|
|
2192
|
+
- Route: `/content_search_api/getPostsByAuthorTagsText/:author/:searchTags/:searchText/:searchIn?/:observer?/:bodyLength?/:orderBy?/:orderDir?/:limit?/:offset?`
|
|
2193
|
+
- Result: JSON Object
|
|
2194
|
+
- Max. limit: 1000
|
|
2195
|
+
- Example: `/content_search_api/getPostsByAuthorTagsText/author/steem/search`
|
|
2196
|
+
|
|
2197
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2198
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2199
|
+
| `author` | account_name | yes | — | — | — |
|
|
2200
|
+
| `searchTags` | string | yes | — | — | — |
|
|
2201
|
+
| `searchText` | string | yes | — | — | — |
|
|
2202
|
+
| `searchIn` | fixed_value | no | `any` | — | body | title | any |
|
|
2203
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2204
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2205
|
+
| `orderBy` | fixed_value | no | `time` | — | time |
|
|
2206
|
+
| `orderDir` | fixed_value | no | `DESC` | — | ASC | DESC |
|
|
2207
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2208
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2209
|
+
|
|
2210
|
+
### `sds.contentSearch.getPostsByAuthorTimeTagsText()`
|
|
2211
|
+
|
|
2212
|
+
Returns a feed list with :author's posts in the given time range that contain :searchTags in tags and :searchText in :searchIn.
|
|
2213
|
+
**Ranges**: [ { "from": "fromTime", "to": "toTime" } ]
|
|
2214
|
+
|
|
2215
|
+
- Route: `/content_search_api/getPostsByAuthorTimeTagsText/:author/:fromTime-:toTime/:searchTags/:searchText/:searchIn?/:observer?/:bodyLength?/:orderBy?/:orderDir?/:limit?/:offset?`
|
|
2216
|
+
- Result: JSON Object
|
|
2217
|
+
- Max. limit: 1000
|
|
2218
|
+
- Example: `/content_search_api/getPostsByAuthorTimeTagsText/author/1496948307-1596948307/steem/search`
|
|
2219
|
+
|
|
2220
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2221
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2222
|
+
| `author` | account_name | yes | — | — | — |
|
|
2223
|
+
| `fromTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
2224
|
+
| `toTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
2225
|
+
| `searchTags` | string | yes | — | — | — |
|
|
2226
|
+
| `searchText` | string | yes | — | — | — |
|
|
2227
|
+
| `searchIn` | fixed_value | no | `any` | — | body | title | any |
|
|
2228
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2229
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2230
|
+
| `orderBy` | fixed_value | no | `time` | — | time |
|
|
2231
|
+
| `orderDir` | fixed_value | no | `DESC` | — | ASC | DESC |
|
|
2232
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2233
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2234
|
+
|
|
2235
|
+
### `sds.contentSearch.getActivePostsByText()`
|
|
2236
|
+
|
|
2237
|
+
Returns a feed list with active posts that contain :searchText in :searchIn.
|
|
2238
|
+
|
|
2239
|
+
- Route: `/content_search_api/getActivePostsByText/:searchText/:searchIn?/:observer?/:bodyLength?/:orderBy?/:orderDir?/:limit?/:offset?`
|
|
2240
|
+
- Result: JSON Object
|
|
2241
|
+
- Max. limit: 1000
|
|
2242
|
+
- Example: `/content_search_api/getActivePostsByText/search`
|
|
2243
|
+
|
|
2244
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2245
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2246
|
+
| `searchText` | string | yes | — | — | — |
|
|
2247
|
+
| `searchIn` | fixed_value | no | `any` | — | body | title | any |
|
|
2248
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2249
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2250
|
+
| `orderBy` | fixed_value | no | `time` | — | time |
|
|
2251
|
+
| `orderDir` | fixed_value | no | `DESC` | — | ASC | DESC |
|
|
2252
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2253
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2254
|
+
|
|
2255
|
+
### `sds.contentSearch.getActivePostsByTagsText()`
|
|
2256
|
+
|
|
2257
|
+
Returns a feed list with active posts that contain :searchTags in tags and :searchText in :searchIn.
|
|
2258
|
+
|
|
2259
|
+
- Route: `/content_search_api/getActivePostsByTagsText/:searchTags/:searchText/:searchIn?/:observer?/:bodyLength?/:orderBy?/:orderDir?/:limit?/:offset?`
|
|
2260
|
+
- Result: JSON Object
|
|
2261
|
+
- Max. limit: 1000
|
|
2262
|
+
- Example: `/content_search_api/getActivePostsByTagsText/steem/search`
|
|
2263
|
+
|
|
2264
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2265
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2266
|
+
| `searchTags` | string | yes | — | — | — |
|
|
2267
|
+
| `searchText` | string | yes | — | — | — |
|
|
2268
|
+
| `searchIn` | fixed_value | no | `any` | — | body | title | any |
|
|
2269
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2270
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2271
|
+
| `orderBy` | fixed_value | no | `time` | — | time |
|
|
2272
|
+
| `orderDir` | fixed_value | no | `DESC` | — | ASC | DESC |
|
|
2273
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2274
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2275
|
+
|
|
2276
|
+
### `sds.contentSearch.getActivePostsByAuthorText()`
|
|
2277
|
+
|
|
2278
|
+
Returns a feed list with :author's active posts that contain :searchText in :searchIn.
|
|
2279
|
+
|
|
2280
|
+
- Route: `/content_search_api/getActivePostsByAuthorText/:author/:searchText/:searchIn?/:observer?/:bodyLength?/:orderBy?/:orderDir?/:limit?/:offset?`
|
|
2281
|
+
- Result: JSON Object
|
|
2282
|
+
- Max. limit: 1000
|
|
2283
|
+
- Example: `/content_search_api/getActivePostsByAuthorText/author/search`
|
|
2284
|
+
|
|
2285
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2286
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2287
|
+
| `author` | account_name | yes | — | — | — |
|
|
2288
|
+
| `searchText` | string | yes | — | — | — |
|
|
2289
|
+
| `searchIn` | fixed_value | no | `any` | — | body | title | any |
|
|
2290
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2291
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2292
|
+
| `orderBy` | fixed_value | no | `time` | — | time |
|
|
2293
|
+
| `orderDir` | fixed_value | no | `DESC` | — | ASC | DESC |
|
|
2294
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2295
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2296
|
+
|
|
2297
|
+
### `sds.contentSearch.getActivePostsByAuthorTagsText()`
|
|
2298
|
+
|
|
2299
|
+
Returns a feed list with :author's active posts that contain :searchTags in tags and :searchText in :searchIn.
|
|
2300
|
+
|
|
2301
|
+
- Route: `/content_search_api/getActivePostsByAuthorTagsText/:author/:searchTags/:searchText/:searchIn?/:observer?/:bodyLength?/:orderBy?/:orderDir?/:limit?/:offset?`
|
|
2302
|
+
- Result: JSON Object
|
|
2303
|
+
- Max. limit: 1000
|
|
2304
|
+
- Example: `/content_search_api/getActivePostsByAuthorTagsText/author/steem/search`
|
|
2305
|
+
|
|
2306
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2307
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2308
|
+
| `author` | account_name | yes | — | — | — |
|
|
2309
|
+
| `searchTags` | string | yes | — | — | — |
|
|
2310
|
+
| `searchText` | string | yes | — | — | — |
|
|
2311
|
+
| `searchIn` | fixed_value | no | `any` | — | body | title | any |
|
|
2312
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2313
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2314
|
+
| `orderBy` | fixed_value | no | `time` | — | time |
|
|
2315
|
+
| `orderDir` | fixed_value | no | `DESC` | — | ASC | DESC |
|
|
2316
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2317
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2318
|
+
|
|
2319
|
+
### `sds.contentSearch.getCommentsByText()`
|
|
2320
|
+
|
|
2321
|
+
Returns a feed list with comments that contain :searchText in :searchIn.
|
|
2322
|
+
|
|
2323
|
+
- Route: `/content_search_api/getCommentsByText/:searchText/:searchIn?/:observer?/:bodyLength?/:orderBy?/:orderDir?/:limit?/:offset?`
|
|
2324
|
+
- Result: JSON Object
|
|
2325
|
+
- Max. limit: 1000
|
|
2326
|
+
- Example: `/content_search_api/getCommentsByText/search`
|
|
2327
|
+
|
|
2328
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2329
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2330
|
+
| `searchText` | string | yes | — | — | — |
|
|
2331
|
+
| `searchIn` | fixed_value | no | `any` | — | body | title | any |
|
|
2332
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2333
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2334
|
+
| `orderBy` | fixed_value | no | `time` | — | time |
|
|
2335
|
+
| `orderDir` | fixed_value | no | `DESC` | — | ASC | DESC |
|
|
2336
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2337
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2338
|
+
|
|
2339
|
+
### `sds.contentSearch.getCommentsByTagsText()`
|
|
2340
|
+
|
|
2341
|
+
Returns a feed list with comments that contain :searchTags in tags and :searchText in :searchIn.
|
|
2342
|
+
|
|
2343
|
+
- Route: `/content_search_api/getCommentsByTagsText/:searchTags/:searchText/:searchIn?/:observer?/:bodyLength?/:orderBy?/:orderDir?/:limit?/:offset?`
|
|
2344
|
+
- Result: JSON Object
|
|
2345
|
+
- Max. limit: 1000
|
|
2346
|
+
- Example: `/content_search_api/getCommentsByTagsText/steem/search`
|
|
2347
|
+
|
|
2348
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2349
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2350
|
+
| `searchTags` | string | yes | — | — | — |
|
|
2351
|
+
| `searchText` | string | yes | — | — | — |
|
|
2352
|
+
| `searchIn` | fixed_value | no | `any` | — | body | title | any |
|
|
2353
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2354
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2355
|
+
| `orderBy` | fixed_value | no | `time` | — | time |
|
|
2356
|
+
| `orderDir` | fixed_value | no | `DESC` | — | ASC | DESC |
|
|
2357
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2358
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2359
|
+
|
|
2360
|
+
### `sds.contentSearch.getCommentsByTimeTagsText()`
|
|
2361
|
+
|
|
2362
|
+
Returns a feed list with comments in the given time range that contain :searchTags in tags and :searchText in :searchIn.
|
|
2363
|
+
**Ranges**: [ { "from": "fromTime", "to": "toTime" } ]
|
|
2364
|
+
|
|
2365
|
+
- Route: `/content_search_api/getCommentsByTimeTagsText/:fromTime-:toTime/:searchTags/:searchText/:searchIn?/:observer?/:bodyLength?/:orderBy?/:orderDir?/:limit?/:offset?`
|
|
2366
|
+
- Result: JSON Object
|
|
2367
|
+
- Max. limit: 1000
|
|
2368
|
+
- Example: `/content_search_api/getCommentsByTimeTagsText/1496948307-1596948307/steem/search`
|
|
2369
|
+
|
|
2370
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2371
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2372
|
+
| `fromTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
2373
|
+
| `toTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
2374
|
+
| `searchTags` | string | yes | — | — | — |
|
|
2375
|
+
| `searchText` | string | yes | — | — | — |
|
|
2376
|
+
| `searchIn` | fixed_value | no | `any` | — | body | title | any |
|
|
2377
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2378
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2379
|
+
| `orderBy` | fixed_value | no | `time` | — | time |
|
|
2380
|
+
| `orderDir` | fixed_value | no | `DESC` | — | ASC | DESC |
|
|
2381
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2382
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2383
|
+
|
|
2384
|
+
### `sds.contentSearch.getCommentsByAuthorText()`
|
|
2385
|
+
|
|
2386
|
+
Returns a feed list with :author's comments that contain :searchText in :searchIn.
|
|
2387
|
+
|
|
2388
|
+
- Route: `/content_search_api/getCommentsByAuthorText/:author/:searchText/:searchIn?/:observer?/:bodyLength?/:orderBy?/:orderDir?/:limit?/:offset?`
|
|
2389
|
+
- Result: JSON Object
|
|
2390
|
+
- Max. limit: 1000
|
|
2391
|
+
- Example: `/content_search_api/getCommentsByAuthorText/author/search`
|
|
2392
|
+
|
|
2393
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2394
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2395
|
+
| `author` | account_name | yes | — | — | — |
|
|
2396
|
+
| `searchText` | string | yes | — | — | — |
|
|
2397
|
+
| `searchIn` | fixed_value | no | `any` | — | body | title | any |
|
|
2398
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2399
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2400
|
+
| `orderBy` | fixed_value | no | `time` | — | time |
|
|
2401
|
+
| `orderDir` | fixed_value | no | `DESC` | — | ASC | DESC |
|
|
2402
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2403
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2404
|
+
|
|
2405
|
+
### `sds.contentSearch.getCommentsByAuthorTagsText()`
|
|
2406
|
+
|
|
2407
|
+
Returns a feed list with :author's comments that contain :searchTags in tags and :searchText in :searchIn.
|
|
2408
|
+
|
|
2409
|
+
- Route: `/content_search_api/getCommentsByAuthorTagsText/:author/:searchTags/:searchText/:searchIn?/:observer?/:bodyLength?/:orderBy?/:orderDir?/:limit?/:offset?`
|
|
2410
|
+
- Result: JSON Object
|
|
2411
|
+
- Max. limit: 1000
|
|
2412
|
+
- Example: `/content_search_api/getCommentsByAuthorTagsText/author/steem/search`
|
|
2413
|
+
|
|
2414
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2415
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2416
|
+
| `author` | account_name | yes | — | — | — |
|
|
2417
|
+
| `searchTags` | string | yes | — | — | — |
|
|
2418
|
+
| `searchText` | string | yes | — | — | — |
|
|
2419
|
+
| `searchIn` | fixed_value | no | `any` | — | body | title | any |
|
|
2420
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2421
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2422
|
+
| `orderBy` | fixed_value | no | `time` | — | time |
|
|
2423
|
+
| `orderDir` | fixed_value | no | `DESC` | — | ASC | DESC |
|
|
2424
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2425
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2426
|
+
|
|
2427
|
+
### `sds.contentSearch.getCommentsByAuthorTimeTagsText()`
|
|
2428
|
+
|
|
2429
|
+
Returns a feed list with :author's comments in the given time range that contain :searchTags in tags and :searchText in :searchIn.
|
|
2430
|
+
**Ranges**: [ { "from": "fromTime", "to": "toTime" } ]
|
|
2431
|
+
|
|
2432
|
+
- Route: `/content_search_api/getCommentsByAuthorTimeTagsText/:author/:fromTime-:toTime/:searchTags/:searchText/:searchIn?/:observer?/:bodyLength?/:orderBy?/:orderDir?/:limit?/:offset?`
|
|
2433
|
+
- Result: JSON Object
|
|
2434
|
+
- Max. limit: 1000
|
|
2435
|
+
- Example: `/content_search_api/getCommentsByAuthorTimeTagsText/author/1496948307-1596948307/steem/search`
|
|
2436
|
+
|
|
2437
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2438
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2439
|
+
| `author` | account_name | yes | — | — | — |
|
|
2440
|
+
| `fromTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
2441
|
+
| `toTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
2442
|
+
| `searchTags` | string | yes | — | — | — |
|
|
2443
|
+
| `searchText` | string | yes | — | — | — |
|
|
2444
|
+
| `searchIn` | fixed_value | no | `any` | — | body | title | any |
|
|
2445
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2446
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2447
|
+
| `orderBy` | fixed_value | no | `time` | — | time |
|
|
2448
|
+
| `orderDir` | fixed_value | no | `DESC` | — | ASC | DESC |
|
|
2449
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2450
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2451
|
+
|
|
2452
|
+
### `sds.contentSearch.getActiveCommentsByText()`
|
|
2453
|
+
|
|
2454
|
+
Returns a feed list with active comments that contain :searchText in :searchIn.
|
|
2455
|
+
|
|
2456
|
+
- Route: `/content_search_api/getActiveCommentsByText/:searchText/:searchIn?/:observer?/:bodyLength?/:orderBy?/:orderDir?/:limit?/:offset?`
|
|
2457
|
+
- Result: JSON Object
|
|
2458
|
+
- Max. limit: 1000
|
|
2459
|
+
- Example: `/content_search_api/getActiveCommentsByText/search`
|
|
2460
|
+
|
|
2461
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2462
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2463
|
+
| `searchText` | string | yes | — | — | — |
|
|
2464
|
+
| `searchIn` | fixed_value | no | `any` | — | body | title | any |
|
|
2465
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2466
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2467
|
+
| `orderBy` | fixed_value | no | `time` | — | time |
|
|
2468
|
+
| `orderDir` | fixed_value | no | `DESC` | — | ASC | DESC |
|
|
2469
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2470
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2471
|
+
|
|
2472
|
+
### `sds.contentSearch.getActiveCommentsByTagsText()`
|
|
2473
|
+
|
|
2474
|
+
Returns a feed list with active comments that contain :searchTags in tags and :searchText in :searchIn.
|
|
2475
|
+
|
|
2476
|
+
- Route: `/content_search_api/getActiveCommentsByTagsText/:searchTags/:searchText/:searchIn?/:observer?/:bodyLength?/:orderBy?/:orderDir?/:limit?/:offset?`
|
|
2477
|
+
- Result: JSON Object
|
|
2478
|
+
- Max. limit: 1000
|
|
2479
|
+
- Example: `/content_search_api/getActiveCommentsByTagsText/steem/search`
|
|
2480
|
+
|
|
2481
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2482
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2483
|
+
| `searchTags` | string | yes | — | — | — |
|
|
2484
|
+
| `searchText` | string | yes | — | — | — |
|
|
2485
|
+
| `searchIn` | fixed_value | no | `any` | — | body | title | any |
|
|
2486
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2487
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2488
|
+
| `orderBy` | fixed_value | no | `time` | — | time |
|
|
2489
|
+
| `orderDir` | fixed_value | no | `DESC` | — | ASC | DESC |
|
|
2490
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2491
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2492
|
+
|
|
2493
|
+
### `sds.contentSearch.getActiveCommentsByAuthorText()`
|
|
2494
|
+
|
|
2495
|
+
Returns a feed list with :author's active comments that contain :searchText in :searchIn.
|
|
2496
|
+
|
|
2497
|
+
- Route: `/content_search_api/getActiveCommentsByAuthorText/:author/:searchText/:searchIn?/:observer?/:bodyLength?/:orderBy?/:orderDir?/:limit?/:offset?`
|
|
2498
|
+
- Result: JSON Object
|
|
2499
|
+
- Max. limit: 1000
|
|
2500
|
+
- Example: `/content_search_api/getActiveCommentsByAuthorText/author/search`
|
|
2501
|
+
|
|
2502
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2503
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2504
|
+
| `author` | account_name | yes | — | — | — |
|
|
2505
|
+
| `searchText` | string | yes | — | — | — |
|
|
2506
|
+
| `searchIn` | fixed_value | no | `any` | — | body | title | any |
|
|
2507
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2508
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2509
|
+
| `orderBy` | fixed_value | no | `time` | — | time |
|
|
2510
|
+
| `orderDir` | fixed_value | no | `DESC` | — | ASC | DESC |
|
|
2511
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2512
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2513
|
+
|
|
2514
|
+
### `sds.contentSearch.getActiveCommentsByAuthorTagsText()`
|
|
2515
|
+
|
|
2516
|
+
Returns a feed list with :author's active comments that contain :searchTags in tags and :searchText in :searchIn.
|
|
2517
|
+
|
|
2518
|
+
- Route: `/content_search_api/getActiveCommentsByAuthorTagsText/:author/:searchTags/:searchText/:searchIn?/:observer?/:bodyLength?/:orderBy?/:orderDir?/:limit?/:offset?`
|
|
2519
|
+
- Result: JSON Object
|
|
2520
|
+
- Max. limit: 1000
|
|
2521
|
+
- Example: `/content_search_api/getActiveCommentsByAuthorTagsText/author/steem/search`
|
|
2522
|
+
|
|
2523
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2524
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2525
|
+
| `author` | account_name | yes | — | — | — |
|
|
2526
|
+
| `searchTags` | string | yes | — | — | — |
|
|
2527
|
+
| `searchText` | string | yes | — | — | — |
|
|
2528
|
+
| `searchIn` | fixed_value | no | `any` | — | body | title | any |
|
|
2529
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2530
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2531
|
+
| `orderBy` | fixed_value | no | `time` | — | time |
|
|
2532
|
+
| `orderDir` | fixed_value | no | `DESC` | — | ASC | DESC |
|
|
2533
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2534
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2535
|
+
|
|
2536
|
+
---
|
|
2537
|
+
|
|
2538
|
+
## `feeds_api`
|
|
2539
|
+
|
|
2540
|
+
Namespace: `sds.feeds` · Group: Posts · 83 methods
|
|
2541
|
+
|
|
2542
|
+
### `sds.feeds.getConfig()`
|
|
2543
|
+
|
|
2544
|
+
Returns this module's active configuration.
|
|
2545
|
+
|
|
2546
|
+
- Route: `/feeds_api/getConfig`
|
|
2547
|
+
- Result: JSON Object
|
|
2548
|
+
- Example: `/feeds_api/getConfig`
|
|
2549
|
+
|
|
2550
|
+
_No parameters._
|
|
2551
|
+
|
|
2552
|
+
### `sds.feeds.getAccountBlog()`
|
|
2553
|
+
|
|
2554
|
+
Returns a feed list with :account's own (non-community) and resteemed posts ordered by time descending.
|
|
2555
|
+
|
|
2556
|
+
- Route: `/feeds_api/getAccountBlog/:account/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2557
|
+
- Result: JSON Object
|
|
2558
|
+
- Max. limit: 1000
|
|
2559
|
+
- Example: `/feeds_api/getAccountBlog/steemchiller`
|
|
2560
|
+
|
|
2561
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2562
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2563
|
+
| `account` | account_name | yes | — | — | — |
|
|
2564
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2565
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2566
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2567
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2568
|
+
|
|
2569
|
+
### `sds.feeds.getAccountFriendsFeed()`
|
|
2570
|
+
|
|
2571
|
+
Returns a feed list with posts by :account's followed accounts and their resteemed posts ordered by time descending.
|
|
2572
|
+
|
|
2573
|
+
- Route: `/feeds_api/getAccountFriendsFeed/:account/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2574
|
+
- Result: JSON Object
|
|
2575
|
+
- Max. limit: 1000
|
|
2576
|
+
- Example: `/feeds_api/getAccountFriendsFeed/steemchiller`
|
|
2577
|
+
|
|
2578
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2579
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2580
|
+
| `account` | account_name | yes | — | — | — |
|
|
2581
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2582
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2583
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2584
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2585
|
+
|
|
2586
|
+
### `sds.feeds.getAccountCommunitiesFeedByCreated()`
|
|
2587
|
+
|
|
2588
|
+
Returns a feed list with posts from :account's subscribed communities ordered by created time descending.
|
|
2589
|
+
|
|
2590
|
+
- Route: `/feeds_api/getAccountCommunitiesFeedByCreated/:account/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2591
|
+
- Result: JSON Object
|
|
2592
|
+
- Max. limit: 1000
|
|
2593
|
+
- Example: `/feeds_api/getAccountCommunitiesFeedByCreated/steemitblog`
|
|
2594
|
+
|
|
2595
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2596
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2597
|
+
| `account` | account_name | yes | — | — | — |
|
|
2598
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2599
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2600
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2601
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2602
|
+
|
|
2603
|
+
### `sds.feeds.getAccountCommunitiesFeedByTrending()`
|
|
2604
|
+
|
|
2605
|
+
Returns a feed list with posts from :account's subscribed communities ordered by trending score descending.
|
|
2606
|
+
|
|
2607
|
+
- Route: `/feeds_api/getAccountCommunitiesFeedByTrending/:account/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2608
|
+
- Result: JSON Object
|
|
2609
|
+
- Max. limit: 1000
|
|
2610
|
+
- Example: `/feeds_api/getAccountCommunitiesFeedByTrending/steemitblog`
|
|
2611
|
+
|
|
2612
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2613
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2614
|
+
| `account` | account_name | yes | — | — | — |
|
|
2615
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2616
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2617
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2618
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2619
|
+
|
|
2620
|
+
### `sds.feeds.getAccountCommunitiesFeedByTrendingWithoutWhales()`
|
|
2621
|
+
|
|
2622
|
+
Returns a feed list with posts from :account's subscribed communities ordered by trending score (calculated without whale votes) descending.
|
|
2623
|
+
|
|
2624
|
+
- Route: `/feeds_api/getAccountCommunitiesFeedByTrendingWithoutWhales/:account/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2625
|
+
- Result: JSON Object
|
|
2626
|
+
- Max. limit: 1000
|
|
2627
|
+
- Example: `/feeds_api/getAccountCommunitiesFeedByTrendingWithoutWhales/steemitblog`
|
|
2628
|
+
|
|
2629
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2630
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2631
|
+
| `account` | account_name | yes | — | — | — |
|
|
2632
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2633
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2634
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2635
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2636
|
+
|
|
2637
|
+
### `sds.feeds.getAccountCommunitiesFeedByHot()`
|
|
2638
|
+
|
|
2639
|
+
Returns a feed list with posts from :account's subscribed communities ordered by hot score descending.
|
|
2640
|
+
|
|
2641
|
+
- Route: `/feeds_api/getAccountCommunitiesFeedByHot/:account/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2642
|
+
- Result: JSON Object
|
|
2643
|
+
- Max. limit: 1000
|
|
2644
|
+
- Example: `/feeds_api/getAccountCommunitiesFeedByHot/steemitblog`
|
|
2645
|
+
|
|
2646
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2647
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2648
|
+
| `account` | account_name | yes | — | — | — |
|
|
2649
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2650
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2651
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2652
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2653
|
+
|
|
2654
|
+
### `sds.feeds.getAccountCommunitiesFeedByHotWithoutWhales()`
|
|
2655
|
+
|
|
2656
|
+
Returns a feed list with posts from :account's subscribed communities ordered by hot score (calculated without whale votes) descending.
|
|
2657
|
+
|
|
2658
|
+
- Route: `/feeds_api/getAccountCommunitiesFeedByHotWithoutWhales/:account/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2659
|
+
- Result: JSON Object
|
|
2660
|
+
- Max. limit: 1000
|
|
2661
|
+
- Example: `/feeds_api/getAccountCommunitiesFeedByHotWithoutWhales/steemitblog`
|
|
2662
|
+
|
|
2663
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2664
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2665
|
+
| `account` | account_name | yes | — | — | — |
|
|
2666
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2667
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2668
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2669
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2670
|
+
|
|
2671
|
+
### `sds.feeds.getAccountCommunitiesFeedByInteraction()`
|
|
2672
|
+
|
|
2673
|
+
Returns a feed list with posts from :account's subscribed communities ordered by interaction score descending.
|
|
2674
|
+
|
|
2675
|
+
- Route: `/feeds_api/getAccountCommunitiesFeedByInteraction/:account/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2676
|
+
- Result: JSON Object
|
|
2677
|
+
- Max. limit: 1000
|
|
2678
|
+
- Example: `/feeds_api/getAccountCommunitiesFeedByInteraction/steemitblog`
|
|
2679
|
+
|
|
2680
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2681
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2682
|
+
| `account` | account_name | yes | — | — | — |
|
|
2683
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2684
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2685
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2686
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2687
|
+
|
|
2688
|
+
### `sds.feeds.getAccountCommunitiesFeedByPayout()`
|
|
2689
|
+
|
|
2690
|
+
Returns a feed list with posts from :account's subscribed communities ordered by payout descending.
|
|
2691
|
+
|
|
2692
|
+
- Route: `/feeds_api/getAccountCommunitiesFeedByPayout/:account/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2693
|
+
- Result: JSON Object
|
|
2694
|
+
- Max. limit: 1000
|
|
2695
|
+
- Example: `/feeds_api/getAccountCommunitiesFeedByPayout/steemitblog`
|
|
2696
|
+
|
|
2697
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2698
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2699
|
+
| `account` | account_name | yes | — | — | — |
|
|
2700
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2701
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2702
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2703
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2704
|
+
|
|
2705
|
+
### `sds.feeds.getAccountCommunitiesFeedByCommentsPayout()`
|
|
2706
|
+
|
|
2707
|
+
Returns a feed list with posts from :account's subscribed communities ordered by comments payout descending.
|
|
2708
|
+
|
|
2709
|
+
- Route: `/feeds_api/getAccountCommunitiesFeedByCommentsPayout/:account/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2710
|
+
- Result: JSON Object
|
|
2711
|
+
- Max. limit: 1000
|
|
2712
|
+
- Example: `/feeds_api/getAccountCommunitiesFeedByCommentsPayout/steemitblog`
|
|
2713
|
+
|
|
2714
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2715
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2716
|
+
| `account` | account_name | yes | — | — | — |
|
|
2717
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2718
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2719
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2720
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2721
|
+
|
|
2722
|
+
### `sds.feeds.getPostsByAuthor()`
|
|
2723
|
+
|
|
2724
|
+
Returns a feed list with :author's posts ordered by created time descending.
|
|
2725
|
+
|
|
2726
|
+
- Route: `/feeds_api/getPostsByAuthor/:author/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2727
|
+
- Result: JSON Object
|
|
2728
|
+
- Max. limit: 1000
|
|
2729
|
+
- Example: `/feeds_api/getPostsByAuthor/steemitblog`
|
|
2730
|
+
|
|
2731
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2732
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2733
|
+
| `author` | account_name | yes | — | — | — |
|
|
2734
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2735
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2736
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2737
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2738
|
+
|
|
2739
|
+
### `sds.feeds.getPostsByPayout()`
|
|
2740
|
+
|
|
2741
|
+
Returns a feed list with all posts ordered by payout amount descending.
|
|
2742
|
+
|
|
2743
|
+
- Route: `/feeds_api/getPostsByPayout/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2744
|
+
- Result: JSON Object
|
|
2745
|
+
- Max. limit: 1000
|
|
2746
|
+
- Example: `/feeds_api/getPostsByPayout`
|
|
2747
|
+
|
|
2748
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2749
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2750
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2751
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2752
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2753
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2754
|
+
|
|
2755
|
+
### `sds.feeds.getPostsByCommentsPayout()`
|
|
2756
|
+
|
|
2757
|
+
Returns a feed list with all posts ordered by total comments payout amount descending.
|
|
2758
|
+
|
|
2759
|
+
- Route: `/feeds_api/getPostsByCommentsPayout/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2760
|
+
- Result: JSON Object
|
|
2761
|
+
- Max. limit: 1000
|
|
2762
|
+
- Example: `/feeds_api/getPostsByCommentsPayout`
|
|
2763
|
+
|
|
2764
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2765
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2766
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2767
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2768
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2769
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2770
|
+
|
|
2771
|
+
### `sds.feeds.getPostsByTagCreated()`
|
|
2772
|
+
|
|
2773
|
+
Returns a feed list with all posts containing :tag ordered by created time descending.
|
|
2774
|
+
|
|
2775
|
+
- Route: `/feeds_api/getPostsByTagCreated/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2776
|
+
- Result: JSON Object
|
|
2777
|
+
- Max. limit: 1000
|
|
2778
|
+
- Example: `/feeds_api/getPostsByTagCreated/steem`
|
|
2779
|
+
|
|
2780
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2781
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2782
|
+
| `tag` | string | yes | — | — | — |
|
|
2783
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2784
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2785
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2786
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2787
|
+
|
|
2788
|
+
### `sds.feeds.getActivePostsByAuthor()`
|
|
2789
|
+
|
|
2790
|
+
Returns a feed list with :author's active posts ordered by created time descending.
|
|
2791
|
+
|
|
2792
|
+
- Route: `/feeds_api/getActivePostsByAuthor/:author/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2793
|
+
- Result: JSON Object
|
|
2794
|
+
- Max. limit: 1000
|
|
2795
|
+
- Example: `/feeds_api/getActivePostsByAuthor/steemitblog`
|
|
2796
|
+
|
|
2797
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2798
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2799
|
+
| `author` | account_name | yes | — | — | — |
|
|
2800
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2801
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2802
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2803
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2804
|
+
|
|
2805
|
+
### `sds.feeds.getActivePostsByCreated()`
|
|
2806
|
+
|
|
2807
|
+
Returns a feed list with active posts ordered by created time descending.
|
|
2808
|
+
|
|
2809
|
+
- Route: `/feeds_api/getActivePostsByCreated/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2810
|
+
- Result: JSON Object
|
|
2811
|
+
- Max. limit: 1000
|
|
2812
|
+
- Example: `/feeds_api/getActivePostsByCreated`
|
|
2813
|
+
|
|
2814
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2815
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2816
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2817
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2818
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2819
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2820
|
+
|
|
2821
|
+
### `sds.feeds.getActivePostsByTrending()`
|
|
2822
|
+
|
|
2823
|
+
Returns a feed list with active posts ordered by trending score descending.
|
|
2824
|
+
|
|
2825
|
+
- Route: `/feeds_api/getActivePostsByTrending/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2826
|
+
- Result: JSON Object
|
|
2827
|
+
- Max. limit: 1000
|
|
2828
|
+
- Example: `/feeds_api/getActivePostsByTrending`
|
|
2829
|
+
|
|
2830
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2831
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2832
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2833
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2834
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2835
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2836
|
+
|
|
2837
|
+
### `sds.feeds.getActivePostsByTrendingWithoutWhales()`
|
|
2838
|
+
|
|
2839
|
+
Returns a feed list with active posts ordered by trending score (calculated without whale votes) descending.
|
|
2840
|
+
|
|
2841
|
+
- Route: `/feeds_api/getActivePostsByTrendingWithoutWhales/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2842
|
+
- Result: JSON Object
|
|
2843
|
+
- Max. limit: 1000
|
|
2844
|
+
- Example: `/feeds_api/getActivePostsByTrendingWithoutWhales`
|
|
2845
|
+
|
|
2846
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2847
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2848
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2849
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2850
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2851
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2852
|
+
|
|
2853
|
+
### `sds.feeds.getActivePostsByHot()`
|
|
2854
|
+
|
|
2855
|
+
Returns a feed list with active posts ordered by hot score descending.
|
|
2856
|
+
|
|
2857
|
+
- Route: `/feeds_api/getActivePostsByHot/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2858
|
+
- Result: JSON Object
|
|
2859
|
+
- Max. limit: 1000
|
|
2860
|
+
- Example: `/feeds_api/getActivePostsByHot`
|
|
2861
|
+
|
|
2862
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2863
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2864
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2865
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2866
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2867
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2868
|
+
|
|
2869
|
+
### `sds.feeds.getActivePostsByHotWithoutWhales()`
|
|
2870
|
+
|
|
2871
|
+
Returns a feed list with active posts ordered by hot score (calculated without whale votes) descending.
|
|
2872
|
+
|
|
2873
|
+
- Route: `/feeds_api/getActivePostsByHotWithoutWhales/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2874
|
+
- Result: JSON Object
|
|
2875
|
+
- Max. limit: 1000
|
|
2876
|
+
- Example: `/feeds_api/getActivePostsByHotWithoutWhales`
|
|
2877
|
+
|
|
2878
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2879
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2880
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2881
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2882
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2883
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2884
|
+
|
|
2885
|
+
### `sds.feeds.getActivePostsByInteraction()`
|
|
2886
|
+
|
|
2887
|
+
Returns a feed list with active posts ordered by interaction score descending.
|
|
2888
|
+
|
|
2889
|
+
- Route: `/feeds_api/getActivePostsByInteraction/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2890
|
+
- Result: JSON Object
|
|
2891
|
+
- Max. limit: 1000
|
|
2892
|
+
- Example: `/feeds_api/getActivePostsByInteraction`
|
|
2893
|
+
|
|
2894
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2895
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2896
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2897
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2898
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2899
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2900
|
+
|
|
2901
|
+
### `sds.feeds.getActivePostsByPayout()`
|
|
2902
|
+
|
|
2903
|
+
Returns a feed list with active posts ordered by payout amount descending.
|
|
2904
|
+
|
|
2905
|
+
- Route: `/feeds_api/getActivePostsByPayout/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2906
|
+
- Result: JSON Object
|
|
2907
|
+
- Max. limit: 1000
|
|
2908
|
+
- Example: `/feeds_api/getActivePostsByPayout`
|
|
2909
|
+
|
|
2910
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2911
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2912
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2913
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2914
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2915
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2916
|
+
|
|
2917
|
+
### `sds.feeds.getActivePostsByCommentsPayout()`
|
|
2918
|
+
|
|
2919
|
+
Returns a feed list with active posts ordered by total comments payout amount descending.
|
|
2920
|
+
|
|
2921
|
+
- Route: `/feeds_api/getActivePostsByCommentsPayout/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2922
|
+
- Result: JSON Object
|
|
2923
|
+
- Max. limit: 1000
|
|
2924
|
+
- Example: `/feeds_api/getActivePostsByCommentsPayout`
|
|
2925
|
+
|
|
2926
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2927
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2928
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2929
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2930
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2931
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2932
|
+
|
|
2933
|
+
### `sds.feeds.getActivePostsByPromoted()`
|
|
2934
|
+
|
|
2935
|
+
Returns a feed list with active posts ordered by promoted amount descending.
|
|
2936
|
+
|
|
2937
|
+
- Route: `/feeds_api/getActivePostsByPromoted/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2938
|
+
- Result: JSON Object
|
|
2939
|
+
- Max. limit: 1000
|
|
2940
|
+
- Example: `/feeds_api/getActivePostsByPromoted`
|
|
2941
|
+
|
|
2942
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2943
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2944
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2945
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2946
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2947
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2948
|
+
|
|
2949
|
+
### `sds.feeds.getActivePostsByTagCreated()`
|
|
2950
|
+
|
|
2951
|
+
Returns a feed list with active posts containing :tag ordered by created time descending.
|
|
2952
|
+
|
|
2953
|
+
- Route: `/feeds_api/getActivePostsByTagCreated/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2954
|
+
- Result: JSON Object
|
|
2955
|
+
- Max. limit: 1000
|
|
2956
|
+
- Example: `/feeds_api/getActivePostsByTagCreated/steem`
|
|
2957
|
+
|
|
2958
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2959
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2960
|
+
| `tag` | string | yes | — | — | — |
|
|
2961
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2962
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2963
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2964
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2965
|
+
|
|
2966
|
+
### `sds.feeds.getActivePostsByTagTrending()`
|
|
2967
|
+
|
|
2968
|
+
Returns a feed list with active posts containing :tag ordered by trending score descending.
|
|
2969
|
+
|
|
2970
|
+
- Route: `/feeds_api/getActivePostsByTagTrending/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2971
|
+
- Result: JSON Object
|
|
2972
|
+
- Max. limit: 1000
|
|
2973
|
+
- Example: `/feeds_api/getActivePostsByTagTrending/steem`
|
|
2974
|
+
|
|
2975
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2976
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2977
|
+
| `tag` | string | yes | — | — | — |
|
|
2978
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2979
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2980
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2981
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2982
|
+
|
|
2983
|
+
### `sds.feeds.getActivePostsByTagTrendingWithoutWhales()`
|
|
2984
|
+
|
|
2985
|
+
Returns a feed list with active posts containing :tag ordered by trending score (calculated without whale votes) descending.
|
|
2986
|
+
|
|
2987
|
+
- Route: `/feeds_api/getActivePostsByTagTrendingWithoutWhales/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
2988
|
+
- Result: JSON Object
|
|
2989
|
+
- Max. limit: 1000
|
|
2990
|
+
- Example: `/feeds_api/getActivePostsByTagTrendingWithoutWhales/steem`
|
|
2991
|
+
|
|
2992
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
2993
|
+
| --- | --- | --- | --- | --- | --- |
|
|
2994
|
+
| `tag` | string | yes | — | — | — |
|
|
2995
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
2996
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
2997
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
2998
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
2999
|
+
|
|
3000
|
+
### `sds.feeds.getActivePostsByTagHot()`
|
|
3001
|
+
|
|
3002
|
+
Returns a feed list with active posts containing :tag ordered by hot score descending.
|
|
3003
|
+
|
|
3004
|
+
- Route: `/feeds_api/getActivePostsByTagHot/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3005
|
+
- Result: JSON Object
|
|
3006
|
+
- Max. limit: 1000
|
|
3007
|
+
- Example: `/feeds_api/getActivePostsByTagHot/steem`
|
|
3008
|
+
|
|
3009
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3010
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3011
|
+
| `tag` | string | yes | — | — | — |
|
|
3012
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3013
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3014
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3015
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3016
|
+
|
|
3017
|
+
### `sds.feeds.getActivePostsByTagHotWithoutWhales()`
|
|
3018
|
+
|
|
3019
|
+
Returns a feed list with active posts containing :tag ordered by hot score (calculated without whale votes) descending.
|
|
3020
|
+
|
|
3021
|
+
- Route: `/feeds_api/getActivePostsByTagHotWithoutWhales/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3022
|
+
- Result: JSON Object
|
|
3023
|
+
- Max. limit: 1000
|
|
3024
|
+
- Example: `/feeds_api/getActivePostsByTagHotWithoutWhales/steem`
|
|
3025
|
+
|
|
3026
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3027
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3028
|
+
| `tag` | string | yes | — | — | — |
|
|
3029
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3030
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3031
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3032
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3033
|
+
|
|
3034
|
+
### `sds.feeds.getActivePostsByTagInteraction()`
|
|
3035
|
+
|
|
3036
|
+
Returns a feed list with active posts containing :tag ordered by interaction score descending.
|
|
3037
|
+
|
|
3038
|
+
- Route: `/feeds_api/getActivePostsByTagInteraction/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3039
|
+
- Result: JSON Object
|
|
3040
|
+
- Max. limit: 1000
|
|
3041
|
+
- Example: `/feeds_api/getActivePostsByTagInteraction/steem`
|
|
3042
|
+
|
|
3043
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3044
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3045
|
+
| `tag` | string | yes | — | — | — |
|
|
3046
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3047
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3048
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3049
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3050
|
+
|
|
3051
|
+
### `sds.feeds.getActivePostsByTagPayout()`
|
|
3052
|
+
|
|
3053
|
+
Returns a feed list with active posts containing :tag ordered by payout amount descending.
|
|
3054
|
+
|
|
3055
|
+
- Route: `/feeds_api/getActivePostsByTagPayout/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3056
|
+
- Result: JSON Object
|
|
3057
|
+
- Max. limit: 1000
|
|
3058
|
+
- Example: `/feeds_api/getActivePostsByTagPayout/steem`
|
|
3059
|
+
|
|
3060
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3061
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3062
|
+
| `tag` | string | yes | — | — | — |
|
|
3063
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3064
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3065
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3066
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3067
|
+
|
|
3068
|
+
### `sds.feeds.getActivePostsByTagCommentsPayout()`
|
|
3069
|
+
|
|
3070
|
+
Returns a feed list with active posts containing :tag ordered by total comments payout amount descending.
|
|
3071
|
+
|
|
3072
|
+
- Route: `/feeds_api/getActivePostsByTagCommentsPayout/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3073
|
+
- Result: JSON Object
|
|
3074
|
+
- Max. limit: 1000
|
|
3075
|
+
- Example: `/feeds_api/getActivePostsByTagCommentsPayout/steem`
|
|
3076
|
+
|
|
3077
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3078
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3079
|
+
| `tag` | string | yes | — | — | — |
|
|
3080
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3081
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3082
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3083
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3084
|
+
|
|
3085
|
+
### `sds.feeds.getActivePostsByTagPromoted()`
|
|
3086
|
+
|
|
3087
|
+
Returns a feed list with active posts containing :tag ordered by promoted amount descending.
|
|
3088
|
+
|
|
3089
|
+
- Route: `/feeds_api/getActivePostsByTagPromoted/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3090
|
+
- Result: JSON Object
|
|
3091
|
+
- Max. limit: 1000
|
|
3092
|
+
- Example: `/feeds_api/getActivePostsByTagPromoted/steem`
|
|
3093
|
+
|
|
3094
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3095
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3096
|
+
| `tag` | string | yes | — | — | — |
|
|
3097
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3098
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3099
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3100
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3101
|
+
|
|
3102
|
+
### `sds.feeds.getCommentsByAuthor()`
|
|
3103
|
+
|
|
3104
|
+
Returns a feed list with :author's comments ordered by created time descending.
|
|
3105
|
+
|
|
3106
|
+
- Route: `/feeds_api/getCommentsByAuthor/:author/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3107
|
+
- Result: JSON Object
|
|
3108
|
+
- Max. limit: 1000
|
|
3109
|
+
- Example: `/feeds_api/getCommentsByAuthor/steemitblog`
|
|
3110
|
+
|
|
3111
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3112
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3113
|
+
| `author` | account_name | yes | — | — | — |
|
|
3114
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3115
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3116
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3117
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3118
|
+
|
|
3119
|
+
### `sds.feeds.getCommentsByParentAuthor()`
|
|
3120
|
+
|
|
3121
|
+
Returns a feed list with comments that are replies to :parentAuthor ordered by created time descending.
|
|
3122
|
+
|
|
3123
|
+
- Route: `/feeds_api/getCommentsByParentAuthor/:parentAuthor/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3124
|
+
- Result: JSON Object
|
|
3125
|
+
- Max. limit: 1000
|
|
3126
|
+
- Example: `/feeds_api/getCommentsByParentAuthor/steemitblog`
|
|
3127
|
+
|
|
3128
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3129
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3130
|
+
| `parentAuthor` | account_name | yes | — | — | — |
|
|
3131
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3132
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3133
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3134
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3135
|
+
|
|
3136
|
+
### `sds.feeds.getCommentsByPayout()`
|
|
3137
|
+
|
|
3138
|
+
Returns a feed list with all comments ordered by payout amount descending.
|
|
3139
|
+
|
|
3140
|
+
- Route: `/feeds_api/getCommentsByPayout/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3141
|
+
- Result: JSON Object
|
|
3142
|
+
- Max. limit: 1000
|
|
3143
|
+
- Example: `/feeds_api/getCommentsByPayout`
|
|
3144
|
+
|
|
3145
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3146
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3147
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3148
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3149
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3150
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3151
|
+
|
|
3152
|
+
### `sds.feeds.getCommentsByTagCreated()`
|
|
3153
|
+
|
|
3154
|
+
Returns a feed list with all comments containing :tag ordered by created time descending.
|
|
3155
|
+
|
|
3156
|
+
- Route: `/feeds_api/getCommentsByTagCreated/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3157
|
+
- Result: JSON Object
|
|
3158
|
+
- Max. limit: 1000
|
|
3159
|
+
- Example: `/feeds_api/getCommentsByTagCreated/steem`
|
|
3160
|
+
|
|
3161
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3162
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3163
|
+
| `tag` | string | yes | — | — | — |
|
|
3164
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3165
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3166
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3167
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3168
|
+
|
|
3169
|
+
### `sds.feeds.getActiveCommentsByAuthor()`
|
|
3170
|
+
|
|
3171
|
+
Returns a feed list with :author's active comments ordered by created time descending.
|
|
3172
|
+
|
|
3173
|
+
- Route: `/feeds_api/getActiveCommentsByAuthor/:author/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3174
|
+
- Result: JSON Object
|
|
3175
|
+
- Max. limit: 1000
|
|
3176
|
+
- Example: `/feeds_api/getActiveCommentsByAuthor/steemitblog`
|
|
3177
|
+
|
|
3178
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3179
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3180
|
+
| `author` | account_name | yes | — | — | — |
|
|
3181
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3182
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3183
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3184
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3185
|
+
|
|
3186
|
+
### `sds.feeds.getActiveCommentsByCreated()`
|
|
3187
|
+
|
|
3188
|
+
Returns a feed list with all comments ordered by created time descending.
|
|
3189
|
+
|
|
3190
|
+
- Route: `/feeds_api/getActiveCommentsByCreated/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3191
|
+
- Result: JSON Object
|
|
3192
|
+
- Max. limit: 1000
|
|
3193
|
+
- Example: `/feeds_api/getActiveCommentsByCreated`
|
|
3194
|
+
|
|
3195
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3196
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3197
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3198
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3199
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3200
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3201
|
+
|
|
3202
|
+
### `sds.feeds.getActiveCommentsByPayout()`
|
|
3203
|
+
|
|
3204
|
+
Returns a feed list with all comments ordered by payout amount descending.
|
|
3205
|
+
|
|
3206
|
+
- Route: `/feeds_api/getActiveCommentsByPayout/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3207
|
+
- Result: JSON Object
|
|
3208
|
+
- Max. limit: 1000
|
|
3209
|
+
- Example: `/feeds_api/getActiveCommentsByPayout`
|
|
3210
|
+
|
|
3211
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3212
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3213
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3214
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3215
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3216
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3217
|
+
|
|
3218
|
+
### `sds.feeds.getActiveCommentsByTagCreated()`
|
|
3219
|
+
|
|
3220
|
+
Returns a feed list with active comments containing :tag ordered by created time descending.
|
|
3221
|
+
|
|
3222
|
+
- Route: `/feeds_api/getActiveCommentsByTagCreated/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3223
|
+
- Result: JSON Object
|
|
3224
|
+
- Max. limit: 1000
|
|
3225
|
+
- Example: `/feeds_api/getActiveCommentsByTagCreated/steem`
|
|
3226
|
+
|
|
3227
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3228
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3229
|
+
| `tag` | string | yes | — | — | — |
|
|
3230
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3231
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3232
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3233
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3234
|
+
|
|
3235
|
+
### `sds.feeds.getActiveCommentsByTagPayout()`
|
|
3236
|
+
|
|
3237
|
+
Returns a feed list with active comments containing :tag ordered by payout amount descending.
|
|
3238
|
+
|
|
3239
|
+
- Route: `/feeds_api/getActiveCommentsByTagPayout/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3240
|
+
- Result: JSON Object
|
|
3241
|
+
- Max. limit: 1000
|
|
3242
|
+
- Example: `/feeds_api/getActiveCommentsByTagPayout/steem`
|
|
3243
|
+
|
|
3244
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3245
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3246
|
+
| `tag` | string | yes | — | — | — |
|
|
3247
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3248
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3249
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3250
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3251
|
+
|
|
3252
|
+
### `sds.feeds.getCommunityPostsByAuthor()`
|
|
3253
|
+
|
|
3254
|
+
Returns a feed list with :author's community posts ordered by created time descending.
|
|
3255
|
+
|
|
3256
|
+
- Route: `/feeds_api/getCommunityPostsByAuthor/:community/:author/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3257
|
+
- Result: JSON Object
|
|
3258
|
+
- Max. limit: 1000
|
|
3259
|
+
- Example: `/feeds_api/getCommunityPostsByAuthor/hive-172186/steemitblog`
|
|
3260
|
+
|
|
3261
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3262
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3263
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3264
|
+
| `author` | account_name | yes | — | — | — |
|
|
3265
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3266
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3267
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3268
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3269
|
+
|
|
3270
|
+
### `sds.feeds.getCommunityPostsByCreated()`
|
|
3271
|
+
|
|
3272
|
+
Returns a feed list with community posts ordered by created time descending.
|
|
3273
|
+
|
|
3274
|
+
- Route: `/feeds_api/getCommunityPostsByCreated/:community/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3275
|
+
- Result: JSON Object
|
|
3276
|
+
- Max. limit: 1000
|
|
3277
|
+
- Example: `/feeds_api/getCommunityPostsByCreated/hive-172186`
|
|
3278
|
+
|
|
3279
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3280
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3281
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3282
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3283
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3284
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3285
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3286
|
+
|
|
3287
|
+
### `sds.feeds.getCommunityPostsByPayout()`
|
|
3288
|
+
|
|
3289
|
+
Returns a feed list with all commmunity posts ordered by payout amount descending.
|
|
3290
|
+
|
|
3291
|
+
- Route: `/feeds_api/getCommunityPostsByPayout/:community/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3292
|
+
- Result: JSON Object
|
|
3293
|
+
- Max. limit: 1000
|
|
3294
|
+
- Example: `/feeds_api/getCommunityPostsByPayout/hive-172186`
|
|
3295
|
+
|
|
3296
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3297
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3298
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3299
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3300
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3301
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3302
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3303
|
+
|
|
3304
|
+
### `sds.feeds.getCommunityPostsByCommentsPayout()`
|
|
3305
|
+
|
|
3306
|
+
Returns a feed list with all community posts ordered by total comments payout amount descending.
|
|
3307
|
+
|
|
3308
|
+
- Route: `/feeds_api/getCommunityPostsByCommentsPayout/:community/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3309
|
+
- Result: JSON Object
|
|
3310
|
+
- Max. limit: 1000
|
|
3311
|
+
- Example: `/feeds_api/getCommunityPostsByCommentsPayout/hive-172186`
|
|
3312
|
+
|
|
3313
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3314
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3315
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3316
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3317
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3318
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3319
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3320
|
+
|
|
3321
|
+
### `sds.feeds.getCommunityPostsByTagAuthor()`
|
|
3322
|
+
|
|
3323
|
+
Returns a feed list with :author's community posts containing :tag ordered by created time descending.
|
|
3324
|
+
|
|
3325
|
+
- Route: `/feeds_api/getCommunityPostsByTagAuthor/:community/:tag/:author/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3326
|
+
- Result: JSON Object
|
|
3327
|
+
- Max. limit: 1000
|
|
3328
|
+
- Example: `/feeds_api/getCommunityPostsByTagAuthor/hive-172186/steem/steemitblog`
|
|
3329
|
+
|
|
3330
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3331
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3332
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3333
|
+
| `tag` | string | yes | — | — | — |
|
|
3334
|
+
| `author` | account_name | yes | — | — | — |
|
|
3335
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3336
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3337
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3338
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3339
|
+
|
|
3340
|
+
### `sds.feeds.getCommunityPostsByTagCreated()`
|
|
3341
|
+
|
|
3342
|
+
Returns a feed list with community posts containing :tag ordered by created time descending.
|
|
3343
|
+
|
|
3344
|
+
- Route: `/feeds_api/getCommunityPostsByTagCreated/:community/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3345
|
+
- Result: JSON Object
|
|
3346
|
+
- Max. limit: 1000
|
|
3347
|
+
- Example: `/feeds_api/getCommunityPostsByTagCreated/hive-172186/steem`
|
|
3348
|
+
|
|
3349
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3350
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3351
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3352
|
+
| `tag` | string | yes | — | — | — |
|
|
3353
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3354
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3355
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3356
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3357
|
+
|
|
3358
|
+
### `sds.feeds.getCommunityPostsByTagPayout()`
|
|
3359
|
+
|
|
3360
|
+
Returns a feed list with all commmunity posts containing :tag ordered by payout amount descending.
|
|
3361
|
+
|
|
3362
|
+
- Route: `/feeds_api/getCommunityPostsByTagPayout/:community/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3363
|
+
- Result: JSON Object
|
|
3364
|
+
- Max. limit: 1000
|
|
3365
|
+
- Example: `/feeds_api/getCommunityPostsByTagPayout/hive-172186/steem`
|
|
3366
|
+
|
|
3367
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3368
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3369
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3370
|
+
| `tag` | string | yes | — | — | — |
|
|
3371
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3372
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3373
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3374
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3375
|
+
|
|
3376
|
+
### `sds.feeds.getCommunityPostsByTagCommentsPayout()`
|
|
3377
|
+
|
|
3378
|
+
Returns a feed list with all community posts containing :tag ordered by total comments payout amount descending.
|
|
3379
|
+
|
|
3380
|
+
- Route: `/feeds_api/getCommunityPostsByTagCommentsPayout/:community/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3381
|
+
- Result: JSON Object
|
|
3382
|
+
- Max. limit: 1000
|
|
3383
|
+
- Example: `/feeds_api/getCommunityPostsByTagCommentsPayout/hive-172186/steem`
|
|
3384
|
+
|
|
3385
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3386
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3387
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3388
|
+
| `tag` | string | yes | — | — | — |
|
|
3389
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3390
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3391
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3392
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3393
|
+
|
|
3394
|
+
### `sds.feeds.getActiveCommunityPostsByAuthor()`
|
|
3395
|
+
|
|
3396
|
+
Returns a feed list with :author's active community posts ordered by created time descending.
|
|
3397
|
+
|
|
3398
|
+
- Route: `/feeds_api/getActiveCommunityPostsByAuthor/:community/:author/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3399
|
+
- Result: JSON Object
|
|
3400
|
+
- Max. limit: 1000
|
|
3401
|
+
- Example: `/feeds_api/getActiveCommunityPostsByAuthor/hive-172186/steemitblog`
|
|
3402
|
+
|
|
3403
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3404
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3405
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3406
|
+
| `author` | account_name | yes | — | — | — |
|
|
3407
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3408
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3409
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3410
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3411
|
+
|
|
3412
|
+
### `sds.feeds.getActiveCommunityPostsByCreated()`
|
|
3413
|
+
|
|
3414
|
+
Returns a feed list with active community posts ordered by created time descending.
|
|
3415
|
+
|
|
3416
|
+
- Route: `/feeds_api/getActiveCommunityPostsByCreated/:community/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3417
|
+
- Result: JSON Object
|
|
3418
|
+
- Max. limit: 1000
|
|
3419
|
+
- Example: `/feeds_api/getActiveCommunityPostsByCreated/hive-172186`
|
|
3420
|
+
|
|
3421
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3422
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3423
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3424
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3425
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3426
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3427
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3428
|
+
|
|
3429
|
+
### `sds.feeds.getActiveCommunityPostsByTrending()`
|
|
3430
|
+
|
|
3431
|
+
Returns a feed list with active community posts ordered by trending score descending.
|
|
3432
|
+
|
|
3433
|
+
- Route: `/feeds_api/getActiveCommunityPostsByTrending/:community/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3434
|
+
- Result: JSON Object
|
|
3435
|
+
- Max. limit: 1000
|
|
3436
|
+
- Example: `/feeds_api/getActiveCommunityPostsByTrending/hive-172186`
|
|
3437
|
+
|
|
3438
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3439
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3440
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3441
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3442
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3443
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3444
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3445
|
+
|
|
3446
|
+
### `sds.feeds.getActiveCommunityPostsByTrendingWithoutWhales()`
|
|
3447
|
+
|
|
3448
|
+
Returns a feed list with active community posts ordered by trending score (calculated without whale votes) descending.
|
|
3449
|
+
|
|
3450
|
+
- Route: `/feeds_api/getActiveCommunityPostsByTrendingWithoutWhales/:community/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3451
|
+
- Result: JSON Object
|
|
3452
|
+
- Max. limit: 1000
|
|
3453
|
+
- Example: `/feeds_api/getActiveCommunityPostsByTrendingWithoutWhales/hive-172186`
|
|
3454
|
+
|
|
3455
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3456
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3457
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3458
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3459
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3460
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3461
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3462
|
+
|
|
3463
|
+
### `sds.feeds.getActiveCommunityPostsByHot()`
|
|
3464
|
+
|
|
3465
|
+
Returns a feed list with active community posts ordered by hot score descending.
|
|
3466
|
+
|
|
3467
|
+
- Route: `/feeds_api/getActiveCommunityPostsByHot/:community/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3468
|
+
- Result: JSON Object
|
|
3469
|
+
- Max. limit: 1000
|
|
3470
|
+
- Example: `/feeds_api/getActiveCommunityPostsByHot/hive-172186`
|
|
3471
|
+
|
|
3472
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3473
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3474
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3475
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3476
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3477
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3478
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3479
|
+
|
|
3480
|
+
### `sds.feeds.getActiveCommunityPostsByHotWithoutWhales()`
|
|
3481
|
+
|
|
3482
|
+
Returns a feed list with active community posts ordered by hot score (calculated without whale votes) descending.
|
|
3483
|
+
|
|
3484
|
+
- Route: `/feeds_api/getActiveCommunityPostsByHotWithoutWhales/:community/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3485
|
+
- Result: JSON Object
|
|
3486
|
+
- Max. limit: 1000
|
|
3487
|
+
- Example: `/feeds_api/getActiveCommunityPostsByHotWithoutWhales/hive-172186`
|
|
3488
|
+
|
|
3489
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3490
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3491
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3492
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3493
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3494
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3495
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3496
|
+
|
|
3497
|
+
### `sds.feeds.getActiveCommunityPostsByInteraction()`
|
|
3498
|
+
|
|
3499
|
+
Returns a feed list with active community posts ordered by interaction score descending.
|
|
3500
|
+
|
|
3501
|
+
- Route: `/feeds_api/getActiveCommunityPostsByInteraction/:community/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3502
|
+
- Result: JSON Object
|
|
3503
|
+
- Max. limit: 1000
|
|
3504
|
+
- Example: `/feeds_api/getActiveCommunityPostsByInteraction/hive-172186`
|
|
3505
|
+
|
|
3506
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3507
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3508
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3509
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3510
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3511
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3512
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3513
|
+
|
|
3514
|
+
### `sds.feeds.getActiveCommunityPostsByPayout()`
|
|
3515
|
+
|
|
3516
|
+
Returns a feed list with active community posts ordered by payout amount descending.
|
|
3517
|
+
|
|
3518
|
+
- Route: `/feeds_api/getActiveCommunityPostsByPayout/:community/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3519
|
+
- Result: JSON Object
|
|
3520
|
+
- Max. limit: 1000
|
|
3521
|
+
- Example: `/feeds_api/getActiveCommunityPostsByPayout/hive-172186`
|
|
3522
|
+
|
|
3523
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3524
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3525
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3526
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3527
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3528
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3529
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3530
|
+
|
|
3531
|
+
### `sds.feeds.getActiveCommunityPostsByCommentsPayout()`
|
|
3532
|
+
|
|
3533
|
+
Returns a feed list with active community posts ordered by total comments payout amount descending.
|
|
3534
|
+
|
|
3535
|
+
- Route: `/feeds_api/getActiveCommunityPostsByCommentsPayout/:community/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3536
|
+
- Result: JSON Object
|
|
3537
|
+
- Max. limit: 1000
|
|
3538
|
+
- Example: `/feeds_api/getActiveCommunityPostsByCommentsPayout/hive-172186`
|
|
3539
|
+
|
|
3540
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3541
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3542
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3543
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3544
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3545
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3546
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3547
|
+
|
|
3548
|
+
### `sds.feeds.getActiveCommunityPostsByPromoted()`
|
|
3549
|
+
|
|
3550
|
+
Returns a feed list with active community posts ordered by promoted amount descending.
|
|
3551
|
+
|
|
3552
|
+
- Route: `/feeds_api/getActiveCommunityPostsByPromoted/:community/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3553
|
+
- Result: JSON Object
|
|
3554
|
+
- Max. limit: 1000
|
|
3555
|
+
- Example: `/feeds_api/getActiveCommunityPostsByPromoted/hive-172186`
|
|
3556
|
+
|
|
3557
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3558
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3559
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3560
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3561
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3562
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3563
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3564
|
+
|
|
3565
|
+
### `sds.feeds.getActiveCommunityPostsByTagAuthor()`
|
|
3566
|
+
|
|
3567
|
+
Returns a feed list with :author's active community posts containing :tag ordered by created time descending.
|
|
3568
|
+
|
|
3569
|
+
- Route: `/feeds_api/getActiveCommunityPostsByTagAuthor/:community/:tag/:author/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3570
|
+
- Result: JSON Object
|
|
3571
|
+
- Max. limit: 1000
|
|
3572
|
+
- Example: `/feeds_api/getActiveCommunityPostsByTagAuthor/hive-172186/steem/steemitblog`
|
|
3573
|
+
|
|
3574
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3575
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3576
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3577
|
+
| `tag` | string | yes | — | — | — |
|
|
3578
|
+
| `author` | account_name | yes | — | — | — |
|
|
3579
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3580
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3581
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3582
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3583
|
+
|
|
3584
|
+
### `sds.feeds.getActiveCommunityPostsByTagCreated()`
|
|
3585
|
+
|
|
3586
|
+
Returns a feed list with active community posts containing :tag ordered by created time descending.
|
|
3587
|
+
|
|
3588
|
+
- Route: `/feeds_api/getActiveCommunityPostsByTagCreated/:community/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3589
|
+
- Result: JSON Object
|
|
3590
|
+
- Max. limit: 1000
|
|
3591
|
+
- Example: `/feeds_api/getActiveCommunityPostsByTagCreated/hive-172186/steem`
|
|
3592
|
+
|
|
3593
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3594
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3595
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3596
|
+
| `tag` | string | yes | — | — | — |
|
|
3597
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3598
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3599
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3600
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3601
|
+
|
|
3602
|
+
### `sds.feeds.getActiveCommunityPostsByTagTrending()`
|
|
3603
|
+
|
|
3604
|
+
Returns a feed list with active community posts containing :tag ordered by trending score descending.
|
|
3605
|
+
|
|
3606
|
+
- Route: `/feeds_api/getActiveCommunityPostsByTagTrending/:community/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3607
|
+
- Result: JSON Object
|
|
3608
|
+
- Max. limit: 1000
|
|
3609
|
+
- Example: `/feeds_api/getActiveCommunityPostsByTagTrending/hive-172186/steem`
|
|
3610
|
+
|
|
3611
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3612
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3613
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3614
|
+
| `tag` | string | yes | — | — | — |
|
|
3615
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3616
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3617
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3618
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3619
|
+
|
|
3620
|
+
### `sds.feeds.getActiveCommunityPostsByTagTrendingWithoutWhales()`
|
|
3621
|
+
|
|
3622
|
+
Returns a feed list with active community posts containing :tag ordered by trending score (calculated without whale votes) descending.
|
|
3623
|
+
|
|
3624
|
+
- Route: `/feeds_api/getActiveCommunityPostsByTagTrendingWithoutWhales/:community/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3625
|
+
- Result: JSON Object
|
|
3626
|
+
- Max. limit: 1000
|
|
3627
|
+
- Example: `/feeds_api/getActiveCommunityPostsByTagTrendingWithoutWhales/hive-172186/steem`
|
|
3628
|
+
|
|
3629
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3630
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3631
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3632
|
+
| `tag` | string | yes | — | — | — |
|
|
3633
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3634
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3635
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3636
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3637
|
+
|
|
3638
|
+
### `sds.feeds.getActiveCommunityPostsByTagHot()`
|
|
3639
|
+
|
|
3640
|
+
Returns a feed list with active community posts containing :tag ordered by hot score descending.
|
|
3641
|
+
|
|
3642
|
+
- Route: `/feeds_api/getActiveCommunityPostsByTagHot/:community/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3643
|
+
- Result: JSON Object
|
|
3644
|
+
- Max. limit: 1000
|
|
3645
|
+
- Example: `/feeds_api/getActiveCommunityPostsByTagHot/hive-172186/steem`
|
|
3646
|
+
|
|
3647
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3648
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3649
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3650
|
+
| `tag` | string | yes | — | — | — |
|
|
3651
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3652
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3653
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3654
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3655
|
+
|
|
3656
|
+
### `sds.feeds.getActiveCommunityPostsByTagHotWithoutWhales()`
|
|
3657
|
+
|
|
3658
|
+
Returns a feed list with active community posts containing :tag ordered by hot score (calculated without whale votes) descending.
|
|
3659
|
+
|
|
3660
|
+
- Route: `/feeds_api/getActiveCommunityPostsByTagHotWithoutWhales/:community/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3661
|
+
- Result: JSON Object
|
|
3662
|
+
- Max. limit: 1000
|
|
3663
|
+
- Example: `/feeds_api/getActiveCommunityPostsByTagHotWithoutWhales/hive-172186/steem`
|
|
3664
|
+
|
|
3665
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3666
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3667
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3668
|
+
| `tag` | string | yes | — | — | — |
|
|
3669
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3670
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3671
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3672
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3673
|
+
|
|
3674
|
+
### `sds.feeds.getActiveCommunityPostsByTagInteraction()`
|
|
3675
|
+
|
|
3676
|
+
Returns a feed list with active community posts containing :tag ordered by interaction score descending.
|
|
3677
|
+
|
|
3678
|
+
- Route: `/feeds_api/getActiveCommunityPostsByTagInteraction/:community/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3679
|
+
- Result: JSON Object
|
|
3680
|
+
- Max. limit: 1000
|
|
3681
|
+
- Example: `/feeds_api/getActiveCommunityPostsByTagInteraction/hive-172186/steem`
|
|
3682
|
+
|
|
3683
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3684
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3685
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3686
|
+
| `tag` | string | yes | — | — | — |
|
|
3687
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3688
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3689
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3690
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3691
|
+
|
|
3692
|
+
### `sds.feeds.getActiveCommunityPostsByTagPayout()`
|
|
3693
|
+
|
|
3694
|
+
Returns a feed list with active community posts containing :tag ordered by payout amount descending.
|
|
3695
|
+
|
|
3696
|
+
- Route: `/feeds_api/getActiveCommunityPostsByTagPayout/:community/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3697
|
+
- Result: JSON Object
|
|
3698
|
+
- Max. limit: 1000
|
|
3699
|
+
- Example: `/feeds_api/getActiveCommunityPostsByTagPayout/hive-172186/steem`
|
|
3700
|
+
|
|
3701
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3702
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3703
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3704
|
+
| `tag` | string | yes | — | — | — |
|
|
3705
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3706
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3707
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3708
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3709
|
+
|
|
3710
|
+
### `sds.feeds.getActiveCommunityPostsByTagCommentsPayout()`
|
|
3711
|
+
|
|
3712
|
+
Returns a feed list with active community posts containing :tag ordered by total comments payout amount descending.
|
|
3713
|
+
|
|
3714
|
+
- Route: `/feeds_api/getActiveCommunityPostsByTagCommentsPayout/:community/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3715
|
+
- Result: JSON Object
|
|
3716
|
+
- Max. limit: 1000
|
|
3717
|
+
- Example: `/feeds_api/getActiveCommunityPostsByTagCommentsPayout/hive-172186/steem`
|
|
3718
|
+
|
|
3719
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3720
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3721
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3722
|
+
| `tag` | string | yes | — | — | — |
|
|
3723
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3724
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3725
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3726
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3727
|
+
|
|
3728
|
+
### `sds.feeds.getActiveCommunityPostsByTagPromoted()`
|
|
3729
|
+
|
|
3730
|
+
Returns a feed list with active community posts containing :tag ordered by promoted amount descending.
|
|
3731
|
+
|
|
3732
|
+
- Route: `/feeds_api/getActiveCommunityPostsByTagPromoted/:community/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3733
|
+
- Result: JSON Object
|
|
3734
|
+
- Max. limit: 1000
|
|
3735
|
+
- Example: `/feeds_api/getActiveCommunityPostsByTagPromoted/hive-172186/steem`
|
|
3736
|
+
|
|
3737
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3738
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3739
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3740
|
+
| `tag` | string | yes | — | — | — |
|
|
3741
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3742
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3743
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3744
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3745
|
+
|
|
3746
|
+
### `sds.feeds.getCommunityCommentsByAuthor()`
|
|
3747
|
+
|
|
3748
|
+
Returns a feed list with :author's community comments ordered by created time descending.
|
|
3749
|
+
|
|
3750
|
+
- Route: `/feeds_api/getCommunityCommentsByAuthor/:community/:author/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3751
|
+
- Result: JSON Object
|
|
3752
|
+
- Max. limit: 1000
|
|
3753
|
+
- Example: `/feeds_api/getCommunityCommentsByAuthor/hive-172186/steemitblog`
|
|
3754
|
+
|
|
3755
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3756
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3757
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3758
|
+
| `author` | account_name | yes | — | — | — |
|
|
3759
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3760
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3761
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3762
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3763
|
+
|
|
3764
|
+
### `sds.feeds.getCommunityCommentsByCreated()`
|
|
3765
|
+
|
|
3766
|
+
Returns a feed list with community comments ordered by created time descending.
|
|
3767
|
+
|
|
3768
|
+
- Route: `/feeds_api/getCommunityCommentsByCreated/:community/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3769
|
+
- Result: JSON Object
|
|
3770
|
+
- Max. limit: 1000
|
|
3771
|
+
- Example: `/feeds_api/getCommunityCommentsByCreated/hive-172186`
|
|
3772
|
+
|
|
3773
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3774
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3775
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3776
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3777
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3778
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3779
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3780
|
+
|
|
3781
|
+
### `sds.feeds.getCommunityCommentsByPayout()`
|
|
3782
|
+
|
|
3783
|
+
Returns a feed list with all commmunity comments ordered by payout amount descending.
|
|
3784
|
+
|
|
3785
|
+
- Route: `/feeds_api/getCommunityCommentsByPayout/:community/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3786
|
+
- Result: JSON Object
|
|
3787
|
+
- Max. limit: 1000
|
|
3788
|
+
- Example: `/feeds_api/getCommunityCommentsByPayout/hive-172186`
|
|
3789
|
+
|
|
3790
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3791
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3792
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3793
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3794
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3795
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3796
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3797
|
+
|
|
3798
|
+
### `sds.feeds.getCommunityCommentsByTagAuthor()`
|
|
3799
|
+
|
|
3800
|
+
Returns a feed list with :author's community comments containing :tag ordered by created time descending.
|
|
3801
|
+
|
|
3802
|
+
- Route: `/feeds_api/getCommunityCommentsByTagAuthor/:community/:tag/:author/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3803
|
+
- Result: JSON Object
|
|
3804
|
+
- Max. limit: 1000
|
|
3805
|
+
- Example: `/feeds_api/getCommunityCommentsByTagAuthor/hive-172186/steem/steemitblog`
|
|
3806
|
+
|
|
3807
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3808
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3809
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3810
|
+
| `tag` | string | yes | — | — | — |
|
|
3811
|
+
| `author` | account_name | yes | — | — | — |
|
|
3812
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3813
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3814
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3815
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3816
|
+
|
|
3817
|
+
### `sds.feeds.getCommunityCommentsByTagCreated()`
|
|
3818
|
+
|
|
3819
|
+
Returns a feed list with community comments containing :tag ordered by created time descending.
|
|
3820
|
+
|
|
3821
|
+
- Route: `/feeds_api/getCommunityCommentsByTagCreated/:community/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3822
|
+
- Result: JSON Object
|
|
3823
|
+
- Max. limit: 1000
|
|
3824
|
+
- Example: `/feeds_api/getCommunityCommentsByTagCreated/hive-172186/steem`
|
|
3825
|
+
|
|
3826
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3827
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3828
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3829
|
+
| `tag` | string | yes | — | — | — |
|
|
3830
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3831
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3832
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3833
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3834
|
+
|
|
3835
|
+
### `sds.feeds.getCommunityCommentsByTagPayout()`
|
|
3836
|
+
|
|
3837
|
+
Returns a feed list with all commmunity comments containing :tag ordered by payout amount descending.
|
|
3838
|
+
|
|
3839
|
+
- Route: `/feeds_api/getCommunityCommentsByTagPayout/:community/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3840
|
+
- Result: JSON Object
|
|
3841
|
+
- Max. limit: 1000
|
|
3842
|
+
- Example: `/feeds_api/getCommunityCommentsByTagPayout/hive-172186/steem`
|
|
3843
|
+
|
|
3844
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3845
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3846
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3847
|
+
| `tag` | string | yes | — | — | — |
|
|
3848
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3849
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3850
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3851
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3852
|
+
|
|
3853
|
+
### `sds.feeds.getActiveCommunityCommentsByAuthor()`
|
|
3854
|
+
|
|
3855
|
+
Returns a feed list with :author's active community comments ordered by created time descending.
|
|
3856
|
+
|
|
3857
|
+
- Route: `/feeds_api/getActiveCommunityCommentsByAuthor/:community/:author/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3858
|
+
- Result: JSON Object
|
|
3859
|
+
- Max. limit: 1000
|
|
3860
|
+
- Example: `/feeds_api/getActiveCommunityCommentsByAuthor/hive-172186/steemitblog`
|
|
3861
|
+
|
|
3862
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3863
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3864
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3865
|
+
| `author` | account_name | yes | — | — | — |
|
|
3866
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3867
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3868
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3869
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3870
|
+
|
|
3871
|
+
### `sds.feeds.getActiveCommunityCommentsByCreated()`
|
|
3872
|
+
|
|
3873
|
+
Returns a feed list with active community comments ordered by created time descending.
|
|
3874
|
+
|
|
3875
|
+
- Route: `/feeds_api/getActiveCommunityCommentsByCreated/:community/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3876
|
+
- Result: JSON Object
|
|
3877
|
+
- Max. limit: 1000
|
|
3878
|
+
- Example: `/feeds_api/getActiveCommunityCommentsByCreated/hive-172186`
|
|
3879
|
+
|
|
3880
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3881
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3882
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3883
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3884
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3885
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3886
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3887
|
+
|
|
3888
|
+
### `sds.feeds.getActiveCommunityCommentsByPayout()`
|
|
3889
|
+
|
|
3890
|
+
Returns a feed list with active community comments ordered by payout amount descending.
|
|
3891
|
+
|
|
3892
|
+
- Route: `/feeds_api/getActiveCommunityCommentsByPayout/:community/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3893
|
+
- Result: JSON Object
|
|
3894
|
+
- Max. limit: 1000
|
|
3895
|
+
- Example: `/feeds_api/getActiveCommunityCommentsByPayout/hive-172186`
|
|
3896
|
+
|
|
3897
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3898
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3899
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3900
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3901
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3902
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3903
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3904
|
+
|
|
3905
|
+
### `sds.feeds.getActiveCommunityCommentsByTagAuthor()`
|
|
3906
|
+
|
|
3907
|
+
Returns a feed list with :author's active community comments containing :tag ordered by created time descending.
|
|
3908
|
+
|
|
3909
|
+
- Route: `/feeds_api/getActiveCommunityCommentsByTagAuthor/:community/:tag/:author/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3910
|
+
- Result: JSON Object
|
|
3911
|
+
- Max. limit: 1000
|
|
3912
|
+
- Example: `/feeds_api/getActiveCommunityCommentsByTagAuthor/hive-172186/steem/steemitblog`
|
|
3913
|
+
|
|
3914
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3915
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3916
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3917
|
+
| `tag` | string | yes | — | — | — |
|
|
3918
|
+
| `author` | account_name | yes | — | — | — |
|
|
3919
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3920
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3921
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3922
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3923
|
+
|
|
3924
|
+
### `sds.feeds.getActiveCommunityCommentsByTagCreated()`
|
|
3925
|
+
|
|
3926
|
+
Returns a feed list with active community comments containing :tag ordered by created time descending.
|
|
3927
|
+
|
|
3928
|
+
- Route: `/feeds_api/getActiveCommunityCommentsByTagCreated/:community/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3929
|
+
- Result: JSON Object
|
|
3930
|
+
- Max. limit: 1000
|
|
3931
|
+
- Example: `/feeds_api/getActiveCommunityCommentsByTagCreated/hive-172186/steem`
|
|
3932
|
+
|
|
3933
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3934
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3935
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3936
|
+
| `tag` | string | yes | — | — | — |
|
|
3937
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3938
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3939
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3940
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3941
|
+
|
|
3942
|
+
### `sds.feeds.getActiveCommunityCommentsByTagPayout()`
|
|
3943
|
+
|
|
3944
|
+
Returns a feed list with active community comments containing :tag ordered by payout amount descending.
|
|
3945
|
+
|
|
3946
|
+
- Route: `/feeds_api/getActiveCommunityCommentsByTagPayout/:community/:tag/:observer?/:bodyLength?/:limit?/:offset?`
|
|
3947
|
+
- Result: JSON Object
|
|
3948
|
+
- Max. limit: 1000
|
|
3949
|
+
- Example: `/feeds_api/getActiveCommunityCommentsByTagPayout/hive-172186/steem`
|
|
3950
|
+
|
|
3951
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3952
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3953
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
3954
|
+
| `tag` | string | yes | — | — | — |
|
|
3955
|
+
| `observer` | account_name | no | `null` | — | — |
|
|
3956
|
+
| `bodyLength` | int | no | `250` | 0 – 1000 | — |
|
|
3957
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
3958
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
3959
|
+
|
|
3960
|
+
---
|
|
3961
|
+
|
|
3962
|
+
## `posts_api`
|
|
3963
|
+
|
|
3964
|
+
Namespace: `sds.posts` · Group: Posts · 14 methods
|
|
3965
|
+
|
|
3966
|
+
### `sds.posts.getConfig()`
|
|
3967
|
+
|
|
3968
|
+
Returns this module's active configuration.
|
|
3969
|
+
|
|
3970
|
+
- Route: `/posts_api/getConfig`
|
|
3971
|
+
- Result: JSON Object
|
|
3972
|
+
- Example: `/posts_api/getConfig`
|
|
3973
|
+
|
|
3974
|
+
_No parameters._
|
|
3975
|
+
|
|
3976
|
+
### `sds.posts.getPost()`
|
|
3977
|
+
|
|
3978
|
+
Returns the post data for the given :author / :permlink.
|
|
3979
|
+
|
|
3980
|
+
- Route: `/posts_api/getPost/:author/:permlink/:withVotes?/:observer?/:fields?`
|
|
3981
|
+
- Result: JSON Object
|
|
3982
|
+
- Example: `/posts_api/getPost/steemit/firstpost`
|
|
3983
|
+
|
|
3984
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
3985
|
+
| --- | --- | --- | --- | --- | --- |
|
|
3986
|
+
| `author` | account_name | yes | — | — | — |
|
|
3987
|
+
| `permlink` | string | yes | — | — | — |
|
|
3988
|
+
| `withVotes` | bool | no | `true` | — | true | false | 1 | 0 |
|
|
3989
|
+
| `observer` | account_name | no | — | — | — |
|
|
3990
|
+
| `fields` | fixed_csv | no | `*` | — | link_id | link_status | author_reputation | author_status | author_role | author_title | author | permlink | … (53 values) |
|
|
3991
|
+
|
|
3992
|
+
### `sds.posts.getPostReplies()`
|
|
3993
|
+
|
|
3994
|
+
Returns all replies of the post with the given :author / :permlink.
|
|
3995
|
+
|
|
3996
|
+
- Route: `/posts_api/getPostReplies/:author/:permlink/:withVotes?/:observer?/:fields?`
|
|
3997
|
+
- Result: JSON Object
|
|
3998
|
+
- Example: `/posts_api/getPostReplies/steemit/firstpost`
|
|
3999
|
+
|
|
4000
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4001
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4002
|
+
| `author` | account_name | yes | — | — | — |
|
|
4003
|
+
| `permlink` | string | yes | — | — | — |
|
|
4004
|
+
| `withVotes` | bool | no | `true` | — | true | false | 1 | 0 |
|
|
4005
|
+
| `observer` | account_name | no | — | — | — |
|
|
4006
|
+
| `fields` | fixed_csv | no | `*` | — | link_id | link_status | author_reputation | author_status | author_role | author_title | author | permlink | … (53 values) |
|
|
4007
|
+
|
|
4008
|
+
### `sds.posts.getPostWithReplies()`
|
|
4009
|
+
|
|
4010
|
+
Returns the data and all replies of the post with the given :author / :permlink.
|
|
4011
|
+
|
|
4012
|
+
- Route: `/posts_api/getPostWithReplies/:author/:permlink/:withVotes?/:observer?/:fields?`
|
|
4013
|
+
- Result: JSON Object
|
|
4014
|
+
- Example: `/posts_api/getPostWithReplies/bestmalik/re-steemit-firstpost-20160726t035722561z`
|
|
4015
|
+
|
|
4016
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4017
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4018
|
+
| `author` | account_name | yes | — | — | — |
|
|
4019
|
+
| `permlink` | string | yes | — | — | — |
|
|
4020
|
+
| `withVotes` | bool | no | `true` | — | true | false | 1 | 0 |
|
|
4021
|
+
| `observer` | account_name | no | — | — | — |
|
|
4022
|
+
| `fields` | fixed_csv | no | `*` | — | link_id | link_status | author_reputation | author_status | author_role | author_title | author | permlink | … (53 values) |
|
|
4023
|
+
|
|
4024
|
+
### `sds.posts.getBeneficiaries()`
|
|
4025
|
+
|
|
4026
|
+
Returns all beneficiaries of the post with the given :author / :permlink.
|
|
4027
|
+
|
|
4028
|
+
- Route: `/posts_api/getBeneficiaries/:author/:permlink`
|
|
4029
|
+
- Result: JSON Object
|
|
4030
|
+
- Example: `/posts_api/getBeneficiaries/steemit/firstpost`
|
|
4031
|
+
|
|
4032
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4033
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4034
|
+
| `author` | account_name | yes | — | — | — |
|
|
4035
|
+
| `permlink` | string | yes | — | — | — |
|
|
4036
|
+
|
|
4037
|
+
### `sds.posts.getPayout()`
|
|
4038
|
+
|
|
4039
|
+
Returns the payout data of the post with the given :author / :permlink.
|
|
4040
|
+
|
|
4041
|
+
- Route: `/posts_api/getPayout/:author/:permlink/:withVotes?/:withBenefs?`
|
|
4042
|
+
- Result: JSON Object
|
|
4043
|
+
- Example: `/posts_api/getPayout/steemit/firstpost`
|
|
4044
|
+
|
|
4045
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4046
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4047
|
+
| `author` | account_name | yes | — | — | — |
|
|
4048
|
+
| `permlink` | string | yes | — | — | — |
|
|
4049
|
+
| `withVotes` | bool | no | `false` | — | true | false | 1 | 0 |
|
|
4050
|
+
| `withBenefs` | bool | no | `false` | — | true | false | 1 | 0 |
|
|
4051
|
+
|
|
4052
|
+
### `sds.posts.getVotes()`
|
|
4053
|
+
|
|
4054
|
+
Returns all votes of the post with the given :author / :permlink.
|
|
4055
|
+
|
|
4056
|
+
- Route: `/posts_api/getVotes/:author/:permlink`
|
|
4057
|
+
- Result: JSON Object
|
|
4058
|
+
- Example: `/posts_api/getVotes/steemit/firstpost`
|
|
4059
|
+
|
|
4060
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4061
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4062
|
+
| `author` | account_name | yes | — | — | — |
|
|
4063
|
+
| `permlink` | string | yes | — | — | — |
|
|
4064
|
+
|
|
4065
|
+
### `sds.posts.getPostById()`
|
|
4066
|
+
|
|
4067
|
+
Returns the post data for the given :linkId.
|
|
4068
|
+
|
|
4069
|
+
- Route: `/posts_api/getPostById/:linkId/:withVotes?/:observer?/:fields?`
|
|
4070
|
+
- Result: JSON Object
|
|
4071
|
+
- Example: `/posts_api/getPostById/1`
|
|
4072
|
+
|
|
4073
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4074
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4075
|
+
| `linkId` | int | yes | — | ≥ 1 | — |
|
|
4076
|
+
| `withVotes` | bool | no | `true` | — | true | false | 1 | 0 |
|
|
4077
|
+
| `observer` | account_name | no | — | — | — |
|
|
4078
|
+
| `fields` | fixed_csv | no | `*` | — | link_id | link_status | author_reputation | author_status | author_role | author_title | author | permlink | … (53 values) |
|
|
4079
|
+
|
|
4080
|
+
### `sds.posts.getPostRepliesById()`
|
|
4081
|
+
|
|
4082
|
+
Returns all replies of the post with the given :linkId.
|
|
4083
|
+
|
|
4084
|
+
- Route: `/posts_api/getPostRepliesById/:linkId/:withVotes?/:observer?/:fields?`
|
|
4085
|
+
- Result: JSON Object
|
|
4086
|
+
- Example: `/posts_api/getPostRepliesById/1`
|
|
4087
|
+
|
|
4088
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4089
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4090
|
+
| `linkId` | int | yes | — | ≥ 1 | — |
|
|
4091
|
+
| `withVotes` | bool | no | `true` | — | true | false | 1 | 0 |
|
|
4092
|
+
| `observer` | account_name | no | — | — | — |
|
|
4093
|
+
| `fields` | fixed_csv | no | `*` | — | link_id | link_status | author_reputation | author_status | author_role | author_title | author | permlink | … (53 values) |
|
|
4094
|
+
|
|
4095
|
+
### `sds.posts.getPostWithRepliesById()`
|
|
4096
|
+
|
|
4097
|
+
Returns the data and all replies of the post with the given :linkId.
|
|
4098
|
+
|
|
4099
|
+
- Route: `/posts_api/getPostWithRepliesById/:linkId/:withVotes?/:observer?/:fields?`
|
|
4100
|
+
- Result: JSON Object
|
|
4101
|
+
- Example: `/posts_api/getPostWithRepliesById/264480`
|
|
4102
|
+
|
|
4103
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4104
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4105
|
+
| `linkId` | int | yes | — | ≥ 1 | — |
|
|
4106
|
+
| `withVotes` | bool | no | `true` | — | true | false | 1 | 0 |
|
|
4107
|
+
| `observer` | account_name | no | — | — | — |
|
|
4108
|
+
| `fields` | fixed_csv | no | `*` | — | link_id | link_status | author_reputation | author_status | author_role | author_title | author | permlink | … (53 values) |
|
|
4109
|
+
|
|
4110
|
+
### `sds.posts.getBeneficiariesById()`
|
|
4111
|
+
|
|
4112
|
+
Returns all beneficiaries of the post with the given :linkId.
|
|
4113
|
+
|
|
4114
|
+
- Route: `/posts_api/getBeneficiariesById/:linkId`
|
|
4115
|
+
- Result: JSON Object
|
|
4116
|
+
- Example: `/posts_api/getBeneficiariesById/1`
|
|
4117
|
+
|
|
4118
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4119
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4120
|
+
| `linkId` | int | yes | — | ≥ 1 | — |
|
|
4121
|
+
|
|
4122
|
+
### `sds.posts.getPayoutById()`
|
|
4123
|
+
|
|
4124
|
+
Returns the payout data of the post with the given :linkId.
|
|
4125
|
+
|
|
4126
|
+
- Route: `/posts_api/getPayoutById/:linkId/:withVotes?/:withBenefs?`
|
|
4127
|
+
- Result: JSON Object
|
|
4128
|
+
- Example: `/posts_api/getPayoutById/1`
|
|
4129
|
+
|
|
4130
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4131
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4132
|
+
| `linkId` | int | yes | — | ≥ 1 | — |
|
|
4133
|
+
| `withVotes` | bool | no | `false` | — | true | false | 1 | 0 |
|
|
4134
|
+
| `withBenefs` | bool | no | `false` | — | true | false | 1 | 0 |
|
|
4135
|
+
|
|
4136
|
+
### `sds.posts.getVotesById()`
|
|
4137
|
+
|
|
4138
|
+
Returns all votes of the post with the given :linkId.
|
|
4139
|
+
|
|
4140
|
+
- Route: `/posts_api/getVotesById/:linkId`
|
|
4141
|
+
- Result: JSON Object
|
|
4142
|
+
- Example: `/posts_api/getVotesById/1`
|
|
4143
|
+
|
|
4144
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4145
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4146
|
+
| `linkId` | int | yes | — | ≥ 1 | — |
|
|
4147
|
+
|
|
4148
|
+
### `sds.posts.getRootPostsByAuthor()`
|
|
4149
|
+
|
|
4150
|
+
Returns :author's root posts ordered by created time descending.
|
|
4151
|
+
|
|
4152
|
+
- Route: `/posts_api/getRootPostsByAuthor/:author/:withVotes?/:observer?/:fields?/:limit?/:offset?`
|
|
4153
|
+
- Result: JSON Object
|
|
4154
|
+
- Max. limit: 100
|
|
4155
|
+
- Example: `/posts_api/getRootPostsByAuthor/steemit`
|
|
4156
|
+
|
|
4157
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4158
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4159
|
+
| `author` | account_name | yes | — | — | — |
|
|
4160
|
+
| `withVotes` | bool | no | `false` | — | true | false | 1 | 0 |
|
|
4161
|
+
| `observer` | account_name | no | — | — | — |
|
|
4162
|
+
| `fields` | fixed_csv | no | `*` | — | link_id | link_status | author_reputation | author_status | author_role | author_title | author | permlink | … (53 values) |
|
|
4163
|
+
| `limit` | int | no | `10` | 1 – 100 | — |
|
|
4164
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
4165
|
+
|
|
4166
|
+
---
|
|
4167
|
+
|
|
4168
|
+
## `post_resteems_api`
|
|
4169
|
+
|
|
4170
|
+
Namespace: `sds.postResteems` · Group: Posts · 3 methods
|
|
4171
|
+
|
|
4172
|
+
### `sds.postResteems.getConfig()`
|
|
4173
|
+
|
|
4174
|
+
Returns this module's active configuration.
|
|
4175
|
+
|
|
4176
|
+
- Route: `/post_resteems_api/getConfig`
|
|
4177
|
+
- Result: JSON Object
|
|
4178
|
+
- Example: `/post_resteems_api/getConfig`
|
|
4179
|
+
|
|
4180
|
+
_No parameters._
|
|
4181
|
+
|
|
4182
|
+
### `sds.postResteems.getResteems()`
|
|
4183
|
+
|
|
4184
|
+
Returns the resteems for the given :author / :permlink.
|
|
4185
|
+
|
|
4186
|
+
- Route: `/post_resteems_api/getResteems/:author/:permlink/:limit?/:offset?`
|
|
4187
|
+
- Result: JSON Object
|
|
4188
|
+
- Max. limit: 1000
|
|
4189
|
+
- Example: `/post_resteems_api/getResteems/steemit/firstpost`
|
|
4190
|
+
|
|
4191
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4192
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4193
|
+
| `author` | account_name | yes | — | — | — |
|
|
4194
|
+
| `permlink` | string | yes | — | — | — |
|
|
4195
|
+
| `limit` | int | no | `250` | 1 – 1000 | — |
|
|
4196
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
4197
|
+
|
|
4198
|
+
### `sds.postResteems.getResteemsByResteemerTime()`
|
|
4199
|
+
|
|
4200
|
+
Returns the resteems of the given :resteemer in the given time range.
|
|
4201
|
+
**Ranges**: [ { "from": "fromTime", "to": "toTime" } ]
|
|
4202
|
+
|
|
4203
|
+
- Route: `/post_resteems_api/getResteemsByResteemerTime/:resteemer/:fromTime-:toTime/:limit?/:offset?`
|
|
4204
|
+
- Result: JSON Object
|
|
4205
|
+
- Max. limit: 1000
|
|
4206
|
+
- Example: `/post_resteems_api/getResteemsByResteemerTime/steemchiller/1788983274-1789588074`
|
|
4207
|
+
|
|
4208
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4209
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4210
|
+
| `resteemer` | account_name | yes | — | — | — |
|
|
4211
|
+
| `fromTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
4212
|
+
| `toTime` | int (Date / date string / seconds) | yes | — | — | — |
|
|
4213
|
+
| `limit` | int | no | `250` | 1 – 1000 | — |
|
|
4214
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
4215
|
+
|
|
4216
|
+
---
|
|
4217
|
+
|
|
4218
|
+
## `post_tags_api`
|
|
4219
|
+
|
|
4220
|
+
Namespace: `sds.postTags` · Group: Posts · 13 methods
|
|
4221
|
+
|
|
4222
|
+
### `sds.postTags.getConfig()`
|
|
4223
|
+
|
|
4224
|
+
Returns this module's active configuration.
|
|
4225
|
+
|
|
4226
|
+
- Route: `/post_tags_api/getConfig`
|
|
4227
|
+
- Result: JSON Object
|
|
4228
|
+
- Example: `/post_tags_api/getConfig`
|
|
4229
|
+
|
|
4230
|
+
_No parameters._
|
|
4231
|
+
|
|
4232
|
+
### `sds.postTags.getTopPostTags()`
|
|
4233
|
+
|
|
4234
|
+
Returns a list of all in posts used tags, grouped by tag, ordered by usage count descending.
|
|
4235
|
+
|
|
4236
|
+
- Route: `/post_tags_api/getTopPostTags/:limit?/:offset?`
|
|
4237
|
+
- Result: JSON Object
|
|
4238
|
+
- Max. limit: 1000
|
|
4239
|
+
- Example: `/post_tags_api/getTopPostTags`
|
|
4240
|
+
|
|
4241
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4242
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4243
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
4244
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
4245
|
+
|
|
4246
|
+
### `sds.postTags.getTopPostTagsByAuthor()`
|
|
4247
|
+
|
|
4248
|
+
Returns a list of all in :author's posts used tags, grouped by tag, ordered by usage count descending.
|
|
4249
|
+
|
|
4250
|
+
- Route: `/post_tags_api/getTopPostTagsByAuthor/:author/:limit?/:offset?`
|
|
4251
|
+
- Result: JSON Object
|
|
4252
|
+
- Max. limit: 1000
|
|
4253
|
+
- Example: `/post_tags_api/getTopPostTagsByAuthor/steemchiller`
|
|
4254
|
+
|
|
4255
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4256
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4257
|
+
| `author` | account_name | yes | — | — | — |
|
|
4258
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
4259
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
4260
|
+
|
|
4261
|
+
### `sds.postTags.getTopPostTagsByCommunity()`
|
|
4262
|
+
|
|
4263
|
+
Returns a list of all in :community's posts used tags, grouped by tag, ordered by usage count descending.
|
|
4264
|
+
|
|
4265
|
+
- Route: `/post_tags_api/getTopPostTagsByCommunity/:community/:limit?/:offset?`
|
|
4266
|
+
- Result: JSON Object
|
|
4267
|
+
- Max. limit: 1000
|
|
4268
|
+
- Example: `/post_tags_api/getTopPostTagsByCommunity/hive-172186`
|
|
4269
|
+
|
|
4270
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4271
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4272
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
4273
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
4274
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
4275
|
+
|
|
4276
|
+
### `sds.postTags.getTopActivePostTags()`
|
|
4277
|
+
|
|
4278
|
+
Returns a list of all in active posts used tags, grouped by tag, ordered by usage count descending.
|
|
4279
|
+
|
|
4280
|
+
- Route: `/post_tags_api/getTopActivePostTags/:limit?/:offset?`
|
|
4281
|
+
- Result: JSON Object
|
|
4282
|
+
- Max. limit: 1000
|
|
4283
|
+
- Example: `/post_tags_api/getTopActivePostTags`
|
|
4284
|
+
|
|
4285
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4286
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4287
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
4288
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
4289
|
+
|
|
4290
|
+
### `sds.postTags.getTopActivePostTagsByAuthor()`
|
|
4291
|
+
|
|
4292
|
+
Returns a list of all in :author's active posts used tags, grouped by tag, ordered by usage count descending.
|
|
4293
|
+
|
|
4294
|
+
- Route: `/post_tags_api/getTopActivePostTagsByAuthor/:author/:limit?/:offset?`
|
|
4295
|
+
- Result: JSON Object
|
|
4296
|
+
- Max. limit: 1000
|
|
4297
|
+
- Example: `/post_tags_api/getTopActivePostTagsByAuthor/steemchiller`
|
|
4298
|
+
|
|
4299
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4300
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4301
|
+
| `author` | account_name | yes | — | — | — |
|
|
4302
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
4303
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
4304
|
+
|
|
4305
|
+
### `sds.postTags.getTopActivePostTagsByCommunity()`
|
|
4306
|
+
|
|
4307
|
+
Returns a list of all in :community's active posts used tags, grouped by tag, ordered by usage count descending.
|
|
4308
|
+
|
|
4309
|
+
- Route: `/post_tags_api/getTopActivePostTagsByCommunity/:community/:limit?/:offset?`
|
|
4310
|
+
- Result: JSON Object
|
|
4311
|
+
- Max. limit: 1000
|
|
4312
|
+
- Example: `/post_tags_api/getTopActivePostTagsByCommunity/hive-172186`
|
|
4313
|
+
|
|
4314
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4315
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4316
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
4317
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
4318
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
4319
|
+
|
|
4320
|
+
### `sds.postTags.getTopCommentTags()`
|
|
4321
|
+
|
|
4322
|
+
Returns a list of all in comments used tags, grouped by tag, ordered by usage count descending.
|
|
4323
|
+
|
|
4324
|
+
- Route: `/post_tags_api/getTopCommentTags/:limit?/:offset?`
|
|
4325
|
+
- Result: JSON Object
|
|
4326
|
+
- Max. limit: 1000
|
|
4327
|
+
- Example: `/post_tags_api/getTopCommentTags`
|
|
4328
|
+
|
|
4329
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4330
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4331
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
4332
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
4333
|
+
|
|
4334
|
+
### `sds.postTags.getTopCommentTagsByAuthor()`
|
|
4335
|
+
|
|
4336
|
+
Returns a list of all in :author's comments used tags, grouped by tag, ordered by usage count descending.
|
|
4337
|
+
|
|
4338
|
+
- Route: `/post_tags_api/getTopCommentTagsByAuthor/:author/:limit?/:offset?`
|
|
4339
|
+
- Result: JSON Object
|
|
4340
|
+
- Max. limit: 1000
|
|
4341
|
+
- Example: `/post_tags_api/getTopCommentTagsByAuthor/steemchiller`
|
|
4342
|
+
|
|
4343
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4344
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4345
|
+
| `author` | account_name | yes | — | — | — |
|
|
4346
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
4347
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
4348
|
+
|
|
4349
|
+
### `sds.postTags.getTopCommentTagsByCommunity()`
|
|
4350
|
+
|
|
4351
|
+
Returns a list of all in :community's comments used tags, grouped by tag, ordered by usage count descending.
|
|
4352
|
+
|
|
4353
|
+
- Route: `/post_tags_api/getTopCommentTagsByCommunity/:community/:limit?/:offset?`
|
|
4354
|
+
- Result: JSON Object
|
|
4355
|
+
- Max. limit: 1000
|
|
4356
|
+
- Example: `/post_tags_api/getTopCommentTagsByCommunity/hive-172186`
|
|
4357
|
+
|
|
4358
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4359
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4360
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
4361
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
4362
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
4363
|
+
|
|
4364
|
+
### `sds.postTags.getTopActiveCommentTags()`
|
|
4365
|
+
|
|
4366
|
+
Returns a list of all in active comments used tags, grouped by tag, ordered by usage count descending.
|
|
4367
|
+
|
|
4368
|
+
- Route: `/post_tags_api/getTopActiveCommentTags/:limit?/:offset?`
|
|
4369
|
+
- Result: JSON Object
|
|
4370
|
+
- Max. limit: 1000
|
|
4371
|
+
- Example: `/post_tags_api/getTopActiveCommentTags`
|
|
4372
|
+
|
|
4373
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4374
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4375
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
4376
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
4377
|
+
|
|
4378
|
+
### `sds.postTags.getTopActiveCommentTagsByAuthor()`
|
|
4379
|
+
|
|
4380
|
+
Returns a list of all in :author's active comments used tags, grouped by tag, ordered by usage count descending.
|
|
4381
|
+
|
|
4382
|
+
- Route: `/post_tags_api/getTopActiveCommentTagsByAuthor/:author/:limit?/:offset?`
|
|
4383
|
+
- Result: JSON Object
|
|
4384
|
+
- Max. limit: 1000
|
|
4385
|
+
- Example: `/post_tags_api/getTopActiveCommentTagsByAuthor/steemchiller`
|
|
4386
|
+
|
|
4387
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4388
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4389
|
+
| `author` | account_name | yes | — | — | — |
|
|
4390
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
4391
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
4392
|
+
|
|
4393
|
+
### `sds.postTags.getTopActiveCommentTagsByCommunity()`
|
|
4394
|
+
|
|
4395
|
+
Returns a list of all in :community's active comments used tags, grouped by tag, ordered by usage count descending.
|
|
4396
|
+
|
|
4397
|
+
- Route: `/post_tags_api/getTopActiveCommentTagsByCommunity/:community/:limit?/:offset?`
|
|
4398
|
+
- Result: JSON Object
|
|
4399
|
+
- Max. limit: 1000
|
|
4400
|
+
- Example: `/post_tags_api/getTopActiveCommentTagsByCommunity/hive-172186`
|
|
4401
|
+
|
|
4402
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4403
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4404
|
+
| `community` | account_name (e.g. `hive-160125`) | yes | — | — | — |
|
|
4405
|
+
| `limit` | int | no | `100` | 1 – 1000 | — |
|
|
4406
|
+
| `offset` | int | no | `0` | ≥ 0 | — |
|
|
4407
|
+
|
|
4408
|
+
---
|
|
4409
|
+
|
|
4410
|
+
## `system_api`
|
|
4411
|
+
|
|
4412
|
+
Namespace: `sds.system` · Group: System · 5 methods
|
|
4413
|
+
|
|
4414
|
+
### `sds.system.getDataSources()`
|
|
4415
|
+
|
|
4416
|
+
Returns data source state information.
|
|
4417
|
+
|
|
4418
|
+
- Route: `/system_api/getDataSources`
|
|
4419
|
+
- Result: JSON Object
|
|
4420
|
+
- Example: `/system_api/getDataSources`
|
|
4421
|
+
|
|
4422
|
+
_No parameters._
|
|
4423
|
+
|
|
4424
|
+
### `sds.system.getState()`
|
|
4425
|
+
|
|
4426
|
+
Returns general system state information.
|
|
4427
|
+
|
|
4428
|
+
- Route: `/system_api/getState`
|
|
4429
|
+
- Result: JSON Object
|
|
4430
|
+
- Example: `/system_api/getState`
|
|
4431
|
+
|
|
4432
|
+
_No parameters._
|
|
4433
|
+
|
|
4434
|
+
### `sds.system.getVersion()`
|
|
4435
|
+
|
|
4436
|
+
Returns the currently running SDS version.
|
|
4437
|
+
|
|
4438
|
+
- Route: `/system_api/getVersion`
|
|
4439
|
+
- Result: String
|
|
4440
|
+
- Example: `/system_api/getVersion`
|
|
4441
|
+
|
|
4442
|
+
_No parameters._
|
|
4443
|
+
|
|
4444
|
+
### `sds.system.hasMethod()`
|
|
4445
|
+
|
|
4446
|
+
Checks if a request handler for :moduleId/:methodId exists in this instance.
|
|
4447
|
+
|
|
4448
|
+
- Route: `/system_api/hasMethod/:moduleId/:methodId`
|
|
4449
|
+
- Result: Boolean
|
|
4450
|
+
- Example: `/system_api/hasMethod/blocks_api/getBlock`
|
|
4451
|
+
|
|
4452
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4453
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4454
|
+
| `moduleId` | string | yes | — | — | — |
|
|
4455
|
+
| `methodId` | string | yes | — | — | — |
|
|
4456
|
+
|
|
4457
|
+
### `sds.system.hasModule()`
|
|
4458
|
+
|
|
4459
|
+
Checks if a module with :moduleId is active in this instance.
|
|
4460
|
+
|
|
4461
|
+
- Route: `/system_api/hasModule/:moduleId`
|
|
4462
|
+
- Result: Boolean
|
|
4463
|
+
- Example: `/system_api/hasModule/blocks_api`
|
|
4464
|
+
|
|
4465
|
+
| Parameter | Type | Required | Default | Range | Allowed values |
|
|
4466
|
+
| --- | --- | --- | --- | --- | --- |
|
|
4467
|
+
| `moduleId` | string | yes | — | — | — |
|
|
4468
|
+
|