<center>http://puu.sh/rfIMU/c097a8f467.png</center>

The STEEM Network runs on decentralized <code>steemd</code> server nodes which allow for numerous complex functions to be called depending on which API module is referenced.

This page lists various API calls for the <code>steemd</code> binary which acts as a backbone for the entire STEEM network. It should be noted that <code>steemd</code> is different than the STEEM wallet which is <code>cli_wallet</code> which is a completely different program that can be run alongside or independently of a <code>steemd</code> node. STEEM is pretty complex and a number of API call rules apply.

Most bots and other automated scripts accomplish their goal by using the <code>cli_wallet</code> program. You can visit our current documentation on it here: <a href="http://steem.global/?page_id=122"><strong>cli_wallet API</strong></a> <-- Under Construction!

&nbsp;
<h1 style="text-align: center;">Before Attempting steemd RPC Calls</h1>
In order to access <code>steemd</code> calls you MUST have a full node running and listening to port 8092, on a local machine (or other server you have access to). If you would like more information on setting up your own full STEEM node please check out the following information: <a href="https://steemit.com/allinone/@omotherhen/ezsteem-suite-1-0-the-ez-way-to-setup-your-steem-miner-node-in-a-linux-vm-windows-compatible" target="_blank"><strong>EZSTEEM</strong></a>  or <a href="https://steemit.com/steem/@someguy123/steem-in-a-box-deploy-a-new-seed-witness-or-rpc-server-with-a-one-liner" target="_blank"><strong>STEEM-in-a-box</strong></a> 

Make sure to set the rpc-endpoint in your STEEM nodes <code>config.ini</code> file.

Or can start your <code>steemd</code> client with the following to run it listening on port 8092:

<code>./steemd --rpc-endpoint=127.0.0.1:8092</code>

This allows our <code>steemd</code> server an RPC endpoint so that we can make calls to the node via RPC-JSON and have the program respond properly.

&nbsp;
<h1 style="text-align: center;">Call Format for <code>steemd</code></h1>
The STEEM network is built off of Graphene architecture meaning that RPC calls are state-less and can be accessed through regular JSON formatted RPC-HTTP.

The following structure should be used when calling the <code>steemd</code> client: <code>{ "jsonrpc": "2.0", "method": "get_accounts", "params": [["klye"]], "id": 1 }</code>

Or like
<code>
{
"jsonrpc": "2.0",
"method": "get_accounts",
"params": [["klye"]],
"id": 1
}
</code>

In the example above the "get_accounts" function calls to the database_api module and would returns information pertaining to the @klye account.

&nbsp;
<h2 style="text-align: center;">Using <code>curl</code></h2>
A simple way to pass command to the same command to the <code>steemd</code> client is by with <code>curl</code> using the following format:

<code>curl --data '{"jsonrpc": "2.0", "method": "get_accounts", "params": [["klye"]], "id": 1 }' http://127.0.0.1:8090/rpc</code>
<h2 style="text-align: center;">Calls That Are a Success</h2>
When an API call is successful it will return a response JSON formatted. The returned response should also have a similar id number indicating it's from the call you've just put out:

<code>{ "id":1, "result": "data" }
</code>

The output of the above curl call invoking the get_accounts function with the id of 1 &amp; the klye username in the only parameter yields a response of:

<code>{"id":1,"result":[{"id":"2.2.9852","name":"klye","owner":{"weight_threshold":1,"account_auths":[],
"key_auths":[["STM7wBNbebQLUi8ayUqSCFHnJRHewrPdD1CCTjJeH2C2ym4gsyeiL",1]]},
"active":{"weight_threshold":1,"account_auths":[],"key_auths":[["STM5pMzmpjvcUnwwt5TJvzWhH6z4Ku5nzcUFA1NGHHJ7RnjFAnxT3",1]]},
"posting":{"weight_threshold":1,"account_auths":[],"key_auths":[["STM8f9jATn1kYzVhuLA7xKMZXS4zDBpJph5qNfMsRFb3iL4raoAYe",1]]},
"memo_key":"STM8XCEUv4bPbXTsHRQctHf2UASzsevoeV8tBYfb6D7btuTt5bzuz",
"json_metadata":"","proxy":"","last_owner_update":"1970-01-01T00:00:00","last_account_update":"1970-01-01T00:00:00","created":"2016-05-25T23:34:03","mined":false,"owner_challenged":false,"active_challenged":false,"last_owner_proved":"1970-01-01T00:00:00","last_active_proved":"1970-01-01T00:00:00","recovery_account":"steem","last_account_recovery":"1970-01-01T00:00:00","comment_count":0,"lifetime_vote_count":0,"post_count":1417,"voting_power":9714,"last_vote_time":"2016-09-18T03:03:09","balance":"0.000 STEEM","sbd_balance":"0.089 SBD","sbd_seconds":"195301723950","sbd_seconds_last_update":"2016-09-16T14:41:15","sbd_last_interest_payment":"2016-09-02T11:15:03","vesting_shares":"8673602.167564 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":12180,"posting_rewards":4896836,"proxied_vsf_votes":[0,0,0,0],"witnesses_voted_for":12,"average_bandwidth":236760191,"lifetime_bandwidth":"1827138000000","last_bandwidth_update":"2016-09-18T05:44:51","average_market_bandwidth":122097987,"last_market_bandwidth_update":"2016-09-16T14:41:15","last_post":"2016-09-17T20:57:39","last_root_post":"2016-09-13T16:00:36","post_bandwidth":10000,"last_active":"2016-09-18T05:44:51","activity_shares":"20803969092513102456","last_activity_payout":"1970-01-01T00:00:00","vesting_balance":"0.000 STEEM","reputation":0,"transfer_history":[],"market_history":[],"post_history":[],"vote_history":[],"other_history":[],"witness_votes":["anyx","dantheman","jesta","liondani","pfunk","pharesim","proctologic","riverhead","roadscape","royaltiffany","smooth.witness","someguy123"],"blog_category":{}}]}</code>

As you can see a fair amount of data is given off by some of these calls which can easily be parsed or scraped for whatever intention a coder had for the information.
<h2 style="text-align: center;">Calls That Fail</h2>
If an API doesn't return a successful call the return output will show some details as shown below:

<code>
{
"id": 0
"error": {
"data": {
"code": error-code,
"name": " .. name of exception .."
"message": " .. message of exception ..",
"stack": [ .. stack trace .. ],
},
"code": 1,
},
}
</code>

Error handling will spit out some information pertaining to what went wrong. I've included an actual example of a response from a failed call below:

<code>{"id": 177,"error": {"code": 1,"message": "7 bad_cast_exception: Bad Cast\nInvalid cast from string_type to Array\n {\"type\":\"string_type\"}\n th_a variant.cpp:537 get_array","data": {"code": 7,"name": "bad_cast_exception","message": "Bad Cast","stack": [{"context": {"level": "error","file": "variant.cpp","line": 537,"method": "get_array","hostname": "","thread_name": "th_a","timestamp": "2016-09-18T06:41:36"},"format": "Invalid cast from ${type} to Array","data" :{"type": "string_type"}}]}}}</code>

As clearly seen above the failure response is in depth however hard for most humans to decypher. I'll be going into further details of how this is broken down in the future.

&nbsp;
<h1 style="text-align: center;">login_api functions</h1>
&nbsp;
<h2>login</h2>
<b>Call example</b>: <code>{ "id": 1, "method": "login", "params": [["username", "password"]]}</code>
<b>Usage</b>: Allows login to accounts on the STEEM network
<h2>get_api_by_name</h2>
<b>Call example</b>: <code>{ "id": 2, "method": "get_api_by_name", "params": [["apiname"]]}</code>
<b>Usage</b>: Returns ??? (more info needed)

&nbsp;
<h1 style="text-align: center;">database_api functions</h1>
&nbsp;
<h1 style="text-align: center;">Accounts</h1>
&nbsp;
<h2>get_accounts</h2>
<b>JSON example</b>: <code>{"id":3,"method":"get_accounts","params":[["username"]]}</code>
<b>Usage</b>: Return displays a large amount of data pertaining to accounts included in call. Call multiples simply by adding a comma between the names.
Example: "params":[["usernamehere", "steem-global"]]
<h2>get_account_references</h2>
<b>Call example</b>: <code>{"id":4,"method":"get_account_references","params":[["accountid"]]}</code>
<b>Usage</b>: Currently returns an error. Will update in future when more info on this is found.
<h2>lookup_account_names</h2>
<b>Call example</b>: <code>{"id":5,"method":"lookup_account_names","params":[["username", "callback"]]}</code>
<b>Usage</b>: Returns information about the accounts. Call multiples simply by adding a comma between the names. example: "usernamehere", "steem-global"
<h2>lookup_accounts</h2>
<b>Call example</b>: <code>{"id":6,"method":"lookup_accounts","params":[["username", "limit"]]}</code>
<b>Usage</b>: Acts as a search function to display usernames containing letters given in the first parameter.
<h2>get_account_count</h2>
<b>Call example</b>: <code>{"id":7,"method":"get_account_count","params":[]}</code>
<b>Usage</b>: Shows the number of STEEM accounts on the network currently.
<h2>get_conversion_requests</h2>
<b>Call example</b>: <code>{"id":8,"method":"get_conversion_requests","params":[["username"]]}</code>
<b>Usage</b>: Displays current conversion requests of the given account.
<h2>get_account_history</h2>
<b>Call example</b>: <code>{"id": 9, method: 'get_account_history', 'params': [["username", "from", "limit"]]}</code>
<b>Usage</b>: Allows you to recall the history of given account on the STEEM network.
<h2>get_owner_history</h2>
<b>Call example</b>: <code>{"id": 10, method: 'get_owner_history', 'params': [["username"]]}</code>
<b>Usage</b>: Goes back and display if the given account has changed ownership on the blockchain.
<h2>get_recovery_request</h2>
<b>Call example</b>: <code>{"id": 11, method: 'get_recovery_request', 'params': [["username"]]}</code>
<b>Usage</b>: If the status of the account is currently flagged as wanting recovered will return true, returns "null" otherwise.

&nbsp;
<h1 style="text-align: center;">Voting</h1>
&nbsp;
<h2>get_active_votes</h2>
<b>Call example</b>: <code>{"id": 12, method: 'get_active_votes', 'params': [[ "username", "permalink"]]} </code>
<b>Usage</b>: Check and see if a post currently has any active votes on it.
<h2>get_account_votes</h2>
<b>Call example</b>: <code>{"id": 13, method: 'get_account_votes', 'params': [[ "username"]]}</code>
<b>Usage</b>: Lists the last 100+ votes on the given account.

&nbsp;
<h1 style="text-align: center;">Market</h1>

&nbsp;
<h2>get_order_book</h2>
<b>Call example</b>: <code>{"id":14,"method":"get_order_book","params":["limit"]}</code>
<b>Usage</b>: Returns a list of orders on the internal STEEM market.
<h2>get_open_orders</h2>
<b>Call example</b>: <code>{"id":15,"method":"get_open_orders","params":["username"]}</code>
<b>Usage</b>: If specified username has orders open on the internal STEEM market it will return them.
<h2>get_liquidity_queue</h2>
<b>Call example</b>: <code>{"id":16,"method":"get_liquidity_queue","params":["startusername", "limit"]}</code>
<b>Usage</b>: When there are users in the liquidity queue it will return them.
<h2>get_current_median_history_price</h2>
<b>Call example</b>: <code>{"id":17,"method":"get_current_median_history_price","params":[]}</code>
<b>Usage</b>: Grabs the current median conversion price of SBD / STEEM.
<h2>get_feed_history</h2>
<b>Call example</b>: <code>{"id":18,"method":"get_chain_properties","params":[]}</code>
<b>Usage</b>: Fetches the conversion history of SBD / STEEM.

&nbsp;
<h1 style="text-align: center;">Content</h1>
&nbsp;
<h2>get_content</h2>
<b>Call example</b>: <code>{"id":19,"method":"get_content","params":["username","permalink"]}</code>
<b>Usage</b>: Grabs information about the post given in second parameter.
<h2>get_content_replies</h2>
<b>Call example</b>: <code>{"id":20,"method":"get_content_replies","params":["username","permalink"]}</code>
<b>Usage</b>: Lists all replies on the post given in second parameter.
<h2>get_discussions_by_author_before_date</h2>
<b>Call example</b>: <code>{"id":21,"method":"get_content_replies","params":[["username", "startpermalink", "beforedate", "limit"]]}</code>
<b>Usage</b>: Grabs discussions from the username given from a starting permalink or start date.
<h2>get_replies_by_last_update</h2>
<b>Call example</b>: <code>{"id":22,"method":"get_content_replies","params":[["username", "startpermalink", "limit"]]}</code>
<b>Usage</b>: Grabs replies from the username given from a starting permalink.

&nbsp;
<h1 style="text-align: center;">Block Info</h1>
&nbsp;
<h2>get_block</h2>
<b>Call example</b>: <code>{"id":23,"method":"get_block","params":["blocknumber"]}</code>
<b>Usage</b>: Displays various information about the particular block number given.
<h2>get_block_header</h2>
<b>Call example</b>: <code>{"id":24,"method":"get_block_header","params":["blocknumber"]}</code>
<b>Usage</b>: Shows the header and other brief info about the given block number.
<h2>get_state</h2>
<b>Call example</b>: <code>{"id":25,"method":"get_block_header","params":["path"]}</code>
<b>Usage</b>: Gets the current state of the STEEM network. Leave path blank for current info.
<h2>get_trending_categories</h2>
<b>Call example</b>: <code>{"id":26,"method":"get_trending_categories","params":[["searchafter","limit"]]}</code>
<b>Usage</b>: Allows for the searching of trending categories both current and past.
<h2>get_best_categories</h2>
<b>Call example</b>: <code>{"id":27,"method":"get_best_categories","params":[["after","limit"]]}</code>
<b>Usage</b>: To be 100% honest I wasn't able to figure this call out yet.
<h2>get_active_categories</h2>
<b>Call example</b>: <code>{"id":28,"method":"get_active_categories","params":[["after","limit"]]}</code>
<b>Usage</b>: To be 100% honest I wasn't able to figure this call out yet.
<h2>get_discussions_in_category_by_total_pending_payout</h2>
<b>Call example</b>: <code>Unknown. I couldn't get it to work.</code>
<b>Usage</b>: To be 100% honest I wasn't able to figure this call out yet.
<h2>get_discussions_in_category_by_last_update</h2>
<b>Call example</b>: <code>Unknown. I couldn't get it to work.</code>
<b>Usage</b>: To be 100% honest I wasn't able to figure this call out yet.
<h2>get_discussions_by_last_update</h2>
<b>Call example</b>: <code>Unknown. I couldn't get it to work.</code>
<b>Usage</b>: To be 100% honest I wasn't able to figure this call out yet.

&nbsp;
<h1 style="text-align: center;">Transactions / Authority / Validation</h1>
&nbsp;
<h2>get_transaction_hex</h2>
<b>Call example</b>: <code>{"id":32,"method":"get_transaction_hex","params":["trx"]}</code>
<b>Usage</b>: Fetches the transaction hex digits from the given transaction.
<h2>get_transaction</h2>
<b>Call example</b>: <code>{"id":33,"method":"get_transaction","params":["txid"]}</code>
<b>Usage</b>: Grabs the details a transaction from a given transactionID.
<h2>get_potential_signatures</h2>
<b>Call example</b>: <code>{"id":34,"method":"get_potential_signatures","params":["trx"]}</code>
<b>Usage</b>: To be 100% honest I haven't attempted to figure out call out yet.
<h2>get_required_signatures</h2>
<b>Call example</b>: <code>{"id":35,"method":"get_required_signatures","params":[["trx", "availablekeys"]]}</code>
<b>Usage</b>: To be 100% honest I haven't attempted to figure out call out yet.
<h2>verify_authority</h2>
<b>Call example</b>: <code>{"id":36,"method":"verify_authority","params":["trx"]}</code>
<b>Usage</b>: To be 100% honest I haven't attempted to figure out call out yet.
<h2>verify_account_authority</h2>
<b>Call example</b>: <code>{"id":37,"method":"verify_account_authority","params":[["userid/username", "signer"]]}</code>
<b>Usage</b>: To be 100% honest I haven't attempted to figure out call out yet.

&nbsp;
<h1 style="text-align: center;">Globals</h1>
&nbsp;
<h2>get_config</h2>
<b>Call example</b>: <code>{"id":38,"method":"get_config","params":[]}</code>
<b>Usage</b>: Displays the current configuration of the <code>steemd</code> node.
<h2>get_dynamic_global_properties</h2>
<b>Call example</b>: <code>{"id":39,"method":"get_dynamic_global_properties","params":[]}</code>
<b>Usage</b>: Shows an overview of various information regarding the current state of the STEEM network.
<h2>get_chain_properties</h2>
<b>Call example</b>: <code>{"id":40,"method":"get_chain_properties","params":[]}</code>
<b>Usage</b>: Returns current account creation fee, maximum block size and SBD(Steem Dollar) interest rate.
<h2>get_hardfork_version</h2>
<b>Call example</b>: <code>{"id":40,"method":"get_hardfork_version","params":[]}</code>
<b>Usage</b>: The current version of STEEM hardfork will be displayed.
<h2>get_next_scheduled_hardfork</h2>
<b>Call example</b>: <code>{"id":42,"method":"get_hardfork_version","params":[]}</code>
<b>Usage</b>: Gives a date and version as to when the next version of STEEM is expected.

&nbsp;
<h1 style="text-align: center;">Witnesses</h1>
&nbsp;
<h2>get_witnesses</h2>
<b>Call example</b>: <code>{"id":43,"method":"get_witnesses","params":["witnessid"]}</code>
<b>Usage</b>: I've not looked into what this call does yet, will shortly.
<h2>get_witness_by_account</h2>
<b>Call example</b>: <code>{"id":44,"method":"get_witness_by_account","params":["username"]}</code>
<b>Usage</b>: When invoked answers true if the username given is a witness or <code>"result": null</code> if not.
<h2>get_witnesses_by_vote</h2>
<b>Call example</b>: <code>{"id":45,"method":"get_witnesses_by_vote","params":[["username/blank", "limit"]]}</code>
<b>Usage</b>: Displays a list of the top witnesses by order of witness votes.
<h2>lookup_witness_accounts</h2>
<b>Call example</b>: <code>{"id":46,"method":"lookup_witness_accounts","params":[["searchusername", "limit"]]}</code>
<b>Usage</b>: Returns a list of every user that has declared their intent to run as witness.
<h2>get_witness_count</h2>
<b>Call example</b>: <code>{"id":47,"method":"get_witness_count","params":[]}</code>
<b>Usage</b>: Calculates and displays the total number of accounts that have shown intent to run for witness.
<h2>get_active_witnesses</h2>
<b>Call example</b>: <code>{"id":48,"method":"get_active_witnesses","params":[]}</code>
<b>Usage</b>: Shows the current active witnesses (Top 21 last I checked, might be wrong).
<h2>get_miner_queue</h2>
<b>Call example</b>: <code>{"id":49,"method":"get_miner_queue","params":[]}</code>
<b>Usage</b>: Creates a list of miners waiting to get into the DPOW line to create a block.

&nbsp;
<h1 style="text-align: center;">Subscriptions</h1>
&nbsp;
<h2>set_subscribe_callback</h2>
<b>Call example</b>: <code>{"id":50,"method":"set_subscribe_callback","params":[["cb", "clearfilter"]]}</code>
<b>Usage</b>: I've not yet looked into how this function works, sorry. Will update soon.
<h2>set_pending_transaction_callback</h2>
<b>Call example</b>: <code>{"id":51,"method":"set_pending_transaction_callback","params":["cb"]}</code>
<b>Usage</b>: I've not yet looked into how this function works, sorry. Will update soon.
<h2>set_block_applied_callback</h2>
<b>Call example</b>: <code>{"id":52,"method":"set_block_applied_callback","params":["cb"]}</code>
<b>Usage</b>: I've not yet looked into how this function works, sorry. Will update soon.
<h2>cancel_all_subscriptions</h2>
<b>Call example</b>: <code>{"id":53,"method":"cancel_all_subscriptions","params":["cb"]}</code>
<b>Usage</b>: I've not yet looked into how this function works, but it seemingly appears to cancel subscriptions.

&nbsp;
<h1 style="text-align: center;">Tags</h1>
&nbsp;
<h2>get_trending_tags</h2>
<b>Call example</b>: <code>{"id":54,"method":"get_trending_tags","params":[["aftertag", "limit"]]}</code>
<b>Usage</b>: Displays a list of tags containing the first parameter (almost as if parent and "spin-off" tags).
<h2>get_discussions_by_trending</h2>
<b>Call example</b>: <code>{"id":55,"method":"get_discussions_by_trending","params":[{"tag":"tagnamehere", "limit":"10"}]}</code>
<b>Usage</b>: Displays a list of tags containing the first parameter (almost as if parent and "spin-off" tags).
<h2>get_discussions_by_created</h2>
<b>Call example</b>: <code>{"id":56,"method":"get_discussions_by_created","params":[{"tag":"tagnamehere","limit":"10"}]}</code>
<b>Usage</b>: Displays a list of post from the start of the tags containing the first parameter.
<h2>get_discussions_by_active</h2>
<b>Call example</b>: <code>{"id":57,"method":"get_discussions_by_active","params":[{"tag":"tagnamehere","limit":"10"}]}</code>
<b>Usage</b>: Displays a list of active posts from tag contained the first parameter.
<h2>get_discussions_by_cashout</h2>
<b>Call example</b>: <code>{"id":58,"method":"get_discussions_by_cashout","params":[{"tag":"tagnamehere","limit":"10"}]}</code>
<b>Usage</b>: Displays a list of posts with outstanding payouts from the tag contained the first parameter.
<h2>get_discussions_by_payout</h2>
<b>Call example</b>: <code>{"id":59,"method":"get_discussions_by_payout","params":[{"tag":"tagnamehere","limit":"10"}]}</code>
<b>Usage</b>: Couldn't seem to get this one to work properly, will look at it more closely soon.
<h2>get_discussions_by_votes</h2>
<b>Call example</b>: <code>{"id":60,"method":"get_discussions_by_votes","params":[{"tag":"tagnamehere","limit":"10"}]}</code>
<b>Usage</b>: Returns a list of posts sorted by votes from the tag contained the first parameter.
<h2>get_discussions_by_children</h2>
<b>Call example</b>: <code>{"id":61,"method":"get_discussions_by_children","params":[{"tag":"tagnamehere","limit":"10"}]}</code>
<b>Usage</b>: Calls forth a list of child posts from the tag contained the first parameter.
<h2>get_discussions_by_hot</h2>
<b>Call example</b>: <code>{"id":62,"method":"get_discussions_by_hot","params":[{"tag":"tagnamehere","limit":"10"}]}</code>
<b>Usage</b>: Conjures up a list of the hottest posts from the tag contained the first parameter.
<h2>get_discussions_by_total_pending_payout</h2>
<b>Call example</b>: <code>{"id":63,"method":"get_discussions_by_total_pending_payout","params":[{"tag":"tagnamehere","limit":"10"}]}</code>
<b>Usage</b>: I haven't checked out this one yet but I imagine it does something similar to its siblings above.

&nbsp;
<h1 style="text-align: center;">Keys</h1>
&nbsp;
<h2>get_key_references</h2>
<b>Call example</b>: <code>{"id":64,"method":"get_key_references","params":["key"]}</code>
<b>Usage</b>: Not had the chance to look into this yet.

<a href="http://steem.global/?page_id=122"><strong>
</strong></a>

<center><h1>This is a work in progress</h1></center>

I'd like to ask the community in aide in helping me explain the calls and functions I was unable to figure out in the comments section below. This information is being mirrored on my site [steem.global](http://steem.global)  STEEM Network News & Node and hopefully once I'm done filling in the gaps here and making a more comprehensive write-up as well as start the <code>cli_wallet</code> write up it will allow for enough documentation for coinpayments.net to want to have a whack at integrating our currency and token into their payment gateway platform allowing for EASY woocommerce integrations of SBD/ STEEM.

<h1>Thanks for reading. I hope you find this info useful!</h1>