create account

Ideas for the New Developers Portal by imwatsi

View this thread on: hive.blogpeakd.comecency.com
· @imwatsi ·
$0.15
Ideas for the New Developers Portal
In response to @whysteem's call for input on a [new Developers Portal for Steem](https://steemit.com/whysteem/@whysteem/updating-developer-portal-what-would-you-suggest), I have written this post to summarize a few suggestions.

Most of these ideas came from my initial experience from perusing the API documentation for the first time last week, when I was trying to find direct API methods to get specific data for a Python tool I am making, without using a library, like steem-python.

# Categorize or group the methods

It would be helpful to separate the methods some more. Separate those that are considered "stable" compared to the others, for example:

### Stable

- QUERIES (for retreiving data)
    - Blockchain: `get_account_count`, `get_active_witnesses`, `get_block`, `get_block_header`, `get_chain_properties`, `get_dynamic_global_properties`
    - Transactions: `broadcast_transaction_synchronous`, `broadcast_transaction_synchronous`, 
    - Account: `get_account_history`, `get_account_reputations`, `get_account_votes`, `get_blog`, `get_blog_authors`
    - Content: `get_active_votes`, `get_content`, `get_content_replies`
    - Market: `get_feed_history`, `get_market_history`, `get_market_history_buckets`, `get_order_book`
</br>
- ACTIONS (for performing actions)
    - Wallet: `transfer`, `transfer_to_vesting`, `withdraw_vesting`
    - Posting: `vote`, `comment`
    - Accont: `create_claimed_account`, `account_update`

### Beta

- ... put the methods that are in Beta here

### Deprecated (historical purposes)

You could also move deprecated methods to their own section, like an archive of sorts. Or exclude them altogether.

# Tag mechanism

I also suggest a tag mechanism to allow for dual listing in categories because some methods are useful for multiple categories, e.g. `get_reward_fund` can go under **Market** and **Blockchain**.

# More details on parameters

Adding more details to parameter definitions and the range of options will help too. `condenser_api.get_reward_fund` for example states `["post"]` as parameter, which leaves the reader wondering what it's used for and if other options can be used instead.

*That's all I have for now. I'll take this opportunity to go through as many methods as I can and test them out. I will share more suggestions as they come.*
👍  , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , and 200 others
properties (23)
authorimwatsi
permlinkideas-for-the-new-developers-portal
categorywhysteem
json_metadata{"tags":["whysteem","steem","developers","api","documentation"],"users":["whysteem"],"links":["https://steemit.com/whysteem/@whysteem/updating-developer-portal-what-would-you-suggest"],"app":"steemit/0.1","format":"markdown"}
created2019-05-12 18:28:54
last_update2019-05-12 18:28:54
depth0
children0
last_payout2019-05-19 18:28:54
cashout_time1969-12-31 23:59:59
total_payout_value0.136 HBD
curator_payout_value0.012 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length2,310
author_reputation131,386,362,730,495
root_title"Ideas for the New Developers Portal"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id84,734,377
net_rshares350,588,195,823
author_curate_reward""
vote details (264)