Steemit REST API documentation - Part 1 by joomla-tips

View this thread on: hive.blog | peakd.com | ecency.com

steemjs · @joomla-tips · Aug 13 '16 (edited)

Steemit REST API documentation - Part 1

<html>
<p>This is a first simple tutorial on using some of the methods of the SteemJS&nbsp;npm package via a REST API.</p>
<p>SteemJS is a Javascript API for the Steem Blockchain developed and maintained by @fabien. See original posts by @fabien at: &nbsp;</p>
<ul>
  <li><a href="https://steemit.com/steemjs/@fabien/steemjs-new-npm-package-for-javascript-lovers">SteemJS : the library for JavaScript lovers</a></li>
  <li><a href="https://steemit.com/steemjs/@fabien/steemjs">SteemJS: Explore Steem blockchain! New update with full database API methods coverage</a></li>
  <li><a href="https://steemit.com/steemjs/@fabien/steem-api-now-released">Steem API: Now Released!</a></li>
</ul>
<p><img src="https://dl.dropboxusercontent.com/u/552542683/SteemJS-intro.png" /></p>
<h2>REST API Methods</h2>
<h3><br></h3>
<h3>&nbsp;Get Trending Tags</h3>
<p><code>https://api.steemjs.com/getTrendingTags?afterTag=funny&amp;limit=100</code></p>
<p><strong>afterTag</strong><em>: </em>tag name</p>
<p><strong>limit:&nbsp;</strong>tags count</p>
<p><br></p>
<h3>Get Block Header</h3>
<p><code>https://api.steemjs.com/getBlockHeader?blockNum=68456</code></p>
<p><strong>blockNum</strong><em>: </em>block number</p>
<p><br></p>
<h3>Get Block</h3>
<p><code>https://api.steemjs.com/getBlock?blockNum=214</code></p>
<p><strong>blockNum</strong><em>: </em>block number</p>
<p><br></p>
<h3>Get State</h3>
<p><code>https://api.steemjs.com/getState?path=/trending/funny</code></p>
<p>or you can use a scope</p>
<p><code>https://api.steemjs.com/getState?path=/trending/funny&amp;scope=content</code></p>
<p><strong>path</strong><em>: </em>specify path</p>
<p><strong>scope</strong>: eg: content</p>
<p><br></p>
<h3>Get Trending Categories</h3>
<p><code>https://api.steemjs.com/getTrendingCategories?after=joomla&amp;limit=100</code></p>
<p><strong>after</strong><em>: </em>category name</p>
<p><strong>limit</strong>: categories count</p>
<p><br></p>
<h3>Get Config</h3>
<p><code>https://api.steemjs.com/getConfig</code></p>
<p><br></p>
<h3>Get Dynamic Global Properties</h3>
<p><code>https://api.steemjs.com/getDynamicGlobalProperties</code></p>
<p><br></p>
<h3>Get Chain Properties</h3>
<p><code>https://api.steemjs.com/getChainProperties</code></p>
<p><br></p>
<h3>Get Feed History</h3>
<p><code>https://api.steemjs.com/getFeedHistory</code></p>
<p><br></p>
<h3>Get Current Median History Price</h3>
<p><code>https://api.steemjs.com/getCurrentMedianHistoryPrice</code></p>
<p><br></p>
<h3>Get Witness Schedule</h3>
<p><code>https://api.steemjs.com/getWitnessSchedule</code></p>
<p><br></p>
<h3>Get Hardfork Version</h3>
<p><code>https://api.steemjs.com/getHardforkVersion</code></p>
<p><br></p>
<h3>Get Next Scheduled Hardfork</h3>
<p><code>https://api.steemjs.com/getNextScheduledHardfork</code></p>
<p><br></p>
<h3>Get Accounts</h3>
<p><code>https://api.steemjs.com/getAccounts?names[]=ned&amp;names[]=joomla-tips</code></p>
<p><strong>names[]</strong><em>: </em>account name</p>
<p><br></p>
<h3>Lookup Account Names</h3>
<p><code>https://api.steemjs.com/lookupAccountNames?accountNames[]=dollarvigilante&amp;accountNames[]=joomla-tips</code></p>
<p><strong>accountNames[]</strong><em>: </em>account name</p>
<p><br></p>
<h3>Get Account Count</h3>
<p><code>https://api.steemjs.com/getAccountCount</code></p>
<p><br></p>
<h3>Get Conversion Requests</h3>
<p><code>https://api.steemjs.com/getConversionRequests?accountName=dollarvigilante</code></p>
<p><strong>accountName</strong><em>: </em>account name</p>
<p><br></p>
<h3>Get Order Book</h3>
<p><code>https://api.steemjs.com/getOrderBook?limit=100</code></p>
<p><strong>limit</strong><em>: </em>orders count</p>
<p><br></p>
<h3>Get Account Votes</h3>
<p><code>https://api.steemjs.com/getAccountVotes?voter=ned</code></p>
<p><strong>voter</strong><em>: </em>voter name</p>
<p><br></p>
<h3>Get Content</h3>
<p><code>https://api.steemjs.com/getContent?author=dollarvigilante&amp;permlink=could-steem-be-the-gateway-drug-to-mainstream-cryptocurrency-usage-and-the-end-of-central-banks-and-government</code></p>
<p><strong>author</strong><em>: </em>author name</p>
<p><strong>permlink</strong>: post permlink</p>
<p><br></p>
<p><br></p>
<p><br></p>
</html>

👍 fabien, antizvuk, tomoaki, allmonitors, joomla-tips, minitek, thekao, quochuy, hoffmann, neversmile12b1, crypto570, staticinstance, ar2ro

`author`	joomla-tips
`permlink`	steemit-rest-api-documentation-part-1
`category`	steemjs
`json_metadata`	{"tags":["steemjs","steem-api","steem","programming"],"users":["fabien"],"links":["https://steemit.com/steemjs/@fabien/steemjs-new-npm-package-for-javascript-lovers","https://steemit.com/steemjs/@fabien/steemjs","https://steemit.com/steemjs/@fabien/steem-api-now-released"],"image":["https://dl.dropboxusercontent.com/u/552542683/SteemJS-intro.png"]}
`created`	2016-08-13 17:09:39
`last_update`	2016-08-13 17:11:48
`depth`	0
`children`	11
`last_payout`	2016-09-13 05:41:51
`cashout_time`	1969-12-31 23:59:59
`total_payout_value`	0.000 HBD
`curator_payout_value`	0.000 HBD
`pending_payout_value`	0.000 HBD
`promoted`	0.000 HBD
`body_length`	4,183
`author_reputation`	88,503,590,937
`root_title`	"Steemit REST API documentation - Part 1"
`beneficiaries`	`[]`
`max_accepted_payout`	1,000,000.000 HBD
`percent_hbd`	10,000
`post_id`	785,287
`net_rshares`	25,068,819,367
`author_curate_reward`	""

properties (23)vote details (13)

voter	rshares	pct
antizvuk	3,452,750,703	100%
allmonitors	606,171,414	100%
fabien	18,648,831,056	100%
ar2ro	0	100%
tomoaki	2,191,235,220	100%
minitek	57,079,325	100%
joomla-tips	57,976,055	100%
thekao	54,775,594	100%
staticinstance	0	100%
crypto570	0	100%
neversmile12b1	0	100%
hoffmann	0	100%
quochuy	0	100%

@neversmile12b1 · Feb 2 '18

Awesome, how do you find out these apis? Could you please release part 2?

properties (22)

`author`	neversmile12b1
`permlink`	re-joomla-tips-steemit-rest-api-documentation-part-1-20180202t062258856z
`category`	steemjs
`json_metadata`	{"tags":["steemjs"],"app":"steemit/0.1"}
`created`	2018-02-02 06:23:00
`last_update`	2018-02-02 06:23:00
`depth`	1
`children`	0
`last_payout`	2018-02-09 06:23:00
`cashout_time`	1969-12-31 23:59:59
`total_payout_value`	0.000 HBD
`curator_payout_value`	0.000 HBD
`pending_payout_value`	0.000 HBD
`promoted`	0.000 HBD
`body_length`	73
`author_reputation`	4,313,287,532
`root_title`	"Steemit REST API documentation - Part 1"
`beneficiaries`	`[]`
`max_accepted_payout`	1,000,000.000 HBD
`percent_hbd`	10,000
`post_id`	34,323,347
`net_rshares`	0

@staticinstance · Aug 2 '17

This is awesome, thanks!

properties (22)

`author`	staticinstance
`permlink`	re-joomla-tips-steemit-rest-api-documentation-part-1-20170802t035307503z
`category`	steemjs
`json_metadata`	{"tags":["steemjs"],"app":"steemit/0.1"}
`created`	2017-08-02 03:53:06
`last_update`	2017-08-02 03:53:06
`depth`	1
`children`	0
`last_payout`	2017-08-09 03:53:06
`cashout_time`	1969-12-31 23:59:59
`total_payout_value`	0.000 HBD
`curator_payout_value`	0.000 HBD
`pending_payout_value`	0.000 HBD
`promoted`	0.000 HBD
`body_length`	24
`author_reputation`	23,856,326,319,736
`root_title`	"Steemit REST API documentation - Part 1"
`beneficiaries`	`[]`
`max_accepted_payout`	1,000,000.000 HBD
`percent_hbd`	10,000
`post_id`	10,497,849
`net_rshares`	0

@t3ran13 · Sep 5 '16 (edited)

how can i get user blog posts list?

👍 fastnabus

`author`	t3ran13
`permlink`	re-joomla-tips-steemit-rest-api-documentation-part-1-20160905t082208740z
`category`	steemjs
`json_metadata`	{"tags":["steemjs"]}
`created`	2016-09-05 08:22:09
`last_update`	2016-09-05 17:33:42
`depth`	1
`children`	0
`last_payout`	2016-09-13 05:41:51
`cashout_time`	1969-12-31 23:59:59
`total_payout_value`	0.000 HBD
`curator_payout_value`	0.000 HBD
`pending_payout_value`	0.000 HBD
`promoted`	0.000 HBD
`body_length`	35
`author_reputation`	50,037,290,585,145
`root_title`	"Steemit REST API documentation - Part 1"
`beneficiaries`	`[]`
`max_accepted_payout`	1,000,000.000 HBD
`percent_hbd`	10,000
`post_id`	1,131,596
`net_rshares`	0
`author_curate_reward`	""

properties (23)vote details (1)

voter	weight	wgt%	rshares	pct	time
fastnabus	0 B		0	0%

@the5kyliner · Sep 21 '17

Is there any way on posting on steem via JS API?

properties (22)

`author`	the5kyliner
`permlink`	re-joomla-tips-steemit-rest-api-documentation-part-1-20170921t200722720z
`category`	steemjs
`json_metadata`	{"tags":["steemjs"],"app":"steemit/0.1"}
`created`	2017-09-21 20:06:51
`last_update`	2017-09-21 20:06:51
`depth`	1
`children`	0
`last_payout`	2017-09-28 20:06:51
`cashout_time`	1969-12-31 23:59:59
`total_payout_value`	0.000 HBD
`curator_payout_value`	0.000 HBD
`pending_payout_value`	0.000 HBD
`promoted`	0.000 HBD
`body_length`	48
`author_reputation`	2,984,047,975,687
`root_title`	"Steemit REST API documentation - Part 1"
`beneficiaries`	`[]`
`max_accepted_payout`	1,000,000.000 HBD
`percent_hbd`	10,000
`post_id`	15,554,956
`net_rshares`	0

@tomoaki · Aug 22 '16

will post request API be made ?

properties (22)

`author`	tomoaki
`permlink`	re-joomla-tips-steemit-rest-api-documentation-part-1-20160822t102524004z
`category`	steemjs
`json_metadata`	{"tags":["steemjs"]}
`created`	2016-08-22 10:25:24
`last_update`	2016-08-22 10:25:24
`depth`	1
`children`	5
`last_payout`	2016-09-13 05:41:51
`cashout_time`	1969-12-31 23:59:59
`total_payout_value`	0.000 HBD
`curator_payout_value`	0.000 HBD
`pending_payout_value`	0.000 HBD
`promoted`	0.000 HBD
`body_length`	31
`author_reputation`	630,154,656
`root_title`	"Steemit REST API documentation - Part 1"
`beneficiaries`	`[]`
`max_accepted_payout`	1,000,000.000 HBD
`percent_hbd`	10,000
`post_id`	932,643
`net_rshares`	0

@joomla-tips · Aug 22 '16

Unfortunately this is not publicly available yet but it will be in a few weeks. I will post a new updated article with more methods.

properties (22)

`author`	joomla-tips
`permlink`	re-tomoaki-re-joomla-tips-steemit-rest-api-documentation-part-1-20160822t160107397z
`category`	steemjs
`json_metadata`	{"tags":["steemjs"]}
`created`	2016-08-22 16:01:06
`last_update`	2016-08-22 16:01:06
`depth`	2
`children`	4
`last_payout`	2016-09-13 05:41:51
`cashout_time`	1969-12-31 23:59:59
`total_payout_value`	0.000 HBD
`curator_payout_value`	0.000 HBD
`pending_payout_value`	0.000 HBD
`promoted`	0.000 HBD
`body_length`	132
`author_reputation`	88,503,590,937
`root_title`	"Steemit REST API documentation - Part 1"
`beneficiaries`	`[]`
`max_accepted_payout`	1,000,000.000 HBD
`percent_hbd`	10,000
`post_id`	936,347
`net_rshares`	0

@faddat · Aug 25 '16

How can I get a category returned to me as JSON?

properties (22)

`author`	faddat
`permlink`	re-joomla-tips-re-tomoaki-re-joomla-tips-steemit-rest-api-documentation-part-1-20160825t014838340z
`category`	steemjs
`json_metadata`	{"tags":["steemjs"]}
`created`	2016-08-25 01:47:45
`last_update`	2016-08-25 01:47:45
`depth`	3
`children`	0
`last_payout`	2016-09-13 05:41:51
`cashout_time`	1969-12-31 23:59:59
`total_payout_value`	0.000 HBD
`curator_payout_value`	0.000 HBD
`pending_payout_value`	0.000 HBD
`promoted`	0.000 HBD
`body_length`	48
`author_reputation`	36,581,868,473,026
`root_title`	"Steemit REST API documentation - Part 1"
`beneficiaries`	`[]`
`max_accepted_payout`	1,000,000.000 HBD
`percent_hbd`	10,000
`post_id`	976,232
`net_rshares`	0

@igloro · Jan 2 '18

Still no ability to make post with API ?

properties (22)

`author`	igloro
`permlink`	re-joomla-tips-re-tomoaki-re-joomla-tips-steemit-rest-api-documentation-part-1-20180102t140810054z
`category`	steemjs
`json_metadata`	{"tags":["steemjs"],"app":"steemit/0.1"}
`created`	2018-01-02 14:08:06
`last_update`	2018-01-02 14:08:06
`depth`	3
`children`	0
`last_payout`	2018-01-09 14:08:06
`cashout_time`	1969-12-31 23:59:59
`total_payout_value`	0.000 HBD
`curator_payout_value`	0.000 HBD
`pending_payout_value`	0.000 HBD
`promoted`	0.000 HBD
`body_length`	40
`author_reputation`	11,402,779,056
`root_title`	"Steemit REST API documentation - Part 1"
`beneficiaries`	`[]`
`max_accepted_payout`	1,000,000.000 HBD
`percent_hbd`	10,000
`post_id`	26,565,696
`net_rshares`	0

@indominus · May 22 '17

Did the post API ever get added?

properties (22)

`author`	indominus
`permlink`	re-joomla-tips-re-tomoaki-re-joomla-tips-steemit-rest-api-documentation-part-1-20170522t071510046z
`category`	steemjs
`json_metadata`	{"tags":["steemjs"],"app":"steemit/0.1"}
`created`	2017-05-22 07:15:09
`last_update`	2017-05-22 07:15:09
`depth`	3
`children`	1
`last_payout`	2017-05-29 07:15:09
`cashout_time`	1969-12-31 23:59:59
`total_payout_value`	0.000 HBD
`curator_payout_value`	0.000 HBD
`pending_payout_value`	0.000 HBD
`promoted`	0.000 HBD
`body_length`	32
`author_reputation`	6,059,351,799
`root_title`	"Steemit REST API documentation - Part 1"
`beneficiaries`	`[]`
`max_accepted_payout`	1,000,000.000 HBD
`percent_hbd`	10,000
`post_id`	3,654,667
`net_rshares`	0

1 reply

@yurtsevt · Aug 24 '17

Is this api currently active? I need a stable api for some testings, thank you.

👍 yurtsevt

`author`	yurtsevt
`permlink`	re-joomla-tips-steemit-rest-api-documentation-part-1-20170824t002419112z
`category`	steemjs
`json_metadata`	{"tags":["steemjs"],"app":"steemit/0.1"}
`created`	2017-08-24 00:24:18
`last_update`	2017-08-24 00:24:18
`depth`	1
`children`	0
`last_payout`	2017-08-31 00:24:18
`cashout_time`	1969-12-31 23:59:59
`total_payout_value`	0.000 HBD
`curator_payout_value`	0.000 HBD
`pending_payout_value`	0.000 HBD
`promoted`	0.000 HBD
`body_length`	79
`author_reputation`	1,521,137,589
`root_title`	"Steemit REST API documentation - Part 1"
`beneficiaries`	`[]`
`max_accepted_payout`	1,000,000.000 HBD
`percent_hbd`	10,000
`post_id`	12,688,155
`net_rshares`	0
`author_curate_reward`	""

properties (23)vote details (1)

voter	weight	wgt%	rshares	pct	time
yurtsevt	0 B		0	100%