Hive Docs - API Definitions
While the condenser_api.* calls are ready for use, all other appbase methods are currently works in progress and may change, or be unsuitable for production use.
Condenser Api
Methods:
To help with this transition, we created condenser_api, which contains all of the API methods that currently exist and uses the existing argument formatting. The easiest way to get your app to work with Appbase is to change the api to condenser_api.
All calls in condenser_api will return [] as the argument, as the array argument passing is opaque and implemented in the API calls themselves. They follow the current argument formatting. Existing apps should only need to skip using login_api and send all of their calls to condenser_api without any other changes required to use Appbase.
For example, calling get_dynamic_global_properties with condenser_api vs database_api:
{"jsonrpc":"2.0", "method":"condenser_api.get_dynamic_global_properties", "params":[], "id":1}
{"jsonrpc":"2.0", "method":"database_api.get_dynamic_global_properties", "id":1}
Because the method has no arguments, the params field can be omitted when not using condenser_api. However, it can optionally be included as the void type (e.g. "params":{}) but it is not required.
condenser_api.broadcast_block
Used to broadcast a block.
Also see: network_broadcast_api.broadcast_block
Query Parameters JSON
[
{
"previous": "0000000000000000000000000000000000000000",
"timestamp": "1970-01-01T00:00:00",
"witness": "",
"transaction_merkle_root": "0000000000000000000000000000000000000000",
"extensions": [],
"witness_signature": "0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"transactions": []
}
]
Expected Response JSON
{}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.broadcast_block", "params":[{"previous":"0000000000000000000000000000000000000000","timestamp":"1970-01-01T00:00:00","witness":"","transaction_merkle_root":"0000000000000000000000000000000000000000","extensions":[],"witness_signature":"0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000","transactions":[]}], "id":1}' https://api.steemit.com
condenser_api.broadcast_transaction
Used to broadcast a transaction.
Also see: network_broadcast_api.broadcast_transaction
Query Parameters JSON
[
{
"ref_block_num": 0,
"ref_block_prefix": 0,
"expiration": "1970-01-01T00:00:00",
"operations": [],
"extensions": [],
"signatures": []
}
]
Expected Response JSON
{}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.broadcast_transaction", "params":[{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[["vote",{"voter":"steemit","author":"alice","permlink":"a-post-by-alice","weight":10000}]],"extensions":[],"signatures":[]}], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.broadcast_transaction", "params":[{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[["pow",{"worker_account":"cloop3","block_id":"00000449f7860b82b4fbe2f317c670e9f01d6d9a","nonce":3899,"work":{"worker":"STM7P5TDnA87Pj9T4mf6YHrhzjC1KbPZpNxLWCcVcHxNYXakpoT4F","input":"ae8e7c677119d22385f8c48026fee7aad7bba693bf788d7f27047f40b47738c0","signature":"1f38fe9a3f9989f84bd94aa5bbc88beaf09b67f825aa4450cf5105d111149ba6db560b582c7dbb026c7fc9c2eb5051815a72b17f6896ed59d3851d9a0f9883ca7a","work":"000e7b209d58f2e64b36e9bf12b999c6c7af168cc3fc41eb7f8a4bf796c174c3"},"props":{"account_creation_fee":"100.000 STEEM","maximum_block_size":131072,"sbd_interest_rate":1000}}]],"extensions":[],"signatures":[]}], "id":1}' https://api.steemit.com
condenser_api.broadcast_transaction_synchronous
Used to broadcast a transaction and waits for it to be processed synchronously.
Query Parameters JSON
[
{
"ref_block_num": 0,
"ref_block_prefix": 0,
"expiration": "1970-01-01T00:00:00",
"operations": [],
"extensions": [],
"signatures": []
}
]
Expected Response JSON
{
"id": "0000000000000000000000000000000000000000",
"block_num": 0,
"trx_num": 0,
"expired": false
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.broadcast_transaction_synchronous", "params":[{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[["vote",{"voter":"steemit","author":"alice","permlink":"a-post-by-alice","weight":10000}]],"extensions":[],"signatures":[]}], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.broadcast_transaction_synchronous", "params":[{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[["pow",{"worker_account":"cloop3","block_id":"00000449f7860b82b4fbe2f317c670e9f01d6d9a","nonce":3899,"work":{"worker":"STM7P5TDnA87Pj9T4mf6YHrhzjC1KbPZpNxLWCcVcHxNYXakpoT4F","input":"ae8e7c677119d22385f8c48026fee7aad7bba693bf788d7f27047f40b47738c0","signature":"1f38fe9a3f9989f84bd94aa5bbc88beaf09b67f825aa4450cf5105d111149ba6db560b582c7dbb026c7fc9c2eb5051815a72b17f6896ed59d3851d9a0f9883ca7a","work":"000e7b209d58f2e64b36e9bf12b999c6c7af168cc3fc41eb7f8a4bf796c174c3"},"props":{"account_creation_fee":"100.000 STEEM","maximum_block_size":131072,"sbd_interest_rate":1000}}]],"extensions":[],"signatures":[]}], "id":1}' https://api.steemit.com
- Disabled
- Related
condenser_api.get_account_bandwidth
Disabled since 0.20.6, see: #3029
Returns the available bandwidth of an account. Parameters: account:string; type:string, e.g.: forum or market
account (string) |
type (string) |
|
|---|---|---|
"steemit" |
"forum" |
Query the available forum bandwidth for the account named “steemit”. |
"alice" |
"market" |
Query the available market bandwidth for the account named “alice”. |
Query Parameters JSON
["steemit", "forum"]
Expected Response JSON
{
"id": 8,
"account": "steemit",
"type": "forum",
"average_bandwidth": 214996934,
"lifetime_bandwidth": "48395000000",
"last_bandwidth_update": "2018-02-16T03:11:00"
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_account_bandwidth", "params":["steemit","forum"], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_account_bandwidth", "params":["alice","market"], "id":1}' https://api.steemit.com
condenser_api.get_account_count
Returns the number of accounts.
Query Parameters JSON
[]
Expected Response JSON
0
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_account_count", "params":[], "id":1}' https://api.steemit.com
condenser_api.get_account_history
Returns a history of all operations for a given account. Parameters: account:string; start:int. e.g.: -1 for reverse history or any positive numeric; limit:int up to 10000
account (string) |
start (int) |
limit (int) |
|
|---|---|---|---|
"steemit" |
1000 |
1000 |
Queries the account named steemit starting on the latest item in history, up to 1,000 results. |
"alice" |
-1 |
10000 |
Queries the account named alice starting on the oldest item in history, up to 10,000 results. |
Also see: account_history_api.get_account_history, Paginated API Methods
Query Parameters JSON
["", 0, 1000]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_account_history", "params":["steemit", 1000, 1000], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_account_history", "params":["steemit", -1, 10000], "id":1}' https://api.steemit.com
- Since: HF13
- Related
condenser_api.get_account_reputations
Returns a list of account reputations. Parameters: account_lower_bound:string; limit:int up to 1000
account_lower_bound (string) |
limit (int) |
|
|---|---|---|
"steemit" |
1 |
Queries for accounts that start with “steemit”, only one result. |
"a" |
10 |
Queries for accounts that start with “a”, up to 10 results. |
Also see: follow_api.get_account_reputations
Query Parameters JSON
["", 1000]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_account_reputations", "params":["steemit", 1], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_account_reputations", "params":["a", 10], "id":1}' https://api.steemit.com
condenser_api.get_account_votes
Returns all votes by an account. Parameters: account:string
account (string) |
|
|---|---|
"steemit" |
Queries for votes by “steemit”. |
"alice" |
Queries for votes by “alice”. |
Query Parameters JSON
[""]
Expected Response JSON
[
{
"authorperm": "",
"weight": "",
"rshares": "",
"percent": null,
"time": "2016-04-29T22:27:42"
}
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_account_votes", "params":["steemit"], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_account_votes", "params":["alice"], "id":1}' https://api.steemit.com
condenser_api.get_accounts
Returns accounts, queried by name. Parameters: account:string array
account (string array) |
|
|---|---|
["steemit"] |
Queries for account named “steemit”. |
["steemit", "alice"] |
Queries for accounts named “steemit” and “alice”. |
Also see: database_api.find_accounts
Query Parameters JSON
[[""]]
Expected Response JSON
[
{
"id": 0,
"name": "",
"owner": {
"weight_threshold": 0,
"account_auths": [],
"key_auths": [["", 0], ["", 0], ["", 0]]
},
"active": {
"weight_threshold": 0,
"account_auths": [],
"key_auths": [["", 0], ["", 0]]
},
"posting": {
"weight_threshold": 0,
"account_auths": [],
"key_auths": [["", 0], ["", 0], ["", 0]]
},
"memo_key": "",
"json_metadata": "",
"proxy": "",
"last_owner_update": "2017-03-16T21:17:51",
"last_account_update": "2017-03-16T23:10:36",
"created": "2016-03-24T17:00:21",
"mined": false,
"recovery_account": "",
"last_account_recovery": "1970-01-01T00:00:00",
"reset_account": "null",
"comment_count": 0,
"lifetime_vote_count": 0,
"post_count": 0,
"can_vote": false,
"voting_power": 0,
"last_vote_time": "2016-12-04T23:10:57",
"balance": "0.000 STEEM",
"savings_balance": "0.0 STEEM",
"sbd_balance": "0.0 SBD",
"sbd_seconds": "",
"sbd_seconds_last_update": "2018-04-10T04:08:36",
"sbd_last_interest_payment": "2018-03-15T17:58:24",
"savings_sbd_balance": "0.000 SBD",
"savings_sbd_seconds": "",
"savings_sbd_seconds_last_update": "1970-01-01T00:00:00",
"savings_sbd_last_interest_payment": "1970-01-01T00:00:00",
"savings_withdraw_requests": 0,
"reward_sbd_balance": "0.000 SBD",
"reward_steem_balance": "0.000 STEEM",
"reward_vesting_balance": "0.000000 VESTS",
"reward_vesting_steem": "0.000 STEEM",
"vesting_shares": "0.000 VESTS",
"delegated_vesting_shares": "0.000000 VESTS",
"received_vesting_shares": "0.000000 VESTS",
"vesting_withdraw_rate": "0.000000 VESTS",
"next_vesting_withdrawal": "1969-12-31T23:59:59",
"withdrawn": 0,
"to_withdraw": 0,
"withdraw_routes": 0,
"curation_rewards": 0,
"posting_rewards": 0,
"proxied_vsf_votes": [0, 0, 0, 0],
"witnesses_voted_for": 0,
"last_post": "2016-03-30T18:30:18",
"last_root_post": "2016-03-30T18:30:18",
"vesting_balance": "0.000 STEEM",
"reputation": "",
"transfer_history": [],
"market_history": [],
"post_history": [],
"vote_history": [],
"other_history": [],
"witness_votes": [],
"tags_usage": [],
"guest_bloggers": []
}
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_accounts", "params":[["steemit"]], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_accounts", "params":[["steemit", "alice"]], "id":1}' https://api.steemit.com
condenser_api.get_active_votes
Returns all votes for the given post. Parameters: author:string; permlink:string
author (string) |
permlink (string) |
|
|---|---|---|
"steemit" |
"firstpost" |
Queries votes for content with a slug @steemit/firstpost |
"alice" |
"a-post-by-alice" |
Queries votes for content with a slug @alice/a-post-by-alice |
Also see: tags_api.get_active_votes
Query Parameters JSON
["", ""]
Expected Response JSON
[
{
"voter": "",
"weight": "",
"rshares": 0,
"percent": 0,
"reputation": "",
"time": "1970-01-01T00:00:00"
}
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_active_votes", "params":["steemit", "firstpost"], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_active_votes", "params":["alice", "a-post-by-alice"], "id":1}' https://api.steemit.com
condenser_api.get_active_witnesses
Returns the list of active witnesses.
Also see: database_api.get_active_witnesses
Query Parameters JSON
[]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_active_witnesses", "params":[], "id":1}' https://api.steemit.com
condenser_api.get_block
Returns a block. Parameters: block_num:int
block_num (int) |
|
|---|---|
1 |
Queries the very first block. |
8675309 |
Queries block number 8,675,309. |
62396745 |
Queries block number 62,396,745. |
Also see: block_api.get_block
Query Parameters JSON
[1]
Expected Response JSON
{
"previous": "0000000000000000000000000000000000000000",
"timestamp": "2016-03-24T16:05:00",
"witness": "initminer",
"transaction_merkle_root": "0000000000000000000000000000000000000000",
"extensions": [],
"witness_signature": "204f8ad56a8f5cf722a02b035a61b500aa59b9519b2c33c77a80c0a714680a5a5a7a340d909d19996613c5e4ae92146b9add8a7a663eef37d837ef881477313043",
"transactions": [],
"block_id": "0000000109833ce528d5bbfb3f6225b39ee10086",
"signing_key": "STM8GC13uCZbP44HzMLV6zPZGwVQ8Nt4Kji8PapsPiNq1BK153XTX",
"transaction_ids": []
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_block", "params":[1], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_block", "params":[8675309], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_block", "params":[62396745], "id":1}' https://api.steemit.com
condenser_api.get_block_header
Returns a block header. Parameters: block_num:int
block_num (int) |
|
|---|---|
1 |
Queries the block headers for the very first block. |
8675309 |
Queries block headers for block number 8,675,309. |
62396745 |
Queries block headers for block number 62,396,745. |
Also see: block_api.get_block_header
Query Parameters JSON
[1]
Expected Response JSON
{
"previous": "0000000000000000000000000000000000000000",
"timestamp": "2016-03-24T16:05:00",
"witness": "initminer",
"transaction_merkle_root": "0000000000000000000000000000000000000000",
"extensions": []
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_block_header", "params":[1], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_block_header", "params":[8675309], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_block_header", "params":[62396745], "id":1}' https://api.steemit.com
condenser_api.get_blog
Returns the list of blog entries for an account. Parameters: account:string; start_entry_id:int; limit:int up to 500
account (string) |
start_entry_id (int) |
limit (int) |
|
|---|---|---|---|
| “steemit” | 0 |
1 |
Queries the blog for the account named “steemit”, up to one result. |
| “alice” | 0 |
50 |
Queries the blog for the account named “alice”, up to 50 results. |
Also see: follow_api.get_blog, Paginated API Methods
Query Parameters JSON
["steemit", 0, 1]
Expected Response JSON
[
{
"comment": {
"id": 0,
"author": "steemit",
"permlink": "firstpost",
"category": "meta",
"parent_author": "",
"parent_permlink": "meta",
"title": "Welcome to Steem!",
"body": "Steemit is a social media platform where anyone can earn STEEM points by posting. The more people who like a post, the more STEEM the poster earns. Anyone can sell their STEEM for cash or vest it to boost their voting power.",
"json_metadata": "",
"last_update": "2016-03-30T18:30:18",
"created": "2016-03-30T18:30:18",
"active": "2018-04-09T12:00:42",
"last_payout": "2016-08-24T19:59:42",
"depth": 0,
"children": 336,
"net_rshares": 0,
"abs_rshares": 0,
"vote_rshares": 0,
"children_abs_rshares": "26169324897669",
"cashout_time": "1969-12-31T23:59:59",
"max_cashout_time": "1969-12-31T23:59:59",
"total_vote_weight": 0,
"reward_weight": 10000,
"total_payout_value": {
"amount": "942",
"precision": 3,
"nai": "@@000000013"
},
"curator_payout_value": {
"amount": "756",
"precision": 3,
"nai": "@@000000013"
},
"author_rewards": 3548,
"net_votes": 90,
"root_author": "steemit",
"root_permlink": "firstpost",
"max_accepted_payout": {
"amount": "1000000000",
"pecision": 3,
"nai": "@@000000013"
},
"percent_steem_dollars": 10000,
"allow_replies": true,
"allow_votes": true,
"allow_curation_rewards": true,
"beneficiaries": []
},
"blog": "steemit",
"reblog_on": "1970-01-01T00:00:00",
"entry_id": 0
}
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_blog", "params":["steemit",0,1], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_blog", "params":["alice",0,50], "id":1}' https://api.steemit.com
condenser_api.get_blog_authors
Returns a list of authors that have had their content reblogged on a given blog account. Parameters: account:string
account (string) |
|
|---|---|
"steemit" |
Queries for account named “steemit”. |
"alice" |
Queries for accounts named alice”. |
Also see: follow_api.get_blog_authors
Query Parameters JSON
[""]
Expected Response JSON
[{"author": "", "count": 0}]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_blog_authors", "params":["steemit"], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_blog_authors", "params":["alice"], "id":1}' https://api.steemit.com
condenser_api.get_blog_entries
Returns a list of blog entries for an account. Parameters: account:string; start_entry_id:int; limit:int up to 500
account (string) |
start_entry_id (int) |
limit (int) |
|
|---|---|---|---|
| “steemit” | 0 |
1 |
Queries the blog entries for the account named “steemit”, up to one result. |
| “alice” | 0 |
50 |
Queries the blog entries for the account named “alice”, up to 50 results. |
Also see: follow_api.get_blog_entries, Paginated API Methods
Query Parameters JSON
["steemit", 0, 1]
Expected Response JSON
[
{
"author": "steemit",
"permlink": "firstpost",
"blog": "steemit",
"reblog_on": "1970-01-01T00:00:00",
"entry_id": 0
}
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_blog_entries", "params":["steemit",0,1], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_blog_entries", "params":["alice",0,50], "id":1}' https://api.steemit.com
condenser_api.get_chain_properties
Returns the chain properties.
Query Parameters JSON
[]
Expected Response JSON
{
"account_creation_fee": "0.100 STEEM",
"maximum_block_size": 131072,
"sbd_interest_rate": 1000,
"account_subsidy_limit": 0
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_chain_properties", "params":[], "id":1}' https://api.steemit.com
- Since: HF17
- Related
condenser_api.get_comment_discussions_by_payout
Returns a list of discussions based on payout.
Also see: tags_api.get_comment_discussions_by_payout
Query Parameters JSON
[
{
"tag": "",
"limit": 0,
"filter_tags": [],
"select_authors": [],
"select_tags": [],
"truncate_body": 0
}
]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_comment_discussions_by_payout", "params":[{"tag":"steem","limit":1}], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_comment_discussions_by_payout", "params":[{"tag":"photography","limit":10,"truncate_body":0}], "id":1}' https://api.steemit.com
condenser_api.get_config
Returns information about compile-time constants. See: Understanding Configuration Values
Also see: database_api.get_config
Query Parameters JSON
[]
Expected Response JSON
{}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_config", "params":[], "id":1}' https://api.steemit.com
condenser_api.get_content
Returns the content (post or comment). Parameters: author:string; permlink:string
author (string) |
permlink (string) |
|
|---|---|---|
"steemit" |
"firstpost" |
Queries content with a slug @steemit/firstpost |
"alice" |
"a-post-by-alice" |
Queries content with a slug @alice/a-post-by-alice |
Query Parameters JSON
["", ""]
Expected Response JSON
{
"id": 0,
"author": "",
"permlink": "",
"category": "",
"parent_author": "",
"parent_permlink": "",
"title": "",
"body": "",
"json_metadata": "",
"last_update": "1970-01-01T00:00:00",
"created": "1970-01-01T00:00:00",
"active": "1970-01-01T00:00:00",
"last_payout": "1970-01-01T00:00:00",
"depth": 0,
"children": 0,
"net_rshares": 0,
"abs_rshares": 0,
"vote_rshares": 0,
"children_abs_rshares": 0,
"cashout_time": "1970-01-01T00:00:00",
"max_cashout_time": "1970-01-01T00:00:00",
"total_vote_weight": 0,
"reward_weight": 0,
"total_payout_value": "0.000 STEEM",
"curator_payout_value": "0.000 STEEM",
"author_rewards": 0,
"net_votes": 0,
"root_author": "",
"root_permlink": "",
"max_accepted_payout": "0.000 STEEM",
"percent_steem_dollars": 0,
"allow_replies": false,
"allow_votes": false,
"allow_curation_rewards": false,
"beneficiaries": [],
"url": "",
"root_title": "",
"pending_payout_value": "0.000 STEEM",
"total_pending_payout_value": "0.000 STEEM",
"active_votes": [],
"replies": [],
"author_reputation": 0,
"promoted": "0.000 STEEM",
"body_length": 0,
"reblogged_by": []
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_content", "params":["steemit", "firstpost"], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_content", "params":["alice", "a-post-by-alice"], "id":1}' https://api.steemit.com
condenser_api.get_content_replies
Returns a list of replies. Parameters: author:string; permlink:string
author (string) |
permlink (string) |
|
|---|---|---|
"steemit" |
"firstpost" |
Queries replies for a slug @steemit/firstpost |
"alice" |
"a-post-by-alice" |
Queries replies for a slug @alice/a-post-by-alice |
Also see: tags_api.get_content_replies
Query Parameters JSON
["", ""]
Expected Response JSON
{
"id": 0,
"author": "",
"permlink": "",
"category": "",
"parent_author": "",
"parent_permlink": "",
"title": "",
"body": "",
"json_metadata": "",
"last_update": "1970-01-01T00:00:00",
"created": "1970-01-01T00:00:00",
"active": "1970-01-01T00:00:00",
"last_payout": "1970-01-01T00:00:00",
"depth": 0,
"children": 0,
"net_rshares": 0,
"abs_rshares": 0,
"vote_rshares": 0,
"children_abs_rshares": 0,
"cashout_time": "1970-01-01T00:00:00",
"max_cashout_time": "1970-01-01T00:00:00",
"total_vote_weight": 0,
"reward_weight": 0,
"total_payout_value": "0.000 STEEM",
"curator_payout_value": "0.000 STEEM",
"author_rewards": 0,
"net_votes": 0,
"root_author": "",
"root_permlink": "",
"max_accepted_payout": "0.000 STEEM",
"percent_steem_dollars": 0,
"allow_replies": false,
"allow_votes": false,
"allow_curation_rewards": false,
"beneficiaries": [],
"url": "",
"root_title": "",
"pending_payout_value": "0.000 STEEM",
"total_pending_payout_value": "0.000 STEEM",
"active_votes": [],
"replies": [],
"author_reputation": 0,
"promoted": "0.000 STEEM",
"body_length": 0,
"reblogged_by": []
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_content_replies", "params":["steemit", "firstpost"], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_content_replies", "params":["alice", "a-post-by-alice"], "id":1}' https://api.steemit.com
condenser_api.get_conversion_requests
Returns a list of conversion request. Parameters: id:integer
id (int) |
|
|---|---|
1234 |
Queries a conversion request with the id of 1234. |
Also see: database_api.list_sbd_conversion_requests
Query Parameters JSON
[0]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_conversion_requests", "params":[1234], "id":1}' https://api.steemit.com
condenser_api.get_current_median_history_price
Query Parameters JSON
[]
Expected Response JSON
{"base": "0.000 STEEM", "quote": "0.000 STEEM"}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_current_median_history_price", "params":[], "id":1}' https://api.steemit.com
condenser_api.get_discussions_by_active
Returns a list of discussions based on active.
Also see: tags_api.get_discussions_by_active
Query Parameters JSON
[
{
"tag": "",
"limit": 0,
"filter_tags": [],
"select_authors": [],
"select_tags": [],
"truncate_body": 0
}
]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_active", "params":[{"tag":"steem","limit":1}], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_active", "params":[{"tag":"photography","limit":10,"truncate_body":0}], "id":1}' https://api.steemit.com
condenser_api.get_discussions_by_author_before_date
Returns a list of discussions based on author before date.
Also see: tags_api.get_discussions_by_author_before_date, Paginated API Methods
Query Parameters JSON
["", "", "1970-01-01T00:00:00", 100]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_author_before_date", "params":["steemit","firstpost","2016-04-19T22:49:43",1], "id":1}' https://api.steemit.com
condenser_api.get_discussions_by_blog
Returns a list of discussions by blog.
Also see: tags_api.get_discussions_by_blog
Query Parameters JSON
[
{
"tag": "",
"limit": 0,
"filter_tags": [],
"select_authors": [],
"select_tags": [],
"truncate_body": 0
}
]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_blog", "params":[{"tag":"steemit","limit":1}], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_blog", "params":[{"tag":"alice","limit":10}], "id":1}' https://api.steemit.com
condenser_api.get_discussions_by_cashout
Returns a list of discussions by cashout.
Also see: tags_api.get_discussions_by_cashout
Query Parameters JSON
[
{
"tag": "",
"limit": 0,
"filter_tags": [],
"select_authors": [],
"select_tags": [],
"truncate_body": 0
}
]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_cashout", "params":[{"tag":"steem","limit":1}], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_cashout", "params":[{"tag":"photography","limit":10,"truncate_body":0}], "id":1}' https://api.steemit.com
condenser_api.get_discussions_by_children
Returns a list of discussions by children.
Also see: tags_api.get_discussions_by_children
Query Parameters JSON
[
{
"tag": "",
"limit": 0,
"filter_tags": [],
"select_authors": [],
"select_tags": [],
"truncate_body": 0
}
]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_children", "params":[{"tag":"steem","limit":1}], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_children", "params":[{"tag":"photography","limit":10,"truncate_body":0}], "id":1}' https://api.steemit.com
condenser_api.get_discussions_by_comments
Returns a list of discussions by comments.
Also see: tags_api.get_discussions_by_comments
Query Parameters JSON
[
{
"start_author": "",
"start_permlink": "",
"limit": 100
}
]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_comments", "params":[{"start_author":"steemit","start_permlink":"firstpost","limit":1}], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_comments", "params":[{"start_author":"alice","start_permlink":"a-post-by-alice","limit":10,"truncate_body":0}], "id":1}' https://api.steemit.com
condenser_api.get_discussions_by_created
Returns a list of discussions by created.
Also see: tags_api.get_discussions_by_created
Query Parameters JSON
[
{
"tag": "",
"limit": 0,
"filter_tags": [],
"select_authors": [],
"select_tags": [],
"truncate_body": 0
}
]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_created", "params":[{"tag":"steem","limit":1}], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_created", "params":[{"tag":"photography","limit":10,"truncate_body":0}], "id":1}' https://api.steemit.com
- Since: HF14
- Related
condenser_api.get_discussions_by_feed
Returns a list of discussions by feed.
Also see: tags_api.get_discussions_by_feed
Query Parameters JSON
[
{
"tag": "",
"start_author": "",
"start_permlink": "",
"limit": 100
}
]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_feed", "params":[{"tag":"steem","limit":1}], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_feed", "params":[{"tag":"photography","limit":10,"truncate_body":0}], "id":1}' https://api.steemit.com
condenser_api.get_discussions_by_hot
Returns a list of discussions by hot.
Also see: tags_api.get_discussions_by_hot
Query Parameters JSON
[
{
"tag": "",
"limit": 0,
"filter_tags": [],
"select_authors": [],
"select_tags": [],
"truncate_body": 0
}
]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_hot", "params":[{"tag":"steem","limit":1}], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_hot", "params":[{"tag":"photography","limit":10,"truncate_body":0}], "id":1}' https://api.steemit.com
- Since: HF13
- Related
condenser_api.get_discussions_by_promoted
Returns a list of discussions by promoted.
Also see: tags_api.get_discussions_by_promoted
Query Parameters JSON
[
{
"tag": "",
"limit": 0,
"filter_tags": [],
"select_authors": [],
"select_tags": [],
"truncate_body": 0
}
]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_promoted", "params":[{"tag":"steem","limit":1}], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_promoted", "params":[{"tag":"photography","limit":10,"truncate_body":0}], "id":1}' https://api.steemit.com
condenser_api.get_discussions_by_trending
Returns a list of discussions by trending.
Also see: tags_api.get_discussions_by_trending
Query Parameters JSON
[
{
"tag": "",
"limit": 0,
"filter_tags": [],
"select_authors": [],
"select_tags": [],
"truncate_body": 0
}
]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_trending", "params":[{"tag":"steem","limit":1}], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_trending", "params":[{"tag":"photography","limit":10,"truncate_body":0}], "id":1}' https://api.steemit.com
condenser_api.get_discussions_by_votes
Returns a list of discussions by votes.
Also see: tags_api.get_discussions_by_votes
Query Parameters JSON
[
{
"tag": "",
"limit": 0,
"filter_tags": [],
"select_authors": [],
"select_tags": [],
"truncate_body": 0
}
]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_votes", "params":[{"tag":"steem","limit":1}], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_votes", "params":[{"tag":"photography","limit":10,"truncate_body":0}], "id":1}' https://api.steemit.com
condenser_api.get_dynamic_global_properties
Returns the current dynamic global properties. See: Understanding Dynamic Global Properties
Also see: database_api.get_dynamic_global_properties
Query Parameters JSON
[]
Expected Response JSON
{
"head_block_number": 0,
"head_block_id": "0000000000000000000000000000000000000000",
"time": "1970-01-01T00:00:00",
"current_witness": "",
"total_pow": "18446744073709551615",
"num_pow_witnesses": 0,
"virtual_supply": "0.000 STEEM",
"current_supply": "0.000 STEEM",
"confidential_supply": "0.000 STEEM",
"current_sbd_supply": "0.000 STEEM",
"confidential_sbd_supply": "0.000 STEEM",
"total_vesting_fund_steem": "0.000 STEEM",
"total_vesting_shares": "0.000 STEEM",
"total_reward_fund_steem": "0.000 STEEM",
"total_reward_shares2": "0",
"pending_rewarded_vesting_shares": "0.000 STEEM",
"pending_rewarded_vesting_steem": "0.000 STEEM",
"sbd_interest_rate": 0,
"sbd_print_rate": 10000,
"maximum_block_size": 0,
"current_aslot": 0,
"recent_slots_filled": "0",
"participation_count": 0,
"last_irreversible_block_num": 0,
"vote_power_reserve_rate": 40
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_dynamic_global_properties", "params":[], "id":1}' https://api.steemit.com
- Since: HF14
- Related
condenser_api.get_escrow
Returns the escrow for a certain account by id.
Also see: database_api.list_escrows
Query Parameters JSON
["", 0]
Expected Response JSON
null
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_escrow", "params":["steemit", 1234], "id":1}' https://api.steemit.com
- Since: HF17
- Related
condenser_api.get_expiring_vesting_delegations
Returns the expiring vesting delegations for an account. Parameters: account:string, after:timestamp
account (string) |
after (timestamp) |
|
|---|---|---|
"steemit" |
"2018-01-01T00:00:00" |
Queries for expiring vesting after January 1st, 2018. |
"alice" |
"2017-12-01T00:00:00" |
Queries for expiring vesting after December 1st, 2017. |
Query Parameters JSON
["", "1970-01-01T00:00:00"]
Expected Response JSON
[
{
"id": 0,
"delegator": "",
"vesting_shares": "0.000000 VESTS",
"expiration": "1970-01-01T00:00:00"
}
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_expiring_vesting_delegations", "params":["steemit","2018-01-01T00:00:00"], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_expiring_vesting_delegations", "params":["alice","2017-12-01T00:00:00"], "id":1}' https://api.steemit.com
- Since: HF14
- Related
condenser_api.get_feed
Returns a list of items in an account’s feed. Parameters: account:string; start_entry_id:int; limit:int up to 500
account (string) |
start_entry_id (int) |
limit (int) |
|
|---|---|---|---|
"steemit" |
0 |
1 |
Queries the account named steemit starting on the first item, up to 1 result. |
"alice" |
1 |
10 |
Queries the account named alice starting on the second item, up to 10 results. |
Also see: follow_api.get_feed, Paginated API Methods
Query Parameters JSON
["", 0, 1]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_feed", "params":["steemit",0,1], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_feed", "params":["alice",1,10], "id":1}' https://api.steemit.com
- Since: HF14
- Related
condenser_api.get_feed_entries
Returns a list of entries in an account’s feed. Parameters: account:string; start_entry_id:int; limit:int up to 500
account (string) |
start_entry_id (int) |
limit (int) |
|
|---|---|---|---|
"steemit" |
0 |
1 |
Queries the account named steemit starting on the first item, up to 1 result. |
"alice" |
1 |
10 |
Queries the account named alice starting on the second item, up to 10 results. |
Also see: follow_api.get_feed_entries, Paginated API Methods
Query Parameters JSON
["", 0, 1]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_feed_entries", "params":["steemit",0,1], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_feed_entries", "params":["alice",1,10], "id":1}' https://api.steemit.com
condenser_api.get_feed_history
Returns the history of price feed values.
Also see: database_api.get_feed_history
Query Parameters JSON
[]
Expected Response JSON
{
"id": 0,
"current_median_history": {"base": "0.000 STEEM", "quote": "0.000 STEEM"},
"price_history": []
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_feed_history", "params":[], "id":1}' https://api.steemit.com
- Since: HF9
- Related
condenser_api.get_follow_count
Returns the count of followers/following for an account. Parameters: account:string
account (string) |
|
|---|---|
"steemit" |
Queries the account named steemit. |
"alice" |
Queries the account named alice. |
Also see: follow_api.get_follow_count
Query Parameters JSON
[""]
Expected Response JSON
{
"account": "",
"follower_count": 0,
"following_count": 0
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_follow_count", "params":["steemit"], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_follow_count", "params":["alice"], "id":1}' https://api.steemit.com
- Since: HF9
- Related
condenser_api.get_followers
Returns the list of followers for an account. Parameters: account:string; start:string (account to start from); type:string e.g.: blog; limit:int up to 1000
account (string) |
start (string) |
type (string) |
limit (int) |
|
|---|---|---|---|---|
"steemit" |
null |
"blog" |
10 |
Queries for follows of the account named steemit, up to 10 results. |
"alice" |
null |
"ignore" |
100 |
Queries for mutes of the account named alice, up to 100 results. |
Also see: follow_api.get_followers, Paginated API Methods
Query Parameters JSON
["", "", "", 1]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_followers", "params":["steemit",null,"blog",10], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_followers", "params":["alice",null,"ignore",100], "id":1}' https://api.steemit.com
- Since: HF9
- Related
condenser_api.get_following
Returns the list of accounts that are following an account. Parameters: account:string; start:string (account to start from); type:string e.g.: blog; limit:int up to 1000
account (string) |
start (string) |
type (string) |
limit (int) |
|
|---|---|---|---|---|
"steemit" |
null |
"blog" |
10 |
Queries for follows of the account named steemit, up to 10 results. |
"alice" |
null |
"ignore" |
100 |
Queries for mutes of the account named alice, up to 100 results. |
Also see: follow_api.get_following, Paginated API Methods
Query Parameters JSON
["", "", "", 1]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_following", "params":["steemit",null,"blog",10], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_following", "params":["alice",null,"ignore",100], "id":1}' https://api.steemit.com
condenser_api.get_hardfork_version
Returns the current hardfork version.
Also see: database_api.get_hardfork_properties
Query Parameters JSON
[]
Expected Response JSON
"0.0.0"
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_hardfork_version", "params":[], "id":1}' https://api.steemit.com
- Since: HF16
- Related
condenser_api.get_key_references
Returns all accounts that have the key associated with their owner or active authorities.
Also see: account_by_key_api.get_key_references
Query Parameters JSON
[
[
"STM5jZtLoV8YbxCxr4imnbWn61zMB24wwonpnVhfXRmv7j6fk3dTH"
]
]
Expected Response JSON
[["steemit"]]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_key_references", "params":[["STM5jZtLoV8YbxCxr4imnbWn61zMB24wwonpnVhfXRmv7j6fk3dTH"]], "id":1}' https://api.steemit.com
condenser_api.get_market_history
Returns the market history for the internal SBD:STEEM market. Parameters: bucket_seconds:int; start:timestamp; end:timestamp
bucket_seconds (int) |
start (timestamp) |
end (timestamp) |
|
|---|---|---|---|
15 |
"2018-01-01T00:00:00" |
"2018-01-02T00:00:00" |
Queries for market history between January 1st, 2018 and January 2nd, 2018, segmented by 15 seconds. |
60 |
"2018-01-01T00:00:00" |
"2018-01-02T00:00:00" |
Queries for market history between January 1st, 2018 and January 2nd, 2018, segmented by one minute. |
300 |
"2018-01-01T00:00:00" |
"2018-01-02T00:00:00" |
Queries for market history between January 1st, 2018 and January 2nd, 2018, segmented by five minutes. |
3600 |
"2018-01-01T00:00:00" |
"2018-01-02T00:00:00" |
Queries for market history between January 1st, 2018 and January 2nd, 2018, segmented by one hour. |
86400 |
"2018-01-01T00:00:00" |
"2018-01-02T00:00:00" |
Queries for market history between January 1st, 2018 and January 2nd, 2018, segmented by one day. |
Also see: market_history_api.get_market_history
Query Parameters JSON
[0, "1970-01-01T00:00:00", "1970-01-01T00:00:00"]
Expected Response JSON
[
{
"id": 0,
"open": "1970-01-01T00:00:00",
"seconds": 0,
"steem": {
"high": 0,
"low": 0,
"open": 0,
"close": 0,
"volume": 0
},
"non_steem": {
"high": 0,
"low": 0,
"open": 0,
"close": 0,
"volume": 0
}
}
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_market_history", "params":[15,"2018-01-01T00:00:00","2018-01-02T00:00:00"], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_market_history", "params":[60,"2018-01-01T00:00:00","2018-01-02T00:00:00"], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_market_history", "params":[300,"2018-01-01T00:00:00","2018-01-02T00:00:00"], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_market_history", "params":[3600,"2018-01-01T00:00:00","2018-01-02T00:00:00"], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_market_history", "params":[86400,"2018-01-01T00:00:00","2018-01-02T00:00:00"], "id":1}' https://api.steemit.com
condenser_api.get_market_history_buckets
Returns the bucket seconds being tracked by the plugin.
Also see: market_history_api.get_market_history_buckets
Query Parameters JSON
[]
Expected Response JSON
[15, 60, 300, 3600, 86400]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_market_history_buckets", "params":[], "id":1}' https://api.steemit.com
condenser_api.get_next_scheduled_hardfork
Returns the next scheduled hardfork.
Also see: database_api.get_hardfork_properties
Query Parameters JSON
[]
Expected Response JSON
{
"hf_version": "0.0.0",
"live_time": "1970-01-01T00:00:00"
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_next_scheduled_hardfork", "params":[], "id":1}' https://api.steemit.com
condenser_api.get_open_orders
Returns the open orders for an account. account:string
Also see: database_api.list_limit_orders
Query Parameters JSON
[""]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_open_orders", "params":["steemit"], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_open_orders", "params":["alice"], "id":1}' https://api.steemit.com
condenser_api.get_ops_in_block
Returns all operations contained in a block. Parameters: block_num:int; only_virtual:boolean
block_num (int) |
only_virtual (boolean) |
|
|---|---|---|
1 |
false |
Queries the operations in block #1. |
5443322 |
true |
Queries only the virtual operations in block #5,443,322. |
Also see: account_history_api.get_ops_in_block
Query Parameters JSON
[0, false]
Expected Response JSON
[
{
"trx_id": "0000000000000000000000000000000000000000",
"block": 0,
"trx_in_block": 0,
"op_in_trx": 0,
"virtual_op": 0,
"timestamp": "2016-10-01T06:31:24",
"op": [
"producer_reward",
{
"producer": "",
"vesting_shares": "0.000000 VESTS"
}
]
}
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_ops_in_block", "params":[1,false], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_ops_in_block", "params":[5443322,true], "id":1}' https://api.steemit.com
condenser_api.get_order_book
Returns the internal market order book. Parameters: limit:int up to 500
limit (int) |
|
|---|---|
10 |
Queries up to 10 items in the order book. |
500 |
Queries up to 500 items in the order book. |
Also see: database_api.get_order_book, market_history_api.get_order_book
Query Parameters JSON
[0]
Expected Response JSON
{"bids": [], "asks": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_order_book", "params":[10], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_order_book", "params":[50], "id":1}' https://api.steemit.com
condenser_api.get_owner_history
Returns the owner history of an account. Parameters: account:string
account (string) |
|
|---|---|
"steemit" |
Queries the owner history for account named “steemit”. |
Also see: database_api.list_owner_histories
Query Parameters JSON
[""]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_owner_history", "params":["steemit"], "id":1}' https://api.steemit.com
- Since: HF17
- Related
condenser_api.get_post_discussions_by_payout
Returns a list of post discussions by payout.
Also see: tags_api.get_post_discussions_by_payout
Query Parameters JSON
[
{
"tag": "",
"limit": 0,
"filter_tags": [],
"select_authors": [],
"select_tags": [],
"truncate_body": 0
}
]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_post_discussions_by_payout", "params":[{"tag":"steem","limit":1}], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_post_discussions_by_payout", "params":[{"tag":"photography","limit":10,"truncate_body":0}], "id":1}' https://api.steemit.com
condenser_api.get_potential_signatures
This method will return the set of all public keys that could possibly sign for a given transaction.
Also see: database_api.get_potential_signatures
Query Parameters JSON
[
{
"ref_block_num": 0,
"ref_block_prefix": 0,
"expiration": "1970-01-01T00:00:00",
"operations": [],
"extensions": [],
"signatures": []
}
]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_potential_signatures", "params":[{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[["pow",{"worker_account":"cloop3","block_id":"00000449f7860b82b4fbe2f317c670e9f01d6d9a","nonce":3899,"work":{"worker":"STM7P5TDnA87Pj9T4mf6YHrhzjC1KbPZpNxLWCcVcHxNYXakpoT4F","input":"ae8e7c677119d22385f8c48026fee7aad7bba693bf788d7f27047f40b47738c0","signature":"1f38fe9a3f9989f84bd94aa5bbc88beaf09b67f825aa4450cf5105d111149ba6db560b582c7dbb026c7fc9c2eb5051815a72b17f6896ed59d3851d9a0f9883ca7a","work":"000e7b209d58f2e64b36e9bf12b999c6c7af168cc3fc41eb7f8a4bf796c174c3"},"props":{"account_creation_fee":{"amount":"100000","precision":3,"nai":"@@000000021"},"maximum_block_size":131072,"sbd_interest_rate":1000}}]],"extensions":[],"signatures":[]}], "id":1}' https://api.steemit.com
- Since: HF14
- Related
condenser_api.get_reblogged_by
Returns a list of authors that have reblogged a post. Parameters: author:string; permlink:string
author (string) |
permlink (string) |
|
|---|---|---|
"steemit" |
"firstpost" |
Queries reblogs for content with a slug @steemit/firstpost |
"alice" |
"a-post-by-alice" |
Queries reblogs for content with a slug @alice/a-post-by-alice |
Also see: follow_api.get_reblogged_by
Query Parameters JSON
["", ""]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_reblogged_by", "params":["steemit","firstpost"], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_reblogged_by", "params":["alice","a-post-by-alice"], "id":1}' https://api.steemit.com
condenser_api.get_recent_trades
Returns the most recent trades for the internal SBD:STEEM market. Parameters: limit:int up to 1000
limit (int) |
|
|---|---|
10 |
Queries up to 10 latest trades. |
500 |
Queries up to 500 latest trades. |
Also see: market_history_api.get_recent_trades
Query Parameters JSON
[1]
Expected Response JSON
[
{
"date": "1970-01-01T00:00:00",
"current_pays": "0.0 SBD",
"open_pays": "0.0 STEEM"
}
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_recent_trades", "params":[10], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_recent_trades", "params":[500], "id":1}' https://api.steemit.com
- Since: HF11
- Related
condenser_api.get_recovery_request
Returns the recovery request for an account. Parameters: account:string
account (string) |
|
|---|---|
"steemit" |
Queries the recovery requests for account named “steemit”. |
Also see: database_api.list_account_recovery_requests
Query Parameters JSON
[""]
Expected Response JSON
null
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_recovery_request", "params":["steemit"], "id":1}' https://api.steemit.com
condenser_api.get_replies_by_last_update
Returns a list of replies by last update. start_parent_author:string, start_permlink:string, limit:int up to 100
Also see: tags_api.get_replies_by_last_update, Paginated API Methods
Query Parameters JSON
["", "", 1]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_replies_by_last_update", "params":["steemit","firstpost",1], "id":1}' https://api.steemit.com
condenser_api.get_required_signatures
This API will take a partially signed transaction and a set of public keys that the owner has the ability to sign for and return the minimal subset of public keys that should add signatures to the transaction. Parameters: trx:object; available_keys:[string]
Also see: database_api.get_required_signatures
Query Parameters JSON
[
{
"ref_block_num": 0,
"ref_block_prefix": 0,
"expiration": "1970-01-01T00:00:00",
"operations": [],
"extensions": [],
"signatures": []
},
[]
]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_required_signatures", "params":[{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[["pow",{"worker_account":"cloop3","block_id":"00000449f7860b82b4fbe2f317c670e9f01d6d9a","nonce":3899,"work":{"worker":"STM7P5TDnA87Pj9T4mf6YHrhzjC1KbPZpNxLWCcVcHxNYXakpoT4F","input":"ae8e7c677119d22385f8c48026fee7aad7bba693bf788d7f27047f40b47738c0","signature":"1f38fe9a3f9989f84bd94aa5bbc88beaf09b67f825aa4450cf5105d111149ba6db560b582c7dbb026c7fc9c2eb5051815a72b17f6896ed59d3851d9a0f9883ca7a","work":"000e7b209d58f2e64b36e9bf12b999c6c7af168cc3fc41eb7f8a4bf796c174c3"},"props":{"account_creation_fee":{"amount":"100000","precision":3,"nai":"@@000000021"},"maximum_block_size":131072,"sbd_interest_rate":1000}}]],"extensions":[],"signatures":[]},[]], "id":1}' https://api.steemit.com
- Since: HF17
- Related
condenser_api.get_reward_fund
Returns information about the current reward funds.
Also see: database_api.get_reward_funds
Query Parameters JSON
["post"]
Expected Response JSON
{
"id": 0,
"name": "",
"reward_balance": "0.000 STEEM",
"recent_claims": "0",
"last_update": "1970-01-01T00:00:00",
"content_constant": "0",
"percent_curation_rewards": 0,
"percent_content_rewards": 0,
"author_reward_curve": "quadratic",
"curation_reward_curve": "34723648"
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_reward_fund", "params":["post"], "id":1}' https://api.steemit.com
- Since: HF14
- Related
condenser_api.get_savings_withdraw_from
Returns savings withdraw from an account. Parameters: account:string
account (string) |
|
|---|---|
"steemit" |
Queries the savings withdraw for account named “steemit”. |
Also see: database_api.list_savings_withdrawals
Query Parameters JSON
[""]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_savings_withdraw_from", "params":["steemit"], "id":1}' https://api.steemit.com
- Since: HF14
- Related
condenser_api.get_savings_withdraw_to
Returns the savings withdraw to an account. Parameters: account:string
account (string) |
|
|---|---|
"steemit" |
Queries the savings withdraw for account named “steemit”. |
Also see: database_api.list_savings_withdrawals
Query Parameters JSON
[""]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_savings_withdraw_to", "params":["steemit"], "id":1}' https://api.steemit.com
- Deprecated
- Related
condenser_api.get_state
Returns the state of a path. Deprecated. Parameters: path:string
Query Parameters JSON
[""]
Expected Response JSON
{
"current_route": "",
"props": {
"head_block_number": 0,
"head_block_id": "0000000000000000000000000000000000000000",
"time": "1970-01-01T00:00:00",
"current_witness": "",
"total_pow": "18446744073709551615",
"num_pow_witnesses": 0,
"virtual_supply": "0.000 STEEM",
"current_supply": "0.000 STEEM",
"confidential_supply": "0.000 STEEM",
"current_sbd_supply": "0.000 STEEM",
"confidential_sbd_supply": "0.000 STEEM",
"total_vesting_fund_steem": "0.000 STEEM",
"total_vesting_shares": "0.000 STEEM",
"total_reward_fund_steem": "0.000 STEEM",
"total_reward_shares2": "0",
"pending_rewarded_vesting_shares": "0.000 STEEM",
"pending_rewarded_vesting_steem": "0.000 STEEM",
"sbd_interest_rate": 0,
"sbd_print_rate": 10000,
"maximum_block_size": 0,
"current_aslot": 0,
"recent_slots_filled": "0",
"participation_count": 0,
"last_irreversible_block_num": 0,
"vote_power_reserve_rate": 40,
"average_block_size": 0,
"current_reserve_ratio": 1,
"max_virtual_bandwidth": "0"
},
"tag_idx": {"trending": []},
"tags": {},
"content": {},
"accounts": {},
"witnesses": {},
"discussion_idx": {},
"witness_schedule": {
"id": 0,
"current_virtual_time": "0",
"next_shuffle_block_num": 1,
"current_shuffled_witnesses": [],
"num_scheduled_witnesses": 1,
"top19_weight": 1,
"timeshare_weight": 5,
"miner_weight": 1,
"witness_pay_normalization_factor": 25,
"median_props": {
"account_creation_fee": "0.000 STEEM",
"maximum_block_size": 131072,
"sbd_interest_rate": 1000
},
"majority_version": "0.0.0",
"max_voted_witnesses": 19,
"max_miner_witnesses": 1,
"max_runner_witnesses": 1,
"hardfork_required_witnesses": 17
},
"feed_price": {"base": "0.000 STEEM", "quote": "0.000 STEEM"},
"error": ""
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_state", "params":["/@steemit"], "id":1}' https://api.steemit.com
condenser_api.get_tags_used_by_author
Returns a list of tags used by an author. Parameters: author:string
account (string) |
|
|---|---|
"steemit" |
Queries the tags used by the account named “steemit”. |
Also see: tags_api.get_tags_used_by_author
Query Parameters JSON
[""]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_tags_used_by_author", "params":["steemit"], "id":1}' https://api.steemit.com
condenser_api.get_ticker
Returns the market ticker for the internal SBD:STEEM market.
Also see: market_history_api.get_ticker
Query Parameters JSON
[]
Expected Response JSON
{
"latest": "0.00000000000000000",
"lowest_ask": "0.00000000000000000",
"highest_bid": "0.00000000000000000",
"percent_change": "0.00000000000000000",
"steem_volume": "0.000 STEEM",
"sbd_volume": "0.000 STEEM"
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_ticker", "params":[], "id":1}' https://api.steemit.com
condenser_api.get_trade_history
Returns the trade history for the internal SBD:STEEM market. Parameters: start:timestamp; end:timestamp; limit:int up to 1000
start (timestamp) |
end (timestamp) |
limit (int) |
|
|---|---|---|---|
"2018-01-01T00:00:00" |
"2018-01-02T00:00:00" |
10 | Queries up to 10 trades between January 1st, 2018 and January 2nd, 2018. |
Also see: market_history_api.get_trade_history
Query Parameters JSON
[
"1970-01-01T00:00:00",
"1970-01-01T00:00:00",
1000
]
Expected Response JSON
[
{
"date": "1970-01-01T00:00:00",
"current_pays": "0.000 SBD",
"open_pays": "0.000 STEEM"
}
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_trade_history", "params":["2018-01-01T00:00:00","2018-01-02T00:00:00",10], "id":1}' https://api.steemit.com
condenser_api.get_transaction
Returns the details of a transaction based on a transaction id. Parameters: trx_id:string
trx_id (string) |
|
|---|---|
"6fde0190a97835ea6d9e651293e90c89911f933c" |
Queries for this exact transaction id. |
Also see: account_history_api.get_transaction
Query Parameters JSON
[""]
Expected Response JSON
{
"ref_block_num": 0,
"ref_block_prefix": 0,
"expiration": "1970-01-01T00:00:00",
"operations": [],
"extensions": [],
"signatures": [],
"transaction_id": "0000000000000000000000000000000000000000",
"block_num": 0,
"transaction_num": 0
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_transaction", "params":["6fde0190a97835ea6d9e651293e90c89911f933c"], "id":1}' https://api.steemit.com
condenser_api.get_transaction_hex
Returns a hexdump of the serialized binary form of a transaction.
Also see: database_api.get_transaction_hex
Query Parameters JSON
[
{
"ref_block_num": 0,
"ref_block_prefix": 0,
"expiration": "1970-01-01T00:00:00",
"operations": [],
"extensions": [],
"signatures": []
}
]
Expected Response JSON
""
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_transaction_hex", "params":[{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[["pow",{"worker_account":"cloop3","block_id":"00000449f7860b82b4fbe2f317c670e9f01d6d9a","nonce":3899,"work":{"worker":"STM7P5TDnA87Pj9T4mf6YHrhzjC1KbPZpNxLWCcVcHxNYXakpoT4F","input":"ae8e7c677119d22385f8c48026fee7aad7bba693bf788d7f27047f40b47738c0","signature":"1f38fe9a3f9989f84bd94aa5bbc88beaf09b67f825aa4450cf5105d111149ba6db560b582c7dbb026c7fc9c2eb5051815a72b17f6896ed59d3851d9a0f9883ca7a","work":"000e7b209d58f2e64b36e9bf12b999c6c7af168cc3fc41eb7f8a4bf796c174c3"},"props":{"account_creation_fee":{"amount":"100000","precision":3,"nai":"@@000000021"},"maximum_block_size":131072,"sbd_interest_rate":1000}}]],"extensions":[],"signatures":[]}], "id":1}' https://api.steemit.com
condenser_api.get_trending_tags
Returns the list of trending tags. Parameter: start_tag:string; limit:int up to 100
tag (string) |
limit (int) |
|
|---|---|---|
null |
100 | Queries the top 100 trending tags. |
"steem" |
10 | Queries the tags after “steem”, up to 10 tags. |
Also see: tags_api.get_trending_tags, Paginated API Methods
Query Parameters JSON
["", 1]
Expected Response JSON
[
{
"name": "",
"total_payouts": "0.000 SBD",
"net_votes": 0,
"top_posts": 0,
"comments": 0,
"trending": ""
}
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_trending_tags", "params":[null,100], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_trending_tags", "params":["steem",10], "id":1}' https://api.steemit.com
condenser_api.get_version
Returns the versions of blockchain, steem, and FC.
Also see: database_api.get_version, Paginated API Methods
Query Parameters JSON
[]
Expected Response JSON
{
"blockchain_version": "",
"steem_revision": "",
"fc_revision": ""
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_version", "params":[], "id":1}' https://api.steemit.com
- Since: HF17
- Related
condenser_api.get_vesting_delegations
Returns the vesting delegations by an account. Parameters: delegator_account:string; start_account:string; limit:int up to 1000
delegator_account (string) |
start_account (string) |
limit (int) |
|
|---|---|---|---|
"steemit" |
null |
10 |
Queries up to 10 vesting delegations by “steemit”. |
Also see: database_api.list_vesting_delegations, Paginated API Methods, Paginated API Methods
Query Parameters JSON
["", "", 1]
Expected Response JSON
[
{
"id": 0,
"delegator": "",
"delegatee": "",
"vesting_shares": "0.000000 VESTS",
"min_delegation_time": "1970-01-01T00:00:00"
}
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_vesting_delegations", "params":["steemit",null,10], "id":1}' https://api.steemit.com
condenser_api.get_volume
Returns the market volume for the past 24 hours.
Also see: market_history_api.get_volume
Query Parameters JSON
[]
Expected Response JSON
{
"steem_volume": "0.000 STEEM",
"sbd_volume": "0.000 STEEM"
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_volume", "params":[], "id":1}' https://api.steemit.com
condenser_api.get_withdraw_routes
Returns the withdraw routes for an account. Parameters: account:string; type:string
account (string) |
type (string) |
|
|---|---|---|
"steemit" |
"outgoing" |
Queries outgoing withdraw routes by “steemit”. |
"steemit" |
"incoming" |
Queries incoming withdraw routes by “steemit”. |
"steemit" |
"all" |
Queries all withdraw routes by “steemit”. |
Also see: database_api.list_withdraw_vesting_routes
Query Parameters JSON
["", ""]
Expected Response JSON
[
{
"id": 0,
"from_account": "",
"to_account": "",
"percent": 0,
"auto_vest": false
}
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_withdraw_routes", "params":["steemit","outgoing"], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_withdraw_routes", "params":["steemit","incoming"], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_withdraw_routes", "params":["steemit","all"], "id":1}' https://api.steemit.com
condenser_api.get_witness_by_account
Returns the witness of an account. Parameters: account:string
account (string) |
|
|---|---|
"steemit" |
Queries witness account of “steemit” (of null if none exists). |
Also see: database_api.list_witnesses
Query Parameters JSON
[""]
Expected Response JSON
{
"id": 0,
"owner": "",
"created": "1970-01-01T00:00:00",
"url": "",
"votes": "0",
"virtual_last_update": "0",
"virtual_position": "0",
"virtual_scheduled_time": "0",
"total_missed": 0,
"last_aslot": 0,
"last_confirmed_block_num": 0,
"pow_worker": 0,
"signing_key": "",
"props": {
"account_creation_fee": "0.000 STEEM",
"maximum_block_size": 65536,
"sbd_interest_rate": 0
},
"sbd_exchange_rate": {"base": "0.000 SBD", "quote": "0.000 STEEM"},
"last_sbd_exchange_update": "1970-01-01T00:00:00",
"last_work": "",
"running_version": "",
"hardfork_version_vote": "",
"hardfork_time_vote": "1970-01-01T00:00:00"
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_witness_by_account", "params":["steemit"], "id":1}' https://api.steemit.com
condenser_api.get_witness_count
Query Parameters JSON
[]
Expected Response JSON
0
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_witness_count", "params":[], "id":1}' https://api.steemit.com
condenser_api.get_witness_schedule
Returns the current witness schedule.
Also see: database_api.get_witness_schedule
Query Parameters JSON
[]
Expected Response JSON
{
"id": 0,
"current_virtual_time": "0",
"next_shuffle_block_num": 1,
"current_shuffled_witnesses": [],
"num_scheduled_witnesses": 1,
"top19_weight": 1,
"timeshare_weight": 5,
"miner_weight": 1,
"witness_pay_normalization_factor": 25,
"median_props": {
"account_creation_fee": "0.000 STEEM",
"maximum_block_size": 131072,
"sbd_interest_rate": 1000
},
"majority_version": "0.0.0",
"max_voted_witnesses": 19,
"max_miner_witnesses": 1,
"max_runner_witnesses": 1,
"hardfork_required_witnesses": 17
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_witness_schedule", "params":[], "id":1}' https://api.steemit.com
condenser_api.get_witnesses
Returns current witnesses.
Also see: database_api.list_witnesses
Query Parameters JSON
[[0]]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_witnesses", "params":[[28]], "id":1}' https://api.steemit.com
condenser_api.get_witnesses_by_vote
Returns current witnesses by vote. Parameters: start_name:string; limit:int up to 1000
account (string) |
limit (int) |
|
|---|---|---|
null |
21 |
Queries top 21 witness votes. |
"a" |
1 |
Queries top 10 witness votes starting with “a”. |
Also see: database_api.list_witnesses
Query Parameters JSON
["", 1000]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_witnesses_by_vote", "params":[null, 21], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_witnesses_by_vote", "params":["a", 1], "id":1}' https://api.steemit.com
condenser_api.lookup_account_names
Looks up account names. accounts:[string]
Also see: database_api.find_accounts
Query Parameters JSON
[["steemit"]]
Expected Response JSON
[
{
"id": 28,
"name": "steemit",
"owner": {
"weight_threshold": 1,
"account_auths": [],
"key_auths": [
[
"STM5tfrdPG1Ycjwa9FuBUueDFFyygndBLXdVEEs2c9eRKScnFk6vM",
1
],
[
"STM71f6yWztimJuREVyyMXNqAVbx1FzPVW6LLXNoQ35dHwKuszmHX",
1
],
[
"STM7U3ymhUTuKME72dpdpQkdQvh722gTLjKBKtmKQPPWgtkr418Nf",
1
]
]
},
"active": {
"weight_threshold": 1,
"account_auths": [],
"key_auths": [
[
"STM5832HKCJzs6K3rRCsZ1PidTKgjF38ZJb718Y3pCW92HEMsCGPf",
1
],
[
"STM7Q2rLBqzPzFeteQZewv9Lu3NLE69fZoLeL6YK59t7UmssCBNTU",
1
]
]
},
"posting": {
"weight_threshold": 1,
"account_auths": [],
"key_auths": [
[
"STM5jZtLoV8YbxCxr4imnbWn61zMB24wwonpnVhfXRmv7j6fk3dTH",
1
],
[
"STM7xVFaqi8RxhWKZwuLA2bKrAiQmhnrbgvw4e2ChAsKYQbPjqUq2",
1
],
[
"STM83dmDkQcZU9X8MWcxsTztSyutE6udrb55PvYgu7RLzStaoAt67",
1
]
]
},
"memo_key": "STM5jZtLoV8YbxCxr4imnbWn61zMB24wwonpnVhfXRmv7j6fk3dTH",
"json_metadata": "",
"proxy": "",
"last_owner_update": "2017-03-16T21:17:51",
"last_account_update": "2017-03-16T23:10:36",
"created": "2016-03-24T17:00:21",
"mined": true,
"recovery_account": "steem",
"last_account_recovery": "1970-01-01T00:00:00",
"reset_account": "null",
"comment_count": 0,
"lifetime_vote_count": 0,
"post_count": 1,
"can_vote": true,
"voting_power": 9950,
"last_vote_time": "2016-12-04T23:10:57",
"balance": "0.006 STEEM",
"savings_balance": "11006644.632 STEEM",
"sbd_balance": "8581.890 SBD",
"sbd_seconds": "18846158467785",
"sbd_seconds_last_update": "2018-04-10T04:08:36",
"sbd_last_interest_payment": "2018-03-15T17:58:24",
"savings_sbd_balance": "0.000 SBD",
"savings_sbd_seconds": "0",
"savings_sbd_seconds_last_update": "1970-01-01T00:00:00",
"savings_sbd_last_interest_payment": "1970-01-01T00:00:00",
"savings_withdraw_requests": 0,
"reward_sbd_balance": "0.000 SBD",
"reward_steem_balance": "0.000 STEEM",
"reward_vesting_balance": "0.000000 VESTS",
"reward_vesting_steem": "0.000 STEEM",
"vesting_shares": "90039851836.689703 VESTS",
"delegated_vesting_shares": "0.000000 VESTS",
"received_vesting_shares": "0.000000 VESTS",
"vesting_withdraw_rate": "0.000000 VESTS",
"next_vesting_withdrawal": "1969-12-31T23:59:59",
"withdrawn": 0,
"to_withdraw": 0,
"withdraw_routes": 0,
"curation_rewards": 0,
"posting_rewards": 3548,
"proxied_vsf_votes": ["28583799126", 0, 0, 0],
"witnesses_voted_for": 0,
"last_post": "2016-03-30T18:30:18",
"last_root_post": "2016-03-30T18:30:18"
}
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.lookup_account_names", "params":[["steemit"]], "id":1}' https://api.steemit.com
condenser_api.lookup_accounts
Looks up accounts starting with name. Parameterslower_bound_name:string; limit:int up to 1000
lower_bound_name (string) |
limit (int) |
|
|---|---|---|
"a" |
10 | Queries up to 10 accounts that start with “a”. |
Also see: database_api.list_accounts
Query Parameters JSON
["", 1]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.lookup_accounts", "params":["a",10], "id":1}' https://api.steemit.com
condenser_api.lookup_witness_accounts
Looks up witness accounts starting with name. Parameters: lower_bound_name:string; limit:int up to 1000
lower_bound_name (string) |
limit (int) |
|
|---|---|---|
"a" |
10 | Queries up to 10 witnesses that start with “a”. |
Also see: database_api.list_witnesses
Query Parameters JSON
["", 1]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.lookup_witness_accounts", "params":["a",10], "id":1}' https://api.steemit.com
- Disabled
- Related
condenser_api.verify_account_authority
Not Implemented
Also see: database_api.verify_account_authority
Query Parameters JSON
["", [""]]
Expected Response JSON
false
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.verify_account_authority", "params":["temp",["STM8GC13uCZbP44HzMLV6zPZGwVQ8Nt4Kji8PapsPiNq1BK153XTX"]], "id":1}' https://api.steemit.com
condenser_api.verify_authority
Returns true if the transaction has all of the required signatures.
Also see: database_api.verify_authority
Query Parameters JSON
[
{
"ref_block_num": 0,
"ref_block_prefix": 0,
"expiration": "1970-01-01T00:00:00",
"operations": [],
"extensions": [],
"signatures": []
}
]
Expected Response JSON
false
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.verify_authority", "params":[{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[["pow",{"worker_account":"cloop3","block_id":"00000449f7860b82b4fbe2f317c670e9f01d6d9a","nonce":3899,"work":{"worker":"STM7P5TDnA87Pj9T4mf6YHrhzjC1KbPZpNxLWCcVcHxNYXakpoT4F","input":"ae8e7c677119d22385f8c48026fee7aad7bba693bf788d7f27047f40b47738c0","signature":"1f38fe9a3f9989f84bd94aa5bbc88beaf09b67f825aa4450cf5105d111149ba6db560b582c7dbb026c7fc9c2eb5051815a72b17f6896ed59d3851d9a0f9883ca7a","work":"000e7b209d58f2e64b36e9bf12b999c6c7af168cc3fc41eb7f8a4bf796c174c3"},"props":{"account_creation_fee":{"amount":"100000","precision":3,"nai":"@@000000021"},"maximum_block_size":131072,"sbd_interest_rate":1000}}]],"extensions":[],"signatures":[]}], "id":1}' https://api.steemit.com
- Disabled
- Related
condenser_api.get_account_references
Not Implemented
Query Parameters JSON
[]
Expected Response JSON
[]
condenser_api.find_proposals
Finds proposals by proposal.id (not proposal.proposal_id).
Also see: database_api.find_proposals
Query Parameters JSON
[0]
Expected Response JSON
[
{
"id": 0,
"proposal_id": "139924505899904",
"creator": "alice",
"receiver": "bob",
"start_date": "2019-07-01T00:00:00",
"end_date": "2019-08-01T23:59:59",
"daily_pay": "4800.000 SBD",
"subject": "My Proposal",
"permlink": "creator-proposal-permlink",
"total_votes": "77351826710",
"status": "active"
}
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.find_proposals", "params":[[0]], "id":1}' https://api.steemit.com
condenser_api.list_proposal_votes
Returns all proposal votes, starting with the specified voter or proposal.id. Parameters: start:array; limit:int; order:string; order_direction:string; status:string
startdepends onorder(see below)voter- voter of the proposal (account name string)proposal.id- id the proposal (int)
limitis up to 1000.ordercan be one of:by_voter_proposal- order by proposal voterby_proposal_voter- order byproposal.id
order_directioncan be one of:ascendingdescending
statusallinactiveactiveexpiredvotable
start (array) |
limit (int) |
order (string) |
order_direction (string) |
status (string) |
|
|---|---|---|---|---|---|
["alice"] |
10 | by_voter_proposal |
ascending |
active |
list 10 proposals with active status, ordered by voter, ascending |
[10] |
1000 | by_proposal_voter |
ascending |
votable |
list 1000 votes on proposal 10, ordered by proposal.id, ascending |
Also see: datbase_api.list_proposals
Query Parameters JSON
[[], 0, "by_name", "ascending", "all"]
Expected Response JSON
[
{
"id": 0,
"voter": "charlie",
"proposal": {
"id": 0,
"proposal_id": 0,
"creator": "alice",
"receiver": "bob",
"start_date": "2019-07-01T00:00:00",
"end_date": "2019-08-01T23:59:59",
"daily_pay": {
"amount": "4800000",
"precision": 3,
"nai": "@@000000013"
},
"subject": "My Proposal",
"permlink": "creator-proposal-permlink",
"total_votes": "77351826710",
"status": "active"
}
}
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.list_proposal_votes", "params":[[""], 10, "by_voter_proposal", "ascending", "active"], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.list_proposal_votes", "params":[[0], 10, "by_proposal_voter", "ascending", "active"], "id":1}' https://api.steemit.com
condenser_api.list_proposals
Returns all proposals, starting with the specified creator or start date. Parameters: start:array; limit:int; order:string; order_direction:string; status:string
startdepends onorder(see below)creator- creator of the proposal (account name string)start_date- start date of the proposal (date string)end_date- end date of the proposal (date string)total_votes- total votes of the proposal (int)
limitis up to 1000.ordercan be one of:by_creator- order by proposal creatorby_start_date- order by proposal start dateby_end_date- order by proposal end dateby_total_votes- order by proposal total votes
order_directioncan be one of:ascendingdescending
statusallinactiveactiveexpiredvotable
start (array) |
limit (int) |
order (string) |
order_direction (string) |
status (string) |
|
|---|---|---|---|---|---|
[""] |
10 | by_creator |
ascending |
active |
list 10 proposals with active status, ordered by creator, ascending |
["2019-08-07T16:54:03"] |
1000 | by_start_date |
ascending |
inactive |
list 1000 proposals with inactive status, ordered by start date, ascending, since 2019-08-07T16:54:03 |
["a"] |
1 | by_creator |
ascending |
expired |
list 1 proposal with expired status, ordered by creator, ascending, by accounts starting with “a” |
["alice"] |
10 | by_creator |
ascending |
all |
list 10 proposals with any status, ordered by creator, ascending, by alice |
[""] |
1000 | by_creator |
ascending |
votable |
list 1000 votable proposals, ordered by creator, ascending |
[10] |
1000 | by_total_votes |
ascending |
votable |
list 1000 votable proposals, ordered by creator, ascending, having at least 10 votes |
Also see: datbase_api.list_proposals
Query Parameters JSON
[[], 0, "by_name", "ascending", "all"]
Expected Response JSON
[
{
"id": 0,
"proposal_id": "1103806595072",
"creator": "alice",
"receiver": "bob",
"start_date": "2019-07-01T00:00:00",
"end_date": "2019-08-01T23:59:59",
"daily_pay": "4800.000 SBD",
"subject": "My Proposal",
"permlink": "creator-proposal-permlink",
"total_votes": "77351826710",
"status": "active"
}
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.list_proposals", "params":[[""], 10, "by_creator", "ascending", "active"], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.list_proposals", "params":[["2019-08-07T16:54:03"], 1000, "order_direction": "ascending", "inactive"], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.list_proposals", "params":[["a"], 1, "by_creator", "ascending", "expired"], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.list_proposals", "params":[["alice"], 10, "by_creator", "ascending", "all"], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.list_proposals", "params":[[""], 1000, "by_creator", "ascending", "votable"], "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.list_proposals", "params":[[10], 1000, "by_total_votes", "ascending", "votable"], "id":1}' https://api.steemit.com
Bridge
Methods:
Presents data interpreted by the hivemind database as JSON-RPC.
Also see: Communities Broadcast Ops
bridge.get_ranked_posts
Get ranked posts.
Supported values for sort:
trendinghotcreatedpromotedpayoutpayout_commentsmuted
The value for tag can be any valid tag.
The value for observer can be any valid account or empty string.
Query Parameters JSON
{"sort": "", "tag": "", "observer": ""}
Expected Response JSON
[
{
"post_id": 12345678,
"author": "alice",
"permlink": "that-march-hare",
"category": "wonderland",
"title": "That March Hare",
"body": "I think he went mad.",
"json_metadata": {"tags": ["wonderland"], "app": "steemit/0.2"},
"created": "2019-12-05T16:29:12",
"updated": "2019-12-05T16:29:12",
"depth": 0,
"children": 0,
"net_rshares": 1539574839484,
"is_paidout": false,
"payout_at": "2019-12-12T16:29:12",
"payout": 0.286,
"pending_payout_value": "0.286 SBD",
"author_payout_value": "0.000 SBD",
"curator_payout_value": "0.000 SBD",
"promoted": "0.000 SBD",
"replies": [],
"active_votes": [{"voter": "bob", "rshares": "67759296290"}],
"author_reputation": 47.15,
"stats": {
"hide": false,
"gray": false,
"total_votes": 12,
"flag_weight": 0
},
"beneficiaries": [],
"max_accepted_payout": "1000000.000 SBD",
"percent_steem_dollars": 10000,
"url": "/wonderland/@alice/that-march-hare",
"blacklists": []
}
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_ranked_posts", "params":{"sort":"trending","tag":"","observer":"alice"}, "id":1}' https://api.steemit.com
bridge.account_notifications
Account notifications.
Supported values for type:
new_community- a new community was createdset_role- mod/admin adds a role to an accountset_props- properties set for a communityset_label- a title/badge/label has been set for an accountmute_post- a post has been muted, with a reasonunmute_post- a post has been unmuted, with a reasonpin_post- a post has been pinnedunpin_post- a post has been unpinnedflag_post- a post has been flagged by a member, with a reasonerror- provides feedback to developers for ops that cannot be interpretedsubscribe- an account has subscribed to a communityreply- a post has been replied toreblog- a post has been reblogged/resteemedfollow- an account has followed another accountmention- author mentions an accountvote- voter votes for an author
The score value is based on the originating account’s rank.
Query Parameters JSON
{"account": "alice", "limit": 100}
Expected Response JSON
[
{
"id": 3629306,
"type": "vote",
"score": 25,
"date": "2019-11-20T07:48:06",
"msg": "@bob voted on your post ($0.013)",
"url": "@alice/a-post-by-alice"
}
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.account_notifications", "params":{"account":"alice","limit":100}, "id":1}' https://api.steemit.com
bridge.list_community_roles
List community roles and labels for each account in the community.
Query Parameters JSON
{"community": "hive-123456"}
Expected Response JSON
[
["hive-123456", "owner", ""],
["alice", "admin", "Miss"]
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.list_community_roles", "params":{"community":"hive-123456"}, "id":1}' https://api.steemit.com
bridge.list_all_subscriptions
List all subscriptions to a community for an account.
Query Parameters JSON
{"account": "alice"}
Expected Response JSON
[
["hive-123456", "Wonderland"],
["hive-654321", "Tulgey Wood"]
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.list_all_subscriptions", "params":{"account":"alice"}, "id":1}' https://api.steemit.com
bridge.get_community
Get community details.
Query Parameters JSON
{"name": "hive-123456", "observer": "alice"}
Expected Response JSON
{
"id": 1332149,
"name": "hive-123456",
"title": "@hive-123456",
"about": "Wonderland",
"lang": "en",
"type_id": 1,
"is_nsfw": false,
"subscribers": 0,
"sum_pending": 0,
"num_pending": 0,
"created_at": "2019-10-27 08:28:54",
"context": {
"role": "admin",
"title": "Miss",
"subscribed": true
},
"description": "",
"flag_text": "",
"settings": {},
"team": [
["hive-123456", "owner", ""],
["alice", "admin", "Miss"]
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_community", "params":{"name":"hive-123456","observer":"alice"}, "id":1}' https://api.steemit.com
Account By Key Api
Methods:
Used to lookup account information based on a key. These AppBase API methods are still under development and subject to change.
- Since: HF16
- Related
account_by_key_api.get_key_references
Returns all accounts that have the key associated with their owner or active authorities.
Query Parameters JSON
{"keys": []}
Expected Response JSON
{"accounts": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"account_by_key_api.get_key_references", "params":{"keys":["STM5jZtLoV8YbxCxr4imnbWn61zMB24wwonpnVhfXRmv7j6fk3dTH"]}, "id":1}' https://api.steemit.com
Account History Api
Methods:
Used to lookup account history information. These AppBase API methods are still under development and subject to change.
account_history_api.get_account_history
Returns a history of all operations for a given account.
Also see: Paginated API Methods
Query Parameters JSON
{
"account": "",
"start": "18446744073709551615",
"limit": 1000
}
Expected Response JSON
{"history": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"account_history_api.get_account_history", "params":{"account":"steemit", "start":1000, "limit":1000}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"account_history_api.get_account_history", "params":{"account":"steemit", "start":-1, "limit":10000}, "id":1}' https://api.steemit.com
account_history_api.get_ops_in_block
Returns all operations contained in a block.
Query Parameters JSON
{"block_num": 0, "only_virtual": false}
Expected Response JSON
{"ops": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"account_history_api.get_ops_in_block", "params":{"block_num":1,"only_virtual":false}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"account_history_api.get_ops_in_block", "params":{"block_num":5443322,"only_virtual":true}, "id":1}' https://api.steemit.com
- Deprecated
- Related
account_history_api.get_transaction
Returns the details of a transaction based on a transaction id.
Query Parameters JSON
{"id": "0000000000000000000000000000000000000000"}
Expected Response JSON
{
"ref_block_num": 0,
"ref_block_prefix": 0,
"expiration": "1970-01-01T00:00:00",
"operations": [],
"extensions": [],
"signatures": [],
"transaction_id": "0000000000000000000000000000000000000000",
"block_num": 0,
"transaction_num": 0
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"account_history_api.get_transaction", "params":{"id":"6fde0190a97835ea6d9e651293e90c89911f933c"}, "id":1}' https://api.steemit.com
- Since: HF23
- Related
account_history_api.enum_virtual_ops
Query Parameters JSON
{"block_range_begin": 1, "block_range_end": 2}
Expected Response JSON
{"ops": [], "next_block_range_begin": 0}
Block Api
Methods:
Used to query values related to the block plugin. These AppBase API methods are still under development and subject to change.
block_api.get_block
Retrieve a full, signed block of the referenced block, or null if no matching block was found.
Parameters:
block_num:int
block_num (int) |
|
|---|---|
1 |
Queries the very first block. |
8675309 |
Queries block number 8,675,309. |
62396745 |
Queries block number 62,396,745. |
Query Parameters JSON
{"block_num": 0}
Expected Response JSON
{}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"block_api.get_block", "params":{"block_num":1}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"block_api.get_block", "params":{"block_num":8675309}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"block_api.get_block", "params":{"block_num":62396745}, "id":1}' https://api.steemit.com
block_api.get_block_header
Retrieve a block header of the referenced block, or null if no matching block was found.
Parameters:
block_num:int- Height of the block whose header should be returned
block_num (int) |
|
|---|---|
1 |
Queries the block headers for the very first block. |
8675309 |
Queries block headers for block number 8,675,309. |
62396745 |
Queries block headers for block number 62,396,745. |
Query Parameters JSON
{"block_num": 0}
Expected Response JSON
{}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"block_api.get_block_header", "params":{"block_num":1}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"block_api.get_block_header", "params":{"block_num":8675309}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"block_api.get_block_header", "params":{"block_num":62396745}, "id":1}' https://api.steemit.com
Database Api
Methods:
Used to query information about accounts, transactions, and blockchain data.
To enable this API for steemd, the following is required in config.ini
by specifying:
plugin = database_api
These AppBase API methods are still under development and subject to change.
- Since: HF11
- Related
database_api.find_account_recovery_requests
Returns a list of account recovery requests. Parameters: account:string
account (string) |
|
|---|---|
"steemit" |
Queries the recovery requests for account named “steemit”. |
Query Parameters JSON
{"accounts": []}
Expected Response JSON
{"requests": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_account_recovery_requests", "params": {"accounts":["steemit"]}, "id":1}' https://api.steemit.com
database_api.find_accounts
Returns accounts, queried by name. Parameters: account:string array
account (string array) |
|
|---|---|
["steemit"] |
Queries for account named “steemit”. |
["steemit", "alice"] |
Queries for accounts named “steemit” and “alice”. |
Query Parameters JSON
{"accounts": []}
Expected Response JSON
{
"accounts": [
{
"id": 28,
"name": "steemit",
"owner": {
"weight_threshold": 1,
"account_auths": [],
"key_auths": [
[
"STM6Ezkzey8FWoEnnHHP4rxbrysJqoMmzwR2EdoD5p7FDsF64qxbQ",
1
],
[
"STM7TCZKisQnvR69CK9BaL6W4SJn2cXYwkfWYRicoVGGzhtFswxMH",
1
]
]
},
"active": {
"weight_threshold": 1,
"account_auths": [],
"key_auths": [
[
"STM5VkLha96X5EQu3HSkJdD8SEuwazWtZrzLjUT6Sc5sopgghBYrz",
1
],
[
"STM7u1BsoqLaoCu9XHi1wjWctLWSFCuvyagFjYMfga4QNWEjP7d3U",
1
]
]
},
"posting": {
"weight_threshold": 1,
"account_auths": [],
"key_auths": [
[
"STM6kXdRbWgoH9E4hvtTZeaiSbY8FmGXQavfJZ2jzkKjT5cWYgMBS",
1
],
[
"STM6tDMSSKa8Bd9ss7EjqhXPEHTWissGXJJosAU94LLpC5tsCdo61",
1
]
]
},
"memo_key": "STM5jZtLoV8YbxCxr4imnbWn61zMB24wwonpnVhfXRmv7j6fk3dTH",
"json_metadata": "",
"proxy": "",
"last_owner_update": "2018-05-31T23:32:06",
"last_account_update": "2018-05-31T23:32:06",
"created": "2016-03-24T17:00:21",
"mined": true,
"recovery_account": "steem",
"last_account_recovery": "1970-01-01T00:00:00",
"reset_account": "null",
"comment_count": 0,
"lifetime_vote_count": 0,
"post_count": 1,
"can_vote": true,
"voting_manabar": {
"current_mana": "69835912701503862",
"last_update_time": 1538171805
},
"balance": {
"amount": "2806644634",
"precision": 3,
"nai": "@@000000021"
},
"savings_balance": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
},
"sbd_balance": {
"amount": "8716535",
"precision": 3,
"nai": "@@000000013"
},
"sbd_seconds": "0",
"sbd_seconds_last_update": "2018-11-12T02:39:39",
"sbd_last_interest_payment": "2018-11-12T02:39:39",
"savings_sbd_balance": {
"amount": "0",
"precision": 3,
"nai": "@@000000013"
},
"savings_sbd_seconds": "0",
"savings_sbd_seconds_last_update": "1970-01-01T00:00:00",
"savings_sbd_last_interest_payment": "1970-01-01T00:00:00",
"savings_withdraw_requests": 0,
"reward_sbd_balance": {
"amount": "0",
"precision": 3,
"nai": "@@000000013"
},
"reward_steem_balance": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
},
"reward_vesting_balance": {
"amount": "0",
"precision": 6,
"nai": "@@000000037"
},
"reward_vesting_steem": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
},
"vesting_shares": {
"amount": "90039851836689703",
"precision": 6,
"nai": "@@000000037"
},
"delegated_vesting_shares": {
"amount": "20203939135185841",
"precision": 6,
"nai": "@@000000037"
},
"received_vesting_shares": {
"amount": "0",
"precision": 6,
"nai": "@@000000037"
},
"vesting_withdraw_rate": {
"amount": "0",
"precision": 6,
"nai": "@@000000037"
},
"next_vesting_withdrawal": "1969-12-31T23:59:59",
"withdrawn": 0,
"to_withdraw": 0,
"withdraw_routes": 0,
"curation_rewards": 0,
"posting_rewards": 3548,
"proxied_vsf_votes": ["14953279511", 0, 0, 0],
"witnesses_voted_for": 0,
"last_post": "2016-03-30T18:30:18",
"last_root_post": "2016-03-30T18:30:18",
"last_vote_time": "2016-12-04T23:10:57",
"post_bandwidth": 0,
"pending_claimed_accounts": 0,
"is_smt": false
}
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_accounts", "params": {"accounts":["steemit"]}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_accounts", "params": {"accounts":["steemit", "alice"]}, "id":1}' https://api.steemit.com
- Since: HF11
- Related
database_api.find_change_recovery_account_requests
Returns a list of requests to change the recovery account. Parameters: account:array
account (array) |
|
|---|---|
["steemit"] |
Queries the recovery requests for account named “steemit”. |
Query Parameters JSON
{"accounts": []}
Expected Response JSON
{"requests": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_change_recovery_account_requests", "params": {"accounts":["steemit"]}, "id":1}' https://api.steemit.com
database_api.find_comments
Search for comments.
Query Parameters JSON
{"start": [["", ""]], "limit": 0, "order": ""}
Expected Response JSON
{"comments": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_comments", "params": {"start":[["temp","test1"],["temp","foobar"]], "limit":10, "order":"by_account"}, "id":1}' https://api.steemit.com
- Since: HF14
- Related
database_api.find_decline_voting_rights_requests
Returns a list of requests to decline voting rights.
Query Parameters JSON
{"accounts": []}
Expected Response JSON
{"requests": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_decline_voting_rights_requests", "params": {"accounts":["temp","null"]}, "id":1}' https://api.steemit.com
- Since: HF14
- Related
database_api.find_escrows
Returns a list of escrows.
Query Parameters JSON
{"from": ""}
Expected Response JSON
{
"escrows": [
{
"id": 143,
"escrow_id": 12345,
"from": "temp",
"to": "guest123",
"agent": "smitop",
"ratification_deadline": "2038-01-19T03:14:06",
"escrow_expiration": "2038-01-19T03:14:07",
"sbd_balance": {
"amount": "0",
"precision": 3,
"nai": "@@000000013"
},
"steem_balance": {
"amount": "1",
"precision": 3,
"nai": "@@000000021"
},
"pending_fee": {
"amount": "1",
"precision": 3,
"nai": "@@000000021"
},
"to_approved": false,
"agent_approved": false,
"disputed": false
}
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_escrows", "params": {"from": "temp"}, "id":1}' https://api.steemit.com
database_api.find_limit_orders
Returns a list of limit orders.
Query Parameters JSON
{"account": ""}
Expected Response JSON
{"orders": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_limit_orders", "params": {"account":"temp"}, "id":1}' https://api.steemit.com
database_api.find_owner_histories
Returns owner authority history. Parameters: owner:string
owner (string) |
|
|---|---|
"steemit" |
Queries the owner history for account named “steemit”. |
"alice" |
Queries the owner history for account named “alice”. |
Query Parameters JSON
{"owner": ""}
Expected Response JSON
{"owner_auths": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_owner_histories", "params": {"owner":"steemit"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_owner_histories", "params": {"owner":"alice"}, "id":1}' https://api.steemit.com
- Since: HF14
- Related
database_api.find_savings_withdrawals
Returns the list of savings withdrawls for an account. Parameters: account:string
account (string) |
|
|---|---|
"steemit" |
Queries the savings withdraw for account named “steemit”. |
Query Parameters JSON
{"account": ""}
Expected Response JSON
{"withdrawals": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_savings_withdrawals", "params": {"start":"temp"}, "id":1}' https://api.steemit.com
database_api.find_sbd_conversion_requests
Returns the list of SBD conversion requests for an account. Parameters: account:string
account (string) |
|
|---|---|
"steemit" |
Queries a conversion request for steemit. |
"alice" |
Queries a conversion request for alice. |
Query Parameters JSON
{"account": ""}
Expected Response JSON
{"requests": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_sbd_conversion_requests", "params": {"account":"steemit"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_sbd_conversion_requests", "params": {"account":"alice"}, "id":1}' https://api.steemit.com
- Since: HF17
- Related
database_api.find_vesting_delegation_expirations
Returns the expiring vesting delegations for an account. Parameters: account:string
account (string) |
||
|---|---|---|
"steemit" |
Queries for expiring vesting for steemit. |
|
"alice" |
Queries for expiring vesting for alice. |
Query Parameters JSON
{"account": ""}
Expected Response JSON
{
"delegations": [
{
"id": 3077902,
"delegator": "steem",
"vesting_shares": {
"amount": "201417615",
"precision": 6,
"nai": "@@000000037"
},
"expiration": "2018-12-05T21:46:48"
}
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_vesting_delegation_expirations", "params": {"account":"steemit"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_vesting_delegation_expirations", "params": {"account":"alice"}, "id":1}' https://api.steemit.com
- Since: HF17
- Related
database_api.find_vesting_delegations
Returns the list of vesting delegations for an account. Parameters: account:string
account (string) |
||
|---|---|---|
"steemit" |
Queries for vesting for steemit. |
|
"alice" |
Queries for vesting for alice. |
Query Parameters JSON
{"account": ""}
Expected Response JSON
{"delegations": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_vesting_delegations", "params": {"account":"steemit"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_vesting_delegations", "params": {"account":"alice"}, "id":1}' https://api.steemit.com
database_api.find_votes
Returns all votes for the given post. Parameters: author:string; permlink:string
author (string) |
permlink (string) |
|
|---|---|---|
"steemit" |
"firstpost" |
Queries votes for content with a slug @steemit/firstpost |
"alice" |
"a-post-by-alice" |
Queries votes for content with a slug @alice/a-post-by-alice |
Query Parameters JSON
{"author": "", "permlink": ""}
Expected Response JSON
{
"votes": [
{
"id": 546191,
"voter": "anonymous",
"author": "temp",
"permlink": "test1",
"weight": "1799071158042053295",
"rshares": "432321664017",
"vote_percent": 10000,
"last_update": "2016-07-18T09:25:51",
"num_changes": -1
},
{
"id": 546192,
"voter": "xeroc",
"author": "temp",
"permlink": "test1",
"weight": "1763636725870082814",
"rshares": "525258058869",
"vote_percent": 10000,
"last_update": "2016-07-18T09:25:54",
"num_changes": -1
}
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_votes", "params": {"author":"steemit", "permlink":"firstpost"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_votes", "params": {"author":"alice", "permlink":"a-post-by-alice"}, "id":1}' https://api.steemit.com
database_api.find_withdraw_vesting_routes
Returns the list of vesting withdraw routes for an account.
Query Parameters JSON
{"account": "", "order": "by_name"}
Expected Response JSON
{"routes": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_withdraw_vesting_routes", "params": {"account":"temp", "order":"by_destination"}, "id":1}' https://api.steemit.com
database_api.find_witnesses
Search for witnesses.
Query Parameters JSON
{"owners": []}
Expected Response JSON
{
"witnesses": [
{
"id": 0,
"owner": "initminer",
"created": "1970-01-01T00:00:00",
"url": "",
"votes": 0,
"virtual_last_update": "225400650183277777230188182",
"virtual_position": "28933178228158941342755574680549120",
"virtual_scheduled_time": "340253433742935705172215129634317850517",
"total_missed": 88,
"last_aslot": 1202,
"last_confirmed_block_num": 1092,
"pow_worker": 0,
"signing_key": "STM8GC13uCZbP44HzMLV6zPZGwVQ8Nt4Kji8PapsPiNq1BK153XTX",
"props": {
"account_creation_fee": {
"amount": "1",
"precision": 3,
"nai": "@@000000021"
},
"maximum_block_size": 131072,
"sbd_interest_rate": 1000,
"account_subsidy_budget": 797,
"account_subsidy_decay": 347321
},
"sbd_exchange_rate": {
"base": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
},
"quote": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
}
},
"last_sbd_exchange_update": "1970-01-01T00:00:00",
"last_work": "0000000000000000000000000000000000000000000000000000000000000000",
"running_version": "0.0.0",
"hardfork_version_vote": "0.0.0",
"hardfork_time_vote": "2016-03-24T16:00:00",
"available_witness_account_subsidies": 0
}
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_witnesses", "params": {"owners":["initminer"]}, "id":1}' https://api.steemit.com
database_api.get_active_witnesses
Returns the list of active witnesses.
Query Parameters JSON
{}
Expected Response JSON
{
"witnesses": [
"lukestokes.mhth",
"gtg",
"ausbitbank",
"clayop",
"yabapmatt",
"curie",
"thecryptodrive",
"roelandp",
"followbtcnews",
"timcliff",
"smooth.witness",
"bhuz",
"aggroed",
"blocktrades",
"cervantes",
"utopian-io",
"anyx",
"jesta",
"drakos",
"someguy123",
"good-karma"
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_active_witnesses", "id":1}' https://api.steemit.com
database_api.get_config
Returns information about compile-time constants. Some properties may not be present. See: Understanding Configuration Values
Query Parameters JSON
{}
Expected Response JSON
{
"IS_TEST_NET": false,
"STEEM_ENABLE_SMT": false,
"SBD_SYMBOL": null,
"STEEM_INITIAL_VOTE_POWER_RATE": 40,
"STEEM_REDUCED_VOTE_POWER_RATE": 10,
"STEEM_100_PERCENT": 10000,
"STEEM_1_PERCENT": 100,
"STEEM_ACCOUNT_RECOVERY_REQUEST_EXPIRATION_PERIOD": "86400000000",
"STEEM_ACTIVE_CHALLENGE_COOLDOWN": "86400000000",
"STEEM_ACTIVE_CHALLENGE_FEE": {
"amount": "2000",
"precision": 3,
"nai": "@@000000021"
},
"STEEM_ADDRESS_PREFIX": "STM",
"STEEM_APR_PERCENT_MULTIPLY_PER_BLOCK": "102035135585887",
"STEEM_APR_PERCENT_MULTIPLY_PER_HOUR": "119577151364285",
"STEEM_APR_PERCENT_MULTIPLY_PER_ROUND": "133921203762304",
"STEEM_APR_PERCENT_SHIFT_PER_BLOCK": 87,
"STEEM_APR_PERCENT_SHIFT_PER_HOUR": 77,
"STEEM_APR_PERCENT_SHIFT_PER_ROUND": 83,
"STEEM_BANDWIDTH_AVERAGE_WINDOW_SECONDS": 604800,
"STEEM_BANDWIDTH_PRECISION": 1000000,
"STEEM_BLOCKCHAIN_PRECISION": 1000,
"STEEM_BLOCKCHAIN_PRECISION_DIGITS": 3,
"STEEM_BLOCKCHAIN_HARDFORK_VERSION": "0.20.0",
"STEEM_BLOCKCHAIN_VERSION": "0.20.6",
"STEEM_BLOCK_INTERVAL": 3,
"STEEM_BLOCKS_PER_DAY": 28800,
"STEEM_BLOCKS_PER_HOUR": 1200,
"STEEM_BLOCKS_PER_YEAR": 10512000,
"STEEM_CASHOUT_WINDOW_SECONDS": 604800,
"STEEM_CASHOUT_WINDOW_SECONDS_PRE_HF12": 86400,
"STEEM_CASHOUT_WINDOW_SECONDS_PRE_HF17": 43200,
"STEEM_CHAIN_ID": "0000000000000000000000000000000000000000000000000000000000000000",
"STEEM_COMMENT_REWARD_FUND_NAME": "comment",
"STEEM_CONTENT_APR_PERCENT": 3875,
"STEEM_CONTENT_CONSTANT_HF0": "2000000000000",
"STEEM_CONTENT_REWARD_PERCENT": 7500,
"STEEM_CONVERSION_DELAY": "302400000000",
"STEEM_CONVERSION_DELAY_PRE_HF_16": "604800000000",
"STEEM_CREATE_ACCOUNT_DELEGATION_RATIO": 5,
"STEEM_CREATE_ACCOUNT_DELEGATION_TIME": "2592000000000",
"STEEM_CREATE_ACCOUNT_WITH_STEEM_MODIFIER": 30,
"STEEM_CURATE_APR_PERCENT": 3875,
"STEEM_DEFAULT_SBD_INTEREST_RATE": 1000,
"STEEM_EQUIHASH_K": 6,
"STEEM_EQUIHASH_N": 140,
"STEEM_FEED_HISTORY_WINDOW": 84,
"STEEM_FEED_HISTORY_WINDOW_PRE_HF_16": 168,
"STEEM_FEED_INTERVAL_BLOCKS": 1200,
"STEEM_GENESIS_TIME": "2016-03-24T16:00:00",
"STEEM_HARDFORK_REQUIRED_WITNESSES": 17,
"STEEM_INFLATION_NARROWING_PERIOD": 250000,
"STEEM_INFLATION_RATE_START_PERCENT": 978,
"STEEM_INFLATION_RATE_STOP_PERCENT": 95,
"STEEM_INIT_MINER_NAME": "initminer",
"STEEM_INIT_PUBLIC_KEY_STR": "STM8GC13uCZbP44HzMLV6zPZGwVQ8Nt4Kji8PapsPiNq1BK153XTX",
"STEEM_INIT_SUPPLY": 0,
"STEEM_INIT_TIME": "1970-01-01T00:00:00",
"STEEM_IRREVERSIBLE_THRESHOLD": 7500,
"STEEM_LIQUIDITY_APR_PERCENT": 750,
"STEEM_LIQUIDITY_REWARD_BLOCKS": 1200,
"STEEM_LIQUIDITY_REWARD_PERIOD_SEC": 3600,
"STEEM_LIQUIDITY_TIMEOUT_SEC": "604800000000",
"STEEM_MAX_ACCOUNT_CREATION_FEE": 1000000000,
"STEEM_MAX_ACCOUNT_NAME_LENGTH": 16,
"STEEM_MAX_ACCOUNT_WITNESS_VOTES": 30,
"STEEM_MAX_ASSET_WHITELIST_AUTHORITIES": 10,
"STEEM_MAX_AUTHORITY_MEMBERSHIP": 40,
"STEEM_MAX_BLOCK_SIZE": 393216000,
"STEEM_SOFT_MAX_BLOCK_SIZE": 2097152,
"STEEM_MAX_CASHOUT_WINDOW_SECONDS": 1209600,
"STEEM_MAX_COMMENT_DEPTH": 65535,
"STEEM_MAX_COMMENT_DEPTH_PRE_HF17": 6,
"STEEM_MAX_FEED_AGE_SECONDS": 604800,
"STEEM_MAX_INSTANCE_ID": "281474976710655",
"STEEM_MAX_MEMO_SIZE": 2048,
"STEEM_MAX_WITNESSES": 21,
"STEEM_MAX_MINER_WITNESSES_HF0": 1,
"STEEM_MAX_MINER_WITNESSES_HF17": 0,
"STEEM_MAX_PERMLINK_LENGTH": 256,
"STEEM_MAX_PROXY_RECURSION_DEPTH": 4,
"STEEM_MAX_RATION_DECAY_RATE": 1000000,
"STEEM_MAX_RESERVE_RATIO": 20000,
"STEEM_MAX_RUNNER_WITNESSES_HF0": 1,
"STEEM_MAX_RUNNER_WITNESSES_HF17": 1,
"STEEM_MAX_SATOSHIS": "4611686018427387903",
"STEEM_MAX_SHARE_SUPPLY": "1000000000000000",
"STEEM_MAX_SIG_CHECK_DEPTH": 2,
"STEEM_MAX_SIG_CHECK_ACCOUNTS": 125,
"STEEM_MAX_TIME_UNTIL_EXPIRATION": 3600,
"STEEM_MAX_TRANSACTION_SIZE": 65536,
"STEEM_MAX_UNDO_HISTORY": 10000,
"STEEM_MAX_URL_LENGTH": 127,
"STEEM_MAX_VOTE_CHANGES": 5,
"STEEM_MAX_VOTED_WITNESSES_HF0": 19,
"STEEM_MAX_VOTED_WITNESSES_HF17": 20,
"STEEM_MAX_WITHDRAW_ROUTES": 10,
"STEEM_MAX_WITNESS_URL_LENGTH": 2048,
"STEEM_MIN_ACCOUNT_CREATION_FEE": 1,
"STEEM_MIN_ACCOUNT_NAME_LENGTH": 3,
"STEEM_MIN_BLOCK_SIZE_LIMIT": 65536,
"STEEM_MIN_BLOCK_SIZE": 115,
"STEEM_MIN_CONTENT_REWARD": {
"amount": "1000",
"precision": 3,
"nai": "@@000000021"
},
"STEEM_MIN_CURATE_REWARD": {
"amount": "1000",
"precision": 3,
"nai": "@@000000021"
},
"STEEM_MIN_PERMLINK_LENGTH": 0,
"STEEM_MIN_REPLY_INTERVAL": 20000000,
"STEEM_MIN_REPLY_INTERVAL_HF20": 3000000,
"STEEM_MIN_ROOT_COMMENT_INTERVAL": 300000000,
"STEEM_MIN_VOTE_INTERVAL_SEC": 3,
"STEEM_MINER_ACCOUNT": "miners",
"STEEM_MINER_PAY_PERCENT": 100,
"STEEM_MIN_FEEDS": 7,
"STEEM_MINING_REWARD": {
"amount": "1000",
"precision": 3,
"nai": "@@000000021"
},
"STEEM_MINING_TIME": "2016-03-24T17:00:00",
"STEEM_MIN_LIQUIDITY_REWARD": {
"amount": "1200000",
"precision": 3,
"nai": "@@000000021"
},
"STEEM_MIN_LIQUIDITY_REWARD_PERIOD_SEC": 60000000,
"STEEM_MIN_PAYOUT_SBD": {
"amount": "20",
"precision": 3,
"nai": "@@000000013"
},
"STEEM_MIN_POW_REWARD": {
"amount": "1000",
"precision": 3,
"nai": "@@000000021"
},
"STEEM_MIN_PRODUCER_REWARD": {
"amount": "1000",
"precision": 3,
"nai": "@@000000021"
},
"STEEM_MIN_TRANSACTION_EXPIRATION_LIMIT": 15,
"STEEM_MIN_TRANSACTION_SIZE_LIMIT": 1024,
"STEEM_MIN_UNDO_HISTORY": 10,
"STEEM_NULL_ACCOUNT": "null",
"STEEM_NUM_INIT_MINERS": 1,
"STEEM_OWNER_AUTH_HISTORY_TRACKING_START_BLOCK_NUM": 3186477,
"STEEM_OWNER_AUTH_RECOVERY_PERIOD": "2592000000000",
"STEEM_OWNER_CHALLENGE_COOLDOWN": "86400000000",
"STEEM_OWNER_CHALLENGE_FEE": {
"amount": "30000",
"precision": 3,
"nai": "@@000000021"
},
"STEEM_OWNER_UPDATE_LIMIT": 3600000000,
"STEEM_POST_AVERAGE_WINDOW": 86400,
"STEEM_POST_REWARD_FUND_NAME": "post",
"STEEM_POST_WEIGHT_CONSTANT": 1600000000,
"STEEM_POW_APR_PERCENT": 750,
"STEEM_PRODUCER_APR_PERCENT": 750,
"STEEM_PROXY_TO_SELF_ACCOUNT": "",
"STEEM_SBD_INTEREST_COMPOUND_INTERVAL_SEC": 2592000,
"STEEM_SECONDS_PER_YEAR": 31536000,
"STEEM_RECENT_RSHARES_DECAY_TIME_HF19": "1296000000000",
"STEEM_RECENT_RSHARES_DECAY_TIME_HF17": "2592000000000",
"STEEM_REVERSE_AUCTION_WINDOW_SECONDS_HF6": 1800,
"STEEM_REVERSE_AUCTION_WINDOW_SECONDS_HF20": 900,
"STEEM_ROOT_POST_PARENT": "",
"STEEM_SAVINGS_WITHDRAW_REQUEST_LIMIT": 100,
"STEEM_SAVINGS_WITHDRAW_TIME": "259200000000",
"STEEM_SBD_START_PERCENT_HF14": 200,
"STEEM_SBD_START_PERCENT_HF20": 900,
"STEEM_SBD_STOP_PERCENT_HF14": 500,
"STEEM_SBD_STOP_PERCENT_HF20": 1000,
"STEEM_SECOND_CASHOUT_WINDOW": 2592000,
"STEEM_SOFT_MAX_COMMENT_DEPTH": 255,
"STEEM_START_MINER_VOTING_BLOCK": 864000,
"STEEM_START_VESTING_BLOCK": 201600,
"STEEM_TEMP_ACCOUNT": "temp",
"STEEM_UPVOTE_LOCKOUT_HF7": 60000000,
"STEEM_UPVOTE_LOCKOUT_HF17": "43200000000",
"STEEM_UPVOTE_LOCKOUT_SECONDS": 43200,
"STEEM_VESTING_FUND_PERCENT": 1500,
"STEEM_VESTING_WITHDRAW_INTERVALS": 13,
"STEEM_VESTING_WITHDRAW_INTERVALS_PRE_HF_16": 104,
"STEEM_VESTING_WITHDRAW_INTERVAL_SECONDS": 604800,
"STEEM_VOTE_DUST_THRESHOLD": 50000000,
"STEEM_VOTING_MANA_REGENERATION_SECONDS": 432000,
"STEEM_SYMBOL": null,
"VESTS_SYMBOL": null,
"STEEM_VIRTUAL_SCHEDULE_LAP_LENGTH": "18446744073709551615",
"STEEM_VIRTUAL_SCHEDULE_LAP_LENGTH2": "340282366920938463463374607431768211455",
"STEEM_MAX_LIMIT_ORDER_EXPIRATION": 2419200,
"STEEM_DELEGATION_RETURN_PERIOD_HF0": 604800,
"STEEM_DELEGATION_RETURN_PERIOD_HF20": 432000,
"STEEM_RD_MIN_DECAY_BITS": 6,
"STEEM_RD_MAX_DECAY_BITS": 32,
"STEEM_RD_DECAY_DENOM_SHIFT": 36,
"STEEM_RD_MAX_POOL_BITS": 64,
"STEEM_RD_MAX_BUDGET_1": "17179869183",
"STEEM_RD_MAX_BUDGET_2": 268435455,
"STEEM_RD_MAX_BUDGET_3": 2147483647,
"STEEM_RD_MAX_BUDGET": 268435455,
"STEEM_RD_MIN_DECAY": 64,
"STEEM_RD_MIN_BUDGET": 1,
"STEEM_RD_MAX_DECAY": 4294967295,
"STEEM_ACCOUNT_SUBSIDY_PRECISION": 10000,
"STEEM_WITNESS_SUBSIDY_BUDGET_PERCENT": 12500,
"STEEM_WITNESS_SUBSIDY_DECAY_PERCENT": 210000,
"STEEM_DEFAULT_ACCOUNT_SUBSIDY_DECAY": 347321,
"STEEM_DEFAULT_ACCOUNT_SUBSIDY_BUDGET": 797,
"STEEM_DECAY_BACKSTOP_PERCENT": 9000
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_config", "id":1}' https://api.steemit.com
database_api.get_current_price_feed
Returns the current price feed.
Query Parameters JSON
{}
Expected Response JSON
{
"base": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
},
"quote": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
}
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_current_price_feed", "id":1}' https://api.steemit.com
database_api.get_dynamic_global_properties
Returns the current dynamic global properties. See: Understanding Dynamic Global Properties
Query Parameters JSON
{}
Expected Response JSON
{
"id": 0,
"head_block_number": 0,
"head_block_id": "0000000000000000000000000000000000000000",
"time": "1970-01-01T00:00:00",
"current_witness": "",
"total_pow": "18446744073709551615",
"num_pow_witnesses": 0,
"virtual_supply": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
},
"current_supply": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
},
"confidential_supply": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
},
"init_sbd_supply": {
"amount": "0",
"precision": 3,
"nai": "@@000000013"
},
"current_sbd_supply": {
"amount": "0",
"precision": 3,
"nai": "@@000000013"
},
"confidential_sbd_supply": {
"amount": "0",
"precision": 3,
"nai": "@@000000013"
},
"total_vesting_fund_steem": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
},
"total_vesting_shares": {
"amount": "0",
"precision": 6,
"nai": "@@000000037"
},
"total_reward_fund_steem": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
},
"total_reward_shares2": "0",
"pending_rewarded_vesting_shares": {
"amount": "0",
"precision": 6,
"nai": "@@000000037"
},
"pending_rewarded_vesting_steem": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
},
"sbd_interest_rate": 0,
"sbd_print_rate": 10000,
"maximum_block_size": 0,
"required_actions_partition_percent": 0,
"current_aslot": 0,
"recent_slots_filled": "0",
"participation_count": 0,
"last_irreversible_block_num": 0,
"vote_power_reserve_rate": 40,
"delegation_return_period": 3600,
"reverse_auction_seconds": 0,
"available_account_subsidies": 0,
"sbd_stop_percent": 0,
"sbd_start_percent": 0,
"sbd_stop_adjust": 0,
"next_maintenance_time": "1970-01-01T00:00:00",
"last_budget_time": "1970-01-01T00:00:00",
"content_reward_percent": 7500,
"vesting_reward_percent": 1500,
"sps_fund_percent": 0,
"sps_interval_ledger": {
"amount": "0",
"precision": 3,
"nai": "@@000000013"
},
"downvote_pool_percent": 0,
"smt_creation_fee": {
"amount": "1000",
"precision": 3,
"nai": "@@000000013"
}
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_dynamic_global_properties", "id":1}' https://api.steemit.com
database_api.get_feed_history
Returns the history of price feed values.
Query Parameters JSON
{}
Expected Response JSON
{
"id": 0,
"current_median_history": {
"base": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
},
"quote": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
}
},
"price_history": []
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_feed_history", "id":1}' https://api.steemit.com
database_api.get_hardfork_properties
Returns the current properties about the blockchain’s hardforks.
Query Parameters JSON
{}
Expected Response JSON
{
"id": 0,
"processed_hardforks": [],
"last_hardfork": 0,
"current_hardfork_version": "0.0.0",
"next_hardfork": "0.0.0",
"next_hardfork_time": "1970-01-01T00:00:00"
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_hardfork_properties", "id":1}' https://api.steemit.com
database_api.get_order_book
Returns the order book.
Query Parameters JSON
{"limit": 0}
Expected Response JSON
{"asks": [], "bids": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_order_book", "params":{"limit":10}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_order_book", "params":{"limit":50}, "id":1}' https://api.steemit.com
database_api.get_potential_signatures
This method will return the set of all public keys that could possibly
sign for a given transaction. This call can be used by wallets to filter
their set of public keys to just the relevant subset prior to calling
get_required_signatures to get the minimum subset.
Query Parameters JSON
{
"trx": {
"ref_block_num": 0,
"ref_block_prefix": 0,
"expiration": "1970-01-01T00:00:00",
"operations": [],
"extensions": [],
"signatures": []
}
}
Expected Response JSON
{"keys": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_potential_signatures", "params":{"trx":{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[{"type":"pow_operation","value":{"worker_account":"cloop3","block_id":"00000449f7860b82b4fbe2f317c670e9f01d6d9a","nonce":3899,"work":{"worker":"STM7P5TDnA87Pj9T4mf6YHrhzjC1KbPZpNxLWCcVcHxNYXakpoT4F","input":"ae8e7c677119d22385f8c48026fee7aad7bba693bf788d7f27047f40b47738c0","signature":"1f38fe9a3f9989f84bd94aa5bbc88beaf09b67f825aa4450cf5105d111149ba6db560b582c7dbb026c7fc9c2eb5051815a72b17f6896ed59d3851d9a0f9883ca7a","work":"000e7b209d58f2e64b36e9bf12b999c6c7af168cc3fc41eb7f8a4bf796c174c3"},"props":{"account_creation_fee":{"amount":"100000","precision":3,"nai":"@@000000021"},"maximum_block_size":131072,"sbd_interest_rate":1000}}}],"extensions":[],"signatures":[]}}, "id":1}' https://api.steemit.com
database_api.get_required_signatures
This API will take a partially signed transaction and a set of public keys that the owner has the ability to sign for and return the minimal subset of public keys that should add signatures to the transaction.
Query Parameters JSON
{
"trx": {
"ref_block_num": 0,
"ref_block_prefix": 0,
"expiration": "1970-01-01T00:00:00",
"operations": [],
"extensions": [],
"signatures": []
},
"available_keys": []
}
Expected Response JSON
{"keys": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_required_signatures", "params":{"trx":{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[{"type":"pow_operation","value":{"worker_account":"cloop3","block_id":"00000449f7860b82b4fbe2f317c670e9f01d6d9a","nonce":3899,"work":{"worker":"STM7P5TDnA87Pj9T4mf6YHrhzjC1KbPZpNxLWCcVcHxNYXakpoT4F","input":"ae8e7c677119d22385f8c48026fee7aad7bba693bf788d7f27047f40b47738c0","signature":"1f38fe9a3f9989f84bd94aa5bbc88beaf09b67f825aa4450cf5105d111149ba6db560b582c7dbb026c7fc9c2eb5051815a72b17f6896ed59d3851d9a0f9883ca7a","work":"000e7b209d58f2e64b36e9bf12b999c6c7af168cc3fc41eb7f8a4bf796c174c3"},"props":{"account_creation_fee":{"amount":"100000","precision":3,"nai":"@@000000021"},"maximum_block_size":131072,"sbd_interest_rate":1000}}}],"extensions":[],"signatures":[]},"available_keys":[]}, "id":1}' https://api.steemit.com
- Since: HF17
- Related
database_api.get_reward_funds
Returns information about the current reward funds.
Query Parameters JSON
{}
Expected Response JSON
{"funds": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_reward_funds", "id":1}' https://api.steemit.com
database_api.get_transaction_hex
Returns a hexdump of the serialized binary form of a transaction.
Query Parameters JSON
{
"trx": {
"ref_block_num": 0,
"ref_block_prefix": 0,
"expiration": "1970-01-01T00:00:00",
"operations": [],
"extensions": [],
"signatures": []
}
}
Expected Response JSON
{"hex": "00000000000000000000000000"}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_transaction_hex", "params":{"trx":{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[{"type":"pow_operation","value":{"worker_account":"cloop3","block_id":"00000449f7860b82b4fbe2f317c670e9f01d6d9a","nonce":3899,"work":{"worker":"STM7P5TDnA87Pj9T4mf6YHrhzjC1KbPZpNxLWCcVcHxNYXakpoT4F","input":"ae8e7c677119d22385f8c48026fee7aad7bba693bf788d7f27047f40b47738c0","signature":"1f38fe9a3f9989f84bd94aa5bbc88beaf09b67f825aa4450cf5105d111149ba6db560b582c7dbb026c7fc9c2eb5051815a72b17f6896ed59d3851d9a0f9883ca7a","work":"000e7b209d58f2e64b36e9bf12b999c6c7af168cc3fc41eb7f8a4bf796c174c3"},"props":{"account_creation_fee":{"amount":"100000","precision":3,"nai":"@@000000021"},"maximum_block_size":131072,"sbd_interest_rate":1000}}}],"extensions":[],"signatures":[]}}, "id":1}' https://api.steemit.com
- Since: HF20
- Related
database_api.get_version
Returns the compile time versions of blockchain, steem, FC. Also returns the boot time version of the chain id (may be different from compile time value only when looking at a testnet)
Query Parameters JSON
{}
Expected Response JSON
{
"blockchain_version": "",
"steem_revision": "",
"fc_revision": "",
"chain_id": "0000000000000000000000000000000000000000000000000000000000000000"
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_version", "id":1}' https://api.steemit.com
database_api.get_witness_schedule
Returns the current witness schedule.
Query Parameters JSON
{}
Expected Response JSON
{
"id": 0,
"current_virtual_time": "0",
"next_shuffle_block_num": 76479392,
"current_shuffled_witnesses": [],
"num_scheduled_witnesses": 0,
"elected_weight": 132,
"timeshare_weight": 86,
"miner_weight": 125,
"witness_pay_normalization_factor": 32767,
"median_props": {
"account_creation_fee": {
"amount": "1",
"precision": 3,
"nai": "@@000000021"
},
"maximum_block_size": 131072,
"sbd_interest_rate": 1000,
"account_subsidy_budget": 797,
"account_subsidy_decay": 347321
},
"majority_version": "0.0.0",
"max_voted_witnesses": 0,
"max_miner_witnesses": 0,
"max_runner_witnesses": 0,
"hardfork_required_witnesses": 0,
"account_subsidy_rd": {
"resource_unit": 0,
"budget_per_time_unit": 0,
"pool_eq": 0,
"max_pool_size": 0,
"decay_params": {
"decay_per_time_unit": 0,
"decay_per_time_unit_denom_shift": 0
},
"min_decay": 0
},
"account_subsidy_witness_rd": {
"resource_unit": 0,
"budget_per_time_unit": 0,
"pool_eq": 0,
"max_pool_size": 0,
"decay_params": {
"decay_per_time_unit": 0,
"decay_per_time_unit_denom_shift": 0
},
"min_decay": 0
},
"min_witness_account_subsidy_decay": 0
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_witness_schedule", "id":1}' https://api.steemit.com
- Since: HF11
- Related
database_api.list_account_recovery_requests
Returns a list of account recovery requests. Parameters: start:string, limit:int, order:string
limitis up to 1000.ordercan be one of:by_account- order by accont nameby_expiration- order by expiration
account (string) |
limit (int) |
order (string) |
|
|---|---|---|---|
"steemit" |
10 | "by_account" |
Queries the recovery requests for account named “steemit”, ordered by account name. |
["1960-01-01T00:00:00"] |
10 | "by_expiration" |
Queries the recovery requests for date, ordered by expiration. |
Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{"requests": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_account_recovery_requests", "params": {"start":"", "limit":10, "order":"by_account"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_account_recovery_requests", "params": {"start":["1960-01-01T00:00:00"], "limit":10, "order":"by_expiration"}, "id":1}' https://api.steemit.com
database_api.list_accounts
List accounts ordered by specified key. Parameters: start:object, limit:int, order:string
limitis up to 1000.ordercan be one of:by_name- order by accont nameby_proxy- order by proxyby_next_vesting_withdrawal- order by next next vesting withdrawal
start (object) |
limit (int) |
order (string) |
|---|---|---|
"" |
10 |
"by_name" Queries for up to 10 accounts starting at the beginning, sorted by name. |
["", ""] |
10 |
"by_proxy" Queries for up to 10 accounts starting at the beginning, sorted by proxy. |
["1960-01-01T00:00:00", ""] |
10 |
"by_next_vesting_withdrawal" Queries for up to 10 accounts starting at the beginning, sorted by next vesting withdrawl. |
Also see: Paginated API Methods
Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{
"accounts": [
{
"id": 7184,
"name": "a-0",
"owner": {
"weight_threshold": 1,
"account_auths": [],
"key_auths": [
[
"STM5RrTRNDhhrMaA24SzSeE5AvmUcutb1q1VZp1imnT8p871s3UjN",
1
]
]
},
"active": {
"weight_threshold": 1,
"account_auths": [],
"key_auths": [
[
"STM5RrTRNDhhrMaA24SzSeE5AvmUcutb1q1VZp1imnT8p871s3UjN",
1
]
]
},
"posting": {
"weight_threshold": 1,
"account_auths": [],
"key_auths": [
[
"STM5RrTRNDhhrMaA24SzSeE5AvmUcutb1q1VZp1imnT8p871s3UjN",
1
]
]
},
"memo_key": "STM5RrTRNDhhrMaA24SzSeE5AvmUcutb1q1VZp1imnT8p871s3UjN",
"json_metadata": "",
"proxy": "",
"last_owner_update": "1970-01-01T00:00:00",
"last_account_update": "1970-01-01T00:00:00",
"created": "2016-04-30T12:27:12",
"mined": true,
"recovery_account": "steem",
"last_account_recovery": "1970-01-01T00:00:00",
"reset_account": "null",
"comment_count": 0,
"lifetime_vote_count": 0,
"post_count": 0,
"can_vote": true,
"voting_manabar": {
"current_mana": 10000,
"last_update_time": 1462019232
},
"balance": {
"amount": "1",
"precision": 3,
"nai": "@@000000021"
},
"savings_balance": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
},
"sbd_balance": {
"amount": "0",
"precision": 3,
"nai": "@@000000013"
},
"sbd_seconds": "0",
"sbd_seconds_last_update": "1970-01-01T00:00:00",
"sbd_last_interest_payment": "1970-01-01T00:00:00",
"savings_sbd_balance": {
"amount": "0",
"precision": 3,
"nai": "@@000000013"
},
"savings_sbd_seconds": "0",
"savings_sbd_seconds_last_update": "1970-01-01T00:00:00",
"savings_sbd_last_interest_payment": "1970-01-01T00:00:00",
"savings_withdraw_requests": 0,
"reward_sbd_balance": {
"amount": "0",
"precision": 3,
"nai": "@@000000013"
},
"reward_steem_balance": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
},
"reward_vesting_balance": {
"amount": "0",
"precision": 6,
"nai": "@@000000037"
},
"reward_vesting_steem": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
},
"vesting_shares": {
"amount": "13873020360",
"precision": 6,
"nai": "@@000000037"
},
"delegated_vesting_shares": {
"amount": "0",
"precision": 6,
"nai": "@@000000037"
},
"received_vesting_shares": {
"amount": "0",
"precision": 6,
"nai": "@@000000037"
},
"vesting_withdraw_rate": {
"amount": "0",
"precision": 6,
"nai": "@@000000037"
},
"next_vesting_withdrawal": "1969-12-31T23:59:59",
"withdrawn": 0,
"to_withdraw": 0,
"withdraw_routes": 0,
"curation_rewards": 0,
"posting_rewards": 0,
"proxied_vsf_votes": [0, 0, 0, 0],
"witnesses_voted_for": 0,
"last_post": "1970-01-01T00:00:00",
"last_root_post": "1970-01-01T00:00:00",
"last_vote_time": "1970-01-01T00:00:00",
"post_bandwidth": 0,
"pending_claimed_accounts": 0,
"is_smt": false
}
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_accounts", "params": {"start":"", "limit":10, "order":"by_name"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_accounts", "params": {"start":["", ""], "limit":10, "order":"by_proxy"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_accounts", "params": {"start":["1960-01-01T00:00:00", ""], "limit":10, "order":"by_next_vesting_withdrawal"}, "id":1}' https://api.steemit.com
- Since: HF11
- Related
database_api.list_change_recovery_account_requests
Returns a list of recovery account change requests. Parameters: start:object, limit:int, order:string
startdepends onorder(see below)limitis up to 1000.ordercan be one of:by_account- order by accountstartis string of:account
by_effective_date- order by effective datestartis an array of two values:timestamp,account
start (object) |
limit (int) |
order (string) |
|
|---|---|---|---|
"" |
10 | "by_account" |
Queries first 10 requests, sort by account |
["1960-01-01T00:00:00", ""] |
10 | "by_effective_date" |
Queries first 10 requests, sort by effective date |
Also see: Paginated API Methods
Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{
"requests": [
{
"id": 99,
"account_to_recover": "alice",
"recovery_account": "bob",
"effective_on": "1960-01-01T00:00:00"
}
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_change_recovery_account_requests", "params": {"start":"alice", "limit":10, "order":"by_account"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_change_recovery_account_requests", "params": {"start":["1960-01-01T00:00:00",""], "limit":10, "order":"by_effective_date"}, "id":1}' https://api.steemit.com
database_api.list_comments
Returns all comments, starting with the specified options. Parameters: start:array; limit:int; order:string
startdepends onorder(see below)limitis up to 1000.ordercan be one of:by_cashout_time- order by cashout timestartis an array of one required value and two optional:timestamp,author,permlink
by_permlink- order by permlinkstartis an array of two optional values:author,permlink
by_root- order by rootstartis an array of two required values and two optional:root_author,root_permlink,child_author,child_permlink
by_parent- order by parentstartis an array of two required values and two optional:parent_author,parent_permlink,child_author,child_permlink
start (array) |
limit (int) |
order (string) |
|
|---|---|---|---|
["1970-01-01T00:00:00", "", ""] |
10 | "by_cashout_time" |
Queries first 10 comments, sort by cashout time |
["", ""] |
10 | "by_permlink" |
Queries first 10 comments, sort by permlink |
["steemit","firstpost", "", ""] |
10 | "by_root" |
Queries next 10 comments starting at @steemit/firstpost, sort by root |
["steemit","firstpost", "", ""] |
10 | "by_parent" |
Queries next 10 comments starting at @steemit/firstpost, sort by parent |
Also see: Paginated API Methods
Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{
"comments": [
{
"id": 66710716,
"author": "libert",
"permlink": "libert-re-runicar-re-libert-libert-re-runicar-re-libert-libert-re-runicar-ykwyxgj6-20181128t063355338z",
"category": "steem",
"parent_author": "runicar",
"parent_permlink": "re-libert-libert-re-runicar-re-libert-libert-re-runicar-ykwyxgj6-20181128t063100538z",
"title": "",
"body": "13\n\nPosted using [Partiko Android](https://steemit.com/@partiko-android)",
"json_metadata": "{\"app\":\"partiko\"}",
"last_update": "2018-11-28T06:33:57",
"created": "2018-11-28T06:33:57",
"active": "2018-11-28T06:34:30",
"last_payout": "1970-01-01T00:00:00",
"depth": 5,
"children": 1,
"net_rshares": 0,
"abs_rshares": 0,
"vote_rshares": 0,
"children_abs_rshares": 0,
"cashout_time": "2018-12-05T06:33:57",
"max_cashout_time": "1969-12-31T23:59:59",
"total_vote_weight": 0,
"reward_weight": 10000,
"total_payout_value": {
"amount": "0",
"precision": 3,
"nai": "@@000000013"
},
"curator_payout_value": {
"amount": "0",
"precision": 3,
"nai": "@@000000013"
},
"author_rewards": 0,
"net_votes": 0,
"root_author": "runicar",
"root_permlink": "ykwyxgj6",
"max_accepted_payout": {
"amount": "1000000000",
"precision": 3,
"nai": "@@000000013"
},
"percent_steem_dollars": 10000,
"allow_replies": true,
"allow_votes": true,
"allow_curation_rewards": true,
"beneficiaries": []
}
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_comments", "params": {"start":["1970-01-01T00:00:00","",""], "limit":10, "order":"by_cashout_time"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_comments", "params": {"start":["",""], "limit":10, "order":"by_permlink"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_comments", "params": {"start":["steemit","firstpost","",""], "limit":10, "order":"by_root"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_comments", "params": {"start":["steemit","firstpost","",""], "limit":10, "order":"by_parent"}, "id":1}' https://api.steemit.com
- Since: HF14
- Related
database_api.list_decline_voting_rights_requests
Returns a list of decline voting rights requests. Parameters: start:object; limit:int; order:string
startdepends onorder(see below)limitis up to 1000.ordercan be one of:by_account- order by accountstartis a string:account
by_effective_date- order by effective datestartis an array of two values:timestamp,account
start (object) |
limit (int) |
order (string) |
|
|---|---|---|---|
"" |
10 | "by_account" |
Queries first 10 requests, sort by account |
["1960-01-01T00:00:00", ""] |
10 | "by_effective_date" |
Queries first 10 requests, sort by effective date |
Also see: Paginated API Methods
Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{"requests": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_decline_voting_rights_requests", "params": {"start":"", "limit":10, "order":"by_account"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_decline_voting_rights_requests", "params": {"start":["1970-01-01T00:00:00","",""], "limit":10, "order":"by_effective_date"}, "id":1}' https://api.steemit.com
- Since: HF14
- Related
database_api.list_escrows
Returns a list of escrows. Parameters: start:array; limit:int; order:string
startdepends onorder(see below)limitis up to 1000.ordercan be one of:by_from_id- order by idstartis an array of two values:account,escrow_id
by_ratification_deadline- order by ratification deadlinestartis an array of three values:is_approved,timestamp,escrow_id
start (array) |
limit (int) |
order (string) |
|
|---|---|---|---|
["alice", 99] |
10 | "by_from_id" |
Queries first 10 requests, sort by id |
[true, "1960-01-01T00:00:00", 99] |
10 | "by_ratification_deadline" |
Queries first 10 requests, sort by ratification deadline |
Also see: Paginated API Methods
Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{
"escrows": [
{
"id": 158,
"escrow_id": 1,
"from": "addicttolife",
"to": "fundition.help",
"agent": "ongame",
"ratification_deadline": "2018-11-23T17:31:26",
"escrow_expiration": "2018-11-24T17:31:26",
"sbd_balance": {
"amount": "0",
"precision": 3,
"nai": "@@000000013"
},
"steem_balance": {
"amount": "4832",
"precision": 3,
"nai": "@@000000021"
},
"pending_fee": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
},
"to_approved": true,
"agent_approved": true,
"disputed": false
}
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_escrows", "params": {"start":["",0], "limit":10, "order":"by_from_id"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_escrows", "params": {"start":[true, "1970-01-01T00:00:00", 0], "limit":10, "order":"by_ratification_deadline"}, "id":1}' https://api.steemit.com
database_api.list_limit_orders
Returns a list of limit orders. Parameters: start:array; limit:int; order:string
startdepends onorder(see below)limitis up to 1000.ordercan be one of:by_price- order by pricestartis an array of two values:price,order_type
by_account- order by accountstartis an array of two values:account,order_id
start (array) |
limit (int) |
order (string) |
|
|---|---|---|---|
[{"base": {"amount": "85405", "precision": 3, "nai": "@@000000021"}, "quote": {"amount": "17192", "precision": 3, "nai": "@@000000013"}}, 0] |
10 | "by_price" |
Queries first 10 requests, sort by price |
["alice", 0] |
10 | "by_effective_date" |
Queries first 10 requests, sort by account |
Also see: Paginated API Methods
Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{
"orders": [
{
"id": 3155591,
"created": "2018-12-05T06:34:21",
"expiration": "2018-12-15T06:34:20",
"seller": "teamsmooth-mm",
"orderid": 2000,
"for_sale": 197714,
"sell_price": {
"base": {
"amount": "198513",
"precision": 3,
"nai": "@@000000021"
},
"quote": {
"amount": "80000",
"precision": 3,
"nai": "@@000000013"
}
}
}
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_limit_orders", "params": {"start":[{"base":{"amount":"1000","precision":3,"nai":"@@000000021"},"quote":{"amount":"1","precision":3,"nai":"@@000000013"}},0], "limit":10, "order":"by_price"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_limit_orders", "params": {"start":["alice",0], "limit":10, "order":"by_account"}, "id":1}' https://api.steemit.com
database_api.list_owner_histories
Returns a list of owner authority histories. Parameters: start:array, limit:int
start (array) |
limit (int) |
|
|---|---|---|
["steemit", "1970-01-01T00:00:00"] |
10 | Queries the owner history starting from account named “steemit” on “1970-01-01T00:00:00”, limit 10 results. |
["alice", "1970-01-01T00:00:00"] |
10 | Queries the owner history starting from account named “alice”, limit 10 results. |
Also see: Paginated API Methods
Query Parameters JSON
{"start": null, "limit": 0}
Expected Response JSON
{
"owner_auths": [
{
"id": 129742,
"account": "a-m",
"previous_owner_authority": {
"weight_threshold": 1,
"account_auths": [],
"key_auths": [
[
"STM7J6gXoztfTscNzmzL11DFtTPCFCTeZzsFtFxsQrQw91KnN1YxQ",
1
]
]
},
"last_valid_time": "2018-11-24T02:35:27"
}
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_owner_histories", "params": {"start":["steemit","1970-01-01T00:00:00"], "limit":10}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_owner_histories", "params": {"start":["alice","1970-01-01T00:00:00"], "limit":10}, "id":1}' https://api.steemit.com
- Since: HF14
- Related
database_api.list_savings_withdrawals
Returns a list of savings withdrawls. Parameters: start:object, limit:int, order:string
limitis up to 1000.ordercan be one of:by_from_id- order by idstartis an array of two values:account,request_id
by_complete_from_id- order by id (complete)startis an array of three values:timestamp,account,request_id
by_to_complete- order by completestartis an array of three values:account,timestamp,order_id
start (object) |
limit (int) |
order (string) |
|
|---|---|---|---|
[0] |
10 |
"by_from_id" |
Queries the savings withdraw for id. |
["2018-12-07T16:54:03", "steemit", 0] |
10 |
"by_complete_from_id" |
Queries the savings withdraw for id (completed). |
["", "1970-01-01T00:00:00", 0] |
10 |
"by_to_complete" |
Queries the savings withdraw completed. |
Also see: Paginated API Methods
Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{
"withdrawals": [
{
"id": 120083,
"from": "adafnnys",
"to": "adafnnys",
"memo": "",
"request_id": 1543942411,
"amount": {
"amount": "2413",
"precision": 3,
"nai": "@@000000013"
},
"complete": "2018-12-07T16:54:03"
}
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_savings_withdrawals", "params": {"start":[0], "limit":10, "order":"by_from_id"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_savings_withdrawals", "params": {"start":["2018-12-07T16:54:03", "steemit", 0], "limit":10, "order":"by_complete_from_id"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_savings_withdrawals", "params": {"start":["", "1970-01-01T00:00:00", 0], "limit":10, "order":"by_to_complete"}, "id":1}' https://api.steemit.com
database_api.list_sbd_conversion_requests
Returns the list of SBD conversion requests for an account. Parameters: start:array, limit:int, order:string
limitis up to 1000.ordercan be one of:by_account- order by accont namestartis an array of two values:account,request_id
by_conversion_date- order by conversion datestartis an array of two values:timestamp,request_id
start (array) |
limit (int) |
order (string) |
|
|---|---|---|---|
["steemit", 0] |
10 | by_account |
Queries a conversion request for steemit, limit to 10 results, order by account name. |
["2018-12-07T16:54:03", 0] |
10 | by_conversion_date |
Queries a conversion request from this date, limit to 10 results, order by conversion date. |
Also see: Paginated API Methods
Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{
"requests": [
{
"id": 75677,
"owner": "adenijiadeshina",
"requestid": 3,
"amount": {
"amount": "311",
"precision": 3,
"nai": "@@000000013"
},
"conversion_date": "2018-12-06T20:42:42"
}
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_sbd_conversion_requests", "params": {"start":["steemit", 0], "limit":10, "order":"by_account"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_sbd_conversion_requests", "params": {"start":["2018-12-07T16:54:03", 0], "limit":10, "order":"by_conversion_date"}, "id":1}' https://api.steemit.com
- Since: HF17
- Related
database_api.list_vesting_delegation_expirations
Returns a list of vesting delegation expirations. Parameters: start:array, limit:int, order:string
limitis up to 1000.ordercan be one of:by_expiration- order by expirationstartis an array of two values:timestamp,expiration_id
by_account_expiration- order by account expirationstartis an array of two values:account,timestamp,expiration_id
start (array) |
limit (int) |
order (string) |
|
|---|---|---|---|
["1970-01-01T00:00:00", 0] |
10 | by_expiration |
Queries delegations, limit to 10 results, order by expiration. |
["alice", "1970-01-01T00:00:00", 0] |
10 | by_account_expiration |
Queries delegation from this date, limit to 10 results, order by account expiration. |
Also see: Paginated API Methods
Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{
"delegations": [
{
"id": 3076685,
"delegator": "anonsteem",
"vesting_shares": {
"amount": "6050629930",
"precision": 6,
"nai": "@@000000037"
},
"expiration": "2018-12-05T07:07:15"
}
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_vesting_delegation_expirations", "params": {"start":["1970-01-01T00:00:00",0], "limit":10, "order":"by_expiration"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_vesting_delegation_expirations", "params": {"start":["alice", "1970-01-01T00:00:00",0], "limit":10, "order":"by_account_expiration"}, "id":1}' https://api.steemit.com
- Since: HF17
- Related
database_api.list_vesting_delegations
Returns a list of vesting delegations. Parameters: start:array, limit:int, order:string
limitis up to 1000.ordercan be one of:by_delegation- order by delegationsstartis an array of two values:delegator,delegatee
start (array) |
limit (int) |
order (string) |
|
|---|---|---|---|
["", ""] |
10 | by_delegation |
Queries delegations, limit to 10 results, order by delegations. |
Also see: Paginated API Methods
Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{
"delegations": [
{
"id": 554317,
"delegator": "a-0-0-0",
"delegatee": "a-0-0",
"vesting_shares": {
"amount": "6141067173",
"precision": 6,
"nai": "@@000000037"
},
"min_delegation_time": "2018-01-24T22:23:54"
}
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_vesting_delegations", "params": {"start":["",""], "limit":10, "order":"by_delegation"}, "id":1}' https://api.steemit.com
database_api.list_votes
Returns all votes, starting with the specified voter and/or author and permlink. Parameters: start:array; limit:int; order:string
startdepends onorder(see below)voteris optionalauthorandpermlinkare optional, but if one is blank, they must both be blank
limitis up to 1000.ordercan be one of:by_comment_voter- order by comment voterstartis an array of three optional values:author,permlink,voter
by_voter_comment- order by voter commentstartis an array of three optional values:voter,author,permlink
start (array) |
limit (int) |
order (string) |
|
|---|---|---|---|
["", "", ""] |
10 | "by_comment_voter" |
Queries first 10 votes, sort by comment voter |
["", "", ""] |
10 | "by_voter_comment" |
Queries first 10 votes, sort by voter comment |
["xeroc", "vanteem-config", ""] |
10 | "by_comment_voter" |
Queries next 10 votes starting on the post @xeroc/vanteem-config, sort by comment voter |
["alice", "xeroc", "vanteem-config"] |
10 | "by_voter_comment" |
Queries next 10 votes starting at alice on the post @xeroc/vanteem-config, sort by voter comment |
Also see: Paginated API Methods
Query Parameters JSON
{
"start": null,
"limit": 0,
"order": "by_comment_voter"
}
Expected Response JSON
{
"votes": [
{
"id": 9,
"voter": "dantheman",
"author": "steemit",
"permlink": "firstpost",
"weight": "32866333630",
"rshares": 375241,
"vote_percent": 100,
"last_update": "2016-04-07T19:15:36",
"num_changes": -1
}
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_votes", "params": {"start":["", "", ""], "limit":10, "order":"by_comment_voter"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_votes", "params": {"start":["", "", ""], "limit":10, "order":"by_voter_comment"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_votes", "params": {"start":["", "", "steemit"], "limit":10, "order":"by_comment_voter"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_votes", "params": {"start":["alice", "xeroc", "vanteem-config"], "limit":10, "order":"by_voter_comment"}, "id":1}' https://api.steemit.com
database_api.list_withdraw_vesting_routes
Returns a list of vesting withdraw routes. Parameters: start:array; limit:int; order:string
startdepends onorder(see below)limitis up to 1000.ordercan be one of:by_withdraw_route- order by withdraw routestartis an array of two values:from_account,to_account
by_destination- order by destinationstartis an array of two values:to_account,route_id
start (array) |
limit (int) |
order (string) |
|
|---|---|---|---|
["temp", ""] |
10 | "by_withdraw_route" |
Queries first 10 routes, sort by withdraw route |
["", 0] |
10 | "by_destination" |
Queries first 10 routes, sort by destination |
Also see: Paginated API Methods
Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{
"routes": [
{
"id": 39503,
"from_account": "temperature",
"to_account": "luckdiver",
"percent": 10000,
"auto_vest": false
}
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_withdraw_vesting_routes", "params": {"start":["temp",""], "limit":10, "order":"by_withdraw_route"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_withdraw_vesting_routes", "params": {"start":["",0], "limit":10, "order":"by_destination"}, "id":1}' https://api.steemit.com
database_api.list_witness_votes
Returns a list of witness votes. Parameters: start:array; limit:int; order:string
startdepends onorder(see below)limitis up to 1000.ordercan be one of:by_account_witness- order by account witnessstartis an array of two values:account,witness
by_witness_account- order by witness accountstartis an array of two values:witness,account
start (array) |
limit (int) |
order (string) |
|
|---|---|---|---|
["", ""] |
10 | "by_withdraw_route" |
Queries first 10 votes, sort by account witness |
["", ""] |
10 | "by_destination" |
Queries first 10 votes, sort by witness account |
Also see: Paginated API Methods
Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{
"votes": [
{
"id": 428961,
"witness": "aggroed",
"account": "a-0magic"
}
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_witness_votes", "params": {"start":["",""], "limit":10, "order":"by_account_witness"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_witness_votes", "params": {"start":["",""], "limit":10, "order":"by_witness_account"}, "id":1}' https://api.steemit.com
database_api.list_witnesses
Returns the list of witnesses. Parameters: start:object; limit:int; order:string
startdepends onorder(see below)limitis up to 1000.ordercan be one of:by_name- order by namestartis string value:account
by_vote_name- order by vote, namestartis an array of two values:votes,account
by_schedule_time- order by schedule timestartis an array of two values:virtual_scheduled_time,account
start (object) |
limit (int) |
order (string) |
|
|---|---|---|---|
"" |
10 | "by_name" |
Queries first 10 witnesses, sort by account name |
[0, ""] |
10 | "by_vote_name" |
Queries first 10 witnesses, sort by votes |
["473718186844702107410533306", "alice"] |
10 | "by_schedule_time" |
Queries first 10 witnesses, sort by schedule |
Also see: Paginated API Methods
Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{
"witnesses": [
{
"id": 6950,
"owner": "a-0",
"created": "1970-01-01T00:00:00",
"url": "",
"votes": 0,
"virtual_last_update": "0",
"virtual_position": "0",
"virtual_scheduled_time": "340282366920938463463374607431768211455",
"total_missed": 0,
"last_aslot": 1063323,
"last_confirmed_block_num": 1040423,
"pow_worker": 0,
"signing_key": "STM5RrTRNDhhrMaA24SzSeE5AvmUcutb1q1VZp1imnT8p871s3UjN",
"props": {
"account_creation_fee": {
"amount": "1",
"precision": 3,
"nai": "@@000000021"
},
"maximum_block_size": 131072,
"sbd_interest_rate": 1000,
"account_subsidy_budget": 797,
"account_subsidy_decay": 347321
},
"sbd_exchange_rate": {
"base": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
},
"quote": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
}
},
"last_sbd_exchange_update": "1970-01-01T00:00:00",
"last_work": "000000127cb0e335667f30100bc1a061175c2d789f808e0e9ac82ee70fa8e604",
"running_version": "0.0.0",
"hardfork_version_vote": "0.0.0",
"hardfork_time_vote": "2016-03-24T16:00:00",
"available_witness_account_subsidies": 0
}
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_witnesses", "params": {"start":"", "limit":10, "order":"by_name"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_witnesses", "params": {"start":[0,""], "limit":10, "order":"by_vote_name"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_witnesses", "params": {"start":["473718186844702107410533306","alice"], "limit":10, "order":"by_schedule_time"}, "id":1}' https://api.steemit.com
- Disabled
- Related
database_api.verify_account_authority
Not Implemented
Query Parameters JSON
{"account": "", "signers": []}
Expected Response JSON
{"valid": false}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.verify_account_authority", "params":{"account":"temp","signers":["STM8GC13uCZbP44HzMLV6zPZGwVQ8Nt4Kji8PapsPiNq1BK153XTX"]}, "id":1}' https://api.steemit.com
database_api.verify_authority
Returns true if the transaction has all of the required signatures, otherwise throws an exception.
Query Parameters JSON
{
"trx": {
"ref_block_num": 0,
"ref_block_prefix": 0,
"expiration": "1970-01-01T00:00:00",
"operations": [],
"extensions": [],
"signatures": []
}
}
Expected Response JSON
{"valid": false}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.verify_authority", "params":{"trx":{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[{"type":"pow_operation","value":{"worker_account":"cloop3","block_id":"00000449f7860b82b4fbe2f317c670e9f01d6d9a","nonce":3899,"work":{"worker":"STM7P5TDnA87Pj9T4mf6YHrhzjC1KbPZpNxLWCcVcHxNYXakpoT4F","input":"ae8e7c677119d22385f8c48026fee7aad7bba693bf788d7f27047f40b47738c0","signature":"1f38fe9a3f9989f84bd94aa5bbc88beaf09b67f825aa4450cf5105d111149ba6db560b582c7dbb026c7fc9c2eb5051815a72b17f6896ed59d3851d9a0f9883ca7a","work":"000e7b209d58f2e64b36e9bf12b999c6c7af168cc3fc41eb7f8a4bf796c174c3"},"props":{"account_creation_fee":{"amount":"100000","precision":3,"nai":"@@000000021"},"maximum_block_size":131072,"sbd_interest_rate":1000}}}],"extensions":[],"signatures":[]}}, "id":1}' https://api.steemit.com
database_api.verify_signatures
This is a general purpose API that checks signatures against accounts for an arbitrary sha256 hash using the existing authority structures.
Query Parameters JSON
{
"hash": "0000000000000000000000000000000000000000000000000000000000000000",
"signatures": [],
"required_owner": [],
"required_active": [],
"required_posting": [],
"required_other": []
}
Expected Response JSON
{"valid": false}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.verify_signatures", "params":{"hash": "0000000000000000000000000000000000000000000000000000000000000000", "signatures": [], "required_owner": [], "required_active": [], "required_posting": [], "required_other": []}, "id":1}' https://api.steemit.com
database_api.find_proposals
Finds proposals by proposal.id (not proposal.proposal_id).
Query Parameters JSON
{"proposal_ids": [0]}
Expected Response JSON
{
"proposals": [
{
"id": 0,
"proposal_id": "139925218365120",
"creator": "alice",
"receiver": "bob",
"start_date": "2019-07-01T00:00:00",
"end_date": "2019-08-01T23:59:59",
"daily_pay": {
"amount": "4800000",
"precision": 3,
"nai": "@@000000013"
},
"subject": "My Proposal",
"permlink": "creator-proposal-permlink",
"total_votes": "77351826710",
"status": "active"
}
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_proposals", "params":{"proposal_ids": [0]}, "id":1}' https://api.steemit.com
database_api.list_proposal_votes
Returns all proposal votes, starting with the specified voter or proposal.id. Parameters: start:array; limit:int; order:string; order_direction:string; status:string
startdepends onorder(see below)voter- voter of the proposal (account name string)proposal.id- id the proposal (int)
limitis up to 1000.ordercan be one of:by_voter_proposal- order by proposal voterby_proposal_voter- order byproposal.id
order_directioncan be one of:ascendingdescending
statusallinactiveactiveexpiredvotable
start (array) |
limit (int) |
order (string) |
order_direction (string) |
status (string) |
|
|---|---|---|---|---|---|
["alice"] |
10 | by_voter_proposal |
ascending |
active |
list 10 proposals with active status, ordered by voter, ascending |
[10] |
1000 | by_proposal_voter |
ascending |
votable |
list 1000 votes on proposal 10, ordered by proposal.id, ascending |
Also see: Paginated API Methods
Query Parameters JSON
{
"start": null,
"limit": 0,
"order": "by_name",
"order_direction": "ascending",
"status": "all"
}
Expected Response JSON
{
"proposal_votes": [
{
"id": 0,
"voter": "charlie",
"proposal": {
"id": 0,
"proposal_id": 0,
"creator": "alice",
"receiver": "bob",
"start_date": "2019-07-01T00:00:00",
"end_date": "2019-08-01T23:59:59",
"daily_pay": {
"amount": "4800000",
"precision": 3,
"nai": "@@000000013"
},
"subject": "My Proposal",
"permlink": "creator-proposal-permlink",
"total_votes": "77351826710",
"status": "active"
}
}
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_proposal_votes", "params":{"start": [""], "limit": 10, "order": "by_voter_proposal", "order_direction": "ascending", "status": "active"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_proposal_votes", "params":{"start": [0], "limit": 10, "order": "by_proposal_voter", "order_direction": "ascending", "status": "active"}, "id":1}' https://api.steemit.com
database_api.list_proposals
Returns all proposals, starting with the specified creator or start date. Parameters: start:array; limit:int; order:string; order_direction:string; status:string
startdepends onorder(see below)creator- creator of the proposal (account name string)start_date- start date of the proposal (date string)end_date- end date of the proposal (date string)total_votes- total votes of the proposal (int)
limitis up to 1000.ordercan be one of:by_creator- order by proposal creatorby_start_date- order by proposal start dateby_end_date- order by proposal end dateby_total_votes- order by proposal total votes
order_directioncan be one of:ascendingdescending
statusallinactiveactiveexpiredvotable
start (array) |
limit (int) |
order (string) |
order_direction (string) |
status (string) |
|
|---|---|---|---|---|---|
[""] |
10 | by_creator |
ascending |
active |
list 10 proposals with active status, ordered by creator, ascending |
["2019-08-07T16:54:03"] |
1000 | by_start_date |
ascending |
inactive |
list 1000 proposals with inactive status, ordered by start date, ascending, since 2019-08-07T16:54:03 |
["a"] |
1 | by_creator |
ascending |
expired |
list 1 proposal with expired status, ordered by creator, ascending, by accounts starting with “a” |
["alice"] |
10 | by_creator |
ascending |
all |
list 10 proposals with any status, ordered by creator, ascending, by alice |
[""] |
1000 | by_creator |
ascending |
votable |
list 1000 votable proposals, ordered by creator, ascending |
[10] |
1000 | by_total_votes |
ascending |
votable |
list 1000 votable proposals, ordered by creator, ascending, having at least 10 votes |
Also see: Paginated API Methods
Query Parameters JSON
{
"start": null,
"limit": 0,
"order": "by_name",
"order_direction": "ascending",
"status": "all"
}
Expected Response JSON
{
"proposals": [
{
"id": 0,
"proposal_id": "1103806595072",
"creator": "alice",
"receiver": "bob",
"start_date": "2019-07-01T00:00:00",
"end_date": "2019-08-01T23:59:59",
"daily_pay": {
"amount": "4800000",
"precision": 3,
"nai": "@@000000013"
},
"subject": "My Proposal",
"permlink": "creator-proposal-permlink",
"total_votes": "77351826710",
"status": "active"
}
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_proposals", "params":{"start": [""], "limit": 10, "order": "by_creator", "order_direction": "ascending", "status": "active"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_proposals", "params":{"start": ["2019-08-07T16:54:03"], "limit": 1000, "order": "by_start_date", "order_direction": "ascending", "status": "inactive"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_proposals", "params":{"start": ["a"], "limit": 1, "order": "by_creator", "order_direction": "ascending", "status": "expired"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_proposals", "params":{"start": ["alice"], "limit": 10, "order": "by_creator", "order_direction": "ascending", "status": "all"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_proposals", "params":{"start": [""], "limit": 1000, "order": "by_creator", "order_direction": "ascending", "status": "votable"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_proposals", "params":{"start": [10], "limit": 1000, "order": "by_total_votes", "order_direction": "ascending", "status": "votable"}, "id":1}' https://api.steemit.com
- Since: HF23
- Related
database_api.find_smt_contributions
Find SMT contributions. Contributions are needed to track individual contributions on an SMT during the ICO phase.
See: Token Units, Vesting Contributions
Query Parameters JSON
{"symbol_contributors": []}
Expected Response JSON
{
"contributions": [
{
"id": 0,
"symbol": {"nai": "@@422838704", "decimals": 0},
"contributor": "alice",
"contribution_id": 0,
"contribution": {
"amount": "1000",
"precision": 3,
"nai": "@@000000021"
}
}
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_smt_contributions", "params":{"symbol_contributors": []}, "id":1}' https://api.steemit.com
- Since: HF23
- Related
database_api.find_smt_token_emissions
Find SMT emissions.
See: Content Rewards, Qualitative Discussion
Query Parameters JSON
{
"asset_symbol": {"nai": "@@422838704", "decimals": 0}
}
Expected Response JSON
{"token_emissions": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_smt_token_emissions", "params":{"asset_symbol":{"nai":"@@422838704","decimals":0}}, "id":1}' https://api.steemit.com
- Since: HF23
- Related
database_api.find_smt_tokens
Find SMT.
See: Smart Media Tokens (SMTs)
Query Parameters JSON
{"symbols": [], "ignore_precision": false}
Expected Response JSON
{"tokens": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_smt_tokens", "params":{"symbols":[],"ignore_precision":false}, "id":1}' https://api.steemit.com
- Since: HF23
- Related
database_api.get_nai_pool
Return an array of Numeric Asset Identifier (NAI) available to be used for new SMT to be created.
See: Numerical Asset Identifiers
Query Parameters JSON
{}
Expected Response JSON
{"nai_pool": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_nai_pool", "params":{}, "id":1}' https://api.steemit.com
- Since: HF23
- Related
database_api.list_smt_contributions
List SMT contributions. Contributions are needed to track individual contributions on an SMT during the ICO phase. Parameters: start:array; limit:int; order:string
startdepends onorder(see below)limitis up to 1000.ordercan be one of:by_symbol_id- order by symbolby_symbol_contributor- order bysymbol,contributor, andcontribution_id
start (array) |
limit (int) |
order (string) |
|
|---|---|---|---|
[{"nai": "@@422838704", "decimals": 0}, 0] |
10 | by_symbol_id |
list 10 contributions, ordered by symbol, id |
[{"nai": "@@422838704", "decimals": 0}, "alice", 0] |
10 | by_symbol_contributor |
list 10 contributions, ordered by symbol, contributor, id |
See: Token Units, Vesting Contributions
Also see: Paginated API Methods
Query Parameters JSON
{
"start": null,
"limit": 0,
"order": "by_symbol_id"
}
Expected Response JSON
{
"contributions": [
{
"id": 0,
"symbol": {"nai": "@@422838704", "decimals": 0},
"contributor": "alice",
"contribution_id": 0,
"contribution": {
"amount": "1000",
"precision": 3,
"nai": "@@000000021"
}
}
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_smt_contributions", "params":{"start":[{"nai": "@@422838704", "decimals": 0}, 0],"limit":10,"order":"by_symbol_id"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_smt_contributions", "params":{"start":[{"nai": "@@422838704", "decimals": 0}, "alice", 0],"limit":10,"order":"by_symbol_contributor"}, "id":1}' https://api.steemit.com
- Since: HF23
- Related
database_api.list_smt_token_emissions
List SMT emissions. Parameters: start:array; limit:int; order:string
startdepends onorder(see below)limitis up to 1000.ordercan be one of:by_symbol_time- order by symbol and time
start (array) |
limit (int) |
order (string) |
|
|---|---|---|---|
[{"nai": "@@422838704", "decimals": 0}, "2019-08-07T16:54:03"] |
10 | by_symbol_time |
list 10 emissions, ordered by symbol, timestamp |
See: Content Rewards, Qualitative Discussion
Also see: Paginated API Methods
Query Parameters JSON
{
"start": null,
"limit": 0,
"order": "by_symbol_time"
}
Expected Response JSON
{"token_emissions": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_smt_token_emissions", "params":{"start":[{"nai": "@@422838704", "decimals": 0}, "2019-08-07T16:54:03"],"limit":10,"order":"by_symbol_time"}, "id":1}' https://api.steemit.com
- Since: HF23
- Related
database_api.list_smt_tokens
List SMTs. Parameters: start:object; limit:int; order:string
startdepends onorder(see below)limitis up to 1000.ordercan be one of:by_symbol- order by symbolby_control_account- order by control account
start (object) |
limit (int) |
order (string) |
|
|---|---|---|---|
{"nai": "@@422838704", "decimals": 0} |
10 | by_symbol |
list 10 tokens, ordered by symbol |
"" |
10 | by_control_account |
list 10 tokens, ordered by control account |
["", {"nai": "@@422838704", "decimals": 0}] |
10 | by_control_account |
list 10 tokens, ordered by control account, symbol |
See: Smart Media Tokens (SMTs)
Also see: Paginated API Methods
Query Parameters JSON
{"start": null, "limit": 0, "order": "by_symbol"}
Expected Response JSON
{
"tokens": [
{
"token": {
"id": 0,
"liquid_symbol": {"nai": "@@422838704", "decimals": 0},
"control_account": "alice",
"phase": "setup",
"current_supply": 0,
"total_vesting_fund_smt": 0,
"total_vesting_shares": 0,
"total_vesting_fund_ballast": 0,
"total_vesting_shares_ballast": 0,
"pending_rewarded_vesting_shares": 0,
"pending_rewarded_vesting_smt": 0,
"reward_balance": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
},
"recent_claims": "0",
"last_reward_update": "1970-01-01T00:00:00",
"last_virtual_emission_time": "1970-01-01T00:00:00",
"allow_downvotes": true,
"market_maker": {
"steem_balance": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
},
"token_balance": {
"amount": "0",
"precision": 0,
"nai": "@@422838704"
},
"reserve_ratio": 0
},
"allow_voting": true,
"cashout_window_seconds": 3600,
"reverse_auction_window_seconds": 900,
"vote_regeneration_period_seconds": 432000,
"votes_per_regeneration_period": 50,
"content_constant": "2000000000000",
"percent_curation_rewards": 2500,
"author_reward_curve": "linear",
"curation_reward_curve": "square_root",
"max_supply": 0
}
}
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_smt_tokens", "params":{"start":{"nai": "@@422838704", "decimals": 0},"limit":10,"order":"by_symbol"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_smt_tokens", "params":{"start":"","limit":10,"order":"by_control_account"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_smt_tokens", "params":{"start":["", {"nai": "@@422838704", "decimals": 0}],"limit":10,"order":"by_control_account"}, "id":1}' https://api.steemit.com
Debug Node Api
Methods:
This plugin allows all sorts of creative “what-if” experiments with the chain.
See: debug_node_plugin.md
debug_node_api.debug_generate_blocks
Generate blocks locally.
Query Parameters JSON
{
"debug_key": "",
"count": 0,
"skip": 0,
"miss_blocks": 0,
"edit_if_needed": true
}
Expected Response JSON
{"blocks": 0}
debug_node_api.debug_generate_blocks_until
Generate blocks locally until a specified head block time. Can generate them sparsely.
Query Parameters JSON
{
"debug_key": "",
"head_block_time": "1970-01-01T00:00:00",
"generate_sparsely": true
}
Expected Response JSON
{"blocks": 0}
debug_node_api.debug_get_hardfork_property_object
Query Parameters JSON
{}
Expected Response JSON
{
"id": 0,
"processed_hardforks": [],
"last_hardfork": 0,
"current_hardfork_version": "0.0.0",
"next_hardfork": "0.0.0",
"next_hardfork_time": "1970-01-01T00:00:00"
}
debug_node_api.debug_get_json_schema
Query Parameters JSON
{}
Expected Response JSON
{"schema": ""}
debug_node_api.debug_get_witness_schedule
Query Parameters JSON
{}
Expected Response JSON
{
"id": 0,
"current_virtual_time": "0",
"next_shuffle_block_num": 21573344,
"current_shuffled_witnesses": [],
"num_scheduled_witnesses": 192,
"elected_weight": 49,
"timeshare_weight": 73,
"miner_weight": 1,
"witness_pay_normalization_factor": 0,
"median_props": {
"account_creation_fee": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
},
"maximum_block_size": 131072,
"sbd_interest_rate": 1000,
"account_subsidy_budget": 797,
"account_subsidy_decay": 347321
},
"majority_version": "0.0.0",
"max_voted_witnesses": 128,
"max_miner_witnesses": 131,
"max_runner_witnesses": 191,
"hardfork_required_witnesses": 4,
"account_subsidy_rd": {
"resource_unit": 0,
"budget_per_time_unit": 0,
"pool_eq": 0,
"max_pool_size": 0,
"decay_params": {
"decay_per_time_unit": 0,
"decay_per_time_unit_denom_shift": 0
},
"min_decay": 0
},
"account_subsidy_witness_rd": {
"resource_unit": 0,
"budget_per_time_unit": 0,
"pool_eq": 0,
"max_pool_size": 0,
"decay_params": {
"decay_per_time_unit": 0,
"decay_per_time_unit_denom_shift": 0
},
"min_decay": 0
},
"min_witness_account_subsidy_decay": 0
}
debug_node_api.debug_has_hardfork
Query Parameters JSON
{"hardfork_id": 0}
Expected Response JSON
{"has_hardfork": false}
debug_node_api.debug_pop_block
Pop a block from the blockchain, returning it.
Query Parameters JSON
{}
Expected Response JSON
{}
debug_node_api.debug_push_blocks
Push blocks from existing database.
Query Parameters JSON
{
"src_filename": "",
"count": 0,
"skip_validate_invariants": false
}
Expected Response JSON
{"blocks": 0}
debug_node_api.debug_set_hardfork
Query Parameters JSON
{"hardfork_id": 0}
Expected Response JSON
{}
Follow Api
Methods:
Used to lookup information related to reputation and account follow operations. These AppBase API methods are still under development and subject to change.
- Since: HF13
- Related
follow_api.get_account_reputations
Returns a list of account reputations.
Also see: Paginated API Methods
Query Parameters JSON
{"account_lower_bound": "", "limit": 1000}
Expected Response JSON
{"reputations": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"follow_api.get_account_reputations", "params":{"account_lower_bound":"steemit", "limit":1}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"follow_api.get_account_reputations", "params":{"account_lower_bound":"a", "limit":10}, "id":1}' https://api.steemit.com
follow_api.get_blog
Returns the list of blog entries for an account.
Also see: Paginated API Methods
Query Parameters JSON
{"account": "", "start_entry_id": 0, "limit": 500}
Expected Response JSON
{"blog": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"follow_api.get_blog", "params":{"account":"steemit","start_entry_id":0,"limit":1}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"follow_api.get_blog", "params":{"account":"alice","start_entry_id":0,"limit":50}, "id":1}' https://api.steemit.com
follow_api.get_blog_authors
Returns a list of authors that have had their content reblogged on a given blog account.
Also see: Paginated API Methods
Query Parameters JSON
{"blog_account": ""}
Expected Response JSON
{"blog_authors": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"follow_api.get_blog_authors", "params":{"blog_account":"steemit"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"follow_api.get_blog_authors", "params":{"blog_account":"alice"}, "id":1}' https://api.steemit.com
follow_api.get_blog_entries
Returns a list of blog entries for an account.
Also see: Paginated API Methods
Query Parameters JSON
{"account": "", "start_entry_id": 0, "limit": 500}
Expected Response JSON
{"blog": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"follow_api.get_blog_entries", "params":{"account":"steemit","start_entry_id":0,"limit":1}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"follow_api.get_blog_entries", "params":{"account":"alice","start_entry_id":0,"limit":50}, "id":1}' https://api.steemit.com
- Since: HF14
- Related
follow_api.get_feed
Returns a list of items in an account’s feed.
Also see: Paginated API Methods
Query Parameters JSON
{"account": "", "start_entry_id": 0, "limit": 500}
Expected Response JSON
{"feed": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"follow_api.get_feed", "params":{"account":"steemit","start_entry_id":0,"limit":1}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"follow_api.get_feed", "params":{"account":"alice","start_entry_id":1,"limit":10}, "id":1}' https://api.steemit.com
- Since: HF14
- Related
follow_api.get_feed_entries
Returns a list of entries in an account’s feed.
Also see: Paginated API Methods
Query Parameters JSON
{"account": "", "start_entry_id": 0, "limit": 500}
Expected Response JSON
{"feed": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"follow_api.get_feed_entries", "params":{"account":"steemit","start_entry_id":0,"limit":1}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"follow_api.get_feed_entries", "params":{"account":"alice","start_entry_id":1,"limit":10}, "id":1}' https://api.steemit.com
- Since: HF9
- Related
follow_api.get_follow_count
Returns the count of followers for an account.
Query Parameters JSON
{"account": ""}
Expected Response JSON
{
"account": "",
"follower_count": 0,
"following_count": 0
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"follow_api.get_follow_count", "params":{"account":"steemit"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"follow_api.get_follow_count", "params":{"account":"alice"}, "id":1}' https://api.steemit.com
- Since: HF9
- Related
follow_api.get_followers
Returns the list of followers for an account.
Also see: Paginated API Methods
Query Parameters JSON
{
"account": "",
"start": "",
"type": "undefined",
"limit": 1000
}
Expected Response JSON
{"followers": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"follow_api.get_followers", "params":{"account":"steemit","start":null,"type":"blog","limit":10}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"follow_api.get_followers", "params":{"account":"alice","start":null,"type":"ignore","limit":100}, "id":1}' https://api.steemit.com
- Since: HF9
- Related
follow_api.get_following
Returns the list of accounts that are following an account.
Also see: Paginated API Methods
Query Parameters JSON
{
"account": "",
"start": "",
"type": "undefined",
"limit": 1000
}
Expected Response JSON
{"following": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"follow_api.get_following", "params":{"account":"steemit","start":null,"type":"blog","limit":10}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"follow_api.get_following", "params":{"account":"alice","start":null,"type":"ignore","limit":100}, "id":1}' https://api.steemit.com
- Since: HF14
- Related
follow_api.get_reblogged_by
Returns a list of authors that have reblogged a post.
Query Parameters JSON
{"author": "", "permlink": ""}
Expected Response JSON
{"accounts": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"follow_api.get_reblogged_by", "params":{"author":"steemit","permlink":"firstpost"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"follow_api.get_reblogged_by", "params":{"author":"alice","permlink":"a-post-by-alice"}, "id":1}' https://api.steemit.com
Jsonrpc
Methods:
Used to lookup information about the JSON RPC API. These AppBase API methods are still under development and subject to change.
jsonrpc.get_methods
Returns a list of methods supported by the JSON RPC API.
Query Parameters JSON
{}
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"jsonrpc.get_methods", "id":1}' https://api.steemit.com
jsonrpc.get_signature
Returns the signature information for a JSON RPC method including the arguments and expected response JSON.
Query Parameters JSON
{"method": ""}
Expected Response JSON
{"args": null, "ret": null}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"jsonrpc.get_signature", "params":{"method":"jsonrpc.get_methods"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"jsonrpc.get_signature", "params":{"method":"jsonrpc.get_signature"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"jsonrpc.get_signature", "params":{"method":"condenser_api.get_dynamic_global_properties"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"jsonrpc.get_signature", "params":{"method":"database_api.get_dynamic_global_properties"}, "id":1}' https://api.steemit.com
Market History Api
Methods:
Used to lookup market history information. These AppBase API methods are still under development and subject to change.
market_history_api.get_market_history
Returns the market history for the internal SBD:STEEM market.
Query Parameters JSON
{
"bucket_seconds": 0,
"start": "1970-01-01T00:00:00",
"end": "1970-01-01T00:00:00"
}
Expected Response JSON
{"buckets": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"market_history_api.get_market_history", "params":{"bucket_seconds":15,"start":"2018-01-01T00:00:00","end":"2018-01-02T00:00:00"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"market_history_api.get_market_history", "params":{"bucket_seconds":60,"start":"2018-01-01T00:00:00","end":"2018-01-02T00:00:00"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"market_history_api.get_market_history", "params":{"bucket_seconds":300,"start":"2018-01-01T00:00:00","end":"2018-01-02T00:00:00"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"market_history_api.get_market_history", "params":{"bucket_seconds":3600,"start":"2018-01-01T00:00:00","end":"2018-01-02T00:00:00"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"market_history_api.get_market_history", "params":{"bucket_seconds":86400,"start":"2018-01-01T00:00:00","end":"2018-01-02T00:00:00"}, "id":1}' https://api.steemit.com
market_history_api.get_market_history_buckets
Returns the bucket seconds being tracked by the plugin.
Query Parameters JSON
{}
Expected Response JSON
{"bucket_sizes": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"market_history_api.get_market_history_buckets", "id":1}' https://api.steemit.com
market_history_api.get_order_book
Returns the internal market order book.
Query Parameters JSON
{"limit": 500}
Expected Response JSON
{"bids": [], "asks": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"market_history_api.get_order_book", "params":{"limit":10}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"market_history_api.get_order_book", "params":{"limit":50}, "id":1}' https://api.steemit.com
market_history_api.get_recent_trades
Returns the most recent trades for the internal SBD:STEEM market.
Query Parameters JSON
{"limit": 1000}
Expected Response JSON
{"trades": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"market_history_api.get_recent_trades", "params":{"limit":10}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"market_history_api.get_recent_trades", "params":{"limit":500}, "id":1}' https://api.steemit.com
market_history_api.get_ticker
Returns the market ticker for the internal SBD:STEEM market.
Query Parameters JSON
{}
Expected Response JSON
{
"latest": "0.00000000000000000",
"lowest_ask": "0.00000000000000000",
"highest_bid": "0.00000000000000000",
"percent_change": "0.00000000000000000",
"steem_volume": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
},
"sbd_volume": {
"amount": "0",
"precision": 3,
"nai": "@@000000013"
}
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"market_history_api.get_ticker", "id":1}' https://api.steemit.com
market_history_api.get_trade_history
Returns the trade history for the internal SBD:STEEM market.
Query Parameters JSON
{
"start": "1970-01-01T00:00:00",
"end": "1970-01-01T00:00:00",
"limit": 1000
}
Expected Response JSON
{"trades": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"market_history_api.get_trade_history", "params":{"start":"2018-01-01T00:00:00","end":"2018-01-02T00:00:00","limit":10}, "id":1}' https://api.steemit.com
market_history_api.get_volume
Returns the market volume for the past 24 hours.
Query Parameters JSON
{}
Expected Response JSON
{
"steem_volume": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
},
"sbd_volume": {
"amount": "0",
"precision": 3,
"nai": "@@000000013"
}
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"market_history_api.get_volume", "id":1}' https://api.steemit.com
Network Broadcast Api
Methods:
Used to broadcast transactions and blocks. These AppBase API methods are still under development and subject to change.
Also see: Blockchain Ops
network_broadcast_api.broadcast_block
Used to broadcast a block.
Query Parameters JSON
{
"block": {
"previous": "0000000000000000000000000000000000000000",
"timestamp": "1970-01-01T00:00:00",
"witness": "",
"transaction_merkle_root": "0000000000000000000000000000000000000000",
"extensions": [],
"witness_signature": "0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"transactions": []
}
}
Expected Response JSON
{}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"network_broadcast_api.broadcast_block", "params":{"block":{"previous":"0000000000000000000000000000000000000000","timestamp":"1970-01-01T00:00:00","witness":"","transaction_merkle_root":"0000000000000000000000000000000000000000","extensions":[],"witness_signature":"0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000","transactions":[]}}, "id":1}' https://api.steemit.com
network_broadcast_api.broadcast_transaction
Used to broadcast a transaction.
Query Parameters JSON
{
"trx": {
"ref_block_num": 0,
"ref_block_prefix": 0,
"expiration": "1970-01-01T00:00:00",
"operations": [],
"extensions": [],
"signatures": []
},
"max_block_age": -1
}
Expected Response JSON
{}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"network_broadcast_api.broadcast_transaction", "params":{"trx":{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[{"type":"vote_operation","value":{"voter":"steemit","author":"alice","permlink":"a-post-by-alice","weight":10000}}],"extensions":[],"signatures":[]},"max_block_age":50}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"network_broadcast_api.broadcast_transaction", "params":{"trx":{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[{"type":"pow_operation","value":{"worker_account":"cloop3","block_id":"00000449f7860b82b4fbe2f317c670e9f01d6d9a","nonce":3899,"work":{"worker":"STM7P5TDnA87Pj9T4mf6YHrhzjC1KbPZpNxLWCcVcHxNYXakpoT4F","input":"ae8e7c677119d22385f8c48026fee7aad7bba693bf788d7f27047f40b47738c0","signature":"1f38fe9a3f9989f84bd94aa5bbc88beaf09b67f825aa4450cf5105d111149ba6db560b582c7dbb026c7fc9c2eb5051815a72b17f6896ed59d3851d9a0f9883ca7a","work":"000e7b209d58f2e64b36e9bf12b999c6c7af168cc3fc41eb7f8a4bf796c174c3"},"props":{"account_creation_fee":{"amount":"100000","precision":3,"nai":"@@000000021"},"maximum_block_size":131072,"sbd_interest_rate":1000}}}],"extensions":[],"signatures":[]},"max_block_age":50}, "id":1}' https://api.steemit.com
Rc Api
Methods:
Allows querying of various Resource Credit metrics. See: RC Bandwidth System, 0.20.2 Release Notes, Developer Guide: Resource Credit System
- Since: HF20
- Related
rc_api.find_rc_accounts
Returns the available resource credits of accounts. Parameters: accounts:string array
accounts (string) |
|
|---|---|
"steemit" |
Query the available resource credits for the account named “steemit”. |
"alice" |
Query the available resource credits for the accounts named “alice” and “bob”. |
Query Parameters JSON
{"accounts": []}
Expected Response JSON
{
"rc_accounts": [
{
"account": "",
"rc_manabar": {"current_mana": "0", "last_update_time": 0},
"max_rc_creation_adjustment": {
"amount": "0",
"precision": 6,
"nai": "@@000000037"
},
"max_rc": "0"
}
]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"rc_api.find_rc_accounts", "params":{"accounts":["steemit"]}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"rc_api.find_rc_accounts", "params":{"accounts":["alice","bob"]}, "id":1}' https://api.steemit.com
- Since: HF20
- Related
rc_api.get_resource_params
Exports all relevant resource size constants, in particular the measurement-based execution time parameters.
See: #2980
Query Parameters JSON
{}
Expected Response JSON
{
"resource_names": [
"resource_history_bytes",
"resource_new_accounts",
"resource_market_bytes",
"resource_state_bytes",
"resource_execution_time"
],
"resource_params": {
"resource_history_bytes": {
"resource_dynamics_params": {
"resource_unit": 1,
"budget_per_time_unit": 43403,
"pool_eq": "27050539251",
"max_pool_size": "54101078501",
"decay_params": {
"decay_per_time_unit": 3613026481,
"decay_per_time_unit_denom_shift": 51
},
"min_decay": 0
},
"price_curve_params": {
"coeff_a": "14034213032882683904",
"coeff_b": 211332338,
"shift": 52
}
},
"resource_new_accounts": {
"resource_dynamics_params": {
"resource_unit": 10000,
"budget_per_time_unit": 797,
"pool_eq": 157691079,
"max_pool_size": 157691079,
"decay_params": {
"decay_per_time_unit": 347321,
"decay_per_time_unit_denom_shift": 36
},
"min_decay": 0
},
"price_curve_params": {
"coeff_a": "16484671763857882971",
"coeff_b": 1231961,
"shift": 51
}
},
"resource_market_bytes": {
"resource_dynamics_params": {
"resource_unit": 10,
"budget_per_time_unit": 72338,
"pool_eq": 2003755169,
"max_pool_size": 4007510337,
"decay_params": {
"decay_per_time_unit": 2540365427,
"decay_per_time_unit_denom_shift": 46
},
"min_decay": 0
},
"price_curve_params": {
"coeff_a": "9979884823383242752",
"coeff_b": 15654337,
"shift": 56
}
},
"resource_state_bytes": {
"resource_dynamics_params": {
"resource_unit": 1,
"budget_per_time_unit": 34722222,
"pool_eq": "21640431400373",
"max_pool_size": "43280862800744",
"decay_params": {
"decay_per_time_unit": 3613026481,
"decay_per_time_unit_denom_shift": 51
},
"min_decay": 0
},
"price_curve_params": {
"coeff_a": "14034213032882683904",
"coeff_b": "169065870315",
"shift": 52
}
},
"resource_execution_time": {
"resource_dynamics_params": {
"resource_unit": 1,
"budget_per_time_unit": 10273973,
"pool_eq": "6403196140384",
"max_pool_size": "12806392280766",
"decay_params": {
"decay_per_time_unit": 3613026481,
"decay_per_time_unit_denom_shift": 51
},
"min_decay": 0
},
"price_curve_params": {
"coeff_a": "14034213032882683904",
"coeff_b": "50024969847",
"shift": 52
}
}
},
"size_info": {
"resource_state_bytes": {
"authority_base_size": 40000,
"authority_account_member_size": 180000,
"authority_key_member_size": 350000,
"account_object_base_size": 4800000,
"account_authority_object_base_size": 400000,
"account_recovery_request_object_base_size": 320000,
"comment_object_base_size": 2010000,
"comment_object_permlink_char_size": 10000,
"comment_object_parent_permlink_char_size": 20000,
"comment_object_beneficiaries_member_size": 180000,
"comment_vote_object_base_size": 24675,
"convert_request_object_base_size": 480000,
"decline_voting_rights_request_object_base_size": 280000,
"escrow_object_base_size": 1190000,
"limit_order_object_base_size": 147440,
"savings_withdraw_object_byte_size": 14656,
"transaction_object_base_size": 6090,
"transaction_object_byte_size": 174,
"vesting_delegation_object_base_size": 600000,
"vesting_delegation_expiration_object_base_size": 440000,
"withdraw_vesting_route_object_base_size": 430000,
"witness_object_base_size": 2660000,
"witness_object_url_char_size": 10000,
"witness_vote_object_base_size": 400000,
"proposal_object_base_size": 680000,
"proposal_vote_object_base_size": 240000,
"proposal_vote_object_member_size": 80000,
"STATE_BYTES_SCALE": 10000
},
"resource_execution_time": {
"account_create_operation_exec_time": 57700,
"account_create_with_delegation_operation_exec_time": 57700,
"account_update_operation_exec_time": 14000,
"account_update2_operation_exec_time": 14000,
"account_witness_proxy_operation_exec_time": 117000,
"account_witness_vote_operation_exec_time": 23000,
"cancel_transfer_from_savings_operation_exec_time": 11500,
"change_recovery_account_operation_exec_time": 12000,
"claim_account_operation_exec_time": 10000,
"claim_reward_balance_operation_exec_time": 50300,
"comment_operation_exec_time": 114100,
"comment_options_operation_exec_time": 13200,
"convert_operation_exec_time": 15700,
"create_claimed_account_operation_exec_time": 57700,
"custom_operation_exec_time": 11400,
"custom_json_operation_exec_time": 11400,
"custom_binary_operation_exec_time": 11400,
"decline_voting_rights_operation_exec_time": 5300,
"delegate_vesting_shares_operation_exec_time": 19900,
"delete_comment_operation_exec_time": 51100,
"escrow_approve_operation_exec_time": 9900,
"escrow_dispute_operation_exec_time": 11500,
"escrow_release_operation_exec_time": 17200,
"escrow_transfer_operation_exec_time": 19100,
"feed_publish_operation_exec_time": 6200,
"limit_order_cancel_operation_exec_time": 9600,
"limit_order_create_operation_exec_time": 31700,
"limit_order_create2_operation_exec_time": 31700,
"request_account_recovery_operation_exec_time": 54400,
"set_withdraw_vesting_route_operation_exec_time": 17900,
"transfer_from_savings_operation_exec_time": 17500,
"transfer_operation_exec_time": 9600,
"transfer_to_savings_operation_exec_time": 6400,
"transfer_to_vesting_operation_exec_time": 44400,
"vote_operation_exec_time": 26500,
"withdraw_vesting_operation_exec_time": 10400,
"witness_set_properties_operation_exec_time": 9500,
"witness_update_operation_exec_time": 9500,
"create_proposal_operation_exec_time": 31700,
"update_proposal_votes_operation_exec_time": 12000,
"remove_proposal_operation_exec_time": 12000
}
}
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"rc_api.get_resource_params", "id":1}' https://api.steemit.com
- Since: HF20
- Related
rc_api.get_resource_pool
Work in progress. See: #2563, PR#2678
Query Parameters JSON
{}
Expected Response JSON
{
"resource_pool": {
"resource_history_bytes": {"pool": "22530662270"},
"resource_new_accounts": {"pool": 17589594},
"resource_market_bytes": {"pool": 1919726127},
"resource_state_bytes": {"pool": "17720687726725"},
"resource_execution_time": {"pool": "5835324988127"}
}
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"rc_api.get_resource_pool", "id":1}' https://api.steemit.com
Reputation Api
Methods:
Needed by condenser_api to optionally use follow_api or reputation_api
for account reputations (the latter if hivemind is fronting follow_api)
- Since: HF20
- Related
reputation_api.get_account_reputations
Returns the reputation of accounts. Parameters: account:string; limit:int
limitis up to 1000.
account (string) |
limit (int) |
|
|---|---|---|
"steemit" |
10 | Queries the reputation for account named “steemit”. |
See #1425
Also see: Paginated API Methods
Query Parameters JSON
{"account_lower_bound": "", "limit": 1000}
Expected Response JSON
{"account": "steem", "reputation": 0}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"reputation_api.get_account_reputations", "params": {"account_lower_bound": "steem"}, "id":1}' https://api.steemit.com
Rewards Api
Methods:
Returns the simulated curve for payouts. Parameters: curve:string; var1:string
Note: The rewards_api plugin is for testing purposes only, do not run in production.
curve (string) |
var1 (string) |
|
|---|---|---|
"quadratic" |
“2000000000000” | |
"bounded_curation" |
“2000000000000” | |
"linear" |
“2000000000000” | |
"square_root" |
“2000000000000” | |
"convergent_linear" |
“2000000000000” | |
"convergent_square_root" |
“2000000000000” |
See: #3325
rewards_api.simulate_curve_payouts
Query Parameters JSON
{"curve": "quadratic", "var1": "2000000000000"}
Expected Response JSON
{"recent_claims": "", "payouts": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"rewards_api.simulate_curve_payouts", "params": {"curve": "quadratic", "var1": "2000000000000"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"rewards_api.simulate_curve_payouts", "params": {"curve": "bounded_curation", "var1": "2000000000000"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"rewards_api.simulate_curve_payouts", "params": {"curve": "linear", "var1": "2000000000000"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"rewards_api.simulate_curve_payouts", "params": {"curve": "square_root", "var1": "2000000000000"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"rewards_api.simulate_curve_payouts", "params": {"curve": "convergent_linear", "var1": "2000000000000"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"rewards_api.simulate_curve_payouts", "params": {"curve": "convergent_square_root", "var1": "2000000000000"}, "id":1}' https://api.steemit.com
Transaction Status Api
Methods:
This API is intended to evaluate a transaction status after calling condenser_api.broadcast_transaction.
To enable this API for steemd, the following is required in config.ini by specifying:
plugin = transaction_status_api
See: #3060
- Since: The Mysterious Future
- Related
transaction_status_api.find_transaction
Returns the status of a given transaction id. Parameters: trx_id:string; expiration:timestamp (optional)
The result will contain one of the following status values:
| Status | Meaning |
|---|---|
unknown |
Expiration time in future, transaction not included in block or mempool |
within_mempool |
Transaction in mempool |
within_reversible_block |
Transaction has been included in block, block not irreversible |
within_irreversible_block |
Transaction has been included in block, block is irreversible |
expired_reversible |
Transaction has expired, transaction is not irreversible (transaction could be in a fork) |
expired_irreversible |
Transaction has expired, transaction is irreversible (transaction cannot be in a fork) |
too_old |
Transaction is too old, I don’t know about it |
Query Parameters JSON
{
"transaction_id": "0000000000000000000000000000000000000000",
"expiration": "2016-03-24T18:00:21"
}
Expected Response JSON
{"status": "unknown"}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"transaction_status_api.find_transaction", "params": {"transaction_id": "0000000000000000000000000000000000000000"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"transaction_status_api.find_transaction", "params": {"transaction_id": "0000000000000000000000000000000000000000", "expiration":"2016-03-24T18:00:21"}, "id":1}' https://api.steemit.com
Witness Api
Methods:
API removed in 0.20.6, see: #3029
- Disabled
- Related
witness_api.get_account_bandwidth
Disabled since 0.20.6, see: #3029
Returns the available bandwidth of an account. See: Forum/Market Bandwidth
Query Parameters JSON
{"account": "", "type": "post"}
Expected Response JSON
{}
- Disabled
- Related
witness_api.get_reserve_ratio
Disabled since 0.20.6, see: #3029
Returns the current reserve ratio.
Query Parameters JSON
{}
Expected Response JSON
{
"id": 0,
"average_block_size": 0,
"current_reserve_ratio": 1,
"max_virtual_bandwidth": "0"
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"witness_api.get_account_bandwidth", "params":{"account":"steemit","type":"forum"}, "id":1}' https://api.steemit.com
curl -s --data '{"jsonrpc":"2.0", "method":"witness_api.get_account_bandwidth", "params":{"account":"alice","type":"market"}, "id":1}' https://api.steemit.com
Broadcast Ops
Ops:
Virtual Ops:
An operation on Steem is a way of expressing intention on the blockchain.
They are also known as Broadcast Operations. They have types, like vote
or comment. They pass parameters like author and permlink, depending
on what their purpose is.
Operations are grouped into transactions and passed as parameters to
methods like network_broadcast_api.broadcast_transaction, in
the operations array. Transactions must be signed in order for the
blockchain to accept them. Here is an example of a transaction that
contains one operation (shown without signatures).
{
"jsonrpc":"2.0",
"method":"condenser_api.broadcast_transaction",
"params":{
"trx":{
"ref_block_num":1097,
"ref_block_prefix":2181793527,
"expiration":"2016-03-24T18:00:21",
"operations":[
[
"vote",
{
"voter":"steemit",
"author":"alice",
"permlink":"a-post-by-alice",
"weight":10000
}
]
],
"extensions":[],
"signatures":[]
}
},
"id":1
}
Also see: Broadcast Transaction
vote
This operation is used to cast a vote on a post/comment. The primary purpose of voting is to express Proof-of-Brain about content to the blockchain. When a vote is cast, the content is considered in the consensus rules involving author and curation rewards.
An upvote can be cast from the point in time that the content is created up to 6.5 days. The remaining 12 hours are locked out of upvotes at which time only downvotes may be cast.
A secondary aspect to voting involves reputation, which is not part of consensus.
Reputation Rules:
- Must have non-negative reputation to effect another user’s reputation.
- If you are down voting another user, you must have more reputation than them to impact their reputation.
Notes:
voter: must be a valid account nameauthor: must be a valid account namepermlink: must be content created byauthorweight: absolute value must not be more than 10000 (100.00 %).
Roles: posting active owner
Parameters: voter author permlink weight
Example Op:
[
"vote",
{
"voter": "steemit",
"author": "alice",
"permlink": "a-post-by-alice",
"weight": 10000
}
]
comment
Creates a post/comment.
Parameters:
parent_author- the author that comment is being submitted to, when posting a new blog this is an empty stringparent_permlink- specific post that comment is being submitted to, when posting a new blog this is an empty stringauthor- author of the post/comment being submitted (account name)permlink- unique string identifier for the post, linked to the author of the posttitle- human readable title of the post being submitted, this is often blank when commentingbody- body of the post/comment being submitted, ordiff-match-patchwhen updatingjson_metadata- JSON object string
Rules:
- The “title” must not be longer than 256 bytes
- The “title” must be UTF-8
- The “body” must be larger than 0 bytes
- The “body” much also be UTF-8
Additional Parameter Definitions:
permlink- Two authors may have the same permlink as it’s unique to the author only. For example, there could be two authors, alice and bob, and both could have a permlink offirstpostjson_metadata- There is no blockchain enforced validation onjson_metadata, but the community has adopted a particular structure. It should contain a JSON object with the following keys:tags- An array of up to 5 strings. Although the blockchain will accept more than 5, the tags plugin only looks at the first fiveapp- A user agent style application identifier. Typicallyapp_name/version, e.g.steemit/0.1format- The format of the body, e.g. markdown- In addition to the above keys, application developers are free to add any other keys they want to help manage the content they broadcast.
A typical comment operation would look similar to the below:
{
"author": "Joe",
"title": "A post by Joe",
"body": "Look at my awesome post",
"parent_author": "",
"parent_permlink": "steem",
"permlink": "a-post-by-joe",
"json_metadata": "{\"tags\":[\"steemit\",\"example\",\"tags\"]}"
}
Create vs. Update
When a comment is first broadcast, the permlink must be unique for the author. Otherwise, it is interpreted as an update operation. Updating will either replace the entire body with the latest operation or patch the body if using diff-match-patch.
For example, if we have a paragraph that has already been broadcast:
“It’s been quite a lot of fun working with these wonderful folk at Steemit, Inc”
And we want to change it to:
“It’s been quite a lot of fun working with these wonderful people at Steemit, Inc”
We can broadcast the comment operation with the following body:
- "@@ -406,12 +406,14 @@"
- ful
- -folk
- +people
- at
The blockchain will know that this means we have changed the word ‘folk’ to ‘people’ within that paragraph so when fetching this content, this diff will be applied.
In addition to body, the title and json_metadata fields will also be replaced by the latest operation.
See: comment_options, vote, custom_json
It should also be noted that a vote operation can accompany a comment and comment_options in the same transaction when the author self votes.
Roles: posting active owner
Parameters: parent_author parent_permlink author permlink title body json_metadata
Example Op:
[
"comment",
{
"parent_author": "",
"parent_permlink": "steem",
"author": "alice",
"permlink": "a-post-by-alice",
"title": "A Post By Alice",
"body": "This is my post.",
"json_metadata": "{\"tags\":[\"steemit\",\"example\",\"tags\"]}"
}
]
transfer
Transfers asset from one account to another. The memo is plain-text, any encryption on the memo is up to a higher level protocol.
Notes:
- Transferring of Steem Power (VESTS) is not allowed.
- Cannot transfer a negative amount (aka: stealing).
- Memo must be less than 2048 bytes.
- Memo must be UTF-8.
Roles: active owner
Parameters: from to amount memo
Example Op:
[
"transfer",
{
"from": "steemit",
"to": "alice",
"amount": {
"amount": "10",
"precision": 3,
"nai": "@@000000021"
},
"memo": "Thanks for all the fish."
}
]
transfer_to_vesting
This operation converts STEEM into VFS (Vesting Fund Shares) at the current exchange rate. With this operation it is possible to give another account vesting shares so that faucets can pre-fund new accounts with vesting shares.
Notes:
- Amount must be in STEEM.
- Must transfer a nonzero amount.
Roles: active owner
Parameters: from to amount
Example Op:
[
"transfer_to_vesting",
{
"from": "alice",
"to": "",
"amount": {
"amount": "357000",
"precision": 3,
"nai": "@@000000021"
}
}
]
withdraw_vesting
At any given point in time an account can be withdrawing from their vesting shares. A user may change the number of shares they wish to cash out at any time between 0 and their total vesting stake.
After applying this operation, vesting_shares will be withdrawn at a rate of vesting_shares/13 per week for 13 weeks starting one week after this operation is included in the blockchain.
This operation is not valid if the user has no vesting shares.
Notes:
- Amount must be VESTS.
Roles: active owner
Parameters: account vesting_shares
Example Op:
[
"withdraw_vesting",
{
"account": "steemit",
"vesting_shares": {
"amount": "200000000000",
"precision": 6,
"nai": "@@000000037"
}
}
]
limit_order_create
This operation creates a limit order and matches it against existing
open orders. The maximum expiration time for any limit order is 28 days from head_block_time().
Roles: active owner
Parameters: owner orderid amount_to_sell min_to_receive fill_or_kill expiration
Example Op:
[
"limit_order_create",
{
"owner": "steemit",
"orderid": 10,
"amount_to_sell": {
"amount": "9950",
"precision": 3,
"nai": "@@000000021"
},
"min_to_receive": {
"amount": "3500",
"precision": 3,
"nai": "@@000000013"
},
"fill_or_kill": false,
"expiration": "2035-10-29T06:32:22"
}
]
limit_order_cancel
Cancels an order and returns the balance to owner.
Roles: active owner
Parameters: owner orderid
Example Op:
[
"limit_order_cancel",
{"owner": "steemit", "orderid": 10}
]
price
Roles: active owner
Parameters: base quote
feed_publish
Feeds can only be published by the top N witnesses which are included in every round and are used to define the exchange rate between steem and the dollar.
Roles: active owner
Parameters: publisher exchange_rate
Example Op:
[
"feed_publish",
{
"publisher": "alice",
"exchange_rate": {
"base": {
"amount": "1000",
"precision": 3,
"nai": "@@000000013"
},
"quote": {
"amount": "1000000",
"precision": 3,
"nai": "@@000000021"
}
}
}
]
convert
This operation instructs the blockchain to start a conversion between STEEM and SBD, the funds are deposited after 3.5 days.
Roles: active owner
Parameters: owner requestid amount
Example Op:
[
"convert",
{
"owner": "steemit",
"requestid": 1467592156,
"amount": {
"amount": "5000",
"precision": 3,
"nai": "@@000000013"
}
}
]
account_create
Roles: active owner
Parameters: fee creator new_account_name owner active posting memo_key json_metadata
Example Op:
[
"account_create",
{
"fee": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
},
"creator": "steemit",
"new_account_name": "alice",
"owner": {
"weight_threshold": 1,
"account_auths": [],
"key_auths": [
[
"STM5b4i9gBqvh4sbgrooXPu2dbGLewNPZkXeuNeBjyiswnu2szgXx",
1
]
]
},
"active": {
"weight_threshold": 1,
"account_auths": [],
"key_auths": [
[
"STM7ko5nzqaYfjbD4tKWGmiy3xtT9eQFZ3Pcmq5JmygTRptWSiVQy",
1
]
]
},
"posting": {
"weight_threshold": 1,
"account_auths": [],
"key_auths": [
[
"STM5xAKxnMT2y9VoVJdF63K8xRQAohsiQy9bA33aHeyMB5vgkzaay",
1
]
]
},
"memo_key": "STM8ZSyzjPm48GmUuMSRufkVYkwYbZzbxeMysAVp7KFQwbTf98TcG",
"json_metadata": "{}"
}
]
- Since: HF20
- Related
create_claimed_account
When used with claim_account, works identically to account_create. See: Steem 0.20.2 Release Notes
Roles: active owner
Parameters: creator new_account_name owner active posting memo_key json_metadata
Example Op:
[
"create_claimed_account",
{
"creator": "steemit",
"new_account_name": "alice",
"owner": {
"weight_threshold": 1,
"account_auths": [],
"key_auths": [
[
"STM5b4i9gBqvh4sbgrooXPu2dbGLewNPZkXeuNeBjyiswnu2szgXx",
1
]
]
},
"active": {
"weight_threshold": 1,
"account_auths": [],
"key_auths": [
[
"STM7ko5nzqaYfjbD4tKWGmiy3xtT9eQFZ3Pcmq5JmygTRptWSiVQy",
1
]
]
},
"posting": {
"weight_threshold": 1,
"account_auths": [],
"key_auths": [
[
"STM5xAKxnMT2y9VoVJdF63K8xRQAohsiQy9bA33aHeyMB5vgkzaay",
1
]
]
},
"memo_key": "STM8ZSyzjPm48GmUuMSRufkVYkwYbZzbxeMysAVp7KFQwbTf98TcG",
"json_metadata": "{}"
}
]
- Since: HF20
- Related
claim_account
When used with create_claimed_account, works identically to account_create. See: Steem 0.20.2 Release Notes
Roles: active owner
Parameters: fee creator extensions
Example Op:
[
"claim_account",
{
"fee": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
},
"creator": "steemit",
"extensions": []
}
]
- Since: HF20
- Related
witness_set_properties
Added in HF20 to replace the witness_update which was not easily extendable. While it is recommended to use witness_set_properties, witness_update will continue to work. See: Witness Parameters
Roles: block_signing active owner
Parameters: owner props extensions
Example Op:
[
"witness_set_properties",
{
"owner": "alice",
"props": {
"account_creation_fee": "0.000 STEEM",
"account_subsidy_budget": 10000,
"account_subsidy_decay": 330782,
"maximum_block_size": 65536,
"sbd_interest_rate": "0.000 STEEM",
"sbd_exchange_rate": {
"base": "0.000 SBD",
"quote": "0.000 STEEM"
},
"url": "68747470733A2F2F737465656D69742E636F6D",
"new_signing_key": "25688bbe7b1204f26e40be054c8b2ff1997eec6d4e7be6a105aab8a0e6f11c616d7cb6066"
},
"extensions": []
}
]
account_update
Roles: active owner
Parameters: account owner active posting memo_key json_metadata
Example Op:
[
"account_update",
{
"account": "steemit",
"posting": {
"weight_threshold": 1,
"account_auths": [],
"key_auths": [
[
"STM6FATHLohxTN8RWWkU9ZZwVywXo6MEDjHHui1jEBYkG2tTdvMYo",
1
],
[
"STM76EQNV2RTA6yF9TnBvGSV71mW7eW36MM7XQp24JxdoArTfKA76",
1
]
]
},
"memo_key": "STM6FATHLohxTN8RWWkU9ZZwVywXo6MEDjHHui1jEBYkG2tTdvMYo",
"json_metadata": ""
}
]
- Disabled
- Related
report_over_production
Disabled in HF4
This operation is used to report a miner who signs two blocks at the same time. To be valid, the violation must be reported within STEEM_MAX_WITNESSES blocks of the head block (1 round) and the producer must be in the ACTIVE witness set.
Users not in the ACTIVE witness set should not have to worry about their key getting compromised and being used to produced multiple blocks so the attacker can report it and steel their vesting steem.
The result of the operation is to transfer the full VESTING STEEM balance of the block producer to the reporter.
Roles: active owner
Parameters: reporter first_block second_block
witness_update
Users who wish to become a witness must pay a fee acceptable to the current witnesses to apply for the position and allow voting to begin.
If the owner isn’t a witness they will become a witness. Witnesses are charged a fee equal to 1 weeks worth of witness pay which in turn is derived from the current share supply. The fee is only applied if the owner is not already a witness.
If the block_signing_key is null then the witness is removed from contention. The network will pick the top 21 witnesses for producing blocks.
Notes:
- The fee paid to register a new witness, should be 10x current block production pay.
urlcannot be more than 2048 bytes.urlmust be UTF-8.feecannot be negative.
Roles: active owner
Parameters: owner url block_signing_key props fee
Example Op:
[
"witness_update",
{
"owner": "alice",
"url": "witness-category/my-witness",
"block_signing_key": "STM8LoQjQqJHvotqBo7HjnqmUbFW9oJ2theyqonzUd9DdJ7YYHsvD",
"props": {
"account_creation_fee": {
"amount": "100000",
"precision": 3,
"nai": "@@000000021"
},
"maximum_block_size": 131072,
"sbd_interest_rate": 1000
},
"fee": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
}
}
]
account_witness_vote
All accounts with a VFS (Vesting Fund Shares) can vote for or against
any witness. See: STEEM_MAX_ACCOUNT_WITNESS_VOTES
If a proxy is specified then all existing votes are removed.
Roles: active owner
Parameters: account witness approve
Example Op:
[
"account_witness_vote",
{
"account": "alice",
"witness": "bob",
"approve": true
}
]
account_witness_proxy
Allows one account to delegate witness votes to another account.
If a proxy is specified then all existing witness votes are removed.
Note, as of HF21, setting a witness proxy also applies to Steem.DAO proposal approval. If you trust someone to cast your witness votes, it is assumed that you would also trust them to cast your proposal votes.
Roles: active owner
Parameters: account proxy
Example Op:
[
"account_witness_proxy",
{"account": "alice", "proxy": "bob"}
]
- Disabled
- Related
pow
Disabled in HF14.
Roles: active owner
Parameters: worker input signature work
Example Op:
[
"pow",
{
"worker_account": "admin",
"block_id": "000004433bd4602cf5f74dbb564183837df9cef8",
"nonce": 82,
"work": {
"worker": "STM65wH1LZ7BfSHcK69SShnqCAH5xdoSZpGkUjmzHJ5GCuxEK9V5G",
"input": "59b009f89477919f95914151cef06f28bf344dd6fb7670aca1c1f4323c80446b",
"signature": "1f3f83209097efcd01b7d6f27ce726164323d503d6fcf4d55bfb7cb3032796f6766738b36062b5850d69447fdf9c091cbc70825df5eeacc4710a0b11ffdbf0912a",
"work": "0b62f4837801cd857f01d6a541faeb13d6bb95f1c36c6b4b14a47df632aa6c92"
},
"props": {
"account_creation_fee": {
"amount": "100000",
"precision": 3,
"nai": "@@000000021"
},
"maximum_block_size": 131072,
"sbd_interest_rate": 1000
}
}
]
custom
Provides a generic way to add higher level protocols on top of witness consensus.
There is no validation for this operation other than that required auths are valid.
Roles: active owner
Parameters: required_auths id data
Example Op:
[
"custom",
{
"required_auths": ["bytemaster"],
"id": 777,
"data": "0a627974656d617374657207737465656d697402a3d13897d82114466ad87a74b73a53292d8331d1bd1d3082da6bfbcff19ed097029db013797711c88cccca3692407f9ff9b9ce7221aaa2d797f1692be2215d0a5f6d2a8cab6832050078bc5729201e3ea24ea9f7873e6dbdc65a6bd9899053b9acda876dc69f11a13df9ca8b26b6"
}
]
delete_comment
Roles: posting active owner
Parameters: author permlink
Example Op:
[
"delete_comment",
{
"author": "alice",
"permlink": "a-post-by-alice"
}
]
custom_json
Serves the same purpose as custom but also supports required posting
authorities. Unlike custom, this operation is designed to be human
readable/developer friendly.
follow
As of HF9, the follow plugin will track follow/unfollow/ignore events.
reblog
As of HF14, allows users to share blogs they find with those who follow them. This change implemented entirely outside the blockchain consensus which means that reblogging does not create a new post, it merely shares an existing post with people who follow you.
witness
As of HF18, the witness plugin has a custom operation called
enable_content_editing that allows a user to signal they want to edit
their content. By consensus, content is editable indefinitely, but is
soft forked to be frozen after payout. This operation requires an
active key and is designed to prevent vandalism if a posting key is
compromised. #1017
Roles: posting active owner
Parameters: required_auths required_posting_auths id json
Example Op:
[
"custom_json",
{
"required_auths": [],
"required_posting_auths": ["steemit"],
"id": "follow",
"json": "[\"follow\",{\"follower\":\"steemit\",\"following\":\"alice\",\"what\":[\"blog\"]}]"
}
]
[
"custom_json",
{
"required_auths": [],
"required_posting_auths": ["alice"],
"id": "follow",
"json": "[\"follow\",{\"follower\":\"alice\",\"following\":\"eve\",\"what\":[\"ignore\"]}]"
}
]
[
"custom_json",
{
"required_auths": [],
"required_posting_auths": ["bob"],
"id": "reblog",
"json": "{\"account\":\"bob\",\"author\":\"alice\",\"permlink\":\"a-post-by-alice\"}"
}
]
[
"custom_json",
{
"required_auths": ["alice"],
"required_posting_auths": [],
"id": "witness",
"json": "[\"enable_content_editing\", {\"account\": \"alice\", \"relock_time\": \"2100-01-01T12:00:00\"}]"
}
]
comment_options
Authors of posts may not want all of the benefits that come from creating a post. This operation allows authors to update properties associated with their post.
Typically, these options will accompany a comment operation in the same transaction.
As of HF17, content can specify beneficiaries to receive a part of
their author rewards. The beneficiaries are specified in the extension
field of the comment_options_operation and is a sorted vector (by
account name) of account name, weight pairs. The beneficiaries can only
be specified once and must be specified before any votes are cast on the
comment. Most apps are already adding a comment_options in the
transaction that creates the comment, so this should not be much of a
challenge to add to existing apps.
Notes:
- The max_accepted_payout may be decreased, but never increased.
- The percent_steem_dollars may be decreased, but never increased.
- Part of
comment_optionvalidation process, to be called whenallowed_vote_assetsobject has been added as comment option extension are:- When votable assets are greater than maximum votable assets: “Too much votable assets specified”
- When the symbol is not allowed in the list for votable assets: “STEEM can not be explicitly specified as one of allowed_vote_assets”
max_accepted_payout: SBD value of the maximum payout this post will receivepercent_steem_dollars: the percent of Steem Dollars to key, unkept amounts will be received as Steem Powerallow_votes: allows/disallows a post to receive votes;allow_curation_rewards: allows/disllows voters to recieve curation rewards. Rewards return to reward fund.beneficiaries- Must have at least one (empty
beneficiariesnot allowed). - Cannot have more than 127 (witness currently only allow up to 8).
- Cannot allocate more than 100% of rewards to one account.
- Cannot allocate more than 100% of rewards to a comment.
- Must be specified in sorted order (account ascending; no duplicates).
- Must have at least one (empty
Roles: posting active owner
Parameters: author permlink max_accepted_payout percent_steem_dollars allow_votes allow_curation_rewards extensions
Example Op:
[
"comment_options",
{
"author": "alice",
"permlink": "a-post-by-alice",
"max_accepted_payout": {
"amount": "1000000",
"precision": 3,
"nai": "@@000000013"
},
"percent_steem_dollars": 5000,
"allow_votes": true,
"allow_curation_rewards": true,
"extensions": []
}
]
[
"comment_options",
{
"author": "bob",
"permlink": "a-post-with-a-beneficiary",
"max_accepted_payout": {
"amount": "1000000",
"precision": 3,
"nai": "@@000000013"
},
"percent_steem_dollars": 63,
"allow_votes": true,
"allow_curation_rewards": true,
"extensions": [
[
0,
{
"beneficiaries": [{"account": "charlie", "weight": 1000}]
}
]
]
}
]
[
"comment_options",
{
"author": "charlie",
"permlink": "a-post-with-multiple-beneficiaries",
"max_accepted_payout": {
"amount": "1000000",
"precision": 3,
"nai": "@@000000013"
},
"percent_steem_dollars": 62688,
"allow_votes": true,
"allow_curation_rewards": true,
"extensions": [
[
0,
{
"beneficiaries": [
{"account": "david", "weight": 500},
{"account": "erin", "weight": 500},
{"account": "faythe", "weight": 1000},
{"account": "frank", "weight": 500}
]
}
]
]
}
]
set_withdraw_vesting_route
Allows an account to setup a vesting withdraw but with the additional request for the funds to be transferred directly to another account’s balance rather than the withdrawing account. In addition, those funds can be immediately vested again, circumventing the conversion from vests to steem and back, guaranteeing they maintain their value.
Notes:
- Percent must be valid steem percent.
Roles: active owner
Parameters: from_account to_account percent auto_vest
Example Op:
[
"set_withdraw_vesting_route",
{
"from_account": "alice",
"to_account": "bob",
"percent": 10000,
"auto_vest": true
}
]
limit_order_create2
This operation is identical to limit_order_create except it serializes
the price rather than calculating it from other fields. The maximum expiration time for any limit order is 28 days from head_block_time().
Roles: active owner
Parameters: owner orderid amount_to_sell exchange_rate fill_or_kill expiration
Example Op:
[
"limit_order_create2",
{
"owner": "alice",
"orderid": 492991,
"amount_to_sell": {
"amount": "1",
"precision": 3,
"nai": "@@000000013"
},
"exchange_rate": {
"base": {
"amount": "1",
"precision": 3,
"nai": "@@000000013"
},
"quote": {
"amount": "10",
"precision": 3,
"nai": "@@000000021"
}
},
"fill_or_kill": false,
"expiration": "2017-05-12T23:11:13"
}
]
- Disabled
- Related
challenge_authority
Disabled in HF14.
Roles: posting active owner
Parameters: challenger challenged require_owner
prove_authority
Roles: active owner
Parameters: challenged require_owner
- Since: HF11
- Related
request_account_recovery
All account recovery requests come from a listed recovery account. This is secure based on the assumption that only a trusted account should be a recovery account. It is the responsibility of the recovery account to verify the identity of the account holder of the account to recover by whichever means they have agreed upon. The blockchain assumes identity has been verified when this operation is broadcast.
This operation creates an account recovery request which the account to recover has 24 hours to respond to before the request expires and is invalidated.
There can only be one active recovery request per account at any one time. Pushing this operation for an account to recover when it already has an active request will either update the request to a new new owner authority and extend the request expiration to 24 hours from the current head block time or it will delete the request. To cancel a request, simply set the weight threshold of the new owner authority to 0, making it an open authority.
Additionally, the new owner authority must be satisfiable. In other words, the sum of the key weights must be greater than or equal to the weight threshold.
This operation only needs to be signed by the the recovery account. The account to recover confirms its identity to the blockchain in the recover account operation.
Notes:
recovery_account: The recovery account is listed as the recovery account on the account to recover.account_to_recover: The account to recover. This is likely due to a compromised owner authority.new_owner_authority: The new owner authority the account to recover wishes to have. This is secret known by the account to recover and will be confirmed in arecover_account.
See: #169
Roles: active owner
Parameters: recovery_account account_to_recover new_owner_authority extensions
Example Op:
[
"request_account_recovery",
{
"recovery_account": "steem",
"account_to_recover": "alice",
"new_owner_authority": {
"weight_threshold": 1,
"account_auths": [],
"key_auths": [
[
"STM6LYxj96zdypHYqgDdD6Nyh2NxerN3P1Mp3ddNm7gci63nfrSuZ",
1
]
]
},
"extensions": []
}
]
- Since: HF11
- Related
recover_account
Roles: owner
Parameters: account_to_recover new_owner_authority recent_owner_authority extensions
Example Op:
[
"recover_account",
{
"account_to_recover": "alice",
"new_owner_authority": {
"weight_threshold": 1,
"account_auths": [],
"key_auths": [
[
"STM7j3nhkhHTpXqLEvdx2yEGhQeeorTcxSV6WDL2DZGxwUxYGrHvh",
1
]
]
},
"recent_owner_authority": {
"weight_threshold": 1,
"account_auths": [],
"key_auths": [
[
"STM78Xth94gNxp8nmByFV2vNAhg9bsSdviJ6fQXUTFikySLK3uTxC",
1
]
]
},
"extensions": []
}
]
- Since: HF11
- Related
change_recovery_account
Each account lists another account as their recovery account.
The recovery account has the ability to create account_recovery_requests
for the account to recover. An account can change their recovery account
at any time with a 30 day delay. This delay is to prevent
an attacker from changing the recovery account to a malicious account
during an attack. These 30 days match the 30 days that an
owner authority is valid for recovery purposes.
On account creation the recovery account is set either to the creator of the account (The account that pays the creation fee and is a signer on the transaction) or to the empty string if the account was mined. An account with no recovery has the top voted witness as a recovery account, at the time the recover request is created. Note: This does mean the effective recovery account of an account with no listed recovery account can change at any time as witness vote weights. The top voted witness is explicitly the most trusted witness according to stake.
See: #169
Roles: owner
Parameters: account_to_recover new_recovery_account extensions
Example Op:
[
"change_recovery_account",
{
"account_to_recover": "alice",
"new_recovery_account": "bob",
"extensions": []
}
]
- Since: HF14
- Related
escrow_transfer
The purpose of this operation is to enable someone to send money contingently to another individual. The funds leave the from account and go into a temporary balance where they are held until from releases it to to or to refunds it to from.
In the event of a dispute the agent can divide the funds between the to/from account. Disputes can be raised any time before or on the dispute deadline time, after the escrow has been approved by all parties.
This operation only creates a proposed escrow transfer. Both the agent and to must agree to the terms of the arrangement by approving the escrow.
The escrow agent is paid the fee on approval of all parties. It is up to the escrow agent to determine the fee.
Escrow transactions are uniquely identified by from and escrow_id,
the escrow_id is defined by the sender.
Roles: active owner
Parameters: from to agent escrow_id sbd_amount steem_amount fee ratification_deadline escrow_expiration json_meta
Example Op:
[
"escrow_transfer",
{
"from": "alice",
"to": "bob",
"sbd_amount": {
"amount": "1000",
"precision": 3,
"nai": "@@000000013"
},
"steem_amount": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
},
"escrow_id": 23456789,
"agent": "charlie",
"fee": {
"amount": "100",
"precision": 3,
"nai": "@@000000013"
},
"json_meta": "{}",
"ratification_deadline": "2017-02-26T11:22:39",
"escrow_expiration": "2017-02-28T11:22:39"
}
]
- Since: HF14
- Related
escrow_dispute
If either the sender or receiver of an escrow payment has an issue, they can raise it for dispute. Once a payment is in dispute, the agent has authority over who gets what.
Roles: active owner
Parameters: from to agent who escrow_id
Example Op:
[
"escrow_dispute",
{
"from": "alice",
"to": "bob",
"agent": "charlie",
"who": "alice",
"escrow_id": 72526562
}
]
- Since: HF14
- Related
escrow_release
This operation can be used by anyone associated with the escrow transfer to release funds if they have permission.
The permission scheme is as follows:
- If there is no dispute and escrow has not expired, either party can release funds to the other.
- If escrow expires and there is no dispute, either party can release funds to either party.
- If there is a dispute regardless of expiration, the agent can release funds to either party following whichever agreement was in place between the parties.
Roles: active owner
Parameters: from to agent who receiver escrow_id sbd_amount steem_amount
Example Op:
[
"escrow_release",
{
"from": "alice",
"to": "bob",
"agent": "charlie",
"who": "charlie",
"receiver": "bob",
"escrow_id": 72526562,
"sbd_amount": {
"amount": "5000",
"precision": 3,
"nai": "@@000000013"
},
"steem_amount": {
"amount": "0",
"precision": 3,
"nai": "@@000000021"
}
}
]
- Disabled
- Related
pow2
Disabled in HF17.
Roles: active owner
Parameters: input pow_summary
Example Op:
[
"pow2",
{
"work": [
0,
{
"input": {
"worker_account": "alice",
"prev_block": "003ea604345523c344fbadab605073ea712dd76f",
"nonce": "1052853013628665497"
},
"pow_summary": 3817904373
}
],
"props": {
"account_creation_fee": {
"amount": "1",
"precision": 3,
"nai": "@@000000021"
},
"maximum_block_size": 131072,
"sbd_interest_rate": 1000
}
}
]
- Since: HF14
- Related
escrow_approve
The agent and to accounts must approve an escrow transaction for it to be valid on the blockchain. Once a party approves the escrow, they cannot revoke their approval. Subsequent escrow approve operations, regardless of the approval, will be rejected.
Roles: active owner
Parameters: from to agent who escrow_id approve
Example Op:
[
"escrow_approve",
{
"from": "alice",
"to": "bob",
"agent": "charlie",
"who": "charlie",
"escrow_id": 59102208,
"approve": true
}
]
- Since: HF14
- Related
transfer_to_savings
For time locked savings accounts. A user can place Steem and Steem Dollars into time locked savings balances. Funds can be withdrawn from these balances after a three day delay. The point of this addition is to mitigate loss from hacked and compromised account. The max a user can lose instantaneously is the sum of what the hold in liquid balances. Assuming an account can be recovered quickly, loss in such situations can be kept to a minimum.
Roles: active owner
Parameters: from to amount memo
Example Op:
[
"transfer_to_savings",
{
"from": "alice",
"to": "alice",
"amount": {
"amount": "1000",
"precision": 3,
"nai": "@@000000013"
},
"memo": ""
}
]
- Since: HF14
- Related
transfer_from_savings
Roles: active owner
Parameters: from request_id to amount memo
Example Op:
[
"transfer_from_savings",
{
"from": "alice",
"request_id": 101,
"to": "alice",
"amount": {
"amount": "1000",
"precision": 3,
"nai": "@@000000013"
},
"memo": ""
}
]
- Since: HF14
- Related
cancel_transfer_from_savings
Roles: active owner
Parameters: from request_id
Example Op:
[
"cancel_transfer_from_savings",
{"from": "alice", "request_id": 1}
]
- Since: HF14
- Related
custom_binary
The semmantics for this operation are the same as the custom_json
operation, but with a binary payload. The json deserialization has a
non-trivial cost associated with it. This operation will allow for
binary deserialization of plugin operations and should improve overall
performance of plugins that chose to use it.
Roles: posting active owner
Parameters: id data
- Since: HF14
- Related
decline_voting_rights
An account can chose to decline their voting rights after a 30 day delay. This includes voting on content and witnesses. The voting rights cannot be acquired again once they have been declined. This is only to formalize a smart contract between certain accounts and the community that currently only exists as a social contract.
Roles: owner
Parameters: account decline
Example Op:
[
"decline_voting_rights",
{"account": "judy", "decline": true}
]
- Since: HF11
- Disabled
- Related
reset_account
This operation allows recovery_account to change account_to_reset’s
owner authority to new_owner_authority after 60 days of inactivity.
See: #169
Roles: active owner
Parameters: reset_account account_to_reset new_owner_authority
- Since: HF11
- Disabled
- Related
set_reset_account
This operation allows account owner to control which account has the
power to execute the reset_account operation after 60 days.
See: #169
Roles: owner posting
Parameters: account current_reset_account reset_account
claim_reward_balance
Roles: posting active owner
Parameters: account reward_steem reward_sbd reward_vests
Example Op:
[
"claim_reward_balance",
{
"account": "alice",
"reward_steem": {
"amount": "17",
"precision": 3,
"nai": "@@000000021"
},
"reward_sbd": {
"amount": "11",
"precision": 3,
"nai": "@@000000013"
},
"reward_vests": {
"amount": "185025103",
"precision": 6,
"nai": "@@000000037"
}
}
]
- Since: HF17
- Related
delegate_vesting_shares
Delegate vesting shares from one account to the other. The vesting
shares are still owned by the original account, but content voting
rights and resource credit are transferred to the receiving
account. This sets the delegation to vesting_shares, increasing it or
decreasing it as needed (i.e. a delegation of 0 removes the delegation).
When a delegation is removed the shares are placed in limbo for a week to prevent a satoshi of VESTS from voting on the same content twice.
Also see:
Roles: active owner
Parameters: delegator delegatee vesting_shares
Example Op:
[
"delegate_vesting_shares",
{
"delegator": "alice",
"delegatee": "bob",
"vesting_shares": {
"amount": "94599167138276",
"precision": 6,
"nai": "@@000000037"
}
}
]
- Since: HF17
- Deprecated
- Related
account_create_with_delegation
Deprecated as of HF20 If an account creation service would still like to provide a delegation of Steem Power
to the accounts they create, they can still follow the account creation operation with an additional call to
delegate_vesting_shares to add a delegation of SP to the account.
Instead of paying the entire account creation fee with Steem, creators can now pay a smaller fee (30x less) and delegate some Steem Power for 30 days. The exact amount is 5 * min_fee + STEEM_POWER == 150 * min_fee. You can pay any combination of STEEM and Steem Power along that curve (so long as the minimum fee is paid).
The witness voted STEEM fee is now the minimum required STEEM fee for delegation. Witnesses should reduce their fee by 30x when the hardfork goes live to preserve the same required fee for an all STEEM account creation.
Also see:
Roles: active owner
Parameters: fee delegation creator new_account_name owner active posting memo_key json_metadata extensions
Example Op:
[
"account_create_with_delegation",
{
"fee": {
"amount": "3000",
"precision": 3,
"nai": "@@000000021"
},
"delegation": {
"amount": "0",
"precision": 6,
"nai": "@@000000037"
},
"creator": "steemit",
"new_account_name": "alice",
"owner": {
"weight_threshold": 1,
"account_auths": [],
"key_auths": [
[
"STM5Tki3ecCdCCHCjhhwvQvXuKryL2s34Ma6CXsRzntSUTYVYxCQ9",
1
]
]
},
"active": {
"weight_threshold": 1,
"account_auths": [],
"key_auths": [
[
"STM6LUoAA8gCL9tHRz7v9xcwR4ZWD3KDRHP5t1U7UAZHdfanLxyBE",
1
]
]
},
"posting": {
"weight_threshold": 1,
"account_auths": [],
"key_auths": [
[
"STM8anmpHdfVE4AmwsDpcSXpRsydHysEbv6vGJkRQy1d1CC83zeTA",
1
]
]
},
"memo_key": "STM67RYDyEkP1Ja1jFehJ45BFGA9oHHUnRnYbxKJEtMhVQiHW3S3k",
"json_metadata": "{}",
"extensions": []
}
]
- Since: HF21
- Related
create_proposal
Creates a new proposal.
Roles: postingactive owner
Parameters: creator receiver start_date end_date daily_pay subject permlink
Example Op:
[
"create_proposal",
{
"creator": "alice",
"receiver": "bob",
"start_date": "2019-08-26T11:22:39",
"end_date": "2019-08-26T11:22:39",
"daily_pay": {
"amount": "3000",
"precision": 3,
"nai": "@@000000013"
},
"subject": "subject",
"permlink": "creator-proposal-permlink"
}
]
- Since: HF21
- Related
remove_proposal
Removes proposal using proposal.id of a given proposal.
Roles: posting active owner
Parameters: creator proposal_ids
Example Op:
[
"remove_proposal",
{"creator": "alice", "proposal_ids": [0]}
]
- Since: HF21
- Related
update_proposal_votes
Update proposal votes by proposal.id.
Roles: posting active owner
Parameters: voter proposal_ids approve
Example Op:
[
"update_proposal_votes",
{
"voter": "alice",
"proposal_ids": [0],
"approve": true
}
]
- Since: HF23
- Related
claim_reward_balance2
Differs with original operation with extensions field and a container of tokens that will be rewarded to an account.
Note: The reward tokens are required to be unique and sorted (both by asset symbol) in ascending order. Otherwise operation validation will fail.
See: #1859
Roles: posting active owner
Parameters: account reward_tokens extensions
Example Op:
[
"claim_reward_balance2",
{
"account": "alice",
"reward_tokens": [
{
"amount": "1",
"precision": 0,
"nai": "@@904705667"
}
],
"extensions": []
}
]
- Since: HF23
- Related
vote2
This operation is used to cast a vote on a post/comment using multiple votable assets.
See: #2748, SMT Voting Mana Deep Dive
Roles: posting active owner
Parameters: voter author permlink weight extensions
Example Op:
[
"vote2",
{
"voter": "steemit",
"author": "alice",
"permlink": "a-post-by-alice",
"rshares": [[{"nai": "@@904705667", "decimals": 0}, 0]],
"extensions": []
}
]
- Since: HF23
- Related
smt_setup
Setup a Smart Media Token. Each SMT has an associated descriptor object which has permanent configuration data. This data cannot be changed after launch.
Parameters:
control_account- The name of the controlling account.symbol- The asset symbol of the created token.max_supply- The maximum supply of a smart media token.contribution_begin_time- The start time of the ICO contribution process.contribution_end_time- The end time of the ICO contribution process.launch_time- The time in which a token should launch.steem_units_min- The minimum steem units required for a successful ICO.steem_units_soft_cap- The steem unit cap in which the pre_soft_cap_unit generation policy applies.steem_units_hard_cap- The steem unit cap in which the post_soft_cap_unit generation policy applies.initial_generation_policy- A JSON string of the STEEM and token destination routes of the ICO process.
Example Initial Generation Policy JSON:
{"type": "smt_capped_generation_policy", "value": {
"pre_soft_cap_unit": {
"steem_unit": [["alice", 100]],
"token_unit": [["$from", 5], ["alice", 1]]
},
"post_soft_cap_unit": {
"steem_unit": [["alice", 100]],
"token_unit": [["$from", 5], ["alice", 1]]
},
"min_steem_units_commitment": {
"lower_bound": 1,
"upper_bound": 1,
"hash": "32edb6022c0921d99aa347e9cda5dc2db413f5574eebaaa8592234308ffebd2b"
},
"hard_cap_steem_units_commitment": {
"lower_bound": "166666666666",
"upper_bound": "166666666666",
"hash": "93c5a6b892de788c5b54b63b91c4b692e36099b05d3af0d16d01c854723dda21"
},
"soft_cap_percent": 10000,
"min_unit_ratio": 1000,
"max_unit_ratio": 1000,
"extensions": []
}}
Roles: active owner
Parameters: control_account symbol contribution_begin_time contribution_end_time launch_time max_supply steem_units_hard_cap steem_units_soft_cap steem_units_min initial_generation_policy extensions
Example Op:
[
"smt_setup",
{
"control_account": "alice",
"symbol": {"nai": "@@000000000", "decimals": 0},
"contribution_begin_time": "2019-08-26T11:22:39",
"contribution_end_time": "2019-08-26T11:22:39",
"launch_time": "2019-09-26T11:22:39",
"max_supply": 1000000000000000,
"steem_units_hard_cap": 10000,
"steem_units_soft_cap": 1000,
"steem_units_min": 0,
"initial_generation_policy": "{\"type\":\"smt_capped_generation_policy\",\"value\":{\"pre_soft_cap_unit\":{\"steem_unit\":[[\"alice\",100]],\"token_unit\":[[\"$from\",5],[\"alice\",1]]},\"post_soft_cap_unit\":{\"steem_unit\":[[\"alice\",100]],\"token_unit\":[[\"$from\",5],[\"alice\",1]]},\"min_steem_units_commitment\":{\"lower_bound\":1,\"upper_bound\":1,\"hash\":\"32edb6022c0921d99aa347e9cda5dc2db413f5574eebaaa8592234308ffebd2b\"},\"hard_cap_steem_units_commitment\":{\"lower_bound\":\"166666666666\",\"upper_bound\":\"166666666666\",\"hash\":\"93c5a6b892de788c5b54b63b91c4b692e36099b05d3af0d16d01c854723dda21\"},\"soft_cap_percent\":10000,\"min_unit_ratio\":1000,\"max_unit_ratio\":1000,\"extensions\":[]}}",
"extensions": []
}
]
- Since: HF23
- Related
smt_setup_emissions
Create Smart Media Token emissions (inflation).
Parameters:
control_account- The name of the controlling account.symbol- The asset symbol of the created token.schedule_time- The time the token is applicable.emissions_unit- The emissions unit.interval_seconds- The seconds between intervals.interval_count- The number of intervals.lep_time- The time of the left endpoint.rep_time- The time of the right endpoint.lep_abs_amount- The absolute emission amount of the left endpoint.rep_abs_amount- The absolute emission amount of the right endpoint.lep_rel_amount_numerator- The relative emission numerator of the left endpoint.rep_rel_amount_numerator- The relative emission numerator of the right endpoint.rel_amount_denom_bits- The about of bits to shift for the relative denominator.remove- Indicates whether an emission should be added or removed.floor_emissions- Indicates whether we should consider the lowest or highest value with regards to relative and absolute emissions.
See: #1513, #2738, SMT Pre-Setup, Inflation Operations, Full JSON Examples, Inflation FAQ
Roles: active owner
Parameters: control_account symbol emissions_unit interval_seconds interval_count lep_time rep_time lep_abs_amount rep_abs_amount lep_rel_amount_numerator rep_rel_amount_numerator rel_amount_denom_bits remove floor_emissions
Example Op:
[
"smt_setup_emissions",
{
"control_account": "alice",
"symbol": {"nai": "@@904705667", "decimals": 0},
"schedule_time": "2019-08-26T11:22:39",
"emissions_unit": {"token_unit": [["alice", 1]]},
"interval_seconds": 21600,
"interval_count": 1,
"lep_time": "2019-08-26T11:22:39",
"rep_time": "2019-08-26T11:22:39",
"lep_abs_amount": {
"amount": "1",
"precision": 0,
"nai": "@@904705667"
},
"rep_abs_amount": {
"amount": "1",
"precision": 0,
"nai": "@@904705667"
},
"lep_rel_amount_numerator": 0,
"rep_rel_amount_numerator": 0,
"rel_amount_denom_bits": 0,
"remove": false,
"floor_emissions": false,
"extensions": []
}
]
- Since: HF23
- Related
smt_set_setup_parameters
Creates Smart Media Token setup parameters.
Parameters:
control_account- The name of the controlling account.symbol- The asset symbol of the created token.setup_parameters- The SMT setup parameters
See: #2727, Named Token Parameters
Roles: active owner
Parameters: control_account symbol setup_parameters
Example Op:
[
"smt_set_setup_parameters",
{
"control_account": "alice",
"symbol": {"nai": "@@000000000", "decimals": 0},
"setup_parameters": [
{
"type": "smt_param_allow_voting",
"value": {"value": true}
}
],
"extensions": []
}
]
- Since: HF23
- Related
smt_set_runtime_parameters
Creates Smart Media Token runtime parameters.
Parameters:
control_account- The name of the controlling account.symbol- The asset symbol of the created token.runtime_parameters- The SMT runtime parameters.
Allowed Author Reward Curves:
linearquadratic
Allowed Curation Reward Curves:
linearsquare_rootbounded_curation
Roles: active owner
Parameters: control_account symbol runtime_parameters
Example Op:
[
"smt_set_runtime_parameters",
{
"control_account": "alice",
"symbol": {"nai": "@@000000000", "decimals": 0},
"runtime_parameters": [
{
"type": "smt_param_windows_v1",
"value": {
"cashout_window_seconds": 90001,
"reverse_auction_window_seconds": 110
}
},
{
"type": "smt_param_vote_regeneration_period_seconds_v1",
"value": {
"vote_regeneration_period_seconds": 7000,
"votes_per_regeneration_period": 1
}
},
{
"type": "smt_param_rewards_v1",
"value": {
"content_constant": 9005,
"percent_curation_rewards": 9006,
"author_reward_curve": "quadratic",
"curation_reward_curve": "bounded_curation"
}
},
{
"type": "smt_param_allow_downvotes",
"value": {"value": true}
}
],
"extensions": []
}
]
- Since: HF23
- Related
smt_create
Create a Smart Media Token.
This operation introduces new SMT into blockchain as identified by Numerical Asset Identifier (NAI). Also the SMT precision (decimal points) is explicitly provided.
Initial Case
The first operation to be executed is an smt_create operation. This operation creates an SMT object in the blockchain state. After executing this operation, the newly created SMT object is not yet fully configured.
Most of the configuration occurs in subsequent operations (smt_set_setup_parameters, smt_setup_inflation, and smt_setup). These later operations may occur in the same transaction, but they may also occur at any later point in time.
Reset Case
Re-issuing smt_create with zero smt_creation_fee and the NAI of a token in the initial setup will reset emmisions and setup state. This is useful for token creators who have put their token in an unlaunchable state.
This will allow deleting of emission schedules with and changing of precision if there are no emission objects already created.
Parameters:
control_account- The name of the controlling account.symbol- The asset symbol of the created token.smt_creation_fee- The amount to be transfered from @account to null account as elevation fee. The amount required is set by thesmt_creation_feefield of thedynamic_global_propertiesobject. This field may contain a value in STEEM or SBD.precision- Separately provided precision for clarity and redundancy.
See: SMT Object Creation
Roles: active owner
Parameters: control_account symbol smt_creation_fee precision
Example Op:
[
"smt_create",
{
"control_account": "alice",
"symbol": {"nai": "@@000000000", "decimals": 0},
"smt_creation_fee": {
"amount": "3000",
"precision": 3,
"nai": "@@000000013"
},
"precision": 0,
"extensions": []
}
]
- Since: HF23
- Related
smt_contribute
Contribute to a token ICO.
Parameters:
contributorThe name of the contributorsymbolThe asset symbol of the SMTcontribution_idA unique contribution ID numbercontributionThe contribution (in STEEM)
See: #2730, Token Units
Roles: active owner
Parameters: contributor symbol contribution_id contribution
Example Op:
[
"smt_contribute",
{
"contributor": "alice",
"symbol": {"nai": "@@422838704", "decimals": 0},
"contribution_id": 0,
"contribution": {
"amount": "1000",
"precision": 3,
"nai": "@@000000021"
},
"extensions": []
}
]
- Since: HF20
- Virtual Operation
- Deprecated
- Related
clear_null_account_balance
Deprecated as of HF23, see: #3556.
For per-block processing that clears null account balances (prior to HF23).
See: #2627
Roles: active owner
Parameters: total_cleared
- Since: HF21
- Virtual Operation
- Related
proposal_pay
Dedicated operation to be generated during proposal payment phase to provide info in Account History related to funds transfer.
Roles: active owner
Parameters: receiver payment trx_id op_in_trx
Example Op:
[
"proposal_pay",
{
"receiver": "steem.dao",
"payment": "1.637 SBD",
"trx_id": "0000000000000000000000000000000000000000",
"op_in_trx": 0
}
]
- Since: HF21
- Virtual Operation
- Related
sps_fund
Created once per maintenance interval to document how much SBD was added to the threasury from inflation in that maintenance interval (i.e., to track the funding of the SPS).
Roles: active owner
Parameters: additional_funds
Example Op:
["sps_fund", {"additional_funds": "71.460 SBD"}]
- Virtual Operation
- Related
fill_convert_request
Fills when conversion requests with a conversion date before the head block time and then converts them to/from steem/sbd at the current median price feed history price times the premium.
Roles: active owner
Parameters: owner requestid amount_in amount_out
- Virtual Operation
- Related
author_reward
Roles: posting active owner
Parameters: author permlink sbd_payout steem_payout vesting_payout
- Virtual Operation
- Related
curation_reward
Roles: posting active owner
Parameters: curator reward comment_author comment_permlink
- Since: HF17
- Virtual Operation
- Related
comment_reward
See: #774
Roles: posting active owner
Parameters: author permlink payout
- Virtual Operation
- Disabled
- Related
liquidity_reward
Deprecated as of HF12, see: #178.
Roles: active owner
Parameters: owner payout
- Virtual Operation
- Related
interest
Roles: active owner
Parameters: owner interest
Example Op:
[
"interest",
{"owner": "alice", "interest": "0.001 SBD"}
]
- Since: HF6
- Virtual Operation
- Related
fill_vesting_withdraw
See: #78
Roles: active owner
Parameters: from_account to_account withdrawn deposited
Example Op:
[
"fill_vesting_withdraw",
{
"from_account": "alice",
"to_account": "alice",
"withdrawn": "0.026475 VESTS",
"deposited": "0.710 STEEM"
}
]
- Virtual Operation
- Related
fill_order
Roles: posting active owner
Parameters: current_owner current_orderid current_pays open_owner open_orderid open_pays
Example Op:
[
"fill_order",
{
"current_owner": "alice",
"current_orderid": 42896,
"current_pays": "94.999 SBD",
"open_owner": "bob",
"open_orderid": 10001,
"open_pays": "500.000 STEEM"
}
]
- Since: HF14
- Virtual Operation
- Related
shutdown_witness
When a witness goes offline.
See: #278
Roles: posting active owner
Parameters: owner
Example Op:
["shutdown_witness", {"owner": "alice"}]
- Since: HF14
- Virtual Operation
- Related
fill_transfer_from_savings
Roles: posting active owner
Parameters: from to amount request_id memo
- Since: HF9
- Virtual Operation
- Related
hardfork
Roles: posting active owner
Parameters: hardfork_id
- Virtual Operation
- Related
comment_payout_update
Roles: posting active owner
Parameters: author permlink
- Since: HF17
- Virtual Operation
- Related
return_vesting_delegation
Roles: posting active owner
Parameters: account vesting_shares
- Since: HF17
- Virtual Operation
- Related
comment_benefactor_reward
Roles: posting active owner
Parameters: benefactor author permlink reward
- Since: HF17
- Virtual Operation
- Related
producer_reward
Witness rewards for block signing are hard to account for. Making these rewards visible will help witnesses and prospective witnesses by providing them with more complete and accurate information to guide their decisions to invest in the platform.
Roles: posting active owner
Parameters: producer vesting_shares
Example Op:
[
"producer_reward",
{
"producer": "alice",
"vesting_shares": "14403.626449 VESTS"
}
]
Broadcast Ops Communities
Ops:
To interact with the communities framework, use custom_json operations with the an id of community. Communities also intepret other ids like follow and reblog.
See: communities.md
Also see: Bridge, Broadcast Transaction, custom_json
setRole
Sets a role for a given account in a community.
- Owner can set any role.
- Admins can set the role of any account to any level below
admin, except for other Admins. - Mods can set the role of any account to any level below
mod, except for other Mods.
Roles: posting
Parameters: community account role
Example Op:
[
"custom_json",
{
"required_auths": [],
"required_posting_auths": ["alice"],
"id": "community",
"json": "[\"setRole\", {\"community\": \"hive-123456\", \"account\": \"bob\", \"role\": \"admin\"}]"
}
]
[
"custom_json",
{
"required_auths": [],
"required_posting_auths": ["alice"],
"id": "community",
"json": "[\"setRole\", {\"community\": \"hive-123456\", \"account\": \"charlie\", \"role\": \"mod\"}]"
}
]
[
"custom_json",
{
"required_auths": [],
"required_posting_auths": ["alice"],
"id": "community",
"json": "[\"setRole\", {\"community\": \"hive-123456\", \"account\": \"dave\", \"role\": \"guest\"}]"
}
]
[
"custom_json",
{
"required_auths": [],
"required_posting_auths": ["alice"],
"id": "community",
"json": "[\"setRole\", {\"community\": \"hive-123456\", \"account\": \"edward\", \"role\": \"member\"}]"
}
]
setUserTitle
Sets a title (badge) for a given account in a community (Mods or higher).
Roles: posting
Parameters: community account title
Example Op:
[
"custom_json",
{
"required_auths": [],
"required_posting_auths": ["alice"],
"id": "community",
"json": "[\"setUserTitle\", {\"community\": \"hive-123456\", \"account\": \"alice\", \"title\": \"Founder\"}]"
}
]
mutePost
Mute a post (Mods or higher). Can be a topic or a comment.
Note: Any posts muted for spam should contain simply the string spam in the notes field. This standardized label will help train automated spam detection.
Roles:
Parameters:
Example Op:
[
"custom_json",
{
"required_auths": [],
"required_posting_auths": ["alice"],
"id": "community",
"json": "[\"mutePost\",{\"community\":\"hive-123456\",\"account\":\"eve\",\"permlink\":\"re-eve-comment-1564339652z\",\"notes\":\"Off Topic\"}]"
}
]
unmutePost
Unmute a post (Mods or higher).
Roles:
Parameters:
Example Op:
[
"custom_json",
{
"required_auths": [],
"required_posting_auths": ["alice"],
"id": "community",
"json": "[\"unmutePost\",{\"community\":\"hive-123456\",\"account\":\"eve\",\"permlink\":\"re-eve-comment-1564339652z\",\"notes\":\"On Topic (on second thought)\"}]"
}
]
updateProps
Roles:
Parameters:
Example Op:
[
"custom_json",
{
"required_auths": [],
"required_posting_auths": ["alice"],
"id": "community",
"json": "[\"updateProps\",{\"community\":\"hive-123456\",\"props\":{\"title\":\"Anti-Knitting\",\"about\":\"A community against knitting.\",\"is_nsfw\":false,\"description\":\"If you like to knitting, go away.\",\"flag_text\":\"Must hate knitting or else you will be muted.\"}}]"
}
]
subscribe
Allows a user to signify they want this community shown on their personal trending feed and to be shown in their navigation menu.
Roles:
Parameters:
Example Op:
[
"custom_json",
{
"required_auths": [],
"required_posting_auths": ["alice"],
"id": "community",
"json": "[\"subscribe\",{\"community\":\"hive-123456\"}]"
}
]
pinPost
Stickies a post to the top of the community homepage (Mods or higher). If multiple posts are stickied, the newest ones are shown first.
Roles:
Parameters:
Example Op:
[
"custom_json",
{
"required_auths": [],
"required_posting_auths": ["alice"],
"id": "community",
"json": "[\"pinPost\",{\"community\":\"hive-123456\",\"account\":\"alice\",\"permlink\":\"a-post-by-alice\"}]"
}
]
unsubscribe
Allows a user to signify they no longer want this community shown on their personal trending feed or to be shown in their navigation menu.
Roles:
Parameters:
Example Op:
[
"custom_json",
{
"required_auths": [],
"required_posting_auths": ["alice"],
"id": "community",
"json": "[\"unsubscribe\",{\"community\":\"hive-123456\"}]"
}
]
unpinPost
Removes a post to the top of the community homepage (Mods or higher).
Roles:
Parameters:
Example Op:
[
"custom_json",
{
"required_auths": [],
"required_posting_auths": ["alice"],
"id": "community",
"json": "[\"unpinPost\",{\"community\":\"hive-123456\",\"account\":\"alice\",\"permlink\":\"a-post-by-alice\"}]"
}
]
flagPost
Used by guests to suggest a post for the review queue. It’s up to the community to define what constitutes flagging.
Roles:
Parameters:
Example Op:
[
"custom_json",
{
"required_auths": [],
"required_posting_auths": ["alice"],
"id": "community",
"json": "[\"flagPost\",{\"community\":\"hive-123456\",\"account\":\"eve\",\"permlink\":\"a-post-by-eve\",\"notes\":\"Warning\"}]"
}
]