create account

Steemit Dev Portal: Document Plugin & API List by inertia

View this thread on: hive.blogpeakd.comecency.com
· @inertia ·
$15.15
Steemit Dev Portal: Document Plugin & API List
<div class="pull-right">
<img src="https://developers.steem.io/images/hero.png" />
</div>

#### Repository
https://github.com/steemit/devportal

#### Site
https://developers.steem.io/

### [Issue](https://github.com/steemit/devportal/issues/371)
- What was the issue(s)?
As a node operator and/or witness, I would like to know exactly which plugins are required by which API, so I can fine-tune my node's resource requirements.
- What was the solution?
Provide information about which APIs require which plugins, and which plugins get enabled automatically.

Once this PR is approved, the devportal site will have the following recipe:

```yaml
title: Plugin & API List
position: 1
description: Run a `steemd` node with your preferred APIs.
exclude: true
layout: full
```

*This is a list of the plugins, and their associated dependencies, required to enable specific apis.*

**When setting up the config file `steemd` will enable the `chain`, `p2p`, and `webserver` plugins regardless of other dependencies.**

## API's with their respective plugin dependencies

### `account_by_key_api`

* **Purpose:** Used to lookup account information based on a public key.
* **Requires:** `account_by_key`
* **Exposed Methods:** `account_by_key_api.*`

Example in `chain.ini`:

```ini
plugin = account_by_key
plugin = account_by_key_api
```

---

### `account_history_api`

* **Purpose:** Used to lookup account history information.
* **Requires:** `account_history` or `account_history_rocksdb`
* **Exposed Methods:** `account_history_api.*`

Note, while the `account_history_rocksdb` plugin is a more efficient, the current implementation does not provide support for `condenser_api.get_transaction`

Example in `chain.ini`:

```ini
plugin = account_history
plugin = account_history_api
```

... or ...

```ini
plugin = account_history_rocksdb
plugin = account_history_api
```

---

### `block_api`

* **Purpose:** Used to query values related to the block plugin.
* **Requires:** *No additional*
* **Exposed Methods:** `block_api.*`

Example in `chain.ini`:

```ini
plugin = block_api
```

---

### `condenser_api`

* **Purpose:** Intended to help ease the transition to AppBase.  It is recommended that apps transition away from this API.
* **Requires:** `database_api` (automatic)
* **Optional:**
  * `account_by_key`
  * `tags`
  * `follow`
  * `market_history`
  * `account_history`
* **Exposed Methods:** `condenser_api.*`

Example in `chain.ini`:

```ini
plugin = account_by_key tags follow market_history account_history
plugin = condenser_api
```

---

### `database_api`

* **Purpose:** Used to query information about accounts, transactions, and blockchain data.
* **Requires:** *No additional*
* **Exposed Methods:** `database_api.*`

Example in `chain.ini`:

```ini
plugin = database_api
```

---

### `debug_node_api`

* **Purpose:** Allows all sorts of creative "what-if" experiments with the chain.
* **Requires:** `debug_node`
* **Exposed Methods:** `debug_node_api.*`

Example in `chain.ini`:

```ini
plugin = debug_node
plugin = debug_node_api
```

---

### `follow_api`

* **Purpose:** Used to lookup information related to reputation and account follow operations.
* **Requires:** `follow` (automatic)
* **Exposed Methods:** `follow_api.*`

Example in `chain.ini`:

```ini
plugin = follow_api
```

---

### `market_history_api`

* **Purpose:** Used to lookup market history information. Can return the market and trade history of the internal STEEM:SBD market. The order book, recent trades and the market volume is made available through this plugin.
* **Requires:** `market_history` (automatic)
* **Exposed Methods:** `market_history_api.*`

Example in `chain.ini`:

```ini
plugin = market_history_api
```

---

### `network_broadcast_api`

* **Purpose:** Used to broadcast transactions and blocks.
* **Requires:** `rc` (automatic)
* **Exposed Methods:** `network_broadcast_api.*`

Example in `chain.ini`:

```ini
plugin = network_broadcast_api
```

---

### `rc_api`

* **Purpose:** Managing of resources - curation rewards, vesting shares, etc.
* **Requires:**
  * `rc` (automatic)
  * `database_api` (automatic)
* **Exposed Methods:** `rc_api.*`

Example in `chain.ini`:

```ini
plugin = rc_api
```

---

### `reputation_api`

* **Purpose:** Manage account reputation (relevant to voting on content).
* **Requires:** `reputation` (automatic)
* **Exposed Methods:** `reputation_api.*`

Example in `chain.ini`:

```ini
plugin = reputation_api
```

---

### `tags_api`

* **Purpose:** Used to lookup information about tags, posts, and discussions as well as votes.
* **Requires:** `tags` (automatic)
* **Exposed Methods:** `tags_api.*`

Example in `chain.ini`:

```ini
plugin = tags_api
```

---

### `transaction_status_api`

* **Purpose:** Evaluates a transaction status after calling `condenser_api.broadcast_transaction`
* **Requires:**
  * `transaction_status` (automatic)
  * `database_api` (automatic)
* **Exposed Methods:** `transaction_status_api.*`

Example in `chain.ini`:

```ini
plugin = transaction_status_api
```

---

### `witness_api` *(deprecated)*

* **Purpose:** The witness plugin contains all of the bandwidth logic (replaced by `rc`).  Can access the available bandwidth of an account and current reserve ratio.
* **Requires:** `rc` (automatic)
* **Exposed Methods:** `witness_api.*`

Example in `chain.ini`:

```ini
plugin = witness_api
```

#### Notes
Complete changes are detailed here:

https://github.com/steemit/devportal/pull/397/files

#### GitHub Account
https://github.com/inertia186
👍  , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , and 10 others
properties (23)
authorinertia
permlinksteemit-dev-portal-document-plugin-and-api-list
categoryutopian-io
json_metadata{"community":"steempeak","app":"steempeak","format":"markdown","tags":["utopian-io","tutorial","steem","devportal","api"],"links":["https://github.com/steemit/devportal","https://developers.steem.io/","https://github.com/steemit/devportal/issues/371","https://github.com/steemit/devportal/pull/397/files","https://github.com/inertia186"],"image":["https://developers.steem.io/images/hero.png"]}
created2018-12-11 20:24:42
last_update2018-12-11 20:24:42
depth0
children7
last_payout2018-12-18 20:24:42
cashout_time1969-12-31 23:59:59
total_payout_value11.287 HBD
curator_payout_value3.858 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length5,531
author_reputation346,568,901,399,561
root_title"Steemit Dev Portal: Document Plugin & API List"
beneficiaries
0.
accountsteempeak
weight500
1.
accountutopian.pay
weight500
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id76,702,829
net_rshares27,780,036,258,810
author_curate_reward""
vote details (74)
@mcfarhat ·
$7.90
Thank you for your contribution.
Although this documentation work is essential and thank you for that, yet in itself does not represent a tutorial, more so "documentation work".

The PR hasn't been merged yet so from a documentation perspective this cannot yet be labelled as such from a utopian review perspective.

You could have adjusted this to a tutorial by providing some real tutorial content in additional to the standard documentation, i.e. by showcasing detailed examples of how the user could utilize those functions in real examples, using any language of your choice.

I suggest you would take every few of those documentation elements, and compile a relevant tutorial which would definitely be helpful to the community as a whole, if you wish to do so.


---- 
Need help? Write a ticket on https://support.utopian.io/. 
Chat with us on [Discord](https://discord.gg/uTyJkNm). 
[[utopian-moderator]](https://join.utopian.io/)
👍  , , , , , , , ,
properties (23)
authormcfarhat
permlinkre-inertia-steemit-dev-portal-document-plugin-and-api-list-20181211t204525042z
categoryutopian-io
json_metadata{"tags":["utopian-io"],"links":["https://support.utopian.io/","https://discord.gg/uTyJkNm","https://join.utopian.io/"],"app":"steemit/0.1"}
created2018-12-11 20:45:27
last_update2018-12-11 20:45:27
depth1
children2
last_payout2018-12-18 20:45:27
cashout_time1969-12-31 23:59:59
total_payout_value5.942 HBD
curator_payout_value1.958 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length937
author_reputation150,651,671,367,256
root_title"Steemit Dev Portal: Document Plugin & API List"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id76,703,506
net_rshares13,157,732,176,789
author_curate_reward""
vote details (9)
@inertia ·
All good points.  I'm with you.  I may just be jumping the gun, including this before it's merged.  I debated using the #blog tag, as in, "here's what I've documented."

Unfortunately, I'm just not sure if there's any priority at Steemit, Inc. to merge stuff like this at the moment.
properties (22)
authorinertia
permlinkre-mcfarhat-re-inertia-steemit-dev-portal-document-plugin-and-api-list-20181211t211237758z
categoryutopian-io
json_metadata{"tags":["utopian-io","blog"],"app":"steemit/0.1"}
created2018-12-11 21:12:36
last_update2018-12-11 21:12:36
depth2
children0
last_payout2018-12-18 21:12:36
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length283
author_reputation346,568,901,399,561
root_title"Steemit Dev Portal: Document Plugin & API List"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id76,704,361
net_rshares0
@utopian-io ·
Thank you for your review, @mcfarhat! Keep up the good work!
properties (22)
authorutopian-io
permlinkre-re-inertia-steemit-dev-portal-document-plugin-and-api-list-20181211t204525042z-20181214t035021z
categoryutopian-io
json_metadata"{"app": "beem/0.20.9"}"
created2018-12-14 03:50:21
last_update2018-12-14 03:50:21
depth2
children0
last_payout2018-12-21 03:50:21
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length60
author_reputation152,955,367,999,756
root_title"Steemit Dev Portal: Document Plugin & API List"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id76,813,356
net_rshares0
@pennsif ·
This post has been included in today's  [**SOS Daily News**](https://steemit.com/steem/@pennsif/sosdailynewsallyouneedtoknowaboutthestateofsteem15december2018-77fz8p7w60) - a digest of all you need to know about the State of Steem.

***

* *Promoter of [**The SOS Forums : Weekly Discussion Forums on the State of Steem**](https://steemit.com/steem/@pennsif/lsyr505f).*

* *Co-ordinator of [**SteemClub-UK**](https://steemit.com/@steemclub-uk).*

* *Editor of the [**weekly listing of steem radio shows, podcasts & social broadcasts**](https://steemit.com/mspwaves/@pennsif/schedule-of-steem-radio-shows-podcasts-and-social-broadcasts-supported-by-dsound-week-beginning-10-december-2018).*

* *Founder of the [**A Dollar A Day**](https://steemit.com/adollaraday/@adollaraday/a-dollar-a-day-charitable-giving-project-over-usd600-donated-in-november-2018-monthly-summary-of-donations-received-and-given) charitable giving project.*

https://pennsif.com/wp-content/uploads/2018/08/adollaraday-linear-400x98.jpg

***
properties (22)
authorpennsif
permlinkre-inertia-steemit-dev-portal-document-plugin-and-api-list-20181216t075215996z
categoryutopian-io
json_metadata{"tags":["utopian-io"],"image":["https://pennsif.com/wp-content/uploads/2018/08/adollaraday-linear-400x98.jpg"],"links":["https://steemit.com/steem/@pennsif/sosdailynewsallyouneedtoknowaboutthestateofsteem15december2018-77fz8p7w60","https://steemit.com/steem/@pennsif/lsyr505f","https://steemit.com/@steemclub-uk","https://steemit.com/mspwaves/@pennsif/schedule-of-steem-radio-shows-podcasts-and-social-broadcasts-supported-by-dsound-week-beginning-10-december-2018","https://steemit.com/adollaraday/@adollaraday/a-dollar-a-day-charitable-giving-project-over-usd600-donated-in-november-2018-monthly-summary-of-donations-received-and-given"],"app":"steemit/0.1"}
created2018-12-16 07:52:15
last_update2018-12-16 07:52:15
depth1
children0
last_payout2018-12-23 07:52:15
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length1,012
author_reputation636,410,097,572,565
root_title"Steemit Dev Portal: Document Plugin & API List"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id76,910,020
net_rshares0
@steem-plus ·
SteemPlus upvote
Hi, @inertia!

You just got a **3.11%** upvote from SteemPlus!
To get higher upvotes, earn more SteemPlus Points (SPP). On your Steemit wallet, check your SPP balance and click on "How to earn SPP?" to find out all the ways to earn.
If you're not using SteemPlus yet, please check our last posts in [here](https://steemit.com/@steem-plus) to see the many ways in which SteemPlus can improve your Steem experience on Steemit and Busy.
properties (22)
authorsteem-plus
permlinksteemit-dev-portal-document-plugin-and-api-list---vote-steemplus
categoryutopian-io
json_metadata{}
created2018-12-12 18:39:45
last_update2018-12-12 18:39:45
depth1
children0
last_payout2018-12-19 18:39:45
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length434
author_reputation247,952,188,232,400
root_title"Steemit Dev Portal: Document Plugin & API List"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id76,749,212
net_rshares0
@steem-ua ·
#### Hi @inertia!

Your post was upvoted by @steem-ua, new Steem dApp, using UserAuthority for algorithmic post curation!
Your **UA** account score is currently 6.474 which ranks you at **#164** across all Steem accounts.
Your rank has improved 1 places in the last three days (old rank 165).

In our last Algorithmic Curation Round, consisting of 239 contributions, your post is ranked at **#15**.
##### Evaluation of your UA score:

* You've built up a nice network.
* The readers appreciate your great work!
* Good user engagement!


**Feel free to join our [@steem-ua Discord server](https://discord.gg/KpBNYGz)**
properties (22)
authorsteem-ua
permlinkre-steemit-dev-portal-document-plugin-and-api-list-20181212t064328z
categoryutopian-io
json_metadata"{"app": "beem/0.20.14"}"
created2018-12-12 06:43:30
last_update2018-12-12 06:43:30
depth1
children0
last_payout2018-12-19 06:43:30
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length617
author_reputation23,214,230,978,060
root_title"Steemit Dev Portal: Document Plugin & API List"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id76,722,769
net_rshares0
@steevebot ·
This post was upvoted by [SteeveBot](https://www.steeve.app/@steeveapp/steevebot-starts-rewarding-steeve-communitys-most-appreciated-content)!

SteeveBot regularly upvotes stories that are appreciated by the community around [Steeve](https://steeve.app/@steeveapp), an AI-powered Steem interface.
properties (22)
authorsteevebot
permlinkre-steemit-dev-portal-document-plugin-and-api-list-20181215t054539
categoryutopian-io
json_metadata""
created2018-12-15 05:45:39
last_update2018-12-15 05:45:39
depth1
children0
last_payout2018-12-22 05:45:39
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length296
author_reputation1,016,697,284,644
root_title"Steemit Dev Portal: Document Plugin & API List"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id76,862,293
net_rshares0