diff --git a/_apidefinitions/bridge.md b/_apidefinitions/bridge.md
index f554772ac2f73ffa0b4a253c5ec4a910e3156e82..81b70bdc7b8a8f1239389838c07a94d4772276f9 100644
--- a/_apidefinitions/bridge.md
+++ b/_apidefinitions/bridge.md
@@ -1,5 +1,5 @@
---
-position: 1
+position: 3
group: communities
exclude: true
canonical_url: .#apidefinitions-bridge
diff --git a/_apidefinitions/broadcast-ops-communities.md b/_apidefinitions/broadcast-ops-customs.md
similarity index 79%
rename from _apidefinitions/broadcast-ops-communities.md
rename to _apidefinitions/broadcast-ops-customs.md
index 63615ccfb4bff165436140e9fe2963d63625bcb5..ad937d59677f2c3a08ca811c0738ed8553563cbb 100644
--- a/_apidefinitions/broadcast-ops-communities.md
+++ b/_apidefinitions/broadcast-ops-customs.md
@@ -1,22 +1,22 @@
---
position: 100
exclude: true
-canonical_url: .#apidefinitions-broadcast-ops-communities
+canonical_url: .#apidefinitions-broadcast-ops-customs
---
Ops:
<ul>
-{% for sections in site.data.apidefinitions.broadcast_ops_communities %}
+{% for sections in site.data.apidefinitions.broadcast_ops_customs %}
{% assign sorted_ops = sections.ops | sort: 'name' %}
{% for op in sorted_ops %}
{% unless op.virtual %}
-<li class="button"><a href="#broadcast_ops_communities_{{ op.name | slug}}">{{op.name | split: '.' | last}}</a></li>
+<li class="button"><a href="#broadcast_ops_customs_{{ op.name | slug}}">{{op.name | split: '.' | last}}</a></li>
{% endunless %}
{% endfor %}
{% endfor %}
</ul>
-{% for sections in site.data.apidefinitions.broadcast_ops_communities %}
+{% for sections in site.data.apidefinitions.broadcast_ops_customs %}
{{ sections.description | liquify | markdownify }}
{% for op in sections.ops %}
<ul style="float: right; list-style: none;">
@@ -39,9 +39,9 @@ Ops:
{% assign search_url = '/search/?q=' | append: keywords | split: '_' | join: ' ' %}
<li class="info"><strong><small><a href="{{ search_url | relative_url }}">Related <i class="fas fa-search fa-xs"></i></a></small></strong></li>
</ul>
-<h4 id="broadcast_ops_communities_{{ op.name | slug }}">
+<h4 id="broadcast_ops_customs_{{ op.name | slug }}">
<code>{{op.name}}</code>
-<a href="#broadcast_ops_communities_{{ op.name | slug}}">
+<a href="#broadcast_ops_customs_{{ op.name | slug}}">
<i class="fas fa-link fa-xs"></i></a>
</h4>
{{ op.purpose | liquify | markdownify }}
diff --git a/_apidefinitions/condenser-api.md b/_apidefinitions/condenser-api.md
index 6a729a5b8e49a69255f3b441fbccb27187fa40d7..c83dceb15b0c48135fa7076fcfcc973837f0a501 100644
--- a/_apidefinitions/condenser-api.md
+++ b/_apidefinitions/condenser-api.md
@@ -1,5 +1,5 @@
---
-position: 0
+position: 4
exclude: true
canonical_url: .#apidefinitions-condenser-api
---
diff --git a/_apidefinitions/database-api.md b/_apidefinitions/database-api.md
index 07f7854376dd7d9e4381d857bd5064c402a3b0fa..db7800f13b736a3a234e5cb4cab1ce2eae63395a 100644
--- a/_apidefinitions/database-api.md
+++ b/_apidefinitions/database-api.md
@@ -1,5 +1,5 @@
---
-position: 4
+position: 5
exclude: true
canonical_url: .#apidefinitions-database-api
---
diff --git a/_data/apidefinitions/account_by_key_api.yml b/_data/apidefinitions/account_by_key_api.yml
index 3d4805ce68be87bdc9524fc5157912a0ae53a0ee..e45cfa02a5a9b7a71db127497d9f05db9371c398 100644
--- a/_data/apidefinitions/account_by_key_api.yml
+++ b/_data/apidefinitions/account_by_key_api.yml
@@ -18,6 +18,5 @@
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-key-references)'
- '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-key-references)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/operations/txaccountupdates)'
+ - '[hivexplorer](https://hivexplorer.com/api-docs?q=get_key_references)'
- '[hivesql](https://docs.hivesql.io/technical-informations/operations/txaccountupdates2)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/accounts)'
diff --git a/_data/apidefinitions/account_history_api.yml b/_data/apidefinitions/account_history_api.yml
index 3b40a9361289d03aa7551b89ea47a7b5c57c2c6b..12b981785bf9913bb07f1d5593961327870f3ebc 100644
--- a/_data/apidefinitions/account_history_api.yml
+++ b/_data/apidefinitions/account_history_api.yml
@@ -54,6 +54,7 @@
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-account-history)'
- '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-account-history)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
+ - '[hivexplorer](https://hivexplorer.com/api-docs?q=get_account_history)'
- api_method: account_history_api.get_ops_in_block
purpose: |
Returns all operations contained in a block. Parameter:
@@ -85,6 +86,7 @@
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-ops-in-block)'
- '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-ops-in-block)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
+ - '[hivexplorer](https://hivexplorer.com/api-docs?q=get_ops_in_block)'
- api_method: account_history_api.get_transaction
purpose: |
Returns the details of a transaction based on a transaction id (including their signatures, operations like also a block_num it was included to).
@@ -173,6 +175,7 @@
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-transaction)'
- '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-transaction)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
+ - '[hivexplorer](https://hivexplorer.com/api-docs?q=get_transaction)'
- '[hivesql](https://docs.hivesql.io/technical-informations/database-diagram#blocks-and-transactions)'
- api_method: account_history_api.enum_virtual_ops
since: HF24
@@ -230,7 +233,7 @@
* `escrow_approved_operation = 0x8000000000`
* `escrow_rejected_operation = 0x10000000000`
* `proxy_cleared_operation = 0x20000000000`
-
+
parameter_json: '{"block_range_begin":1,"block_range_end":2,"include_reversible":true,"group_by_block":false,"operation_begin":0,"limit":1000,"filter":1}'
expected_response_json: |
{
@@ -251,3 +254,4 @@
client_docs:
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
- '[hivesql](https://docs.hivesql.io/technical-informations/virtual-operations)'
+ - '[hivexplorer](https://hivexplorer.com/api-docs?q=enum_virtual_ops)'
diff --git a/_data/apidefinitions/block_api.yml b/_data/apidefinitions/block_api.yml
index 5d446d4bde0580675c21e5429da0e7de177ed14d..88acadab1699663e8c03bd5cbe17a4314eadf013 100644
--- a/_data/apidefinitions/block_api.yml
+++ b/_data/apidefinitions/block_api.yml
@@ -47,6 +47,7 @@
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-block)'
- '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-block)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/BlockApi)'
+ - '[hivexplorer](https://hivexplorer.com/api-docs?q=get_block)'
- api_method: block_api.get_block_header
purpose: |
Retrieve a block header of the referenced block, or null if no matching
@@ -83,6 +84,7 @@
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-block-header)'
- '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-block-header)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/BlockApi)'
+ - '[hivexplorer](https://hivexplorer.com/api-docs?q=get_block_header)'
- api_method: block_api.get_block_range
purpose: |
Retrieve a range of full, signed blocks. The list may be shorter than requested if `count` blocks would take you past the current head block.
@@ -105,3 +107,5 @@
- '{"jsonrpc":"2.0", "method":"block_api.get_block_range", "params":{"starting_block_num": 1, "count": 10}, "id":1}'
- '{"jsonrpc":"2.0", "method":"block_api.get_block_range", "params":{"starting_block_num": 8675309, "count": 50}, "id":1}'
- '{"jsonrpc":"2.0", "method":"block_api.get_block_range", "params":{"starting_block_num": 62396745, "count": 1000}, "id":1}'
+ client_docs:
+ - '[hivexplorer](https://hivexplorer.com/api-docs?q=get_block_range)'
diff --git a/_data/apidefinitions/bridge.yml b/_data/apidefinitions/bridge.yml
index b068a8b346f9676c3dee021a038a24605a0a2bd9..70b71368879e94bd04f7559d39a259174a97e0c7 100644
--- a/_data/apidefinitions/bridge.yml
+++ b/_data/apidefinitions/bridge.yml
@@ -65,6 +65,7 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.get_ranked_posts", "params":{"sort":"trending","tag":"","observer":"alice"}, "id":1}'
client_docs:
+ - '[hivexplorer](https://hivexplorer.com/api-docs?q=get_ranked_posts)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/tags)'
- api_method: bridge.account_notifications
purpose: |
@@ -102,12 +103,10 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.account_notifications", "params":{"account":"alice","limit":100}, "id":1}'
client_docs:
+ - '[hivexplorer](https://hivexplorer.com/api-docs?q=account_notifications)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_account_notifications)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/followers)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/mutes)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/mutesfollows)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/reblogs)'
- api_method: bridge.does_user_follow_any_lists
purpose: Checks if a given observer follows any blacklists or mute lists.
parameter_json: '{"observer":"alice"}'
@@ -116,12 +115,10 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.does_user_follow_any_lists", "params":{"observer":"alice"}, "id":1}'
client_docs:
+ - '[hivexplorer](https://hivexplorer.com/api-docs?q=does_user_follow_any_lists)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_does_user_follow_any_lists)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/blacklistsfollows)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/followers)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/mutes)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/mutesfollows)'
- api_method: bridge.get_account_posts
purpose: |
Lists posts related to a given account.
@@ -136,7 +133,7 @@
* `start_author`: author account name, if passed must be passed with `start_permlink` [optional]
* `start_permlink`: post permlink of given author, point to valid post, paging mechanism [optional]
* `limit`: if omitted the server will use the default value of 20 [optional]
- * `observer`: ignored for `blog`, feed and `replies`, otherwise when passed has to point to valid account used to fill blacklist stats and mark posts of authors blacklisted by observer, at this time ignored [optional]
+ * `observer`: ignored for `blog`, feed and `replies`, otherwise when passed has to point to valid account used to fill blacklist stats and mark posts of authors blacklisted by observer, at this time ignored [optional]
parameter_json: {"sort":"blog", "account": "alice", "limit": 1}
expected_response_json: |
[
@@ -197,10 +194,10 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.get_account_posts", "params":{"sort":"blog", "account": "alice", "limit": 1}, "id":1}'
client_docs:
+ - '[hivexplorer](https://hivexplorer.com/api-docs?q=get_account_posts)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_get_account_posts)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/reblogs)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/tags)'
- api_method: bridge.get_community_context
purpose: Gets the role, subscription status, and title for a given account in a given community.
parameter_json: {"name": "hive-111111", "account": "therealwolf"}
@@ -208,11 +205,10 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.get_community_context", "params":{"name": "hive-111111", "account": "therealwolf"}, "id":1}'
client_docs:
+ - '[hivexplorer](https://hivexplorer.com/api-docs?q=get_community_context)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_get_community_context)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/communities)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/communitiesroles)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/communitiessubscribers)'
- api_method: bridge.get_discussion
purpose: Gives a flattened discussion tree starting at given post.
parameter_json: {"author": "hiveio", "permlink": "around-the-hive-reflections", "observer": "alice"}
@@ -275,6 +271,7 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.get_discussion", "params":{"author": "hiveio", "permlink": "around-the-hive-reflections", "observer": "alice"}, "id":1}'
client_docs:
+ - '[hivexplorer](https://hivexplorer.com/api-docs?q=get_discussion)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_get_discussion)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/tags)'
@@ -293,12 +290,10 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.get_follow_list", "params":{"observer": "blocktrades", "follow_type": "follow_blacklist"}, "id":1}'
client_docs:
+ - '[hivexplorer](https://hivexplorer.com/api-docs?q=get_follow_list)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_get_follow_list)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/blacklistsfollows)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/followers)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/mutes)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/mutesfollows)'
- api_method: bridge.get_profile
purpose: |
Gets profile
@@ -339,6 +334,7 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.get_profile", "params":{"account": "alice", "observer": "bob"}, "id":1}'
client_docs:
+ - '[hivexplorer](https://hivexplorer.com/api-docs?q=get_profile)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_get_profile)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/accounts)'
@@ -380,6 +376,7 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.list_communities", "params":{"limit": 1, "query": "wall street bets"}, "id":1}'
client_docs:
+ - '[hivexplorer](https://hivexplorer.com/api-docs?q=list_communities)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_list_communities)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/communities)'
@@ -405,6 +402,7 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.list_pop_communities", "params":{"limit": 10}, "id":1}'
client_docs:
+ - '[hivexplorer](https://hivexplorer.com/api-docs?q=list_pop_communities)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_list_pop_communities)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- api_method: bridge.list_subscribers
@@ -431,6 +429,7 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.list_subscribers", "params":{"community": "hive-111111", "limit": 10}, "id":1}'
client_docs:
+ - '[hivexplorer](https://hivexplorer.com/api-docs?q=list_subscribers)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_list_subscribers)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/communitiessubscribers)'
@@ -450,6 +449,7 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.list_community_roles", "params":{"community":"hive-123456"}, "id":1}'
client_docs:
+ - '[hivexplorer](https://hivexplorer.com/api-docs?q=list_community_roles)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_list_community_roles)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/communitiesroles)'
@@ -467,6 +467,7 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.list_all_subscriptions", "params":{"account":"alice"}, "id":1}'
client_docs:
+ - '[hivexplorer](https://hivexplorer.com/api-docs?q=list_all_subscriptions)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_list_all_subscriptions)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/communitiessubscribers)'
@@ -477,7 +478,7 @@
* `name` - community category name
* `observer` - valid account [optional]
parameter_json: '{"name":"hive-123456","observer":"alice"}'
- expected_response_json:
+ expected_response_json:
{
"id": 1332149,
"name": "hive-123456",
@@ -508,11 +509,10 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.get_community", "params":{"name":"hive-123456","observer":"alice"}, "id":1}'
client_docs:
+ - '[hivexplorer](https://hivexplorer.com/api-docs?q=get_community)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_get_community)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/communities)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/communitiesroles)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/communitiessubscribers)'
- api_method: bridge.get_relationship_between_accounts
purpose: Tells what relations connect given accounts from the perspective of first account.
parameter_json: '["alice", "bob"]'
@@ -527,13 +527,10 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.get_relationship_between_accounts", "params":["alice", "bob"], "id":1}'
client_docs:
+ - '[hivexplorer](https://hivexplorer.com/api-docs?q=get_relationship_between_accounts)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_get_relationship_between_accounts)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/blacklists)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/blacklistsfollows)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/followers)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/mutes)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/mutesfollows)'
- api_method: bridge.get_payout_stats
purpose: |
Lists communities ordered by payout with stats (total payout, number of posts and authors).
@@ -558,6 +555,7 @@
- '{"jsonrpc":"2.0", "method":"bridge.get_payout_stats", "params":{"limit": 1}, "id":1}'
- '{"jsonrpc":"2.0", "method":"bridge.get_payout_stats", "params":{"limit": 250}, "id":1}'
client_docs:
+ - '[hivexplorer](https://hivexplorer.com/api-docs?q=get_payout_stats)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_get_payout_stats)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/comments)'
@@ -627,10 +625,10 @@
- '{"jsonrpc":"2.0", "method":"bridge.get_post", "params":{"author": "alice", "permlink": "that-march-hare", "observer": "bob"}, "id":1}'
- '{"jsonrpc":"2.0", "method":"bridge.get_post", "params":{"author": "hiveio", "permlink": "around-the-hive-reflections"}, "id":1}'
client_docs:
+ - '[hivexplorer](https://hivexplorer.com/api-docs?q=get_post)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_get_post)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/comments)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/tags)'
- api_method: bridge.get_post_header
purpose: |
Gives very basic information on given post.
@@ -649,6 +647,7 @@
- '{"jsonrpc":"2.0", "method":"bridge.get_post_header", "params":{"author": "alice", "permlink": "that-march-hare"}, "id":1}'
- '{"jsonrpc":"2.0", "method":"bridge.get_post_header", "params":{"author": "hiveio", "permlink": "around-the-hive-reflections"}, "id":1}'
client_docs:
+ - '[hivexplorer](https://hivexplorer.com/api-docs?q=get_post_header)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_post_header)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/comments)'
diff --git a/_data/apidefinitions/broadcast_ops.yml b/_data/apidefinitions/broadcast_ops.yml
index 68b86c08a0b4be17e8006add0100b77bde216294..e31d483a42646274ce3a5d6592369158181f4ea4 100644
--- a/_data/apidefinitions/broadcast_ops.yml
+++ b/_data/apidefinitions/broadcast_ops.yml
@@ -73,6 +73,7 @@
json_examples:
- '["vote", {"voter":"hiveio","author":"alice","permlink":"a-post-by-alice","weight":10000}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/00_vote.md)'
- '[hive-keychain](https://github.com/stoodkev/hive-keychain#requestvote)'
- '[hivesigner.js](https://github.com/ecency/hivesigner-sdk#vote)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#vote)'
@@ -165,6 +166,7 @@
json_examples:
- '["comment",{"parent_author":"","parent_permlink":"hiveio","author":"alice","permlink":"a-post-by-alice","title":"A Post By Alice","body":"This is my post.","json_metadata":"{\"tags\":[\"hiveio\",\"example\",\"tags\"]}"}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/01_comment.md)'
- '[hive-keychain](https://github.com/stoodkev/hive-keychain#requestpost)'
- '[hivesigner.js](https://github.com/ecency/hivesigner-sdk#comment)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#comment)'
@@ -193,6 +195,7 @@
json_examples:
- '["transfer",{"from":"hiveio","to":"alice","amount":{"amount":"10","precision":3,"nai":"@@000000021"},"memo":"Thanks for all the fish."}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/02_transfer.md)'
- '[hive-keychain](https://github.com/stoodkev/hive-keychain#requesttransfer)'
- '[hivesigner.js](https://github.com/ecency/hivesigner-sdk#transfer)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#transfer)'
@@ -222,6 +225,7 @@
json_examples:
- '["transfer_to_vesting",{"from":"alice","to":"","amount":{"amount":"357000","precision":3,"nai":"@@000000021"}}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/03_transfer_to_vesting.md)'
- '[hive-keychain](https://github.com/stoodkev/hive-keychain#requestpowerup)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#transfer-to-vesting)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
@@ -251,6 +255,7 @@
json_examples:
- '["withdraw_vesting",{"account":"hiveio","vesting_shares":{"amount":"200000000000","precision":6,"nai":"@@000000037"}}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/04_withdraw_vesting.md)'
- '[hive-keychain](https://github.com/stoodkev/hive-keychain#requestpowerdown)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#withdraw-vesting)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
@@ -274,6 +279,7 @@
json_examples:
- '["limit_order_create",{"owner":"hiveio","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"}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/05_limit_order_create.md)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#limit-order-create)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.limit_order_create)'
@@ -291,6 +297,7 @@
json_examples:
- '["limit_order_cancel",{"owner":"hiveio","orderid":10}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/06_limit_order_cancel.md)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#limit-order-cancel)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.limit_order_cancel)'
@@ -321,6 +328,7 @@
json_examples:
- '["feed_publish",{"publisher":"alice","exchange_rate":{"base":{"amount":"1000","precision":3,"nai":"@@000000013"},"quote":{"amount":"1000000","precision":3,"nai":"@@000000021"}}}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/07_feed_publish.md)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#feed-publish)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.feed_publish)'
@@ -342,6 +350,7 @@
json_examples:
- '["convert",{"owner":"hiveio","requestid":1467592156,"amount":{"amount":"5000","precision":3,"nai":"@@000000013"}}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/08_convert.md)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#convert)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.convert)'
@@ -365,72 +374,11 @@
json_examples:
- '["account_create",{"fee":{"amount":"0","precision":3,"nai":"@@000000021"},"creator":"hiveio","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":"{}"}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/09_account_create.md)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#account-create)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.account_create)'
- '[hivesql](https://docs.hivesql.io/technical-informations/operations/txaccountcreates)'
- - name: create_claimed_account
- since: HF20
- virtual: false
- purpose: |
- When used with `claim_account`, works identically to `account_create`. See: [0.20.2 Release Notes]({{ 'https://github.com/steemit/steem/releases/tag/v0.20.2' | archived_url }})
- roles:
- - active
- owner
- params:
- - creator
- new_account_name
- owner
- active
- posting
- memo_key
- json_metadata
- json_examples:
- - '["create_claimed_account",{"creator":"hiveio","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":"{}"}]'
- client_docs:
- - '[hive-keychain](https://github.com/stoodkev/hive-keychain#requestcreateclaimedaccount)'
- - '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- - '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.create_claimed_account)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/operations/txaccountcreates)'
- - name: claim_account
- since: HF20
- virtual: false
- purpose: |
- Requests from users or dApps to get an account creation ticket in order to create new accounts. These operations are issued before the actual creation of the account on the blockchain.
-
- See: [0.20.2 Release Notes]({{ 'https://github.com/steemit/steem/releases/tag/v0.20.2' | archived_url }})
- roles:
- - active
- owner
- params:
- - fee
- creator
- extensions
- json_examples:
- - '["claim_account",{"fee":{"amount":"0","precision":3,"nai":"@@000000021"},"creator":"hiveio","extensions":[]}]'
- client_docs:
- - '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- - '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.claim_account)'
- - name: witness_set_properties
- since: HF20
- virtual: false
- purpose: |
- 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]( https://gitlab.syncad.com/hive/hive/-/blob/master/doc/witness_parameters.md)
- roles:
- - block_signing
- active
- owner
- params:
- - owner
- props
- extensions
- json_examples:
- - '["witness_set_properties",{"owner":"alice", "props":{"account_creation_fee":"0.000 HIVE","account_subsidy_budget":10000,"account_subsidy_decay":330782,"maximum_block_size":65536,"hbd_interest_rate": "0.000 HIVE","hbd_exchange_rate":{"base": "0.000 HBD", "quote": "0.000 HIVE"}, "url": "68747470733A2F2F737465656D69742E636F6D", "new_signing_key": "25688bbe7b1204f26e40be054c8b2ff1997eec6d4e7be6a105aab8a0e6f11c616d7cb6066"}, "extensions": []}]'
- client_docs:
- - '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#witness-set-properties)'
- - '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- - '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.witness_set_properties)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/operations/txwitnesssetproperties)'
- name: account_update
virtual: false
purpose: |
@@ -448,73 +396,19 @@
json_examples:
- '["account_update",{"account":"hiveio","posting":{"weight_threshold":1,"account_auths":[],"key_auths":[["STM6FATHLohxTN8RWWkU9ZZwVywXo6MEDjHHui1jEBYkG2tTdvMYo",1],["STM76EQNV2RTA6yF9TnBvGSV71mW7eW36MM7XQp24JxdoArTfKA76",1]]},"memo_key":"STM6FATHLohxTN8RWWkU9ZZwVywXo6MEDjHHui1jEBYkG2tTdvMYo","json_metadata":""}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/10_account_update.md)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#account-update)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.account_update)'
- '[hivesql](https://docs.hivesql.io/technical-informations/operations/txaccountupdates)'
- - name: account_update2
- since: HF21
- virtual: false
- purpose: |
- This operation behaves identically to the existing
- `account_update_operation` except that it allows the posting authority
- to sign when the owner and active authorities and memo key are not
- present (i.e. only valid for posting and JSON metadata).
-
- See: [#3274]({{ 'https://github.com/steemit/steem/issues/3274' | archived_url }})
- roles:
- - posting
- active
- owner
- params:
- - account
- owner
- active
- posting
- memo_key
- json_metadata
- posting_json_metadata
- json_examples:
- - '["account_update",{"account":"hiveio","posting_json_metadata":""}]'
- client_docs:
- - '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#account-update2)'
- - '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- - '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.account_update2)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/operations/txaccountupdates2)'
- - name: report_over_production
- disabled: true
- purpose: |
- 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
- HIVE_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 HIVE.
-
- The result of the operation is to transfer the full VESTING HIVE balance
- of the block producer to the reporter.
- roles:
- - active
- owner
- params:
- - reporter
- first_block
- second_block
- client_docs:
- - '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#report-over-production)'
- - '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- name: witness_update
virtual: false
purpose: |
Users who wish to become a witness must apply for the position and allow voting to begin.
-
+
If the owner isn't a witness they will become 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:**
* `url` cannot be more than 2048 bytes.
* `url` must be UTF-8.
@@ -531,6 +425,7 @@
json_examples:
- '["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,"hbd_interest_rate":1000},"fee":{"amount":"0","precision":3,"nai":"@@000000021"}}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/11_witness_update.md)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#witness-update)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.witness_update)'
@@ -540,7 +435,7 @@
purpose: |
All accounts with a VFS (Vesting Fund Shares) can vote for or against
any witness, up to 30 witnesses. See: [`HIVE_MAX_ACCOUNT_WITNESS_VOTES`]({{ '/tutorials-recipes/understanding-configuration-values.html#HIVE_MAX_ACCOUNT_WITNESS_VOTES' | relative_url }})
-
+
If a proxy is specified then all existing votes are removed.
roles:
- active
@@ -552,6 +447,7 @@
json_examples:
- '["account_witness_vote",{"account":"alice","witness":"bob","approve":true}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/12_account_witness_vote.md)'
- '[hive-keychain](https://github.com/stoodkev/hive-keychain#requestwitnessvote)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#account-witness-vote)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
@@ -561,9 +457,9 @@
virtual: false
purpose: |
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 Hive DHF
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.
@@ -576,6 +472,7 @@
json_examples:
- '["account_witness_proxy",{"account":"alice","proxy":"bob"}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/13_account_witness_proxy.md)'
- '[hive-keychain](https://github.com/stoodkev/hive-keychain#requestproxy)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#account-witness-proxy)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
@@ -597,6 +494,7 @@
json_examples:
- '["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,"hbd_interest_rate":1000}}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/14_pow.md)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#pow)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hivesql](https://docs.hivesql.io/technical-informations/operations/txpows)'
@@ -605,7 +503,7 @@
purpose: |
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:
@@ -618,9 +516,22 @@
json_examples:
- '["custom",{"required_auths":["bytemaster"],"id":777,"data":"0a627974656d617374657207737465656d697402a3d13897d82114466ad87a74b73a53292d8331d1bd1d3082da6bfbcff19ed097029db013797711c88cccca3692407f9ff9b9ce7221aaa2d797f1692be2215d0a5f6d2a8cab6832050078bc5729201e3ea24ea9f7873e6dbdc65a6bd9899053b9acda876dc69f11a13df9ca8b26b6"}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/15_custom.md)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#custom)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.custom)'
+ - name: witness_block_approve
+ virtual: false
+ purpose: |
+ This is an operation for witnesses to approve the block quicker
+ roles:
+ - witness_signature
+ params:
+ - required_auths
+ witness
+ block_id
+ client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/16_witness_block_approve.md)'
- name: delete_comment
virtual: false
purpose: |
@@ -635,6 +546,7 @@
json_examples:
- '["delete_comment",{"author":"alice","permlink":"a-post-by-alice"}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/17_delete_comment.md)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#delete-comment)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.delete_comment)'
@@ -645,20 +557,20 @@
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
@@ -680,23 +592,21 @@
- '["custom_json",{"required_auths":[],"required_posting_auths":["bob"],"id":"reblog","json":"[\"reblog\", {\"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\"}]"}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/18_custom_json.md)'
- '[hive-keychain](https://github.com/stoodkev/hive-keychain#requestcustomjson)'
- '[hivesigner.js](https://github.com/ecency/hivesigner-sdk#custom-json)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#custom-json)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.custom_json)'
- '[hivesql](https://docs.hivesql.io/technical-informations/operations/txcustoms)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/followers)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/mutes)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/mutesfollows)'
- name: comment_options
virtual: false
purpose: |
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
@@ -705,9 +615,9 @@
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_hbd may be decreased, but never increased.
* Part of `comment_option` validation process, to be called when
@@ -741,6 +651,7 @@
- '["comment_options",{"author":"bob","permlink":"a-post-with-a-beneficiary","max_accepted_payout":{"amount":"1000000","precision":3,"nai":"@@000000013"},"percent_hbd":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_hbd":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}]}]]}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/19_comment_options.md)'
- '[hive-keychain](https://github.com/stoodkev/hive-keychain#requestpost)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#comment-options)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
@@ -754,7 +665,7 @@
balance rather than the withdrawing account. In addition, those funds
can be immediately vested again, circumventing the conversion from
vests to hive and back, guaranteeing they maintain their value.
-
+
**Notes:**
* Percent must be valid hive percent.
roles:
@@ -768,6 +679,7 @@
json_examples:
- '["set_withdraw_vesting_route",{"from_account":"alice","to_account":"bob","percent":10000,"auto_vest":true}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/20_set_withdraw_vesting_route.md)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#set-withdraw-vesting-route)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.set_withdraw_vesting_route)'
@@ -796,44 +708,54 @@
json_examples:
- '["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"}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/21_limit_order_create2.md)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#limit-order-create2)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hivesql](https://docs.hivesql.io/technical-informations/operations/txlimitorders)'
- - name: challenge_authority
- disabled: true
+ - name: claim_account
+ since: HF20
virtual: false
purpose: |
- Disabled in HF14.
- <p> </p>
- <p> </p>
- <p> </p>
+ Requests from users or dApps to get an account creation ticket in order to create new accounts. These operations are issued before the actual creation of the account on the blockchain.
+
+ See: [0.20.2 Release Notes]({{ 'https://github.com/steemit/steem/releases/tag/v0.20.2' | archived_url }})
roles:
- - posting
- active
+ - active
owner
params:
- - challenger
- challenged
- require_owner
+ - fee
+ creator
+ extensions
+ json_examples:
+ - '["claim_account",{"fee":{"amount":"0","precision":3,"nai":"@@000000021"},"creator":"hiveio","extensions":[]}]'
client_docs:
- - '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#challenge-authority)'
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/22_claim_account.md)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- - name: prove_authority
+ - '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.claim_account)'
+ - name: create_claimed_account
+ since: HF20
virtual: false
purpose: |
- <p> </p>
- <p> </p>
- <p> </p>
- <p> </p>
+ When used with `claim_account`, works identically to `account_create`. See: [0.20.2 Release Notes]({{ 'https://github.com/steemit/steem/releases/tag/v0.20.2' | archived_url }})
roles:
- active
owner
params:
- - challenged
- require_owner
+ - creator
+ new_account_name
+ owner
+ active
+ posting
+ memo_key
+ json_metadata
+ json_examples:
+ - '["create_claimed_account",{"creator":"hiveio","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":"{}"}]'
client_docs:
- - '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#prove-authority)'
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/23_create_claimed_account.md)'
+ - '[hive-keychain](https://github.com/stoodkev/hive-keychain#requestcreateclaimedaccount)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
+ - '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.create_claimed_account)'
+ - '[hivesql](https://docs.hivesql.io/technical-informations/operations/txaccountcreates)'
- name: request_account_recovery
since: HF11
virtual: false
@@ -844,28 +766,28 @@
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
@@ -873,7 +795,7 @@
* `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 a `recover_account`.
-
+
See: [#169]({{ 'https://github.com/steemit/steem/issues/169' | archived_url }})
roles:
- active
@@ -886,6 +808,7 @@
json_examples:
- '["request_account_recovery",{"recovery_account":"hiveio","account_to_recover":"alice","new_owner_authority":{"weight_threshold":1,"account_auths":[],"key_auths":[["STM6LYxj96zdypHYqgDdD6Nyh2NxerN3P1Mp3ddNm7gci63nfrSuZ",1]]},"extensions":[]}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/24_request_account_recovery.md)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#request-account-recovery)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.request_account_recovery)'
@@ -905,6 +828,7 @@
json_examples:
- '["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":[]}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/25_recover_account.md)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#recover-account)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.recover_account)'
@@ -920,7 +844,7 @@
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
@@ -929,7 +853,7 @@
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]({{ 'https://github.com/steemit/steem/issues/169' | archived_url }}), [PY: Account Recovery]({{ '/tutorials-python/account_recovery.html' | relative_url }})
roles:
- owner
@@ -940,6 +864,7 @@
json_examples:
- '["change_recovery_account",{"account_to_recover":"alice","new_recovery_account":"bob","extensions":[]}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/26_change_recovery_account.md)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#change-recovery-account)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.change_recovery_account)'
@@ -952,22 +877,22 @@
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.
-
+
See: [hive_operations.hpp:299](https://gitlab.syncad.com/hive/hive/-/blob/2074917f0735d9bdf22d33f5bdb089df3f6361b0/libraries/protocol/include/hive/protocol/hive_operations.hpp#L299-335)
roles:
- active
@@ -986,6 +911,7 @@
json_examples:
- '["escrow_transfer",{"from":"alice","to":"bob","hbd_amount":{"amount":"1000","precision":3,"nai":"@@000000013"},"hive_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"}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/27_escrow_transfer.md)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#escrow-transfer)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.escrow_transfer)'
@@ -997,7 +923,7 @@
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.
-
+
See: [hive_operations.hpp:299]( https://gitlab.syncad.com/hive/hive/-/blob/2074917f0735d9bdf22d33f5bdb089df3f6361b0/libraries/protocol/include/hive/protocol/hive_operations.hpp#L299-335)
roles:
- active
@@ -1011,6 +937,7 @@
json_examples:
- '["escrow_dispute",{"from":"alice","to":"bob","agent":"charlie","who":"alice","escrow_id":72526562}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/28_escrow_dispute.md)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#escrow-dispute)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.escrow_dispute)'
@@ -1021,7 +948,7 @@
purpose: |
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.
@@ -1029,9 +956,9 @@
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.
-
+
After the expiration, the receiver can use this operation to claim the funds. If the funds are not claimed by the receiver within 1 month of expiration then the sender can reclaim the funds.
-
+
See: [hive_operations.hpp:299]( https://gitlab.syncad.com/hive/hive/-/blob/2074917f0735d9bdf22d33f5bdb089df3f6361b0/libraries/protocol/include/hive/protocol/hive_operations.hpp#L299-335)
roles:
- active
@@ -1048,6 +975,7 @@
json_examples:
- '["escrow_release",{"from":"alice","to":"bob","agent":"charlie","who":"charlie","receiver":"bob","escrow_id":72526562,"hbd_amount":{"amount":"5000","precision":3,"nai":"@@000000013"},"hive_amount":{"amount":"0","precision":3,"nai":"@@000000021"}}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/29_escrow_release.md)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#escrow-release)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.escrow_release)'
@@ -1066,6 +994,7 @@
json_examples:
- '["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,"hbd_interest_rate":1000}}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/30_pow2.md)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#pow2)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hivesql](https://docs.hivesql.io/technical-informations/operations/txpows)'
@@ -1074,12 +1003,12 @@
virtual: false
purpose: |
After creating an escrow transaction, both the receiver or the agent can approve or disapprove the deal. If nobody approves or disapproves the transaction before the deadline date, the funds are returned to the sender.
-
+
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.
-
+
See: [hive_operations.hpp:299]( https://gitlab.syncad.com/hive/hive/-/blob/2074917f0735d9bdf22d33f5bdb089df3f6361b0/libraries/protocol/include/hive/protocol/hive_operations.hpp#L299-335)
roles:
- active
@@ -1094,6 +1023,7 @@
json_examples:
- '["escrow_approve",{"from":"alice","to":"bob","agent":"charlie","who":"charlie","escrow_id":59102208,"approve":true}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/31_escrow_approve.md)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#escrow-approve)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.escrow_approve)'
@@ -1109,7 +1039,7 @@
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.
-
+
See: [hive_operations.hpp:988]( https://gitlab.syncad.com/hive/hive/-/blob/2074917f0735d9bdf22d33f5bdb089df3f6361b0/libraries/protocol/include/hive/protocol/hive_operations.hpp#L988-996)
roles:
- active
@@ -1122,6 +1052,7 @@
json_examples:
- '["transfer_to_savings",{"from":"alice","to":"alice","amount":{"amount":"1000","precision":3,"nai":"@@000000013"},"memo":""}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/32_transfer_to_savings.md)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#transfer-to-savings)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.transfer_to_savings)'
@@ -1143,6 +1074,7 @@
json_examples:
- '["transfer_from_savings",{"from":"alice","request_id":101,"to":"alice","amount":{"amount":"1000","precision":3,"nai":"@@000000013"},"memo":""}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/33_transfer_from_savings.md)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#transfer-from-savings)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.transfer_from_savings)'
@@ -1161,35 +1093,11 @@
json_examples:
- '["cancel_transfer_from_savings",{"from":"alice","request_id":1}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/34_cancel_transfer_from_savings.md)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#cancel-transfer-from-savings)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.cancel_transfer_from_savings)'
- '[hivesql](https://docs.hivesql.io/technical-informations/operations/txtransfers)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/operations/txtransfers)'
- - name: custom_binary
- since: HF14
- virtual: false
- purpose: |
- 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.
-
- See: [hive_operations.hpp:604]( https://gitlab.syncad.com/hive/hive/-/blob/2074917f0735d9bdf22d33f5bdb089df3f6361b0/libraries/protocol/include/hive/protocol/hive_operations.hpp#L604-619)
- roles:
- - posting
- active
- owner
- params:
- - id
- data
- json_examples:
- - '["custom_binary",{"id": 0, "data": ""}]'
- client_docs:
- - '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#custom-binary)'
- - '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- - '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.custom_binary)'
- name: decline_voting_rights
since: HF14
virtual: false
@@ -1199,7 +1107,7 @@
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.
-
+
See: [hive_operations.hpp:1020]( https://gitlab.syncad.com/hive/hive/-/blob/2074917f0735d9bdf22d33f5bdb089df3f6361b0/libraries/protocol/include/hive/protocol/hive_operations.hpp#L1020-1027)
roles:
- owner
@@ -1209,49 +1117,10 @@
json_examples:
- '["decline_voting_rights",{"account":"judy","decline":true}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/36_decline_voting_rights.md)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.decline_voting_rights)'
- '[hivesql](https://docs.hivesql.io/technical-informations/operations/txdeclinevotingrights)'
- - name: reset_account
- disabled: true
- since: HF11
- virtual: false
- purpose: |
- This operation allows `recovery_account` to change `account_to_reset`'s
- owner authority to `new_owner_authority` after 60 days of inactivity.
-
- See: [#169]({{ 'https://github.com/steemit/steem/issues/169' | archived_url }})
- roles:
- - active
- owner
- params:
- - reset_account
- account_to_reset
- new_owner_authority
- json_examples:
- - '["reset_account",{}]'
- client_docs:
- - '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- - name: set_reset_account
- disabled: true
- since: HF11
- virtual: false
- purpose: |
- This operation allows `account` owner to control which account has the
- power to execute the `reset_account` operation after 60 days.
-
- See: [#169]({{ 'https://github.com/steemit/steem/issues/169' | archived_url }})
- roles:
- - owner
- posting
- params:
- - account
- current_reset_account
- reset_account
- json_examples:
- - '["set_reset_account",{}]'
- client_docs:
- - '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- name: claim_reward_balance
virtual: false
purpose: |
@@ -1268,6 +1137,7 @@
json_examples:
- '["claim_reward_balance",{"account":"alice","reward_hive":{"amount":"17","precision":3,"nai":"@@000000021"},"reward_hbd":{"amount":"11","precision":3,"nai":"@@000000013"},"reward_vests":{"amount":"185025103","precision":6,"nai":"@@000000037"}}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/39_claim_reward_balance.md)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#claim-reward-balance)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.claim_reward_balance)'
@@ -1281,10 +1151,10 @@
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 using them and voting on the same content twice.
-
+
Also see:
* [hive_evaluator.cpp:2309](https://gitlab.syncad.com/hive/hive/-/blob/4b19e00dd6a76699aa4de1c0d50aad392cd2d0b6/libraries/hive_evaluator.cpp#L2309)
roles:
@@ -1297,6 +1167,7 @@
json_examples:
- '["delegate_vesting_shares",{"delegator":"alice","delegatee":"bob","vesting_shares":{"amount":"94599167138276","precision":6,"nai":"@@000000037"}}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/40_delegate_vesting_shares.md)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#delegate-vesting-shares)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.delegate_vesting_shares)'
@@ -1320,7 +1191,7 @@
delegation. Witnesses should reduce their fee by 30x when the hardfork
goes live to preserve the same required fee for an all HIVE account
creation.*
-
+
Also see:
* [config.hpp:145]( https://gitlab.syncad.com/hive/hive/-/blob/65c58af34971416057e142ac1332421e2228749b/libraries/protocol/include/steem/protocol/config.hpp#L145)
* [hive_evaluator.cpp:400]( https://gitlab.syncad.com/hive/hive/-/blob/4b19e00dd6a76699aa4de1c0d50aad392cd2d0b6/libraries/hive_evaluator.cpp#L400)
@@ -1341,10 +1212,62 @@
json_examples:
- '["account_create_with_delegation",{"fee":{"amount":"3000","precision":3,"nai":"@@000000021"},"delegation":{"amount":"0","precision":6,"nai":"@@000000037"},"creator":"hiveio","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":[]}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/41_account_create_with_delegation.md)'
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#account-create-with-delegation)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.account_create_with_delegation)'
- '[hivesql](https://docs.hivesql.io/technical-informations/operations/txaccountcreates)'
+ - name: witness_set_properties
+ since: HF20
+ virtual: false
+ purpose: |
+ 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]( https://gitlab.syncad.com/hive/hive/-/blob/master/doc/witness_parameters.md)
+ roles:
+ - block_signing
+ active
+ owner
+ params:
+ - owner
+ props
+ extensions
+ json_examples:
+ - '["witness_set_properties",{"owner":"alice", "props":{"account_creation_fee":"0.000 HIVE","account_subsidy_budget":10000,"account_subsidy_decay":330782,"maximum_block_size":65536,"hbd_interest_rate": "0.000 HIVE","hbd_exchange_rate":{"base": "0.000 HBD", "quote": "0.000 HIVE"}, "url": "68747470733A2F2F737465656D69742E636F6D", "new_signing_key": "25688bbe7b1204f26e40be054c8b2ff1997eec6d4e7be6a105aab8a0e6f11c616d7cb6066"}, "extensions": []}]'
+ client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/42_witness_set_properties.md)'
+ - '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#witness-set-properties)'
+ - '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
+ - '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.witness_set_properties)'
+ - '[hivesql](https://docs.hivesql.io/technical-informations/operations/txwitnesssetproperties)'
+ - name: account_update2
+ since: HF21
+ virtual: false
+ purpose: |
+ This operation behaves identically to the existing
+ `account_update_operation` except that it allows the posting authority
+ to sign when the owner and active authorities and memo key are not
+ present (i.e. only valid for posting and JSON metadata).
+
+ See: [#3274]({{ 'https://github.com/steemit/steem/issues/3274' | archived_url }})
+ roles:
+ - posting
+ active
+ owner
+ params:
+ - account
+ owner
+ active
+ posting
+ memo_key
+ json_metadata
+ posting_json_metadata
+ json_examples:
+ - '["account_update",{"account":"hiveio","posting_json_metadata":""}]'
+ client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/43_account_update2.md)'
+ - '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#account-update2)'
+ - '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
+ - '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.account_update2)'
+ - '[hivesql](https://docs.hivesql.io/technical-informations/operations/txaccountupdates2)'
- name: create_proposal
since: HF21
deprecated: false
@@ -1366,9 +1289,34 @@
json_examples:
- '["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"}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/44_create_proposal.md)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.create_proposal)'
- '[hivesql](https://docs.hivesql.io/technical-informations/operations/txproposalcreates)'
+ - name: update_proposal_votes
+ since: HF21
+ deprecated: false
+ virtual: false
+ purpose: |
+ Update proposal votes by `proposal.id`.
+
+ Note, proposal votes are only summed at payment time (once per hour) and may not be reported immediately by related API.
+ roles:
+ - posting
+ active
+ owner
+ params:
+ - voter
+ proposal_ids
+ approve
+ json_examples:
+ - '["update_proposal_votes",{"voter":"alice","proposal_ids":[0],"approve":true}]'
+ client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/45_update_proposal_votes.md)'
+ - '[hive-keychain](https://github.com/stoodkev/hive-keychain#requestupdateproposalvote)'
+ - '[beem](https://beem.readthedocs.io/en/latest/beem.blockchaininstance.html?#beem.blockchaininstance.BlockChainInstance.update_proposal_votes)'
+ - '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.update_proposal_votes)'
+ - '[hivesql](https://docs.hivesql.io/technical-informations/operations/txproposalvoteupdates)'
- name: remove_proposal
since: HF21
deprecated: false
@@ -1385,6 +1333,7 @@
json_examples:
- '["remove_proposal",{"creator":"alice","proposal_ids":[0]}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/46_remove_proposal.md)'
- '[hive-keychain](https://github.com/stoodkev/hive-keychain#requestremoveproposal)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.remove_proposal)'
@@ -1408,32 +1357,89 @@
json_examples:
- '["update_proposal",{"proposal_id":0,"creator":"alice","daily_pay":{"amount":"3000","precision":3,"nai":"@@000000013"},"subject":"New Subject","permlink":"creator-proposal-permlink"}]'
client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/47_update_proposal.md)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.update_proposal)'
- '[hivesql](https://docs.hivesql.io/technical-informations/operations/txproposalupdates)'
- - name: update_proposal_votes
- since: HF21
+ - name: collateralized_convert
+ since: HF25
deprecated: false
virtual: false
purpose: |
- Update proposal votes by `proposal.id`.
+ The `collateralized_convert` operation is similar to `convert` operation (see: [convert]({{ '/apidefinitions/#broadcast_ops_convert' | relative_url }})), and instructs the blockchain to convert HIVE to HBD. The operation is performed after a 3.5 days delay, but the owner gets HBD immediately. The price risk is cushioned by extra HIVE. After actual conversion takes place the excess HIVE is returned to the owner.
+ roles:
+ params:
+ - owner
+ requestid
+ amount
+ json_examples:
+ - '["collateralized_convert", {"owner":"hiveio","requestid":1467592156,"amount":{"amount":"5000","precision":3,"nai":"@@000000021"}}]'
+ client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/48_collateralized_convert.md)'
+ - '[hive-js](https://gitlab.syncad.com/hive/hive-js/-/blob/master/doc/README.md#collateralized-convert)'
+ - '[hivesql](https://docs.hivesql.io/technical-informations/operations/txcollateralizedconverts-hf25)'
+ - name: recurrent_transfer
+ since: HF25
+ deprecated: false
+ virtual: false
+ purpose: |
+ The `recurrent_transfer` operation creates/updates/removes a recurrent transfer (transfers any liquid asset every fixed amount of time from one account to another). If amount is set to 0, the recurrent transfer is be deleted. If there is already a recurrent transfer matching from and to, the recurrent transfer is updated.
+
+ Also see: [database_api.find_recurrent_transfers]({{ '/apidefinitions/#database_api.find_recurrent_transfers' | relative_url }})
+ roles:
+ params:
+ - from
+ to
+ amount
+ memo
+ recurrence
+ executions
+ extensions
+ # json_examples:
+ # - '["recurrent_transfer", {}]'
+ client_docs:
+ - '[openApi](https://gitlab.syncad.com/hive/hive/-/blob/master/doc/devs/operations/49_recurrent_transfer.md)'
+ - '[hivesql](https://docs.hivesql.io/technical-informations/operations/txrecurrenttransfers-hf25)'
+ - name: prove_authority
+ virtual: false
+ purpose: |
+ <p> </p>
+ <p> </p>
+ <p> </p>
+ <p> </p>
+ roles:
+ - active
+ owner
+ params:
+ - challenged
+ require_owner
+ client_docs:
+ - '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#prove-authority)'
+ - '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
+ - name: custom_binary
+ since: HF14
+ virtual: false
+ purpose: |
+ 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.
- Note, proposal votes are only summed at payment time (once per hour) and may not be reported immediately by related API.
+ See: [hive_operations.hpp:604]( https://gitlab.syncad.com/hive/hive/-/blob/2074917f0735d9bdf22d33f5bdb089df3f6361b0/libraries/protocol/include/hive/protocol/hive_operations.hpp#L604-619)
roles:
- posting
active
owner
params:
- - voter
- proposal_ids
- approve
+ - id
+ data
json_examples:
- - '["update_proposal_votes",{"voter":"alice","proposal_ids":[0],"approve":true}]'
+ - '["custom_binary",{"id": 0, "data": ""}]'
client_docs:
- - '[hive-keychain](https://github.com/stoodkev/hive-keychain#requestupdateproposalvote)'
- - '[beem](https://beem.readthedocs.io/en/latest/beem.blockchaininstance.html?#beem.blockchaininstance.BlockChainInstance.update_proposal_votes)'
- - '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.update_proposal_votes)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/operations/txproposalvoteupdates)'
+ - '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#custom-binary)'
+ - '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
+ - '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.custom_binary)'
- name: claim_reward_balance2
since: Mysterious Future
virtual: false
@@ -1840,21 +1846,6 @@
- '["comment_reward", {"author": "karla95", "permlink": "blogging-challenge-13-pelicula-favorita", "payout": {"amount": "199", "precision": 3, "nai": "@@000000013"}, "author_rewards": 256, "total_payout_value": {"amount": "108", "precision": 3, "nai": "@@000000013"}, "curator_payout_value": {"amount": "90", "precision": 3, "nai": "@@000000013"}, "beneficiary_payout_value": {"amount": "0", "precision": 3, "nai": "@@000000013"}}]'
client_docs:
- '[hivesql](https://docs.hivesql.io/technical-informations/virtual-operations/vocommentrewards)'
- - name: liquidity_reward
- disabled: true
- virtual: true
- purpose: |
- Liquidity reward was a reward mechanism for the on-chain market designed to pay users who provide liquidity to the market. Deprecated as of HF12, see: [#178]({{ 'https://github.com/steemit/steem/issues/178' | archived_url }})).
- roles:
- - active
- owner
- params:
- - owner
- payout
- json_examples:
- - '["liquidity_reward", {"owner": "adm", "payout": {"amount": "1200000", "precision": 3, "nai": "@@000000021"}}]'
- client_docs:
- - '[hivesql](https://docs.hivesql.io/technical-informations/virtual-operations/voliquidityrewards)'
- name: interest
virtual: true
purpose: |
@@ -2330,40 +2321,3 @@
# - '["fill_recurrent_transfer", {}]'
client_docs:
- '[hivesql](https://docs.hivesql.io/technical-informations/virtual-operations/vofillrecurrenttransfers-hf25)'
- - name: collateralized_convert
- since: HF25
- deprecated: false
- virtual: false
- purpose: |
- The `collateralized_convert` operation is similar to `convert` operation (see: [convert]({{ '/apidefinitions/#broadcast_ops_convert' | relative_url }})), and instructs the blockchain to convert HIVE to HBD. The operation is performed after a 3.5 days delay, but the owner gets HBD immediately. The price risk is cushioned by extra HIVE. After actual conversion takes place the excess HIVE is returned to the owner.
- roles:
- params:
- - owner
- requestid
- amount
- json_examples:
- - '["collateralized_convert", {"owner":"hiveio","requestid":1467592156,"amount":{"amount":"5000","precision":3,"nai":"@@000000021"}}]'
- client_docs:
- - '[hive-js](https://gitlab.syncad.com/hive/hive-js/-/blob/master/doc/README.md#collateralized-convert)'
- - '[hivesql](https://docs.hivesql.io/technical-informations/operations/txcollateralizedconverts-hf25)'
- - name: recurrent_transfer
- since: HF25
- deprecated: false
- virtual: false
- purpose: |
- The `recurrent_transfer` operation creates/updates/removes a recurrent transfer (transfers any liquid asset every fixed amount of time from one account to another). If amount is set to 0, the recurrent transfer is be deleted. If there is already a recurrent transfer matching from and to, the recurrent transfer is updated.
-
- Also see: [database_api.find_recurrent_transfers]({{ '/apidefinitions/#database_api.find_recurrent_transfers' | relative_url }})
- roles:
- params:
- - from
- to
- amount
- memo
- recurrence
- executions
- extensions
- # json_examples:
- # - '["recurrent_transfer", {}]'
- client_docs:
- - '[hivesql](https://docs.hivesql.io/technical-informations/operations/txrecurrenttransfers-hf25)'
diff --git a/_data/apidefinitions/broadcast_ops_communities.yml b/_data/apidefinitions/broadcast_ops_customs.yml
similarity index 99%
rename from _data/apidefinitions/broadcast_ops_communities.yml
rename to _data/apidefinitions/broadcast_ops_customs.yml
index 843ada6f3232ad354d268a692937d89538db1dbc..af2f700d5d64805874c4c06dfbbabfd5e0b2f434 100644
--- a/_data/apidefinitions/broadcast_ops_communities.yml
+++ b/_data/apidefinitions/broadcast_ops_customs.yml
@@ -1,4 +1,4 @@
-- name: broadcast_ops_communities
+- name: broadcast_ops_custom
group: communities
description: |
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`.
diff --git a/_data/apidefinitions/condenser_api.yml b/_data/apidefinitions/condenser_api.yml
index 2592caf54d58e0fc9f746cea38c6c95c3972b166..9913fe13e1ad337768dced9a352ccd08d3f8a9fd 100644
--- a/_data/apidefinitions/condenser_api.yml
+++ b/_data/apidefinitions/condenser_api.yml
@@ -19,32 +19,6 @@
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.
methods:
- - api_method: condenser_api.broadcast_block
- removed: true
- purpose: |
- **Removed: HF26**
-
- Used to broadcast a block.
-
- Also see: [network_broadcast_api.broadcast_block]({{ '/apidefinitions/#network_broadcast_api.broadcast_block' | relative_url }})
- parameter_json:
- - previous: '0000000000000000000000000000000000000000'
- timestamp: '1970-01-01T00:00:00'
- witness: ''
- transaction_merkle_root: '0000000000000000000000000000000000000000'
- extensions: []
- witness_signature: '0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'
- transactions: []
- expected_response_json: {}
- curl_examples:
- - '{"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}'
- expected_curl_responses:
- - attempting to push a block that is too old
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#broadcast-block)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#broadcast-block)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.broadcast_transaction
purpose: |
Used to broadcast a transaction.
@@ -85,52 +59,19 @@
trx_num: 0
expired: false
curl_examples:
- - '{"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":"hiveio","author":"alice","permlink":"a-post-by-alice","weight":10000}]],"extensions":[],"signatures":[]}],
- "id":1}'
- - '{"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":{"amount":"10000","precision":3,"nai":"@@000000021"},"maximum_block_size":131072,"hbd_interest_rate":1000}}]],"extensions":[],"signatures":[]}],
- "id":1}'
+ - '{"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":"hiveio","author":"alice","permlink":"a-post-by-alice","weight":10000}]],"extensions":[],"signatures":[]}],
+ "id":1}'
+ - '{"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":{"amount":"10000","precision":3,"nai":"@@000000021"},"maximum_block_size":131072,"hbd_interest_rate":1000}}]],"extensions":[],"signatures":[]}],
+ "id":1}'
expected_curl_responses:
- - missing required posting authority
- - transaction tapos exception
+ - missing required posting authority
+ - transaction tapos exception
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#broadcast-api)"
- - "[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/TransactionBuilder)"
- - api_method: condenser_api.get_account_bandwidth
- removed: true
- purpose: |
- **Disabled since 0.20.6, see: [#3029]({{ 'https://github.com/steemit/steem/issues/3029' | archived_url }}#issuecomment-428404844); Removed: HF24**
-
- Returns the available bandwidth of an account. Parameters: `account:string`; `type:string`, e.g.: `forum` or `market`
-
- | `account` (string) | `type` (string) | |
- |--------------------|-----------------|-|
- | `"hiveio"` | `"forum"` | Query the available forum bandwidth for the account named "hiveio". |
- | `"alice"` | `"market"` | Query the available market bandwidth for the account named "alice". |
-
- See: [Forum/Market Bandwidth]({{ '/tutorials-recipes/forum-market-bandwidth.html' | relative_url }})
- parameter_json: ["", ""]
- expected_response_json:
- id: 8
- account: hiveio
- type: forum
- average_bandwidth: 214996934
- lifetime_bandwidth: '48395000000'
- last_bandwidth_update: '2018-02-16T03:11:00'
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_account_bandwidth", "params":["hiveio","forum"],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_account_bandwidth", "params":["alice","market"],
- "id":1}'
- expected_curl_responses:
- - Could not find method get_account_bandwidth
- - Could not find method get_account_bandwidth
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#api-call)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-account-bandwidth)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#broadcast-api)"
+ - "[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/TransactionBuilder)"
- api_method: condenser_api.get_account_count
purpose: Returns the number of accounts.
parameter_json: []
@@ -138,6 +79,8 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"condenser_api.get_account_count", "params":[],
"id":1}'
+ client_docs:
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_account_count)"
- api_method: condenser_api.get_account_history
purpose: |
Returns a history of all operations for a given account. Parameters:
@@ -162,9 +105,9 @@
Also see: [account_history_api.get_account_history]({{ '/apidefinitions/#account_history_api.get_account_history' | relative_url }}), [Paginated API Methods]({{ '/tutorials-recipes/paginated-api-methods.html#condenser_apiget_account_history' | relative_url }})
parameter_json:
- - ''
- - 0
- - 1000
+ - ''
+ - 0
+ - 1000
expected_response_json: |
[99, {
"trx_id": "0000000000000000000000000000000000000000",
@@ -176,23 +119,22 @@
"op": {}
}]
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_account_history", "params":["hiveio",
- 1000, 1000], "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_account_history", "params":["hiveio",
- -1, 1000], "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_account_history", "params":["bob",
- -1, 1000, 1], "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_account_history", "params":["charlie",
- -1, 1000, 262144], "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_account_history", "params":["emma",
- -1, 1000, 0, 1], "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-account-history)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-account-history)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/followers)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/mutes)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/mutesfollows)"
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_account_history", "params":["hiveio",
+ 1000, 1000], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_account_history", "params":["hiveio",
+ -1, 1000], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_account_history", "params":["bob",
+ -1, 1000, 1], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_account_history", "params":["charlie",
+ -1, 1000, 262144], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_account_history", "params":["emma",
+ -1, 1000, 0, 1], "id":1}'
+ client_docs:
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_account_history)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-account-history)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-account-history)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/followers)"
- api_method: condenser_api.get_account_reputations
since: HF13
purpose: |
@@ -205,28 +147,19 @@
Also see: [follow_api.get_account_reputations]({{ '/apidefinitions/#follow_api.get_account_reputations' | relative_url }})
parameter_json:
- - ''
- - 1000
+ - ''
+ - 1000
expected_response_json: []
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_account_reputations", "params":["hiveio",
- 1], "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_account_reputations", "params":["a",
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_account_reputations", "params":["hiveio",
+ 1], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_account_reputations", "params":["a",
10], "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-account-reputations)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-account-reputations)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - api_method: condenser_api.get_account_votes
- disabled: true
- purpose: |
- No longer supported. Use: [database_api.list_votes]({{ '/apidefinitions/#database_api.list_votes' | relative_url }})
-
- <p> </p><p> </p><p> </p><p> </p><p> </p>
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-account-votes)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-account-votes)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_account_reputations)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-account-reputations)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-account-reputations)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_accounts
purpose: |
Returns accounts, queried by name. Parameters: `account:string array`; `delayed_votes_active:boolean`
@@ -238,7 +171,7 @@
Also see: [database_api.find_accounts]({{ '/apidefinitions/#database_api.find_accounts' | relative_url }})
parameter_json:
- - - ''
+ - - ''
expected_response_json: |
{
"id": 1370484,
@@ -364,13 +297,14 @@
"guest_bloggers": []
}
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_accounts", "params":[["hiveio"]], "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_accounts", "params":[["hiveio", "alice"], true], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_accounts", "params":[["hiveio"]], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_accounts", "params":[["hiveio", "alice"], true], "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-accounts)"
- - "[beem](https://beem.readthedocs.io/en/latest/beem.blockchain.html#beem.blockchain.Blockchain.get_all_accounts)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/accounts)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_accounts)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-accounts)"
+ - "[beem](https://beem.readthedocs.io/en/latest/beem.blockchain.html#beem.blockchain.Blockchain.get_all_accounts)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/accounts)"
- api_method: condenser_api.get_active_votes
purpose: |
Returns all votes for the given post. Parameters: `author:string`; `permlink:string`
@@ -380,27 +314,28 @@
| `"hiveio"` | `"firstpost"` | Queries votes for content with a slug `@hiveio/firstpost` |
| `"alice"` | `"a-post-by-alice"` | Queries votes for content with a slug `@alice/a-post-by-alice` |
parameter_json:
- - ''
- - ''
+ - ''
+ - ''
expected_response_json:
- - voter: ''
- weight: ''
- rshares: 0
- percent: 0
- reputation: ''
- time: '1970-01-01T00:00:00'
+ - voter: ''
+ weight: ''
+ rshares: 0
+ percent: 0
+ reputation: ''
+ time: '1970-01-01T00:00:00'
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_active_votes", "params":["hiveio",
- "firstpost"], "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_active_votes", "params":["alice",
- "a-post-by-alice"], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_active_votes", "params":["hiveio",
+ "firstpost"], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_active_votes", "params":["alice",
+ "a-post-by-alice"], "id":1}'
expected_curl_responses:
- - Invalid parameters
- - Invalid parameters
+ - Invalid parameters
+ - Invalid parameters
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-active-votes)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-active-votes)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_active_votes)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-active-votes)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-active-votes)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_active_witnesses
purpose: |
Returns the list of active witnesses.
@@ -409,13 +344,14 @@
parameter_json: []
expected_response_json: []
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_active_witnesses", "params":[],
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_active_witnesses", "params":[],
"id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-active-witnesses)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-active-witnesses)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/witnesses)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_active_witnesses)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-active-witnesses)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-active-witnesses)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/witnesses)"
- api_method: condenser_api.get_block
purpose: |
Returns a block. Parameters: `block_num:int`
@@ -441,14 +377,15 @@
signing_key: STM8GC13uCZbP44HzMLV6zPZGwVQ8Nt4Kji8PapsPiNq1BK153XTX
transaction_ids: []
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_block", "params":[1], "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_block", "params":[8675309], "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_block", "params":[62396745],
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_block", "params":[1], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_block", "params":[8675309], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_block", "params":[62396745],
"id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-block)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-block)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_block)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-block)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-block)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_block_header
purpose: |
Returns a block header. Parameters: `block_num:int`
@@ -461,7 +398,7 @@
Also see: [block_api.get_block_header]({{ '/apidefinitions/#block_api.get_block_header' | relative_url }})
parameter_json:
- - 1
+ - 1
expected_response_json:
previous: '0000000000000000000000000000000000000000'
timestamp: '2016-03-24T16:05:00'
@@ -469,16 +406,17 @@
transaction_merkle_root: '0000000000000000000000000000000000000000'
extensions: []
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_block_header", "params":[1],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_block_header", "params":[8675309],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_block_header", "params":[62396745],
- "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-block-header)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-block-header)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_block_header", "params":[1],
+ "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_block_header", "params":[8675309],
+ "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_block_header", "params":[62396745],
+ "id":1}'
+ client_docs:
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_block_header)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-block-header)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-block-header)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_blog
purpose: |
Returns the list of blog entries for an account. Parameters: `account:string`; `start_entry_id:int`; `limit:int` up to 500
@@ -490,69 +428,70 @@
Also see: [Paginated API Methods]({{ '/tutorials-recipes/paginated-api-methods.html#condenser_apiget_blog' | relative_url }})
parameter_json:
- - hiveio
- - 0
- - 1
+ - hiveio
+ - 0
+ - 1
expected_response_json:
- - comment:
- id: 0
- author: hiveio
- permlink: firstpost
- category: meta
- parent_author: ''
- parent_permlink: meta
- title: Welcome to Hive!
- body: Hive is a social media platform where anyone can earn HIVE points by
- posting. The more people who like a post, the more HIVE the poster earns.
- Anyone can sell their HIVE 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: hiveio
- root_permlink: firstpost
- max_accepted_payout:
- amount: '1000000000'
- pecision: 3
- nai: "@@000000013"
- percent_hbd: 10000
- allow_replies: true
- allow_votes: true
- allow_curation_rewards: true
- beneficiaries: []
- blog: hiveio
- reblog_on: '1970-01-01T00:00:00'
- entry_id: 0
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_blog", "params":["hiveio",0,1],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_blog", "params":["alice",0,50],
- "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-blog)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-blog)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - comment:
+ id: 0
+ author: hiveio
+ permlink: firstpost
+ category: meta
+ parent_author: ''
+ parent_permlink: meta
+ title: Welcome to Hive!
+ body: Hive is a social media platform where anyone can earn HIVE points by
+ posting. The more people who like a post, the more HIVE the poster earns.
+ Anyone can sell their HIVE 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: hiveio
+ root_permlink: firstpost
+ max_accepted_payout:
+ amount: '1000000000'
+ pecision: 3
+ nai: "@@000000013"
+ percent_hbd: 10000
+ allow_replies: true
+ allow_votes: true
+ allow_curation_rewards: true
+ beneficiaries: []
+ blog: hiveio
+ reblog_on: '1970-01-01T00:00:00'
+ entry_id: 0
+ curl_examples:
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_blog", "params":["hiveio",0,1],
+ "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_blog", "params":["alice",0,50],
+ "id":1}'
+ client_docs:
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_blog)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-blog)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-blog)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_blog_authors
purpose: |
Returns a list of authors that have had their content reblogged on a given blog account. Parameters: `account:string`
@@ -562,19 +501,19 @@
| `"hiveio"` | Queries for account named "hiveio". |
| `"alice"` | Queries for accounts named alice". |
parameter_json:
- - ''
+ - ''
expected_response_json:
- - author: ''
- count: 0
+ - author: ''
+ count: 0
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_blog_authors", "params":["hiveio"],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_blog_authors", "params":["alice"],
- "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_blog_authors", "params":["hiveio"],
+ "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_blog_authors", "params":["alice"],
+ "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-blog-authors)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-blog-authors)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-blog-authors)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-blog-authors)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_blog_entries
purpose: |
Returns a list of blog entries for an account. Parameters: `account:string`; `start_entry_id:int`; `limit:int` up to 500
@@ -586,24 +525,25 @@
Also see: [Paginated API Methods]({{ '/tutorials-recipes/paginated-api-methods.html#condenser_apiget_blog_entries' | relative_url }})
parameter_json:
- - hiveio
- - 0
- - 1
+ - hiveio
+ - 0
+ - 1
expected_response_json:
- - author: hiveio
- permlink: firstpost
- blog: hiveio
- reblog_on: '1970-01-01T00:00:00'
- entry_id: 0
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_blog_entries", "params":["hiveio",0,1],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_blog_entries", "params":["alice",0,50],
- "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-blog-entries)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-blog-entries)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - author: hiveio
+ permlink: firstpost
+ blog: hiveio
+ reblog_on: '1970-01-01T00:00:00'
+ entry_id: 0
+ curl_examples:
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_blog_entries", "params":["hiveio",0,1],
+ "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_blog_entries", "params":["alice",0,50],
+ "id":1}'
+ client_docs:
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_blog_entries)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-blog-entries)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-blog-entries)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_chain_properties
purpose: Returns the chain properties.
parameter_json: []
@@ -613,12 +553,13 @@
hbd_interest_rate: 1000
account_subsidy_limit: 0
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_chain_properties", "params":[],
- "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_chain_properties", "params":[],
+ "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-chain-properties)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-chain-properties)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_chain_properties)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-chain-properties)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-chain-properties)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_comment_discussions_by_payout
since: HF17
purpose: |
@@ -634,15 +575,16 @@
truncate_body: 0
expected_response_json: []
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_comment_discussions_by_payout",
- "params":[{"tag":"hive","limit":1}], "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_comment_discussions_by_payout",
- "params":[{"tag":"photography","limit":10,"truncate_body":0}], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_comment_discussions_by_payout",
+ "params":[{"tag":"hive","limit":1}], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_comment_discussions_by_payout",
+ "params":[{"tag":"photography","limit":10,"truncate_body":0}], "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-comment-discussions-by-payout)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-comment-discussions-by-payout)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/tags)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_comment_discussions_by_payout)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-comment-discussions-by-payout)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-comment-discussions-by-payout)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/tags)"
- api_method: condenser_api.get_config
purpose: |
Returns information about compile-time constants. See: [Understanding
@@ -652,11 +594,12 @@
parameter_json: []
expected_response_json: {}
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_config", "params":[], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_config", "params":[], "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-config)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-config)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_config)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-config)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-config)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_content
purpose: |
Returns the content (post or comment). Parameters: `author:string`; `permlink:string`
@@ -666,8 +609,8 @@
| `"hiveio"` | `"firstpost"` | Queries content with a slug `@hiveio/firstpost` |
| `"alice"` | `"a-post-by-alice"` | Queries content with a slug `@alice/a-post-by-alice` |
parameter_json:
- - ''
- - ''
+ - ''
+ - ''
expected_response_json:
id: 0
author: ''
@@ -715,18 +658,19 @@
body_length: 0
reblogged_by: []
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_content", "params":["hiveio",
- "firstpost"], "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_content", "params":["alice",
- "a-post-by-alice"], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_content", "params":["hiveio",
+ "firstpost"], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_content", "params":["alice",
+ "a-post-by-alice"], "id":1}'
expected_curl_responses:
- - Invalid parameters
- - Invalid parameters
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-content)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-content)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/comments)"
+ - Invalid parameters
+ - Invalid parameters
+ client_docs:
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_content)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-content)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-content)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/comments)"
- api_method: condenser_api.get_content_replies
purpose: |
Returns a list of replies. Parameters: `author:string`; `permlink:string`
@@ -739,8 +683,8 @@
Also see: [tags_api.get_content_replies]({{ '/apidefinitions/#tags_api.get_content_replies' | relative_url }})
parameter_json:
- - ''
- - ''
+ - ''
+ - ''
expected_response_json:
id: 0
author: ''
@@ -788,17 +732,18 @@
body_length: 0
reblogged_by: []
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_content_replies", "params":["hiveio",
- "firstpost"], "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_content_replies", "params":["alice",
- "a-post-by-alice"], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_content_replies", "params":["hiveio",
+ "firstpost"], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_content_replies", "params":["alice",
+ "a-post-by-alice"], "id":1}'
expected_curl_responses:
- - Invalid parameters
- - Invalid parameters
+ - Invalid parameters
+ - Invalid parameters
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-content-replies)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-content-replies)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_content_replies)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-content-replies)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-content-replies)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_conversion_requests
purpose: |
Returns a list of conversion request. Parameters: `id:integer`
@@ -809,17 +754,18 @@
Also see: [database_api.list_hbd_conversion_requests]({{ '/apidefinitions/#database_api.list_hbd_conversion_requests' | relative_url }})
parameter_json:
- - 0
+ - 0
expected_response_json: []
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_conversion_requests", "params":[1234],
- "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_conversion_requests", "params":[1234],
+ "id":1}'
expected_curl_responses:
- - Given account does not exist
+ - Given account does not exist
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-conversion-requests)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-conversion-requests)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_conversion_requests)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-conversion-requests)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-conversion-requests)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_current_median_history_price
purpose:
parameter_json: []
@@ -827,271 +773,35 @@
base: 0.000 HIVE
quote: 0.000 HIVE
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_current_median_history_price",
- "params":[], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_current_median_history_price",
+ "params":[], "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-current-median-history-price)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-current-median-history-price)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - api_method: condenser_api.get_discussions_by_active
- purpose: Returns a list of discussions based on active.
- parameter_json:
- - tag: ''
- limit: 0
- filter_tags: []
- select_authors: []
- select_tags: []
- truncate_body: 0
- expected_response_json: []
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_active", "params":[{"tag":"hive","limit":1}],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_active", "params":[{"tag":"photography","limit":10,"truncate_body":0}],
- "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-discussions-by-active)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-discussions-by-active)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/tags)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_current_median_history_price)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-current-median-history-price)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-current-median-history-price)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_discussions_by_author_before_date
purpose: |
Returns a list of discussions based on author before date.
Also see: [tags_api.get_discussions_by_author_before_date]({{ '/apidefinitions/#tags_api.get_discussions_by_author_before_date' | relative_url }}), [Paginated API Methods]({{ '/tutorials-recipes/paginated-api-methods.html#condenser_apiget_discussions_by_author_before_date' | relative_url }})
parameter_json:
- - ''
- - ''
- - '1970-01-01T00:00:00'
- - 100
- expected_response_json: []
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_author_before_date",
- "params":["hiveio","firstpost","2016-04-19T22:49:43",1], "id":1}'
- expected_curl_responses:
- - Invalid parameters
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-discussions-by-author-before-date)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-discussions-by-author-before-date)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/tags)"
- - api_method: condenser_api.get_discussions_by_blog
- purpose: |
- Returns a list of discussions by blog.
-
- Also see: [tags_api.get_discussions_by_blog]({{ '/apidefinitions/#tags_api.get_discussions_by_blog' | relative_url }})
- parameter_json:
- - tag: ''
- limit: 0
- filter_tags: []
- select_authors: []
- select_tags: []
- truncate_body: 0
- expected_response_json: []
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_blog", "params":[{"tag":"hiveio","limit":1}],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_blog", "params":[{"tag":"alice","limit":10}],
- "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-discussions-by-blog)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-discussions-by-blog)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/tags)"
- - api_method: condenser_api.get_discussions_by_cashout
- purpose: Returns a list of discussions by cashout.
- parameter_json:
- - tag: ''
- limit: 0
- filter_tags: []
- select_authors: []
- select_tags: []
- truncate_body: 0
- expected_response_json: []
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_cashout", "params":[{"tag":"hive","limit":1}],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_cashout", "params":[{"tag":"photography","limit":10,"truncate_body":0}],
- "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-discussions-by-cashout)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-discussions-by-cashout)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/tags)"
- - api_method: condenser_api.get_discussions_by_children
- purpose: Returns a list of discussions by children.
- parameter_json:
- - tag: ''
- limit: 0
- filter_tags: []
- select_authors: []
- select_tags: []
- truncate_body: 0
- expected_response_json: []
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_children", "params":[{"tag":"hive","limit":1}],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_children", "params":[{"tag":"photography","limit":10,"truncate_body":0}],
- "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-discussions-by-children)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-discussions-by-children)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/tags)"
- - api_method: condenser_api.get_discussions_by_comments
- purpose: |
- Returns a list of discussions by comments.
-
- Also see: [tags_api.get_discussions_by_comments]({{ '/apidefinitions/#tags_api.get_discussions_by_comments' | relative_url }})
- parameter_json:
- - start_author: ''
- start_permlink: ''
- limit: 100
+ - ''
+ - ''
+ - '1970-01-01T00:00:00'
+ - 100
expected_response_json: []
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_comments", "params":[{"start_author":"hiveio","start_permlink":"firstpost","limit":1}],
- "id":1}'
- - '{"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}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_author_before_date",
+ "params":["hiveio","firstpost","2016-04-19T22:49:43",1], "id":1}'
expected_curl_responses:
- - Invalid parameters
- - Invalid parameters
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-discussions-by-comments)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-discussions-by-comments)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/tags)"
- - api_method: condenser_api.get_discussions_by_created
- purpose: |
- Returns a list of discussions by created.
-
- Also see: [tags_api.get_discussions_by_created]({{ '/apidefinitions/#tags_api.get_discussions_by_created' | relative_url }})
- parameter_json:
- - tag: ''
- limit: 0
- filter_tags: []
- select_authors: []
- select_tags: []
- truncate_body: 0
- expected_response_json: []
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_created", "params":[{"tag":"hive","limit":1}],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_created", "params":[{"tag":"photography","limit":10,"truncate_body":0}],
- "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-discussions-by-created)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-discussions-by-created)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/tags)"
- - api_method: condenser_api.get_discussions_by_feed
- since: HF14
- purpose: Returns a list of discussions by feed.
- parameter_json:
- - tag: ''
- start_author: ''
- start_permlink: ''
- limit: 100
- expected_response_json: []
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_feed", "params":[{"tag":"hive","limit":1}],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_feed", "params":[{"tag":"photography","limit":10,"truncate_body":0}],
- "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-discussions-by-feed)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-discussions-by-feed)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/tags)"
- - api_method: condenser_api.get_discussions_by_hot
- purpose: |
- Returns a list of discussions by hot.
-
- Also see: [tags_api.get_discussions_by_hot]({{ '/apidefinitions/#tags_api.get_discussions_by_hot' | relative_url }})
- parameter_json:
- - tag: ''
- limit: 0
- filter_tags: []
- select_authors: []
- select_tags: []
- truncate_body: 0
- expected_response_json: []
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_hot", "params":[{"tag":"hive","limit":1}],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_hot", "params":[{"tag":"photography","limit":10,"truncate_body":0}],
- "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-discussions-by-hot)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-discussions-by-hot)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/tags)"
- - api_method: condenser_api.get_discussions_by_promoted
- since: HF13
- purpose: |
- Returns a list of discussions by promoted.
-
- Also see: [tags_api.get_discussions_by_promoted]({{ '/apidefinitions/#tags_api.get_discussions_by_promoted' | relative_url }})
- parameter_json:
- - tag: ''
- limit: 0
- filter_tags: []
- select_authors: []
- select_tags: []
- truncate_body: 0
- expected_response_json: []
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_promoted", "params":[{"tag":"hive","limit":1}],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_promoted", "params":[{"tag":"photography","limit":10,"truncate_body":0}],
- "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-discussions-by-promoted)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-discussions-by-promoted)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/tags)"
- - api_method: condenser_api.get_discussions_by_trending
- purpose: |
- Returns a list of discussions by trending.
-
- Also see: [tags_api.get_discussions_by_trending]({{ '/apidefinitions/#tags_api.get_discussions_by_trending' | relative_url }})
- parameter_json:
- - tag: ''
- limit: 0
- filter_tags: []
- select_authors: []
- select_tags: []
- truncate_body: 0
- expected_response_json: []
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_trending", "params":[{"tag":"hive","limit":1}],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_trending", "params":[{"tag":"photography","limit":10,"truncate_body":0}],
- "id":1}'
+ - Invalid parameters
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-discussions-by-trending)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-discussions-by-trending)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/tags)"
- - api_method: condenser_api.get_discussions_by_votes
- purpose: Returns a list of discussions by votes.
- parameter_json:
- - tag: ''
- limit: 0
- filter_tags: []
- select_authors: []
- select_tags: []
- truncate_body: 0
- expected_response_json: []
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_votes", "params":[{"tag":"hive","limit":1}],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_votes", "params":[{"tag":"photography","limit":10,"truncate_body":0}],
- "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-discussions-by-votes)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-discussions-by-votes)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/tags)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_discussions_by_author_before_date)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-discussions-by-author-before-date)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-discussions-by-author-before-date)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/tags)"
- api_method: condenser_api.get_dynamic_global_properties
purpose: |
Returns the current dynamic global properties. See: [Understanding
@@ -1126,13 +836,14 @@
last_irreversible_block_num: 0
vote_power_reserve_rate: 40
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_dynamic_global_properties", "params":[],
- "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_dynamic_global_properties", "params":[],
+ "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-dynamic-global-properties)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-dynamic-global-properties)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/dynamicglobalproperties)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_dynamic_global_properties)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-dynamic-global-properties)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-dynamic-global-properties)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/dynamicglobalproperties)"
- api_method: condenser_api.get_escrow
since: HF14
purpose: |
@@ -1144,12 +855,13 @@
- 0
expected_response_json:
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_escrow", "params":["hiveio",
- 1234], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_escrow", "params":["hiveio",
+ 1234], "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-escrow)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-escrow)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_escrow)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-escrow)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-escrow)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_expiring_vesting_delegations
since: HF17
purpose: |
@@ -1160,73 +872,24 @@
| `"hiveio"` | `"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. |
parameter_json:
- - ''
- - '1970-01-01T00:00:00'
+ - ''
+ - '1970-01-01T00:00:00'
expected_response_json:
- - id: 0
- delegator: ''
- vesting_shares: 0.000000 VESTS
- expiration: '1970-01-01T00:00:00'
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_expiring_vesting_delegations",
- "params":["hiveio","2018-01-01T00:00:00"], "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_expiring_vesting_delegations",
- "params":["alice","2017-12-01T00:00:00"], "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#api-call)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-expiring-vesting-delegations)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/delegations)"
- - api_method: condenser_api.get_feed
- since: HF14
- purpose: |
- 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) | |
- |-------------------|---------------|---------------|-|
- | `"hiveio"` | `0` | `1` | Queries the account named `hiveio` 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: [Paginated API Methods]({{ '/tutorials-recipes/paginated-api-methods.html#condenser_apiget_feed' | relative_url }})
- parameter_json:
- - ''
- - 0
- - 1
- expected_response_json: []
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_feed", "params":["hiveio",0,1],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_feed", "params":["alice",1,10],
- "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-feed)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-feed)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - api_method: condenser_api.get_feed_entries
- since: HF14
- purpose: |
- 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) | |
- |-------------------|---------------|---------------|-|
- | `"hiveio"` | `0` | `1` | Queries the account named `hiveio` 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: [Paginated API Methods]({{ '/tutorials-recipes/paginated-api-methods.html#condenser_apiget_feed_entries' | relative_url }})
- parameter_json:
- - ''
- - 0
- - 1
- expected_response_json: []
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_feed_entries", "params":["hiveio",0,1],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_feed_entries", "params":["alice",1,10],
- "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-feed-entries)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-feed-entries)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - id: 0
+ delegator: ''
+ vesting_shares: 0.000000 VESTS
+ expiration: '1970-01-01T00:00:00'
+ curl_examples:
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_expiring_vesting_delegations",
+ "params":["hiveio","2018-01-01T00:00:00"], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_expiring_vesting_delegations",
+ "params":["alice","2017-12-01T00:00:00"], "id":1}'
+ client_docs:
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_expiring_vesting_delegations)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#api-call)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-expiring-vesting-delegations)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/delegations)"
- api_method: condenser_api.get_feed_history
purpose: |
Returns the history of price feed values.
@@ -1240,11 +903,12 @@
quote: 0.000 HIVE
price_history: []
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_feed_history", "params":[], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_feed_history", "params":[], "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-feed-history)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-feed-history)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_feed_history)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-feed-history)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-feed-history)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_follow_count
since: HF9
purpose: |
@@ -1255,23 +919,22 @@
| `"hiveio"` | Queries the account named `hiveio`. |
| `"alice"` | Queries the account named `alice`. |
parameter_json:
- - ''
+ - ''
expected_response_json:
account: ''
follower_count: 0
following_count: 0
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_follow_count", "params":["hiveio"],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_follow_count", "params":["alice"],
- "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_follow_count", "params":["hiveio"],
+ "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_follow_count", "params":["alice"],
+ "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-follow-count)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-follow-count)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/followers)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/mutes)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/mutesfollows)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_follow_count)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-follow-count)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-follow-count)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/followers)"
- api_method: condenser_api.get_followers
since: HF9
purpose: |
@@ -1284,16 +947,16 @@
Also see: [Paginated API Methods]({{ '/tutorials-recipes/paginated-api-methods.html#condenser_apiget_followers' | relative_url }})
parameter_json:
- - ''
- - ''
- - ''
- - 1
+ - ''
+ - ''
+ - ''
+ - 1
expected_response_json: []
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_followers", "params":["hiveio",null,"blog",10],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_followers", "params":["alice",null,"ignore",100],
- "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_followers", "params":["hiveio",null,"blog",10],
+ "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_followers", "params":["alice",null,"ignore",100],
+ "id":1}'
mainnet:
working: true
detail: ''
@@ -1302,12 +965,11 @@
detail: Will not work because this function requires jussi to work correctly
which is not available on the testnet
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-followers)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-followers)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/followers)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/mutes)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/mutesfollows)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_followers)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-followers)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-followers)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/followers)"
- api_method: condenser_api.get_following
since: HF9
purpose: |
@@ -1320,23 +982,22 @@
Also see: [Paginated API Methods]({{ '/tutorials-recipes/paginated-api-methods.html#condenser_apiget_following' | relative_url }})
parameter_json:
- - ''
- - ''
- - ''
- - 1
+ - ''
+ - ''
+ - ''
+ - 1
expected_response_json: []
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_following", "params":["hiveio",null,"blog",10],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_following", "params":["alice",null,"ignore",100],
- "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_following", "params":["hiveio",null,"blog",10],
+ "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_following", "params":["alice",null,"ignore",100],
+ "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-following)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-following)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/followers)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/mutes)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/mutesfollows)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_following)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-following)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-following)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/followers)"
- api_method: condenser_api.get_hardfork_version
purpose: |
Returns the current hardfork version.
@@ -1345,12 +1006,13 @@
parameter_json: []
expected_response_json: 0.0.0
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_hardfork_version", "params":[],
- "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_hardfork_version", "params":[],
+ "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-hardfork-version)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-hardfork-version)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_hardfork_version)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-hardfork-version)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-hardfork-version)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_key_references
since: HF16
purpose: |
@@ -1358,16 +1020,17 @@
Also see: [account_by_key_api.get_key_references]({{ '/apidefinitions/#account_by_key_api.get_key_references' | relative_url }})
parameter_json:
- - - STM6vJmrwaX5TjgTS9dPH8KsArso5m91fVodJvv91j7G765wqcNM9
+ - - STM6vJmrwaX5TjgTS9dPH8KsArso5m91fVodJvv91j7G765wqcNM9
expected_response_json:
- - - hiveio
+ - - hiveio
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_key_references", "params":[["STM6vJmrwaX5TjgTS9dPH8KsArso5m91fVodJvv91j7G765wqcNM9"]],
- "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_key_references", "params":[["STM6vJmrwaX5TjgTS9dPH8KsArso5m91fVodJvv91j7G765wqcNM9"]],
+ "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-key-references)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-key-references)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_key_references)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-key-references)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-key-references)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_market_history
purpose: |
Returns the market history for the internal HBD:HIVE market. Parameters: `bucket_seconds:int`; `start:timestamp`; `end:timestamp`
@@ -1382,40 +1045,41 @@
Also see: [market_history_api.get_market_history]({{ '/apidefinitions/#market_history_api.get_market_history' | relative_url }})
parameter_json:
- - 0
- - '1970-01-01T00:00:00'
- - '1970-01-01T00:00:00'
+ - 0
+ - '1970-01-01T00:00:00'
+ - '1970-01-01T00:00:00'
expected_response_json:
- - id: 0
- open: '1970-01-01T00:00:00'
- seconds: 0
- hive:
- high: 0
- low: 0
- open: 0
- close: 0
- volume: 0
- non_hive:
- high: 0
- low: 0
- open: 0
- close: 0
- volume: 0
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_market_history", "params":[15,"2018-01-01T00:00:00","2018-01-02T00:00:00"],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_market_history", "params":[60,"2018-01-01T00:00:00","2018-01-02T00:00:00"],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_market_history", "params":[300,"2018-01-01T00:00:00","2018-01-02T00:00:00"],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_market_history", "params":[3600,"2018-01-01T00:00:00","2018-01-02T00:00:00"],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_market_history", "params":[86400,"2018-01-01T00:00:00","2018-01-02T00:00:00"],
- "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#api-call)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-market-history)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - id: 0
+ open: '1970-01-01T00:00:00'
+ seconds: 0
+ hive:
+ high: 0
+ low: 0
+ open: 0
+ close: 0
+ volume: 0
+ non_hive:
+ high: 0
+ low: 0
+ open: 0
+ close: 0
+ volume: 0
+ curl_examples:
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_market_history", "params":[15,"2018-01-01T00:00:00","2018-01-02T00:00:00"],
+ "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_market_history", "params":[60,"2018-01-01T00:00:00","2018-01-02T00:00:00"],
+ "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_market_history", "params":[300,"2018-01-01T00:00:00","2018-01-02T00:00:00"],
+ "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_market_history", "params":[3600,"2018-01-01T00:00:00","2018-01-02T00:00:00"],
+ "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_market_history", "params":[86400,"2018-01-01T00:00:00","2018-01-02T00:00:00"],
+ "id":1}'
+ client_docs:
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_market_history)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#api-call)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-market-history)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_market_history_buckets
purpose: |
Returns the bucket seconds being tracked by the plugin.
@@ -1423,18 +1087,19 @@
Also see: [market_history_api.get_market_history_buckets]({{ '/apidefinitions/#market_history_api.get_market_history_buckets' | relative_url }})
parameter_json: []
expected_response_json:
- - 15
- - 60
- - 300
- - 3600
- - 86400
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_market_history_buckets", "params":[],
- "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-market-history-buckets)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-market-history-buckets)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - 15
+ - 60
+ - 300
+ - 3600
+ - 86400
+ curl_examples:
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_market_history_buckets", "params":[],
+ "id":1}'
+ client_docs:
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_market_history_buckets)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-market-history-buckets)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-market-history-buckets)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_next_scheduled_hardfork
purpose: |
Returns the next scheduled hardfork.
@@ -1445,29 +1110,31 @@
hf_version: 0.0.0
live_time: '1970-01-01T00:00:00'
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_next_scheduled_hardfork", "params":[],
- "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_next_scheduled_hardfork", "params":[],
+ "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-next-scheduled-hardfork)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-next-scheduled-hardfork)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_next_scheduled_hardfork)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-next-scheduled-hardfork)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-next-scheduled-hardfork)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_open_orders
purpose: |
Returns the open orders for an account. `account:string`
Also see: [database_api.list_limit_orders]({{ '/apidefinitions/#database_api.list_limit_orders' | relative_url }})
parameter_json:
- - ''
+ - ''
expected_response_json: []
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_open_orders", "params":["hiveio"],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_open_orders", "params":["alice"],
- "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_open_orders", "params":["hiveio"],
+ "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_open_orders", "params":["alice"],
+ "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-open-orders)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-open-orders)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_open_orders)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-open-orders)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-open-orders)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_ops_in_block
purpose: |
Returns all operations contained in a block. Parameters: `block_num:int`; `only_virtual:boolean`
@@ -1479,28 +1146,29 @@
Also see: [account_history_api.get_ops_in_block]({{ '/apidefinitions/#account_history_api.get_ops_in_block' | relative_url }})
parameter_json:
- - 0
- - false
+ - 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
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_ops_in_block", "params":[1,false],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_ops_in_block", "params":[5443322,true],
- "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-ops-in-block)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-ops-in-block)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - 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
+ curl_examples:
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_ops_in_block", "params":[1,false],
+ "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_ops_in_block", "params":[5443322,true],
+ "id":1}'
+ client_docs:
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_ops_in_block)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-ops-in-block)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-ops-in-block)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_order_book
purpose: |
Returns the internal market order book. Parameters: `limit:int` up to 500
@@ -1512,17 +1180,18 @@
Also see: [database_api.get_order_book]({{ '/apidefinitions/#database_api.get_order_book' | relative_url }}), [market_history_api.get_order_book]({{ '/apidefinitions/#market_history_api.get_order_book' | relative_url }})
parameter_json:
- - 0
+ - 0
expected_response_json:
bids: []
asks: []
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_order_book", "params":[10], "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_order_book", "params":[50], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_order_book", "params":[10], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_order_book", "params":[50], "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-order-book)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-order-book)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_order_book)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-order-book)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-order-book)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_owner_history
purpose: |
Returns the owner history of an account. Parameters: `account:string`
@@ -1533,59 +1202,36 @@
Also see: [database_api.list_owner_histories]({{ '/apidefinitions/#database_api.list_owner_histories' | relative_url }})
parameter_json:
- - ''
- expected_response_json: []
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_owner_history", "params":["hiveio"],
- "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-owner-history)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-owner-history)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - api_method: condenser_api.get_post_discussions_by_payout
- since: HF17
- purpose: |
- Returns a list of post discussions by payout.
-
- Also see: [tags_api.get_post_discussions_by_payout]({{ '/apidefinitions/#tags_api.get_post_discussions_by_payout' | relative_url }})
- parameter_json:
- - tag: ''
- limit: 0
- filter_tags: []
- select_authors: []
- select_tags: []
- truncate_body: 0
+ - ''
expected_response_json: []
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_post_discussions_by_payout",
- "params":[{"tag":"hive","limit":1}], "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_post_discussions_by_payout",
- "params":[{"tag":"photography","limit":10,"truncate_body":0}], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_owner_history", "params":["hiveio"],
+ "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-post-discussions-by-payout)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-post-discussions-by-payout)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/tags)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_owner_history)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-owner-history)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-owner-history)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_potential_signatures
purpose: |
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]({{ '/apidefinitions/#database_api.get_potential_signatures' | relative_url }})
parameter_json:
- - ref_block_num: 0
- ref_block_prefix: 0
- expiration: '1970-01-01T00:00:00'
- operations: []
- extensions: []
- signatures: []
+ - ref_block_num: 0
+ ref_block_prefix: 0
+ expiration: '1970-01-01T00:00:00'
+ operations: []
+ extensions: []
+ signatures: []
expected_response_json: []
curl_examples:
- - '{"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,"hbd_interest_rate":1000}}]],"extensions":[],"signatures":[]}],
- "id":1}'
+ - '{"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,"hbd_interest_rate":1000}}]],"extensions":[],"signatures":[]}],
+ "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-potential-signatures)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-potential-signatures)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-potential-signatures)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-potential-signatures)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_reblogged_by
since: HF14
purpose: |
@@ -1596,22 +1242,23 @@
| `"hiveio"` | `"firstpost"` | Queries reblogs for content with a slug `@hiveio/firstpost` |
| `"alice"` | `"a-post-by-alice"` | Queries reblogs for content with a slug `@alice/a-post-by-alice` |
parameter_json:
- - ''
- - ''
+ - ''
+ - ''
expected_response_json: []
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_reblogged_by", "params":["hiveio","firstpost"],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_reblogged_by", "params":["alice","a-post-by-alice"],
- "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_reblogged_by", "params":["hiveio","firstpost"],
+ "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_reblogged_by", "params":["alice","a-post-by-alice"],
+ "id":1}'
expected_curl_responses:
- - Invalid parameters
- - Invalid parameters
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-reblogged-by)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-reblogged-by)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/reblogs)"
+ - Invalid parameters
+ - Invalid parameters
+ client_docs:
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_reblogged_by)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-reblogged-by)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-reblogged-by)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/reblogs)"
- api_method: condenser_api.get_recent_trades
purpose: |
Returns the most recent trades for the internal HBD:HIVE market. Parameters: `limit:int` up to 1000
@@ -1623,20 +1270,21 @@
Also see: [market_history_api.get_recent_trades]({{ '/apidefinitions/#market_history_api.get_recent_trades' | relative_url }})
parameter_json:
- - 1
+ - 1
expected_response_json:
- - date: '1970-01-01T00:00:00'
- current_pays: 0.0 HBD
- open_pays: 0.0 HIVE
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_recent_trades", "params":[10],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_recent_trades", "params":[500],
- "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-recent-trades)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-recent-trades)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - date: '1970-01-01T00:00:00'
+ current_pays: 0.0 HBD
+ open_pays: 0.0 HIVE
+ curl_examples:
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_recent_trades", "params":[10],
+ "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_recent_trades", "params":[500],
+ "id":1}'
+ client_docs:
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_recent_trades)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-recent-trades)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-recent-trades)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_recovery_request
since: HF11
purpose: |
@@ -1648,55 +1296,37 @@
Also see: [database_api.list_account_recovery_requests]({{ '/apidefinitions/#database_api.list_account_recovery_requests' | relative_url }})
parameter_json:
- - ''
+ - ''
expected_response_json:
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_recovery_request", "params":["hiveio"],
- "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-recovery-request)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-recovery-request)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - api_method: condenser_api.get_replies_by_last_update
- purpose: |
- Returns a list of replies by last update. `start_parent_author:string`, `start_permlink:string`, `limit:int` up to 100
-
- Also see: [Paginated API Methods]({{ '/tutorials-recipes/paginated-api-methods.html#condenser_apiget_replies_by_last_update' | relative_url }})
- parameter_json:
- - ''
- - ''
- - 1
- expected_response_json: []
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_replies_by_last_update", "params":["hiveio","firstpost",1],
- "id":1}'
- expected_curl_responses:
- - Invalid parameters
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_recovery_request", "params":["hiveio"],
+ "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-replies-by-last-update)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-replies-by-last-update)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_recovery_request)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-recovery-request)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-recovery-request)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_required_signatures
purpose: |
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]({{ '/apidefinitions/#database_api.get_required_signatures' | relative_url }})
parameter_json:
- - ref_block_num: 0
- ref_block_prefix: 0
- expiration: '1970-01-01T00:00:00'
- operations: []
- extensions: []
- signatures: []
- - []
+ - ref_block_num: 0
+ ref_block_prefix: 0
+ expiration: '1970-01-01T00:00:00'
+ operations: []
+ extensions: []
+ signatures: []
+ - []
expected_response_json: []
curl_examples:
- - '{"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,"hbd_interest_rate":1000}}]],"extensions":[],"signatures":[]},[]],
- "id":1}'
+ - '{"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,"hbd_interest_rate":1000}}]],"extensions":[],"signatures":[]},[]],
+ "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-required-signatures)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-required-signatures)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-required-signatures)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-required-signatures)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_reward_fund
since: HF17
purpose: |
@@ -1704,7 +1334,7 @@
Also see: [database_api.get_reward_funds]({{ '/apidefinitions/#database_api.get_reward_funds' | relative_url }})
parameter_json:
- - post
+ - post
expected_response_json:
id: 0
name: ''
@@ -1717,12 +1347,13 @@
author_reward_curve: quadratic
curation_reward_curve: '34723648'
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_reward_fund", "params":["post"],
- "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_reward_fund", "params":["post"],
+ "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-reward-fund)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-reward-fund)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_reward_fund)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-reward-fund)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-reward-fund)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_savings_withdraw_from
since: HF14
purpose: |
@@ -1734,15 +1365,16 @@
Also see: [database_api.list_savings_withdrawals]({{ '/apidefinitions/#database_api.list_savings_withdrawals' | relative_url }})
parameter_json:
- - ''
+ - ''
expected_response_json: []
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_savings_withdraw_from", "params":["hiveio"],
- "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_savings_withdraw_from", "params":["hiveio"],
+ "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-savings-withdraw-from)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-savings-withdraw-from)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_savings_withdraw_from)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-savings-withdraw-from)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-savings-withdraw-from)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_savings_withdraw_to
since: HF14
purpose: |
@@ -1754,111 +1386,16 @@
Also see: [database_api.list_savings_withdrawals]({{ '/apidefinitions/#database_api.list_savings_withdrawals' | relative_url }})
parameter_json:
- - ''
- expected_response_json: []
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_savings_withdraw_to", "params":["hiveio"],
- "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-savings-withdraw-to)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-savings-withdraw-to)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - api_method: condenser_api.get_state
- deprecated: true
- purpose: |
- Returns the state of a path. **Deprecated.** Parameters: `path:string`
-
- See: [JS: Get State Replacement Api]({{ '/tutorials-javascript/get_state_replacement_api.html' | relative_url }})
- parameter_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 HIVE
- current_supply: 0.000 HIVE
- confidential_supply: 0.000 HIVE
- current_hbd_supply: 0.000 HIVE
- confidential_hbd_supply: 0.000 HIVE
- total_vesting_fund_hive: 0.000 HIVE
- total_vesting_shares: 0.000 HIVE
- total_reward_fund_hive: 0.000 HIVE
- total_reward_shares2: '0'
- pending_rewarded_vesting_shares: 0.000 HIVE
- pending_rewarded_vesting_hive: 0.000 HIVE
- hbd_interest_rate: 0
- hbd_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 HIVE
- maximum_block_size: 131072
- hbd_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 HIVE
- quote: 0.000 HIVE
- error: ''
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_state", "params":["/@hiveio"],
- "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-state)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-state)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/comments)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/tags)"
- - api_method: condenser_api.get_tags_used_by_author
- purpose: |
- Returns a list of tags used by an author. Parameters: `author:string`
-
- | `account` (string) | |
- |--------------------|-|
- | `"hiveio"` | Queries the tags used by the account named "hiveio". |
- parameter_json:
- - ''
+ - ''
expected_response_json: []
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_tags_used_by_author", "params":["hiveio"],
- "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_savings_withdraw_to", "params":["hiveio"],
+ "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#api-call)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-tags-used-by-author)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/tags)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_savings_withdraw_to)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-savings-withdraw-to)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-savings-withdraw-to)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_ticker
purpose: |
Returns the market ticker for the internal HBD:HIVE market.
@@ -1873,11 +1410,12 @@
hive_volume: 0.000 HIVE
hbd_volume: 0.000 HIVE
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_ticker", "params":[], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_ticker", "params":[], "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-ticker)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-ticker)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_ticker)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-ticker)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-ticker)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_trade_history
purpose: |
Returns the trade history for the internal HBD:HIVE market. Parameters: `start:timestamp`; `end:timestamp`; `limit:int` up to 1000
@@ -1888,20 +1426,21 @@
Also see: [market_history_api.get_trade_history]({{ '/apidefinitions/#market_history_api.get_trade_history' | relative_url }})
parameter_json:
- - '1970-01-01T00:00:00'
- - '1970-01-01T00:00:00'
- - 1000
+ - '1970-01-01T00:00:00'
+ - '1970-01-01T00:00:00'
+ - 1000
expected_response_json:
- - date: '1970-01-01T00:00:00'
- current_pays: 0.000 HBD
- open_pays: 0.000 HIVE
+ - date: '1970-01-01T00:00:00'
+ current_pays: 0.000 HBD
+ open_pays: 0.000 HIVE
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_trade_history", "params":["2018-01-01T00:00:00","2018-01-02T00:00:00",10],
- "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_trade_history", "params":["2018-01-01T00:00:00","2018-01-02T00:00:00",10],
+ "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-trade-history)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-trade-history)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_trade_history)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-trade-history)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-trade-history)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_transaction
purpose: |
Returns the details of a transaction based on a transaction id. Parameters: `trx_id:string`
@@ -1912,7 +1451,7 @@
Also see: [account_history_api.get_transaction]({{ '/apidefinitions/#account_history_api.get_transaction' | relative_url }})
parameter_json:
- - ''
+ - ''
expected_response_json:
ref_block_num: 0
ref_block_prefix: 0
@@ -1924,34 +1463,35 @@
block_num: 0
transaction_num: 0
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_transaction", "params":["6fde0190a97835ea6d9e651293e90c89911f933c"],
- "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_transaction", "params":["6fde0190a97835ea6d9e651293e90c89911f933c"],
+ "id":1}'
expected_curl_responses:
- - account_history_api_plugin not enabled
+ - account_history_api_plugin not enabled
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-transaction)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-transaction)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_transaction)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-transaction)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-transaction)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_transaction_hex
purpose: |
Returns a hexdump of the serialized binary form of a transaction.
Also see: [database_api.get_transaction_hex]({{ '/apidefinitions/#database_api.get_transaction_hex' | relative_url }})
parameter_json:
- - ref_block_num: 0
- ref_block_prefix: 0
- expiration: '1970-01-01T00:00:00'
- operations: []
- extensions: []
- signatures: []
+ - ref_block_num: 0
+ ref_block_prefix: 0
+ expiration: '1970-01-01T00:00:00'
+ operations: []
+ extensions: []
+ signatures: []
expected_response_json: ''
curl_examples:
- - '{"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,"hbd_interest_rate":1000}}]],"extensions":[],"signatures":[]}],
- "id":1}'
+ - '{"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,"hbd_interest_rate":1000}}]],"extensions":[],"signatures":[]}],
+ "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-transaction-hex)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-transaction-hex)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-transaction-hex)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-transaction-hex)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_trending_tags
purpose: |
Returns the list of trending tags. Parameter: `start_tag:string`; `limit:int` up to 100
@@ -1963,25 +1503,26 @@
Also see: [Paginated API Methods]({{ '/tutorials-recipes/paginated-api-methods.html#condenser_apiget_trending_tags' | relative_url }})
parameter_json:
- - ''
- - 1
+ - ''
+ - 1
expected_response_json:
- - name: ''
- total_payouts: 0.000 HBD
- net_votes: 0
- top_posts: 0
- comments: 0
- trending: ''
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_trending_tags", "params":[null,100],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_trending_tags", "params":["hive",10],
- "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-trending-tags)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-trending-tags)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/tags)"
+ - name: ''
+ total_payouts: 0.000 HBD
+ net_votes: 0
+ top_posts: 0
+ comments: 0
+ trending: ''
+ curl_examples:
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_trending_tags", "params":[null,100],
+ "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_trending_tags", "params":["hive",10],
+ "id":1}'
+ client_docs:
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_trending_tags)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-trending-tags)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-trending-tags)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/tags)"
- api_method: condenser_api.get_version
purpose: |
Returns the versions of blockchain, hive, and FC.
@@ -1993,11 +1534,12 @@
hive_revision: ''
fc_revision: ''
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_version", "params":[], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_version", "params":[], "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-version)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-version)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_version)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-version)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-version)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_vesting_delegations
since: HF17
purpose: |
@@ -2009,23 +1551,24 @@
Also see: [database_api.list_vesting_delegations]({{ '/apidefinitions/#database_api.list_vesting_delegations' | relative_url }}), [Paginated API Methods]({{ '/tutorials-recipes/paginated-api-methods.html#condenser_apiget_vesting_delegations' | relative_url }})
parameter_json:
- - ''
- - ''
- - 1
+ - ''
+ - ''
+ - 1
expected_response_json:
- - id: 0
- delegator: ''
- delegatee: ''
- vesting_shares: 0.000000 VESTS
- min_delegation_time: '1970-01-01T00:00:00'
+ - id: 0
+ delegator: ''
+ delegatee: ''
+ vesting_shares: 0.000000 VESTS
+ min_delegation_time: '1970-01-01T00:00:00'
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_vesting_delegations", "params":["hiveio",null,10],
- "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_vesting_delegations", "params":["hiveio",null,10],
+ "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-vesting-delegations)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-vesting-delegations)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/delegations)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_vesting_delegations)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-vesting-delegations)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-vesting-delegations)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/delegations)"
- api_method: condenser_api.get_volume
purpose: |
Returns the market volume for the past 24 hours.
@@ -2036,11 +1579,12 @@
hive_volume: 0.000 HIVE
hbd_volume: 0.000 HIVE
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_volume", "params":[], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_volume", "params":[], "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-volume)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-volume)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_volume)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-volume)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-volume)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_withdraw_routes
purpose: |
Returns the withdraw routes for an account. Parameters: `account:string`; `type:string`
@@ -2053,25 +1597,26 @@
Also see: [database_api.list_withdraw_vesting_routes]({{ '/apidefinitions/#database_api.list_withdraw_vesting_routes' | relative_url }})
parameter_json:
- - ''
- - ''
+ - ''
+ - ''
expected_response_json:
- - id: 0
- from_account: ''
- to_account: ''
- percent: 0
- auto_vest: false
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_withdraw_routes", "params":["hiveio","outgoing"],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_withdraw_routes", "params":["hiveio","incoming"],
- "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_withdraw_routes", "params":["hiveio","all"],
- "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-withdraw-routes)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-withdraw-routes)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - id: 0
+ from_account: ''
+ to_account: ''
+ percent: 0
+ auto_vest: false
+ curl_examples:
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_withdraw_routes", "params":["hiveio","outgoing"],
+ "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_withdraw_routes", "params":["hiveio","incoming"],
+ "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_withdraw_routes", "params":["hiveio","all"],
+ "id":1}'
+ client_docs:
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_withdraw_routes)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-withdraw-routes)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-withdraw-routes)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_witness_by_account
purpose: |
Returns the witness of an account. Parameters: `account:string`
@@ -2082,7 +1627,7 @@
Also see: [database_api.list_witnesses]({{ '/apidefinitions/#database_api.list_witnesses' | relative_url }})
parameter_json:
- - ''
+ - ''
expected_response_json:
id: 0
owner: ''
@@ -2110,24 +1655,26 @@
hardfork_version_vote: ''
hardfork_time_vote: '1970-01-01T00:00:00'
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_witness_by_account", "params":["hiveio"],
- "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_witness_by_account", "params":["hiveio"],
+ "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-witness-by-account)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-witness-by-account)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/witnesses)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_witness_by_account)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-witness-by-account)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-witness-by-account)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/witnesses)"
- api_method: condenser_api.get_witness_count
purpose:
parameter_json: []
expected_response_json: 0
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_witness_count", "params":[],
- "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_witness_count", "params":[],
+ "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-witness-count)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-witness-count)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_witness_count)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-witness-count)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-witness-count)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_witness_schedule
purpose: |
Returns the current witness schedule.
@@ -2154,28 +1701,30 @@
max_runner_witnesses: 1
hardfork_required_witnesses: 17
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_witness_schedule", "params":[],
- "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_witness_schedule", "params":[],
+ "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-witness-schedule)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-witness-schedule)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_witness_schedule)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-witness-schedule)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-witness-schedule)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_witnesses
purpose: |
Returns current witnesses.
Also see: [database_api.list_witnesses]({{ '/apidefinitions/#database_api.list_witnesses' | relative_url }})
parameter_json:
- - - 0
+ - - 0
expected_response_json: []
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_witnesses", "params":[[28]],
- "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_witnesses", "params":[[28]],
+ "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-witnesses)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-witnesses)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/witnesses)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_witnesses)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-witnesses)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-witnesses)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/witnesses)"
- api_method: condenser_api.get_witnesses_by_vote
purpose: |
Returns current witnesses by vote. Parameters: `start_name:string`; `limit:int` up to 1000
@@ -2187,27 +1736,28 @@
Also see: [database_api.list_witnesses]({{ '/apidefinitions/#database_api.list_witnesses' | relative_url }})
parameter_json:
- - ''
- - 1000
+ - ''
+ - 1000
expected_response_json: []
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_witnesses_by_vote", "params":[null,
- 21], "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.get_witnesses_by_vote", "params":["a",
- 1], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_witnesses_by_vote", "params":[null,
+ 21], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.get_witnesses_by_vote", "params":["a",
+ 1], "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-witnesses-by-vote)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-witnesses-by-vote)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/witnesses)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_witnesses_by_vote)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-witnesses-by-vote)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-witnesses-by-vote)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/witnesses)"
- api_method: condenser_api.lookup_account_names
purpose: |
Looks up account names. Parameters: `accounts:[string]`; `delayed_votes_active:boolean`
Also see: [database_api.find_accounts]({{ '/apidefinitions/#database_api.find_accounts' | relative_url }})
parameter_json:
- - - hiveio
- - true
+ - - hiveio
+ - true
expected_response_json: |
{
"id": 1370484,
@@ -2333,12 +1883,13 @@
"guest_bloggers": []
}
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.lookup_account_names", "params":[["hiveio"]], "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.lookup_account_names", "params":[["hiveio"], false], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.lookup_account_names", "params":[["hiveio"]], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.lookup_account_names", "params":[["hiveio"], false], "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#lookup-account-names)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#lookup-account-names)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=lookup_account_names)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#lookup-account-names)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#lookup-account-names)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.lookup_accounts
purpose: |
Looks up accounts starting with name. Parameters`lower_bound_name:string`; `limit:int` up to 1000
@@ -2349,16 +1900,17 @@
Also see: [database_api.list_accounts]({{ '/apidefinitions/#database_api.list_accounts' | relative_url }})
parameter_json:
- - ''
- - 1
+ - ''
+ - 1
expected_response_json: []
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.lookup_accounts", "params":["a",10],
- "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.lookup_accounts", "params":["a",10],
+ "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#lookup-accounts)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#lookup-accounts)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=lookup_accounts)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#lookup-accounts)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#lookup-accounts)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.lookup_witness_accounts
purpose: |
Looks up witness accounts starting with name. Parameters: `lower_bound_name:string`; `limit:int` up to 1000
@@ -2369,65 +1921,38 @@
Also see: [database_api.list_witnesses]({{ '/apidefinitions/#database_api.list_witnesses' | relative_url }})
parameter_json:
- - ''
- - 1
+ - ''
+ - 1
expected_response_json: []
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.lookup_witness_accounts", "params":["a",10],
- "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#lookup-witness-accounts)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#lookup-witness-accounts)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/witnesses)"
- - api_method: condenser_api.verify_account_authority
- disabled: true
- purpose: |
- **Not Implemented**
-
- Also see: [database_api.verify_account_authority]({{ '/apidefinitions/#database_api.verify_account_authority' | relative_url }})
- parameter_json:
- - ''
- - - ''
- expected_response_json: false
- curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.verify_account_authority", "params":["temp",["STM8GC13uCZbP44HzMLV6zPZGwVQ8Nt4Kji8PapsPiNq1BK153XTX"]],
- "id":1}'
- expected_curl_responses:
- - Missing Active Authority hiveio
+ - '{"jsonrpc":"2.0", "method":"condenser_api.lookup_witness_accounts", "params":["a",10],
+ "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#verify-account-authority)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#verify-account-authority)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=lookup_witness_accounts)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#lookup-witness-accounts)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#lookup-witness-accounts)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/witnesses)"
- api_method: condenser_api.verify_authority
purpose: |
Returns true if the transaction has all of the required signatures.
Also see: [database_api.verify_authority]({{ '/apidefinitions/#database_api.verify_authority' | relative_url }})
parameter_json:
- - ref_block_num: 0
- ref_block_prefix: 0
- expiration: '1970-01-01T00:00:00'
- operations: []
- extensions: []
- signatures: []
+ - ref_block_num: 0
+ ref_block_prefix: 0
+ expiration: '1970-01-01T00:00:00'
+ operations: []
+ extensions: []
+ signatures: []
expected_response_json: false
curl_examples:
- - '{"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,"hbd_interest_rate":1000}}]],"extensions":[],"signatures":[]}],
- "id":1}'
- client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#verify-authority)"
- - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#verify-authority)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - api_method: condenser_api.get_account_references
- disabled: true
- purpose: |
- **Not Implemented**
- parameter_json: "[]"
- expected_response_json: "[]"
+ - '{"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,"hbd_interest_rate":1000}}]],"extensions":[],"signatures":[]}],
+ "id":1}'
client_docs:
- - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-account-references)"
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#verify-authority)"
+ - "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#verify-authority)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.find_proposals
purpose: |
Finds proposals by `proposal.id` (not `proposal.proposal_id`).
@@ -2451,10 +1976,11 @@
}
]
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.find_proposals", "params":[[0]], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.find_proposals", "params":[[0]], "id":1}'
client_docs:
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/proposals)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=find_proposals)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/proposals)"
- api_method: condenser_api.list_proposal_votes
purpose: |
Returns all proposal votes, starting with the specified voter or `proposal.id`. Parameters: `start:array`; `limit:int`; `order:string`; `order_direction:string`; `status:string`
@@ -2481,7 +2007,7 @@
| `["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]({{ '/apidefinitions/#database_api.list_proposal_votes' | relative_url }})
+ Also see: [database_api.list_proposals]({{ '/apidefinitions/#database_api.list_proposal_votes' | relative_url }})
parameter_json: '[[],0,"by_name","ascending","all"]'
expected_response_json: |
[{
@@ -2506,11 +2032,12 @@
}
}]
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.list_proposal_votes", "params":[[""], 10, "by_voter_proposal", "ascending", "active"], "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.list_proposal_votes", "params":[[0], 10, "by_proposal_voter", "ascending", "active"], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.list_proposal_votes", "params":[[""], 10, "by_voter_proposal", "ascending", "active"], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.list_proposal_votes", "params":[[0], 10, "by_proposal_voter", "ascending", "active"], "id":1}'
client_docs:
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/proposalsapprovals)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=list_proposal_votes)"
+ - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
+ - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/proposalsapprovals)"
- api_method: condenser_api.list_proposals
purpose: |
Returns all proposals, starting with the specified creator or start date. Parameters: `start:array`; `limit:int`; `order:string`; `order_direction:string`; `status:string`
@@ -2564,18 +2091,16 @@
}
]
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.list_proposals", "params":[[""], 10, "by_creator", "ascending", "active"], "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.list_proposals", "params":[["2019-08-07T16:54:03"], 1000, "order_direction": "ascending", "inactive"], "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.list_proposals", "params":[["a"], 1, "by_creator", "ascending", "expired"], "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.list_proposals", "params":[["alice"], 10, "by_creator", "ascending", "all"], "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.list_proposals", "params":[[""], 1000, "by_creator", "ascending", "votable"], "id":1}'
- - '{"jsonrpc":"2.0", "method":"condenser_api.list_proposals", "params":[[10], 1000, "by_total_votes", "ascending", "votable"], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.list_proposals", "params":[[""], 10, "by_creator", "ascending", "active"], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.list_proposals", "params":[["2019-08-07T16:54:03"], 1000, "order_direction": "ascending", "inactive"], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.list_proposals", "params":[["a"], 1, "by_creator", "ascending", "expired"], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.list_proposals", "params":[["alice"], 10, "by_creator", "ascending", "all"], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.list_proposals", "params":[[""], 1000, "by_creator", "ascending", "votable"], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.list_proposals", "params":[[10], 1000, "by_total_votes", "ascending", "votable"], "id":1}'
client_docs:
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=list_proposals)"
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/proposals)'
- client_docs:
- - "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- - "[hivesql](https://docs.hivesql.io/technical-informations/state-tables/proposals)"
- api_method: condenser_api.is_known_transaction
since: HF25
purpose: |
@@ -2599,6 +2124,7 @@
parameter_json: "[]"
expected_response_json: "[]"
client_docs:
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=get_collateralized_conversion_requests)"
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/-/blob/master/doc/README.md#collateralized-convert)'
- "[hivesql](https://docs.hivesql.io/technical-informations/operations/txcollateralizedconverts-hf25)"
- api_method: condenser_api.find_recurrent_transfers
@@ -2623,21 +2149,81 @@
}
]
curl_examples:
- - '{"jsonrpc":"2.0", "method":"condenser_api.find_recurrent_transfers", "params":["alice"], "id":1}'
+ - '{"jsonrpc":"2.0", "method":"condenser_api.find_recurrent_transfers", "params":["alice"], "id":1}'
client_docs:
- - "[hivesql](https://docs.hivesql.io/technical-informations/operations/txrecurrenttransfers-hf25)"
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=find_recurrent_transfers)"
+ - "[hivesql](https://docs.hivesql.io/technical-informations/operations/txrecurrenttransfers-hf25)"
- api_method: condenser_api.find_rc_accounts
since: HF26
- purpose:
+ purpose: Returns the available resource credits of accounts.
parameter_json: "[]"
- expected_response_json: "[]"
+ expected_response_json: |
+ [
+ {
+ "account":"alice",
+ "delegated_rc":0,
+ "max_rc":135630143570,
+ "max_rc_creation_adjustment":"2020.748973 VESTS",
+ "rc_manabar":{"current_mana":135375191366,"last_update_time":1550731380},
+ "received_delegated_rc":0
+ },
+ {
+ "account":"demo",
+ "delegated_rc":0,
+ "max_rc":50966868081,
+ "max_rc_creation_adjustment":"2020.748973 VESTS",
+ "rc_manabar":{"current_mana":50966868081,"last_update_time":1715912571},
+ "received_delegated_rc":6000000000
+ }
+ ]
+ curl_examples:
+ - '{"jsonrpc":"2.0", "method":"condenser_api.find_rc_accounts", "params":[["alice","demo"]], "id":1}'
+ client_docs:
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=find_rc_accounts)"
- api_method: condenser_api.list_rc_accounts
since: HF26
- purpose:
+ purpose: Find accounts and their RC delegations
parameter_json: "[]"
- expected_response_json: "[]"
+ expected_response_json: |
+ [
+ {
+ "account":"ecency",
+ "delegated_rc":2065000000000,
+ "max_rc":7671956433568695,
+ "max_rc_creation_adjustment":"5851.327807 VESTS",
+ "rc_manabar":{"current_mana":3221987144996,"last_update_time":1716194709},
+ "received_delegated_rc":4484642315668049
+ },
+ {
+ "account":"ecency-987",
+ "delegated_rc":0,"max_rc":5568323871,
+ "max_rc_creation_adjustment":"5568.323871 VESTS",
+ "rc_manabar":{"current_mana":5568323871,"last_update_time":1637136366},
+ "received_delegated_rc":0
+ }
+ ]
+ curl_examples:
+ - '{"jsonrpc":"2.0", "method":"condenser_api.list_rc_accounts", "params":["ecency",10], "id":1}'
+ client_docs:
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=list_rc_accounts)"
- api_method: condenser_api.list_rc_direct_delegations
since: HF26
- purpose:
+ purpose: Get list of "from" "to" which account how much RC was delegated.
parameter_json: "[]"
- expected_response_json: "[]"
+ expected_response_json: |
+ [
+ {
+ "delegated_rc":15000000000,
+ "from":"ecency",
+ "to":"raitakun501"
+ },
+ {
+ "delegated_rc":15000000000,
+ "from":"ecency",
+ "to":"vivianemitola"
+ }
+ ]
+ curl_examples:
+ - '{"jsonrpc":"2.0", "method":"condenser_api.list_rc_direct_delegations", "params":[["ecency",""],2], "id":1}'
+ client_docs:
+ - "[hivexplorer](https://hivexplorer.com/api-docs?q=list_rc_direct_delegations)"
diff --git a/_data/nav.yml b/_data/nav.yml
index 1c87a2caf74fd5e76634fb8ab116503dd7d5ca22..baf0a80f3026cea2a19eccbc364fc6a58880c543 100644
--- a/_data/nav.yml
+++ b/_data/nav.yml
@@ -8,10 +8,15 @@ toc:
url: "/quickstart/"
position: 2
exclude: true
+ - title: "JSON-RPC Methods"
+ collection: apidefinitions
+ url: "/apidefinitions/"
+ exclude: true
+ position: 3
- title: "Tutorials"
collection: "tutorials"
url: "/tutorials/"
- position: 3
+ position: 4
exclude: true
docs:
- title: Javascript
@@ -27,24 +32,19 @@ toc:
- title: "Services"
collection: "services"
url: "/services/"
- position: 4
- exclude: true
- - title: "Layer 2s"
- collection: "layer2"
- url: "/layer2/"
position: 5
exclude: true
- - title: "Appbase API"
- collection: apidefinitions
- url: "/apidefinitions/"
- exclude: true
- position: 6
- - title: "Node Operation"
+ - title: "Node Configs"
collection: "nodeop"
url: "/nodeop/"
- position: 7
+ position: 6
exclude: true
top_level_section: true
+ - title: "Layer 2s"
+ collection: "layer2"
+ url: "/layer2/"
+ position: 7
+ exclude: true
- title: "Resources"
collection: "resources"
url: "/resources/"
diff --git a/_sass/_main.scss b/_sass/_main.scss
index e94ea988a5b1bfe2602e5cd02b07ca84f98d9f5d..4d0b7591c2b09be68dd1173d3040acdd42b31173 100644
--- a/_sass/_main.scss
+++ b/_sass/_main.scss
@@ -735,10 +735,18 @@ a[href*='hivesql'] {
padding-left: .90em;
}
+a[href*='hivexplorer'] {
+ background-image: url(../images/languages/restapi.svg);
+ background-size: .90em .90em;
+ background-repeat: no-repeat;
+ background-position: left top;
+ padding-left: .90em;
+}
+
#search-process {
background-image: url(../images/loading.gif);
background-size: .90em .90em;
background-repeat: no-repeat;
background-position: right top;
- padding-left: .90em;
+ padding-left: .90em;
}
diff --git a/apidefinitions.html b/apidefinitions.html
index 3f2038cda5c8afb1bf296d7ce57b3f0a3d53b01d..c4e333f327971cfb518342f44bdb9485c98c7456 100644
--- a/apidefinitions.html
+++ b/apidefinitions.html
@@ -4,14 +4,6 @@ section: API Definitions
permalink: /apidefinitions/
---
-<section class="row">
- <section class="row">
- <blockquote class="warning">
- While the <code>condenser_api.*</code> calls are ready for use, all other appbase methods are currently works in progress and may change, or be unsuitable for production use.
- </blockquote>
- </section>
-</section>
-
{% assign sorted_collections = site.collections | where:'title', "API Definitions" %}
{% for collection in sorted_collections %}
{% assign sorted_docs = collection.docs | sort: "position" %}
diff --git a/images/languages/restapi.svg b/images/languages/restapi.svg
new file mode 100644
index 0000000000000000000000000000000000000000..b82236f1f56723d8b18479f2407a493e27f3510e
--- /dev/null
+++ b/images/languages/restapi.svg
@@ -0,0 +1 @@
+<svg height="256" preserveAspectRatio="xMidYMid" viewBox="0 0 256 256" width="256" xmlns="http://www.w3.org/2000/svg"><path d="m127.059657 255.996921c-68.2090026-.470449-127.51673062-57.078479-127.05700194-128.998618.44199434-69.2024402 57.94900474-127.46727058 129.10736494-126.99545745 69.157108.45954053 127.503089 57.86392555 126.885116 128.19135345.572955 69.689254-58.060868 128.29499-128.935479 127.802722zm0 0c-68.2090026-.470449-127.51673062-57.078479-127.05700194-128.998618.44199434-69.2024402 57.94900474-127.46727058 129.10736494-126.99545745 69.157108.45954053 127.503089 57.86392555 126.885116 128.19135345.572955 69.689254-58.060868 128.29499-128.935479 127.802722z" fill="#fff"/><path d="m127.184644 238.997327c-59.1522675-.408056-110.5810349-49.498583-110.1823412-111.865899.3837257-60.0128327 50.2530972-110.5397174 111.9608142-110.1289408 59.971427.3985349 110.568788 50.1800369 110.032661 111.1667638.496666 60.43313-50.348348 111.255175-111.811134 110.828076zm0 0c-59.1522675-.408056-110.5810349-49.498583-110.1823412-111.865899.3837257-60.0128327 50.2530972-110.5397174 111.9608142-110.1289408 59.971427.3985349 110.568788 50.1800369 110.032661 111.1667638.496666 60.43313-50.348348 111.255175-111.811134 110.828076z" fill="#49a32b"/><path d="m169.327319 127.956161c-.284596 5.290212-4.906213 9.683063-9.461106 8.916425-.021787 0-.044936 0-.068085 0-5.045107.006809-9.139745-4.078298-9.145192-9.123404.171575-5.058724 4.366979-9.045787 9.427064-8.96 5.045106.02451 9.51966 4.288 9.247319 9.166979zm-81.1261275 51.264c1.9022979.055829 3.8059574.014978 5.9996596.014978v13.785873c-13.6347234 2.305361-24.8660426-1.565958-27.6221277-13.091405-.9436596-4.237617-1.5237447-8.548766-1.7361702-12.885787-.292766-4.591659.2137872-9.235064-.1361702-13.818553-.9695319-12.612085-2.6035745-16.917787-14.706383-17.514213v-15.69634c.8674043-.202894 1.7470638-.352681 2.6321702-.452085 6.6355745-.326809 9.4325107-2.361192 10.916766-8.897362.6754042-3.672511 1.0757447-7.389958 1.1942127-11.1223831.5256171-7.2170212.3390639-14.5511489 1.5414468-21.6510638 1.737532-10.267234 8.1116596-15.2551489 18.6403405-15.8134468 2.9957447-.1606808 6.0010212-.0245106 9.3957447-.0245106v14.0908936c-1.3971064.0994042-2.6771064.3022979-3.9489362.2641702-8.5800851-.2628085-9.024 2.6594043-9.650383 9.7620426-.3908085 4.4541276.1484255 8.9845106-.155234 13.453617-.3172766 4.4473189-.9123405 8.8714889-1.7811064 13.2452769-1.2377873 6.338723-5.1349787 11.052936-10.5354894 15.053617 10.4837447 6.822127 11.6765958 17.422978 12.3574468 28.187234.3662979 5.78451.1988085 11.609872.7857022 17.365787.4575319 4.467745 2.1950638 5.607489 6.8085106 5.74366zm8.8360851-60.430979h.1620425c5.0124259.083064 9.0103829 4.213106 8.9273189 9.226893 0 .164766-.005447.328171-.014978.491575-.281873 4.899404-4.481362 8.641362-9.3807664 8.359489-.1974468.004085-.3935319 0-.5909787-.009532-4.9892766-.247829-8.8333617-4.493617-8.5855319-9.482893.2478298-4.989277 4.493617-8.833362 9.4828936-8.585532zm31.2360854 0c5.482212-.042213 9.123404 3.510468 9.152 8.930042.029957 5.565277-3.421958 9.126128-8.868766 9.149277-5.539405.024511-9.186043-3.479149-9.216-8.866043-.016341-.275063-.020426-.550127-.012256-.825191.153873-4.786383 4.158639-8.541958 8.945022-8.388085zm65.399829-6.865702c1.458383 5.446808 4.297532 7.361361 10.03166 7.622808.939575.043575 1.875064.202894 3.163234.345873v15.692255c-.697191.228766-1.412085.40034-2.137872.512-7.684085.477957-11.186383 3.630298-11.962553 11.334808-.49566 4.918468-.454809 9.891405-.795234 14.827575-.142979 5.419574-.635915 10.82417-1.476086 16.179745-1.960851 9.703489-8.019063 14.54434-18.028936 15.135319-3.221787.190638-6.466723.029957-9.940425.029957v-14.025532c1.869617-.115744 3.52-.275064 5.174468-.314553 5.980596-.142979 8.095319-2.071149 8.388085-8.010894.324085-6.525276.465702-13.058723.757106-19.585361.42349-9.433873 3.006639-17.861447 11.795064-23.745362-5.028766-3.585362-9.066213-7.92783-10.112-13.783149-1.265021-7.097191-1.673532-14.3509787-2.354383-21.5475744-.33634-3.597617-.32-7.2265532-.671319-10.8214468-.378553-3.8808511-3.044766-5.2234894-6.577021-5.3106383-2.02349-.0490213-4.055149-.0095319-6.642383-.0095319v-13.696c16.509276-2.7411064 27.913532 2.752 28.972936 18.5477446.443915 6.6328511.378553 13.2970213.803404 19.9298728.186553 3.60851.725787 7.189787 1.612255 10.692085z" fill="#fff"/></svg>
\ No newline at end of file