Hive Developers logo

Hive Developer Portal - API Definitions

Account By Key API

Methods:

Used to lookup account information based on a key. These AppBase API methods are still under development and subject to change.

account_by_key_api.get_key_references

Returns all accounts that have the key associated with their owner or active authorities.

Query Parameters JSON
{
  "keys": [
    "STM6vJmrwaX5TjgTS9dPH8KsArso5m91fVodJvv91j7G765wqcNM9"
  ]
}
Expected Response JSON
{"accounts": ["hiveio"]}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"account_by_key_api.get_key_references", "params":{"keys":["STM6vJmrwaX5TjgTS9dPH8KsArso5m91fVodJvv91j7G765wqcNM9"]}, "id":1}' https://api.hive.blog

Account history API

Methods:

Used to lookup account history information. These AppBase API methods are still under development and subject to change.

account_history_api.get_account_history

Returns a history of all operations for a given account. Parameters:

If either operation_filter_low or operation_filter_high are set, the set of returned operations will include only these matching bitwise filter.

For the first 64 operations (as defined in protocol/operations.hpp), set the corresponding bit in operation_filter_low; for the higher-numbered operations, set the bit in operation_filter_high (pretending operation_filter is a 128-bit bitmask composed of {operation_filter_high, operation_filter_low})

account (string) start (int) limit (int) include_reversible (boolean) operation_filter_low (int) operation_filter_high (int)  
"hiveio" 1000 1000       Queries the account named hiveio starting on the latest item in history, up to 1,000 results.
"alice" -1 1000       Queries the account named alice starting on the oldest item in history, up to 1,000 results.
"bob" -1 1000 true 1   Queries only votes by the account named bob starting on the oldest item in history, up to 1,000 results.
"charlie" -1 1000 true 262144   Queries only custom jsons by the account named charlie starting on the oldest item in history, up to 1,000 results.
"emma" -1 1000 true 0 1 Queries only proposal payments to the account named emma starting on the oldest item in history, up to 1,000 results.

Also see: Paginated API Methods

Query Parameters JSON
{
  "account": "",
  "start": "18446744073709551615",
  "limit": 1000,
  "include_reversible": true,
  "operation_filter_low": 4294967295,
  "operation_filter_high": 4294967295
}
Expected Response JSON
{
  "history": [
    [
      99,
      {
        "trx_id": "0000000000000000000000000000000000000000",
        "block": 0,
        "trx_in_block": 4294967295,
        "op_in_trx": 0,
        "virtual_op": 0,
        "timestamp": "2019-12-09T21:32:39",
        "op": {}
      }
    ]
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"account_history_api.get_account_history", "params":{"account":"hiveio", "start":1000, "limit":1000}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"account_history_api.get_account_history", "params":{"account":"hiveio", "start":-1, "limit":1000}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"account_history_api.get_account_history", "params":{"account":"bob", "start":-1, "limit":1000, "include_reversible": true, "operation_filter_low": 1}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"account_history_api.get_account_history", "params":{"account":"charlie", "start":-1, "limit":1000, "include_reversible": true, "operation_filter_low": 262144}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"account_history_api.get_account_history", "params":{"account":"emma", "start":-1, "limit":1000, "include_reversible": true, "operation_filter_low": 0, "operation_filter_high": 1}, "id":1}' https://api.hive.blog

account_history_api.get_ops_in_block

Returns all operations contained in a block. Parameter:

Query Parameters JSON
{
  "block_num": 0,
  "only_virtual": false,
  "include_reversible": true
}
Expected Response JSON
{
  "ops": [
    {
      "trx_id": "0000000000000000000000000000000000000000",
      "block": 0,
      "trx_in_block": 4294967295,
      "op_in_trx": 0,
      "virtual_op": 0,
      "timestamp": "2019-10-06T09:05:15",
      "op": {}
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"account_history_api.get_ops_in_block", "params":{"block_num":1,"only_virtual":false}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"account_history_api.get_ops_in_block", "params":{"block_num":5443322,"only_virtual":true}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"account_history_api.get_ops_in_block", "params":{"block_num":5443322,"only_virtual":true,"include_reversible":true}, "id":1}' https://api.hive.blog

account_history_api.get_transaction

Returns the details of a transaction based on a transaction id (including their signatures, operations like also a block_num it was included to).

Query Parameters JSON
{"id": "6fde0190a97835ea6d9e651293e90c89911f933c"}
Expected Response JSON
{
  "jsonrpc": "2.0",
  "result": {
    "ref_block_num": 36374,
    "ref_block_prefix": 3218139339,
    "expiration": "2018-04-09T00:29:06",
    "operations": [
      {
        "type": "claim_reward_balance_operation",
        "value": {
          "account": "social",
          "reward_hive": {
            "amount": "0",
            "precision": 3,
            "nai": "@@000000021"
          },
          "reward_hbd": {
            "amount": "0",
            "precision": 3,
            "nai": "@@000000013"
          },
          "reward_vests": {
            "amount": "1",
            "precision": 6,
            "nai": "@@000000037"
          }
        }
      }
    ],
    "extensions": [],
    "signatures": [
      "1b01bdbb0c0d43db821c09ae8a82881c1ce3ba0eca35f23bc06541eca05560742f210a21243e20d04d5c88cb977abf2d75cc088db0fff2ca9fdf2cba753cf69844"
    ],
    "transaction_id": "6fde0190a97835ea6d9e651293e90c89911f933c",
    "block_num": 21401130,
    "transaction_num": 25
  },
  "id": 1
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"account_history_api.get_transaction", "params":{"id":"6fde0190a97835ea6d9e651293e90c89911f933c"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"account_history_api.get_transaction", "params":{"id":"6fde0190a97835ea6d9e651293e90c89911f933c", "include_reversible": true}, "id":1}' https://api.hive.blog

account_history_api.enum_virtual_ops

Allows to specify range of blocks to retrieve virtual operations for.

Query Parameters 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
{
  "ops": [
    {
      "trx_id": "0000000000000000000000000000000000000000",
      "block": 0,
      "trx_in_block": 4294967295,
      "op_in_trx": 0,
      "virtual_op": 0,
      "timestamp": "2016-03-24T17:46:30",
      "op": {},
      "operation_id": "18446744069414584320"
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"account_history_api.enum_virtual_ops", "params":{"block_range_begin":1,"block_range_end":2}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"account_history_api.enum_virtual_ops", "params":{"block_range_begin":1,"block_range_end":2,"include_reversible":true}, "id":1}' https://api.hive.blog

Block API

Methods:

Used to query values related to the block plugin. These AppBase API methods are still under development and subject to change.

block_api.get_block

Retrieve a full, signed block of the referenced block, or null if no matching block was found.

Parameters:

block_num (int)  
1 Queries the very first block.
8675309 Queries block number 8,675,309.
62396745 Queries block number 62,396,745.
Query Parameters JSON
{"block_num": 0}
Expected Response JSON
{
  "block": {
    "previous": "0000000000000000000000000000000000000000",
    "timestamp": "2016-03-24T16:05:00",
    "witness": "",
    "transaction_merkle_root": "0000000000000000000000000000000000000000",
    "extensions": [],
    "witness_signature": "",
    "transactions": [],
    "block_id": "",
    "signing_key": "",
    "transaction_ids": []
  }
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"block_api.get_block", "params":{"block_num":1}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"block_api.get_block", "params":{"block_num":8675309}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"block_api.get_block", "params":{"block_num":62396745}, "id":1}' https://api.hive.blog

block_api.get_block_header

Retrieve a block header of the referenced block, or null if no matching block was found.

Parameters:

block_num (int)  
1 Queries the block headers for the very first block.
8675309 Queries block headers for block number 8,675,309.
62396745 Queries block headers for block number 62,396,745.
Query Parameters JSON
{"block_num": 0}
Expected Response JSON
{
  "header": {
    "previous": "0000000000000000000000000000000000000000",
    "timestamp": "2016-03-24T16:05:00",
    "witness": "",
    "transaction_merkle_root": "0000000000000000000000000000000000000000",
    "extensions": []
  }
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"block_api.get_block_header", "params":{"block_num":1}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"block_api.get_block_header", "params":{"block_num":8675309}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"block_api.get_block_header", "params":{"block_num":62396745}, "id":1}' https://api.hive.blog

block_api.get_block_range

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.

Parameters:

starting_block_num (int) count (int)  
1 10 Queries the block headers for the very first block through the tenth block.
8675309 50 Queries block headers for block numbers 8,675,309 through 8,675,359.
62396745 1000 Queries block headers for block numbers 62,396,745 through 62,397,745.

See: !149, 702ea4a

Query Parameters JSON
{"starting_block_num": 0, "count": 0}
Expected Response JSON
{"blocks": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"block_api.get_block_range", "params":{"starting_block_num": 1, "count": 10}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"block_api.get_block_range", "params":{"starting_block_num": 8675309, "count": 50}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"block_api.get_block_range", "params":{"starting_block_num": 62396745, "count": 1000}, "id":1}' https://api.hive.blog

Bridge

Methods:

Presents data interpreted by the hivemind database as JSON-RPC.

Also see: Communities Broadcast Ops

bridge.get_ranked_posts

Get ranked posts.

Supported values for sort:

The value for tag can be any valid tag.

The value for observer can be any valid account or empty string.

Query Parameters JSON
{"sort": "", "tag": "", "observer": ""}
Expected Response JSON
[
  {
    "post_id": 12345678,
    "author": "alice",
    "permlink": "that-march-hare",
    "category": "wonderland",
    "title": "That March Hare",
    "body": "I think he went mad.",
    "json_metadata": {
      "tags": ["wonderland"],
      "app": "hiveblog/0.1"
    },
    "created": "2019-12-05T16:29:12",
    "updated": "2019-12-05T16:29:12",
    "depth": 0,
    "children": 0,
    "net_rshares": 1539574839484,
    "is_paidout": false,
    "payout_at": "2019-12-12T16:29:12",
    "payout": 0.286,
    "pending_payout_value": "0.286 HBD",
    "author_payout_value": "0.000 HBD",
    "curator_payout_value": "0.000 HBD",
    "promoted": "0.000 HBD",
    "replies": [],
    "active_votes": [{"voter": "bob", "rshares": "67759296290"}],
    "author_reputation": 47.15,
    "stats": {
      "hide": false,
      "gray": false,
      "total_votes": 12,
      "flag_weight": 0
    },
    "beneficiaries": [],
    "max_accepted_payout": "1000000.000 HBD",
    "percent_hbd": 10000,
    "url": "/wonderland/@alice/that-march-hare",
    "blacklists": []
  }
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_ranked_posts", "params":{"sort":"trending","tag":"","observer":"alice"}, "id":1}' https://api.hive.blog

bridge.account_notifications

Account notifications.

Supported values for type:

The score value is based on the originating account’s rank.

Query Parameters JSON
{"account": "alice", "limit": 100}
Expected Response JSON
[
  {
    "id": 3629306,
    "type": "vote",
    "score": 25,
    "date": "2019-11-20T07:48:06",
    "msg": "@bob voted on your post ($0.013)",
    "url": "@alice/a-post-by-alice"
  }
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.account_notifications", "params":{"account":"alice","limit":100}, "id":1}' https://api.hive.blog

bridge.does_user_follow_any_lists

Checks if a given observer follows any blacklists or mute lists.

Query Parameters JSON
{"observer": "alice"}
Expected Response JSON
false
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.does_user_follow_any_lists", "params":{"observer":"alice"}, "id":1}' https://api.hive.blog

bridge.get_account_posts

Lists posts related to a given account.

Query Parameters JSON
{"sort": "blog", "account": "alice", "limit": 1}
Expected Response JSON
[
  {
    "post_id": 101867403,
    "author": "hiveio",
    "permlink": "around-the-hive-reflections",
    "category": "hiveecosystem",
    "title": "Around the Hive: Reflections",
    "body": "It's been a busy year so far for developers on Hive. Layer 2 solutions are in progress, key optimization is an ongoing priority ...",
    "json_metadata": {
      "tags": ["hiveecosystem"],
      "users": ["blocktrades", "howo"],
      "image": [
        "https://images.hive.blog/768x0/https://files.peakd.com/file/peakd-hive/hiveio/pKjrNcbK-Hive-Wallpaper-1920x1080.png",
        "https://images.hive.blog/DQmR3iwCn9yvwXDXfuNjmMX6FrjAvFfYQWgA4QRckpens1j/hive%20dividers-02.png"
      ],
      "links": [
        "https://gitlab.syncad.com/hive/hive-whitepaper/-/blob/master/technical-vision/infographic.pdf"
      ],
      "app": "hiveblog/0.1",
      "format": "markdown",
      "description": "The strength of Hive lies in our decentralization."
    },
    "created": "2021-02-14T08:16:03",
    "updated": "2021-02-14T08:16:03",
    "depth": 0,
    "children": 15,
    "net_rshares": 93531156115025,
    "is_paidout": true,
    "payout_at": "2021-02-21T08:16:03",
    "payout": 0,
    "pending_payout_value": "0.000 HBD",
    "author_payout_value": "0.000 HBD",
    "curator_payout_value": "0.000 HBD",
    "promoted": "0.000 HBD",
    "replies": [],
    "author_reputation": 69.29,
    "stats": {
      "hide": false,
      "gray": false,
      "total_votes": 129,
      "flag_weight": 0
    },
    "url": "/hiveecosystem/@hiveio/around-the-hive-reflections",
    "beneficiaries": [],
    "max_accepted_payout": "0.000 HBD",
    "percent_hbd": 10000,
    "active_votes": [],
    "blacklists": []
  }
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_account_posts", "params":{"sort":"blog", "account": "alice", "limit": 1}, "id":1}' https://api.hive.blog

bridge.get_community_context

Gets the role, subscription status, and title for a given account in a given community.

Query Parameters JSON
{"name": "hive-111111", "account": "therealwolf"}
Expected Response JSON
{
  "role": "admin",
  "subscribed": true,
  "title": "Witness: @therealwolf"
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_community_context", "params":{"name": "hive-111111", "account": "therealwolf"}, "id":1}' https://api.hive.blog

bridge.get_discussion

Gives a flattened discussion tree starting at given post.

Query Parameters JSON
{
  "author": "hiveio",
  "permlink": "around-the-hive-reflections",
  "observer": "alice"
}
Expected Response JSON
{
  "hiveio/around-the-hive-reflections": {
    "post_id": 101867403,
    "author": "hiveio",
    "permlink": "around-the-hive-reflections",
    "category": "hiveecosystem",
    "title": "Around the Hive: Reflections",
    "body": "It's been a busy year so far for developers on Hive. Layer 2 solutions are in progress, key optimization is an ongoing priority ...",
    "json_metadata": {
      "tags": ["hiveecosystem"],
      "users": ["blocktrades", "howo"],
      "image": [
        "https://images.hive.blog/768x0/https://files.peakd.com/file/peakd-hive/hiveio/pKjrNcbK-Hive-Wallpaper-1920x1080.png",
        "https://images.hive.blog/DQmR3iwCn9yvwXDXfuNjmMX6FrjAvFfYQWgA4QRckpens1j/hive%20dividers-02.png"
      ],
      "links": [
        "https://gitlab.syncad.com/hive/hive-whitepaper/-/blob/master/technical-vision/infographic.pdf"
      ],
      "app": "hiveblog/0.1",
      "format": "markdown",
      "description": "The strength of Hive lies in our decentralization."
    },
    "created": "2021-02-14T08:16:03",
    "updated": "2021-02-14T08:16:03",
    "depth": 0,
    "children": 15,
    "net_rshares": 93531156115025,
    "is_paidout": true,
    "payout_at": "2021-02-21T08:16:03",
    "payout": 0,
    "pending_payout_value": "0.000 HBD",
    "author_payout_value": "0.000 HBD",
    "curator_payout_value": "0.000 HBD",
    "promoted": "0.000 HBD",
    "replies": [],
    "author_reputation": 69.29,
    "stats": {
      "hide": false,
      "gray": false,
      "total_votes": 129,
      "flag_weight": 0
    },
    "url": "/hiveecosystem/@hiveio/around-the-hive-reflections",
    "beneficiaries": [],
    "max_accepted_payout": "0.000 HBD",
    "percent_hbd": 10000,
    "active_votes": [],
    "blacklists": []
  }
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_discussion", "params":{"author": "hiveio", "permlink": "around-the-hive-reflections", "observer": "alice"}, "id":1}' https://api.hive.blog

bridge.get_follow_list

Returns blacklisted/muted accounts or list of blacklists/mute lists followed by a given observer.

Query Parameters JSON
{
  "observer": "blocktrades",
  "follow_type": "follow_blacklist"
}
Expected Response JSON
[
  {
    "name": "hive.blog",
    "blacklist_description": "",
    "muted_list_description": ""
  }
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_follow_list", "params":{"observer": "blocktrades", "follow_type": "follow_blacklist"}, "id":1}' https://api.hive.blog

bridge.get_profile

Gets profile

Query Parameters JSON
{"account": "alice", "observer": "bob"}
Expected Response JSON
{
  "id": 241,
  "name": "alice",
  "created": "2016-03-25T15:09:27",
  "active": "2016-04-29T22:28:00",
  "post_count": 0,
  "reputation": 25,
  "blacklists": [],
  "stats": {"rank": 0, "following": 0, "followers": 431},
  "metadata": {
    "profile": {
      "name": "",
      "about": "",
      "website": "",
      "location": "",
      "cover_image": "",
      "profile_image": "",
      "blacklist_description": "",
      "muted_list_description": ""
    }
  },
  "context": {"followed": false}
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_profile", "params":{"account": "alice", "observer": "bob"}, "id":1}' https://api.hive.blog

bridge.list_communities

Gets community

Query Parameters JSON
{"limit": 1, "query": "wall street bets"}
Expected Response JSON
[
  {
    "id": 1432978,
    "name": "hive-103566",
    "title": "Wall Street Bets",
    "about": "Wall Street Bets - In Case Reddit Shuts Down.",
    "lang": "en",
    "type_id": 1,
    "is_nsfw": false,
    "subscribers": 6,
    "sum_pending": 0,
    "num_pending": 0,
    "num_authors": 0,
    "created_at": "2021-01-28 18:34:09",
    "avatar_url": "",
    "context": {},
    "admins": ["spitr"]
  }
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.list_communities", "params":{"limit": 1, "query": "wall street bets"}, "id":1}' https://api.hive.blog

bridge.list_pop_communities

Gets a list of popular communities.

Query Parameters JSON
{"limit": 10}
Expected Response JSON
[
  ["hive-167922", "LeoFinance"],
  ["hive-194913", "Photography Lovers"],
  ["hive-148441", "GEMS"],
  ["hive-196037", "DTube"],
  ["hive-196708", "Hive Pets"],
  ["hive-120586", "Foodies Bee Hive"],
  ["hive-140217", "Hive Gaming"],
  ["hive-174578", "OCD"],
  ["hive-129496", "Nerday"],
  ["hive-193816", "Music"]
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.list_pop_communities", "params":{"limit": 10}, "id":1}' https://api.hive.blog

bridge.list_subscribers

Gets a list of subscribers for a given community.

Query Parameters JSON
{"community": "hive-111111", "limit": 10}
Expected Response JSON
[
  [
    "gatticus",
    "guest",
    null,
    "2021-02-18 13:15:42"
  ],
  [
    "thewarkettle",
    "guest",
    null,
    "2021-02-15 22:04:36"
  ],
  [
    "darkflame",
    "guest",
    null,
    "2021-02-14 00:30:12"
  ],
  [
    "oiuygtfrd76543",
    "guest",
    null,
    "2021-02-01 19:35:03"
  ],
  ["bhattg", "guest", null, "2021-02-01 18:39:06"],
  [
    "elenahornfilm",
    "guest",
    null,
    "2021-02-01 09:19:54"
  ],
  [
    "mrhappypants",
    "guest",
    null,
    "2021-02-01 01:03:48"
  ],
  [
    "petrahaller",
    "guest",
    null,
    "2021-02-01 00:08:09"
  ],
  [
    "hgregoria",
    "guest",
    null,
    "2021-01-29 18:46:12"
  ],
  [
    "theblockabout",
    "guest",
    null,
    "2021-01-29 15:21:48"
  ]
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.list_subscribers", "params":{"community": "hive-111111", "limit": 10}, "id":1}' https://api.hive.blog

bridge.list_community_roles

List community roles and labels for each account in the community.

Query Parameters JSON
{"community": "hive-123456"}
Expected Response JSON
[
  ["hive-123456", "owner", ""],
  ["alice", "admin", "Miss"]
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.list_community_roles", "params":{"community":"hive-123456"}, "id":1}' https://api.hive.blog

bridge.list_all_subscriptions

List all subscriptions, titles, and roles to a community for an account.

Query Parameters JSON
{"account": "alice"}
Expected Response JSON
[
  ["hive-123456", "Wonderland", "guest", ""],
  [
    "hive-654321",
    "Tulgey Wood",
    "admin",
    "Mrs. Vex"
  ]
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.list_all_subscriptions", "params":{"account":"alice"}, "id":1}' https://api.hive.blog

bridge.get_community

Get community details.

Query Parameters JSON
{"name": "hive-123456", "observer": "alice"}
Expected Response JSON
{
  "id": 1332149,
  "name": "hive-123456",
  "title": "@hive-123456",
  "about": "Wonderland",
  "lang": "en",
  "type_id": 1,
  "is_nsfw": false,
  "subscribers": 0,
  "sum_pending": 0,
  "num_pending": 0,
  "num_authors": 0,
  "created_at": "2019-10-27 08:28:54",
  "context": {
    "role": "admin",
    "title": "Miss",
    "subscribed": true
  },
  "avatar_url": "",
  "description": "",
  "flag_text": "",
  "settings": {},
  "team": [
    ["hive-123456", "owner", ""],
    ["alice", "admin", "Miss"]
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_community", "params":{"name":"hive-123456","observer":"alice"}, "id":1}' https://api.hive.blog

bridge.get_relationship_between_accounts

Tells what relations connect given accounts from the perspective of first account.

Query Parameters JSON
["alice", "bob"]
Expected Response JSON
{
  "follows": false,
  "ignores": false,
  "blacklists": false,
  "follows_blacklists": false,
  "follows_muted": false
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_relationship_between_accounts", "params":["alice", "bob"], "id":1}' https://api.hive.blog

bridge.get_payout_stats

Lists communities ordered by payout with stats (total payout, number of posts and authors).

Query Parameters JSON
{"limit": 250}
Expected Response JSON
{
  "items": [
    [
      "hive-167922",
      "LeoFinance",
      10881.39,
      16791,
      1466
    ]
  ],
  "total": 107662.592,
  "blogs": 14453.794
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_payout_stats", "params":{"limit": 1}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_payout_stats", "params":{"limit": 250}, "id":1}' https://api.hive.blog

bridge.get_post

Gives single selected post.

Query Parameters JSON
{
  "author": "hiveio",
  "permlink": "around-the-hive-reflections"
}
Expected Response JSON
{
  "post_id": 101867403,
  "author": "hiveio",
  "permlink": "around-the-hive-reflections",
  "category": "hiveecosystem",
  "title": "Around the Hive: Reflections",
  "body": "It's been a busy year so far for developers on Hive. Layer 2 solutions are in progress, key optimization is an ongoing priority ...",
  "json_metadata": {
    "tags": ["hiveecosystem"],
    "users": ["blocktrades", "howo"],
    "image": [
      "https://images.hive.blog/768x0/https://files.peakd.com/file/peakd-hive/hiveio/pKjrNcbK-Hive-Wallpaper-1920x1080.png",
      "https://images.hive.blog/DQmR3iwCn9yvwXDXfuNjmMX6FrjAvFfYQWgA4QRckpens1j/hive%20dividers-02.png"
    ],
    "links": [
      "https://gitlab.syncad.com/hive/hive-whitepaper/-/blob/master/technical-vision/infographic.pdf"
    ],
    "app": "hiveblog/0.1",
    "format": "markdown",
    "description": "The strength of Hive lies in our decentralization."
  },
  "created": "2021-02-14T08:16:03",
  "updated": "2021-02-14T08:16:03",
  "depth": 0,
  "children": 15,
  "net_rshares": 93531156115025,
  "is_paidout": true,
  "payout_at": "2021-02-21T08:16:03",
  "payout": 0,
  "pending_payout_value": "0.000 HBD",
  "author_payout_value": "0.000 HBD",
  "curator_payout_value": "0.000 HBD",
  "promoted": "0.000 HBD",
  "replies": [],
  "author_reputation": 69.29,
  "stats": {
    "hide": false,
    "gray": false,
    "total_votes": 129,
    "flag_weight": 0
  },
  "url": "/hiveecosystem/@hiveio/around-the-hive-reflections",
  "beneficiaries": [],
  "max_accepted_payout": "0.000 HBD",
  "percent_hbd": 10000,
  "active_votes": [],
  "blacklists": []
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_post", "params":{"author": "alice", "permlink": "that-march-hare", "observer": "bob"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_post", "params":{"author": "hiveio", "permlink": "around-the-hive-reflections"}, "id":1}' https://api.hive.blog

bridge.get_post_header

Gives very basic information on given post.

Query Parameters JSON
{
  "author": "hiveio",
  "permlink": "around-the-hive-reflections"
}
Expected Response JSON
{
  "author": "hiveio",
  "permlink": "around-the-hive-reflections",
  "category": "hiveecosystem",
  "depth": 0
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_post_header", "params":{"author": "alice", "permlink": "that-march-hare"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_post_header", "params":{"author": "hiveio", "permlink": "around-the-hive-reflections"}, "id":1}' https://api.hive.blog

Condenser API

Methods:

To help with this transition, we created condenser_api, which contains all of the API methods that currently exist and uses the existing argument formatting. The easiest way to get your app to work with Appbase is to change the api to condenser_api.

All calls in condenser_api will return [] as the argument, as the array argument passing is opaque and implemented in the API calls themselves. They follow the current argument formatting. Existing apps should only need to skip using login_api and send all of their calls to condenser_api without any other changes required to use Appbase.

For example, calling get_dynamic_global_properties with condenser_api vs database_api:

{"jsonrpc":"2.0", "method":"condenser_api.get_dynamic_global_properties", "params":[], "id":1}
{"jsonrpc":"2.0", "method":"database_api.get_dynamic_global_properties", "id":1}

Because the method has no arguments, the params field can be omitted when not using condenser_api. However, it can optionally be included as the void type (e.g. "params":{}) but it is not required.

condenser_api.broadcast_transaction

Used to broadcast a transaction.

Also see: network_broadcast_api.broadcast_transaction

Query Parameters JSON
[
  {
    "ref_block_num": 0,
    "ref_block_prefix": 0,
    "expiration": "1970-01-01T00:00:00",
    "operations": [],
    "extensions": [],
    "signatures": []
  }
]
Expected Response JSON
{}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.broadcast_transaction", "params":[{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[["vote",{"voter":"hiveio","author":"alice","permlink":"a-post-by-alice","weight":10000}]],"extensions":[],"signatures":[]}], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.broadcast_transaction", "params":[{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[["pow",{"worker_account":"cloop3","block_id":"00000449f7860b82b4fbe2f317c670e9f01d6d9a","nonce":3899,"work":{"worker":"STM7P5TDnA87Pj9T4mf6YHrhzjC1KbPZpNxLWCcVcHxNYXakpoT4F","input":"ae8e7c677119d22385f8c48026fee7aad7bba693bf788d7f27047f40b47738c0","signature":"1f38fe9a3f9989f84bd94aa5bbc88beaf09b67f825aa4450cf5105d111149ba6db560b582c7dbb026c7fc9c2eb5051815a72b17f6896ed59d3851d9a0f9883ca7a","work":"000e7b209d58f2e64b36e9bf12b999c6c7af168cc3fc41eb7f8a4bf796c174c3"},"props":{"account_creation_fee":{"amount":"100000","precision":3,"nai":"@@000000021"},"maximum_block_size":131072,"hbd_interest_rate":1000}}]],"extensions":[],"signatures":[]}], "id":1}' https://api.hive.blog

condenser_api.broadcast_transaction_synchronous

Used to broadcast a transaction and waits for it to be processed synchronously.

Query Parameters JSON
[
  {
    "ref_block_num": 0,
    "ref_block_prefix": 0,
    "expiration": "1970-01-01T00:00:00",
    "operations": [],
    "extensions": [],
    "signatures": []
  }
]
Expected Response JSON
{
  "id": "0000000000000000000000000000000000000000",
  "block_num": 0,
  "trx_num": 0,
  "expired": false
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.broadcast_transaction_synchronous", "params":[{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[["vote",{"voter":"hiveio","author":"alice","permlink":"a-post-by-alice","weight":10000}]],"extensions":[],"signatures":[]}], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.broadcast_transaction_synchronous", "params":[{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[["pow",{"worker_account":"cloop3","block_id":"00000449f7860b82b4fbe2f317c670e9f01d6d9a","nonce":3899,"work":{"worker":"STM7P5TDnA87Pj9T4mf6YHrhzjC1KbPZpNxLWCcVcHxNYXakpoT4F","input":"ae8e7c677119d22385f8c48026fee7aad7bba693bf788d7f27047f40b47738c0","signature":"1f38fe9a3f9989f84bd94aa5bbc88beaf09b67f825aa4450cf5105d111149ba6db560b582c7dbb026c7fc9c2eb5051815a72b17f6896ed59d3851d9a0f9883ca7a","work":"000e7b209d58f2e64b36e9bf12b999c6c7af168cc3fc41eb7f8a4bf796c174c3"},"props":{"account_creation_fee":{"amount":"10000","precision":3,"nai":"@@000000021"},"maximum_block_size":131072,"hbd_interest_rate":1000}}]],"extensions":[],"signatures":[]}], "id":1}' https://api.hive.blog

condenser_api.get_account_count

Returns the number of accounts.

Query Parameters JSON
[]
Expected Response JSON
0
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_account_count", "params":[], "id":1}' https://api.hive.blog

condenser_api.get_account_history

Returns a history of all operations for a given account. Parameters:

If either operation_filter_low or operation_filter_high are set, the set of returned operations will include only these matching bitwise filter.

For the first 64 operations (as defined in protocol/operations.hpp), set the corresponding bit in operation_filter_low; for the higher-numbered operations, set the bit in operation_filter_high (pretending operation_filter is a 128-bit bitmask composed of {operation_filter_high, operation_filter_low})

account (string) start (int) limit (int) operation_filter_low (int) operation_filter_low (int)  
"hiveio" 1000 1000     Queries the account named hiveio starting on the latest item in history, up to 1,000 results.
"alice" -1 1000     Queries the account named alice starting on the oldest item in history, up to 1,000 results.
"bob" -1 1000 1   Queries only votes by the account named bob starting on the oldest item in history, up to 1,000 results.
"charlie" -1 1000 262144   Queries only custom jsons by the account named charlie starting on the oldest item in history, up to 1,000 results.
"emma" -1 1000 0 1 Queries only proposal payments by the account named emma starting on the oldest item in history, up to 1,000 results.

Also see: account_history_api.get_account_history, Paginated API Methods

Query Parameters JSON
["", 0, 1000]
Expected Response JSON
[
  99,
  {
    "trx_id": "0000000000000000000000000000000000000000",
    "block": 0,
    "trx_in_block": 4294967295,
    "op_in_trx": 0,
    "virtual_op": 0,
    "timestamp": "2019-12-09T21:32:39",
    "op": {}
  }
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_account_history", "params":["hiveio", 1000, 1000], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_account_history", "params":["hiveio", -1, 1000], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_account_history", "params":["bob", -1, 1000, 1], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_account_history", "params":["charlie", -1, 1000, 262144], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_account_history", "params":["emma", -1, 1000, 0, 1], "id":1}' https://api.hive.blog

condenser_api.get_account_reputations

Returns a list of account reputations. Parameters: account_lower_bound:string; limit:int up to 1000

account_lower_bound (string) limit (int)  
"hiveio" 1 Queries for accounts that start with “hiveio”, only one result.
"a" 10 Queries for accounts that start with “a”, up to 10 results.

Also see: follow_api.get_account_reputations

Query Parameters JSON
["", 1000]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_account_reputations", "params":["hiveio", 1], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_account_reputations", "params":["a", 10], "id":1}' https://api.hive.blog

condenser_api.get_accounts

Returns accounts, queried by name. Parameters: account:string array; delayed_votes_active:boolean

account (string array) delayed_votes_active (boolean)  
["hiveio"]   Queries for account named “hiveio”.
["hiveio", "alice"] false Queries for accounts named “hiveio” and “alice” with delayed_votes hidden.

Also see: database_api.find_accounts

Query Parameters JSON
[[""]]
Expected Response JSON
{
  "id": 1370484,
  "name": "hiveio",
  "owner": {
    "weight_threshold": 1,
    "account_auths": [],
    "key_auths": [
      [
        "STM65PUAPA4yC4RgPtGgsPupxT6yJtMhmT5JHFdsT3uoCbR8WJ25s",
        1
      ]
    ]
  },
  "active": {
    "weight_threshold": 1,
    "account_auths": [],
    "key_auths": [
      [
        "STM69zfrFGnZtU3gWFWpQJ6GhND1nz7TJsKBTjcWfebS1JzBEweQy",
        1
      ]
    ]
  },
  "posting": {
    "weight_threshold": 1,
    "account_auths": [["threespeak", 1], ["vimm.app", 1]],
    "key_auths": [
      [
        "STM6vJmrwaX5TjgTS9dPH8KsArso5m91fVodJvv91j7G765wqcNM9",
        1
      ]
    ]
  },
  "memo_key": "STM7wrsg1BZogeK7X3eG4ivxmLaH69FomR8rLkBbepb3z3hm5SbXu",
  "json_metadata": "",
  "posting_json_metadata": "{\"profile\":{\"pinned\":\"none\",\"version\":2,\"website\":\"hive.io\",\"profile_image\":\"https://files.peakd.com/file/peakd-hive/hiveio/Jp2YHc6Q-hive-logo.png\",\"cover_image\":\"https://files.peakd.com/file/peakd-hive/hiveio/Xe1TcEBi-hive-banner.png\"}}",
  "proxy": "",
  "last_owner_update": "1970-01-01T00:00:00",
  "last_account_update": "2020-11-12T01:20:48",
  "created": "2020-03-06T12:22:48",
  "mined": false,
  "recovery_account": "steempeak",
  "last_account_recovery": "1970-01-01T00:00:00",
  "reset_account": "null",
  "comment_count": 0,
  "lifetime_vote_count": 0,
  "post_count": 31,
  "can_vote": true,
  "voting_manabar": {
    "current_mana": "598442432741",
    "last_update_time": 1591297380
  },
  "downvote_manabar": {
    "current_mana": "149610608184",
    "last_update_time": 1591297380
  },
  "voting_power": 0,
  "balance": "11.682 HIVE",
  "savings_balance": "0.000 HIVE",
  "hbd_balance": "43.575 HBD",
  "hbd_seconds": "0",
  "hbd_seconds_last_update": "2020-10-21T02:45:12",
  "hbd_last_interest_payment": "2020-10-21T02:45:12",
  "savings_hbd_balance": "0.000 HBD",
  "savings_hbd_seconds": "0",
  "savings_hbd_seconds_last_update": "1970-01-01T00:00:00",
  "savings_hbd_last_interest_payment": "1970-01-01T00:00:00",
  "savings_withdraw_requests": 0,
  "reward_hbd_balance": "0.000 HBD",
  "reward_hive_balance": "0.000 HIVE",
  "reward_vesting_balance": "0.000000 VESTS",
  "reward_vesting_hive": "0.000 HIVE",
  "vesting_shares": "598442.432741 VESTS",
  "delegated_vesting_shares": "0.000000 VESTS",
  "received_vesting_shares": "0.000000 VESTS",
  "vesting_withdraw_rate": "0.000000 VESTS",
  "post_voting_power": "598442.432741 VESTS",
  "next_vesting_withdrawal": "1969-12-31T23:59:59",
  "withdrawn": 0,
  "to_withdraw": 0,
  "withdraw_routes": 0,
  "pending_transfers": 0,
  "curation_rewards": 0,
  "posting_rewards": 604589,
  "proxied_vsf_votes": [0, 0, 0, 0],
  "witnesses_voted_for": 0,
  "last_post": "2021-03-23T18:05:48",
  "last_root_post": "2021-03-23T18:05:48",
  "last_vote_time": "1970-01-01T00:00:00",
  "post_bandwidth": 0,
  "pending_claimed_accounts": 0,
  "delayed_votes": [
    {
      "time": "2021-02-24T05:08:21",
      "val": "11550765516955"
    },
    {
      "time": "2021-02-26T15:46:06",
      "val": "633465684569"
    },
    {
      "time": "2021-03-07T17:54:39",
      "val": "1000000037683"
    },
    {
      "time": "2021-03-16T05:54:33",
      "val": "999978763511"
    },
    {
      "time": "2021-03-18T06:06:00",
      "val": "1000000171317"
    }
  ],
  "vesting_balance": "0.000 HIVE",
  "reputation": "88826789432105",
  "transfer_history": [],
  "market_history": [],
  "post_history": [],
  "vote_history": [],
  "other_history": [],
  "witness_votes": [],
  "tags_usage": [],
  "guest_bloggers": []
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_accounts", "params":[["hiveio"]], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_accounts", "params":[["hiveio", "alice"], true], "id":1}' https://api.hive.blog

condenser_api.get_active_votes

Returns all votes for the given post. Parameters: author:string; permlink:string

author (string) permlink (string)  
"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
Query Parameters JSON
["", ""]
Expected Response JSON
[
  {
    "voter": "",
    "weight": "",
    "rshares": 0,
    "percent": 0,
    "reputation": "",
    "time": "1970-01-01T00:00:00"
  }
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_active_votes", "params":["hiveio", "firstpost"], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_active_votes", "params":["alice", "a-post-by-alice"], "id":1}' https://api.hive.blog

condenser_api.get_active_witnesses

Returns the list of active witnesses.

Also see: database_api.get_active_witnesses

Query Parameters JSON
[]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_active_witnesses", "params":[], "id":1}' https://api.hive.blog

condenser_api.get_block

Returns a block. Parameters: block_num:int

block_num (int)  
1 Queries the very first block.
8675309 Queries block number 8,675,309.
62396745 Queries block number 62,396,745.

Also see: block_api.get_block

Query Parameters JSON
[1]
Expected Response JSON
{
  "previous": "0000000000000000000000000000000000000000",
  "timestamp": "2016-03-24T16:05:00",
  "witness": "initminer",
  "transaction_merkle_root": "0000000000000000000000000000000000000000",
  "extensions": [],
  "witness_signature": "204f8ad56a8f5cf722a02b035a61b500aa59b9519b2c33c77a80c0a714680a5a5a7a340d909d19996613c5e4ae92146b9add8a7a663eef37d837ef881477313043",
  "transactions": [],
  "block_id": "0000000109833ce528d5bbfb3f6225b39ee10086",
  "signing_key": "STM8GC13uCZbP44HzMLV6zPZGwVQ8Nt4Kji8PapsPiNq1BK153XTX",
  "transaction_ids": []
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_block", "params":[1], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_block", "params":[8675309], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_block", "params":[62396745], "id":1}' https://api.hive.blog

condenser_api.get_block_header

Returns a block header. Parameters: block_num:int

block_num (int)  
1 Queries the block headers for the very first block.
8675309 Queries block headers for block number 8,675,309.
62396745 Queries block headers for block number 62,396,745.

Also see: block_api.get_block_header

Query Parameters JSON
[1]
Expected Response JSON
{
  "previous": "0000000000000000000000000000000000000000",
  "timestamp": "2016-03-24T16:05:00",
  "witness": "initminer",
  "transaction_merkle_root": "0000000000000000000000000000000000000000",
  "extensions": []
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_block_header", "params":[1], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_block_header", "params":[8675309], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_block_header", "params":[62396745], "id":1}' https://api.hive.blog

condenser_api.get_blog

Returns the list of blog entries for an account. Parameters: account:string; start_entry_id:int; limit:int up to 500

account (string) start_entry_id (int) limit (int)  
“hiveio” 0 1 Queries the blog for the account named “hiveio”, up to one result.
“alice” 0 50 Queries the blog for the account named “alice”, up to 50 results.

Also see: Paginated API Methods

Query Parameters JSON
["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
  }
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_blog", "params":["hiveio",0,1], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_blog", "params":["alice",0,50], "id":1}' https://api.hive.blog

condenser_api.get_blog_authors

Returns a list of authors that have had their content reblogged on a given blog account. Parameters: account:string

account (string)  
"hiveio" Queries for account named “hiveio”.
"alice" Queries for accounts named alice”.
Query Parameters JSON
[""]
Expected Response JSON
[{"author": "", "count": 0}]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_blog_authors", "params":["hiveio"], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_blog_authors", "params":["alice"], "id":1}' https://api.hive.blog

condenser_api.get_blog_entries

Returns a list of blog entries for an account. Parameters: account:string; start_entry_id:int; limit:int up to 500

account (string) start_entry_id (int) limit (int)  
“hiveio” 0 1 Queries the blog entries for the account named “hiveio”, up to one result.
“alice” 0 50 Queries the blog entries for the account named “alice”, up to 50 results.

Also see: Paginated API Methods

Query Parameters JSON
["hiveio", 0, 1]
Expected Response JSON
[
  {
    "author": "hiveio",
    "permlink": "firstpost",
    "blog": "hiveio",
    "reblog_on": "1970-01-01T00:00:00",
    "entry_id": 0
  }
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_blog_entries", "params":["hiveio",0,1], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_blog_entries", "params":["alice",0,50], "id":1}' https://api.hive.blog

condenser_api.get_chain_properties

Returns the chain properties.

Query Parameters JSON
[]
Expected Response JSON
{
  "account_creation_fee": "0.100 HIVE",
  "maximum_block_size": 131072,
  "hbd_interest_rate": 1000,
  "account_subsidy_limit": 0
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_chain_properties", "params":[], "id":1}' https://api.hive.blog

condenser_api.get_comment_discussions_by_payout

Returns a list of discussions based on payout.

Also see: tags_api.get_comment_discussions_by_payout

Query Parameters JSON
[
  {
    "tag": "",
    "limit": 0,
    "filter_tags": [],
    "select_authors": [],
    "select_tags": [],
    "truncate_body": 0
  }
]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_comment_discussions_by_payout", "params":[{"tag":"hive","limit":1}], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_comment_discussions_by_payout", "params":[{"tag":"photography","limit":10,"truncate_body":0}], "id":1}' https://api.hive.blog

condenser_api.get_config

Returns information about compile-time constants. See: Understanding Configuration Values

Also see: database_api.get_config

Query Parameters JSON
[]
Expected Response JSON
{}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_config", "params":[], "id":1}' https://api.hive.blog

condenser_api.get_content

Returns the content (post or comment). Parameters: author:string; permlink:string

author (string) permlink (string)  
"hiveio" "firstpost" Queries content with a slug @hiveio/firstpost
"alice" "a-post-by-alice" Queries content with a slug @alice/a-post-by-alice
Query Parameters JSON
["", ""]
Expected Response JSON
{
  "id": 0,
  "author": "",
  "permlink": "",
  "category": "",
  "parent_author": "",
  "parent_permlink": "",
  "title": "",
  "body": "",
  "json_metadata": "",
  "last_update": "1970-01-01T00:00:00",
  "created": "1970-01-01T00:00:00",
  "active": "1970-01-01T00:00:00",
  "last_payout": "1970-01-01T00:00:00",
  "depth": 0,
  "children": 0,
  "net_rshares": 0,
  "abs_rshares": 0,
  "vote_rshares": 0,
  "children_abs_rshares": 0,
  "cashout_time": "1970-01-01T00:00:00",
  "max_cashout_time": "1970-01-01T00:00:00",
  "total_vote_weight": 0,
  "reward_weight": 0,
  "total_payout_value": "0.000 HIVE",
  "curator_payout_value": "0.000 HIVE",
  "author_rewards": 0,
  "net_votes": 0,
  "root_author": "",
  "root_permlink": "",
  "max_accepted_payout": "0.000 HIVE",
  "percent_hbd": 0,
  "allow_replies": false,
  "allow_votes": false,
  "allow_curation_rewards": false,
  "beneficiaries": [],
  "url": "",
  "root_title": "",
  "pending_payout_value": "0.000 HIVE",
  "total_pending_payout_value": "0.000 HIVE",
  "active_votes": [],
  "replies": [],
  "author_reputation": 0,
  "promoted": "0.000 HIVE",
  "body_length": 0,
  "reblogged_by": []
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_content", "params":["hiveio", "firstpost"], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_content", "params":["alice", "a-post-by-alice"], "id":1}' https://api.hive.blog

condenser_api.get_content_replies

Returns a list of replies. Parameters: author:string; permlink:string

author (string) permlink (string)  
"hiveio" "firstpost" Queries replies for a slug @hiveio/firstpost
"alice" "a-post-by-alice" Queries replies for a slug @alice/a-post-by-alice

Also see: tags_api.get_content_replies

Query Parameters JSON
["", ""]
Expected Response JSON
{
  "id": 0,
  "author": "",
  "permlink": "",
  "category": "",
  "parent_author": "",
  "parent_permlink": "",
  "title": "",
  "body": "",
  "json_metadata": "",
  "last_update": "1970-01-01T00:00:00",
  "created": "1970-01-01T00:00:00",
  "active": "1970-01-01T00:00:00",
  "last_payout": "1970-01-01T00:00:00",
  "depth": 0,
  "children": 0,
  "net_rshares": 0,
  "abs_rshares": 0,
  "vote_rshares": 0,
  "children_abs_rshares": 0,
  "cashout_time": "1970-01-01T00:00:00",
  "max_cashout_time": "1970-01-01T00:00:00",
  "total_vote_weight": 0,
  "reward_weight": 0,
  "total_payout_value": "0.000 HIVE",
  "curator_payout_value": "0.000 HIVE",
  "author_rewards": 0,
  "net_votes": 0,
  "root_author": "",
  "root_permlink": "",
  "max_accepted_payout": "0.000 HIVE",
  "percent_hbd": 0,
  "allow_replies": false,
  "allow_votes": false,
  "allow_curation_rewards": false,
  "beneficiaries": [],
  "url": "",
  "root_title": "",
  "pending_payout_value": "0.000 HIVE",
  "total_pending_payout_value": "0.000 HIVE",
  "active_votes": [],
  "replies": [],
  "author_reputation": 0,
  "promoted": "0.000 HIVE",
  "body_length": 0,
  "reblogged_by": []
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_content_replies", "params":["hiveio", "firstpost"], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_content_replies", "params":["alice", "a-post-by-alice"], "id":1}' https://api.hive.blog

condenser_api.get_conversion_requests

Returns a list of conversion request. Parameters: id:integer

id (int)  
1234 Queries a conversion request with the id of 1234.

Also see: database_api.list_hbd_conversion_requests

Query Parameters JSON
[0]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_conversion_requests", "params":[1234], "id":1}' https://api.hive.blog

condenser_api.get_current_median_history_price

Query Parameters JSON
[]
Expected Response JSON
{"base": "0.000 HIVE", "quote": "0.000 HIVE"}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_current_median_history_price", "params":[], "id":1}' https://api.hive.blog

condenser_api.get_discussions_by_author_before_date

Returns a list of discussions based on author before date.

Also see: tags_api.get_discussions_by_author_before_date, Paginated API Methods

Query Parameters JSON
["", "", "1970-01-01T00:00:00", 100]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_discussions_by_author_before_date", "params":["hiveio","firstpost","2016-04-19T22:49:43",1], "id":1}' https://api.hive.blog

condenser_api.get_dynamic_global_properties

Returns the current dynamic global properties. See: Understanding Dynamic Global Properties

Also see: database_api.get_dynamic_global_properties

Query Parameters JSON
[]
Expected Response JSON
{
  "head_block_number": 0,
  "head_block_id": "0000000000000000000000000000000000000000",
  "time": "1970-01-01T00:00:00",
  "current_witness": "",
  "total_pow": "18446744073709551615",
  "num_pow_witnesses": 0,
  "virtual_supply": "0.000 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
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_dynamic_global_properties", "params":[], "id":1}' https://api.hive.blog

condenser_api.get_escrow

Returns the escrow for a certain account by id.

Also see: database_api.list_escrows

Query Parameters JSON
["", 0]
Expected Response JSON
null
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_escrow", "params":["hiveio", 1234], "id":1}' https://api.hive.blog

condenser_api.get_expiring_vesting_delegations

Returns the expiring vesting delegations for an account. Parameters: account:string, after:timestamp

account (string) after (timestamp)  
"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.
Query Parameters JSON
["", "1970-01-01T00:00:00"]
Expected Response JSON
[
  {
    "id": 0,
    "delegator": "",
    "vesting_shares": "0.000000 VESTS",
    "expiration": "1970-01-01T00:00:00"
  }
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_expiring_vesting_delegations", "params":["hiveio","2018-01-01T00:00:00"], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_expiring_vesting_delegations", "params":["alice","2017-12-01T00:00:00"], "id":1}' https://api.hive.blog

condenser_api.get_feed_history

Returns the history of price feed values.

Also see: database_api.get_feed_history

Query Parameters JSON
[]
Expected Response JSON
{
  "id": 0,
  "current_median_history": {"base": "0.000 HIVE", "quote": "0.000 HIVE"},
  "price_history": []
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_feed_history", "params":[], "id":1}' https://api.hive.blog

condenser_api.get_follow_count

Returns the count of followers/following for an account. Parameters: account:string

account (string)  
"hiveio" Queries the account named hiveio.
"alice" Queries the account named alice.
Query Parameters JSON
[""]
Expected Response JSON
{
  "account": "",
  "follower_count": 0,
  "following_count": 0
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_follow_count", "params":["hiveio"], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_follow_count", "params":["alice"], "id":1}' https://api.hive.blog

condenser_api.get_followers

Returns the list of followers for an account. Parameters: account:string; start:string (account to start from); type:string e.g.: blog; limit:int up to 1000

account (string) start (string) type (string) limit (int)  
"hiveio" null "blog" 10 Queries for follows of the account named hiveio, up to 10 results.
"alice" null "ignore" 100 Queries for mutes of the account named alice, up to 100 results.

Also see: Paginated API Methods

Query Parameters JSON
["", "", "", 1]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_followers", "params":["hiveio",null,"blog",10], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_followers", "params":["alice",null,"ignore",100], "id":1}' https://api.hive.blog

condenser_api.get_following

Returns the list of accounts that are following an account. Parameters: account:string; start:string (account to start from); type:string e.g.: blog; limit:int up to 1000

account (string) start (string) type (string) limit (int)  
"hiveio" null "blog" 10 Queries for follows of the account named hiveio, up to 10 results.
"alice" null "ignore" 100 Queries for mutes of the account named alice, up to 100 results.

Also see: Paginated API Methods

Query Parameters JSON
["", "", "", 1]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_following", "params":["hiveio",null,"blog",10], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_following", "params":["alice",null,"ignore",100], "id":1}' https://api.hive.blog

condenser_api.get_hardfork_version

Returns the current hardfork version.

Also see: database_api.get_hardfork_properties

Query Parameters JSON
[]
Expected Response JSON
"0.0.0"
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_hardfork_version", "params":[], "id":1}' https://api.hive.blog

condenser_api.get_key_references

Returns all accounts that have the key associated with their owner or active authorities.

Also see: account_by_key_api.get_key_references

Query Parameters JSON
[
  [
    "STM6vJmrwaX5TjgTS9dPH8KsArso5m91fVodJvv91j7G765wqcNM9"
  ]
]
Expected Response JSON
[["hiveio"]]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_key_references", "params":[["STM6vJmrwaX5TjgTS9dPH8KsArso5m91fVodJvv91j7G765wqcNM9"]], "id":1}' https://api.hive.blog

condenser_api.get_market_history

Returns the market history for the internal HBD:HIVE market. Parameters: bucket_seconds:int; start:timestamp; end:timestamp

bucket_seconds (int) start (timestamp) end (timestamp)  
15 "2018-01-01T00:00:00" "2018-01-02T00:00:00" Queries for market history between January 1st, 2018 and January 2nd, 2018, segmented by 15 seconds.
60 "2018-01-01T00:00:00" "2018-01-02T00:00:00" Queries for market history between January 1st, 2018 and January 2nd, 2018, segmented by one minute.
300 "2018-01-01T00:00:00" "2018-01-02T00:00:00" Queries for market history between January 1st, 2018 and January 2nd, 2018, segmented by five minutes.
3600 "2018-01-01T00:00:00" "2018-01-02T00:00:00" Queries for market history between January 1st, 2018 and January 2nd, 2018, segmented by one hour.
86400 "2018-01-01T00:00:00" "2018-01-02T00:00:00" Queries for market history between January 1st, 2018 and January 2nd, 2018, segmented by one day.

Also see: market_history_api.get_market_history

Query Parameters JSON
[0, "1970-01-01T00:00:00", "1970-01-01T00:00:00"]
Expected Response JSON
[
  {
    "id": 0,
    "open": "1970-01-01T00:00:00",
    "seconds": 0,
    "hive": {
      "high": 0,
      "low": 0,
      "open": 0,
      "close": 0,
      "volume": 0
    },
    "non_hive": {
      "high": 0,
      "low": 0,
      "open": 0,
      "close": 0,
      "volume": 0
    }
  }
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_market_history", "params":[15,"2018-01-01T00:00:00","2018-01-02T00:00:00"], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_market_history", "params":[60,"2018-01-01T00:00:00","2018-01-02T00:00:00"], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_market_history", "params":[300,"2018-01-01T00:00:00","2018-01-02T00:00:00"], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_market_history", "params":[3600,"2018-01-01T00:00:00","2018-01-02T00:00:00"], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_market_history", "params":[86400,"2018-01-01T00:00:00","2018-01-02T00:00:00"], "id":1}' https://api.hive.blog

condenser_api.get_market_history_buckets

Returns the bucket seconds being tracked by the plugin.

Also see: market_history_api.get_market_history_buckets

Query Parameters JSON
[]
Expected Response JSON
[15, 60, 300, 3600, 86400]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_market_history_buckets", "params":[], "id":1}' https://api.hive.blog

condenser_api.get_next_scheduled_hardfork

Returns the next scheduled hardfork.

Also see: database_api.get_hardfork_properties, hardfork

Query Parameters JSON
[]
Expected Response JSON
{
  "hf_version": "0.0.0",
  "live_time": "1970-01-01T00:00:00"
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_next_scheduled_hardfork", "params":[], "id":1}' https://api.hive.blog

condenser_api.get_open_orders

Returns the open orders for an account. account:string

Also see: database_api.list_limit_orders

Query Parameters JSON
[""]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_open_orders", "params":["hiveio"], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_open_orders", "params":["alice"], "id":1}' https://api.hive.blog

condenser_api.get_ops_in_block

Returns all operations contained in a block. Parameters: block_num:int; only_virtual:boolean

block_num (int) only_virtual (boolean)  
1 false Queries the operations in block #1.
5443322 true Queries only the virtual operations in block #5,443,322.

Also see: account_history_api.get_ops_in_block

Query Parameters JSON
[0, false]
Expected Response JSON
[
  {
    "trx_id": "0000000000000000000000000000000000000000",
    "block": 0,
    "trx_in_block": 0,
    "op_in_trx": 0,
    "virtual_op": 0,
    "timestamp": "2016-10-01T06:31:24",
    "op": [
      "producer_reward",
      {
        "producer": "",
        "vesting_shares": "0.000000 VESTS"
      }
    ]
  }
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_ops_in_block", "params":[1,false], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_ops_in_block", "params":[5443322,true], "id":1}' https://api.hive.blog

condenser_api.get_order_book

Returns the internal market order book. Parameters: limit:int up to 500

limit (int)  
10 Queries up to 10 items in the order book.
500 Queries up to 500 items in the order book.

Also see: database_api.get_order_book, market_history_api.get_order_book

Query Parameters JSON
[0]
Expected Response JSON
{"bids": [], "asks": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_order_book", "params":[10], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_order_book", "params":[50], "id":1}' https://api.hive.blog

condenser_api.get_owner_history

Returns the owner history of an account. Parameters: account:string

account (string)  
"hiveio" Queries the owner history for account named “hiveio”.

Also see: database_api.list_owner_histories

Query Parameters JSON
[""]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_owner_history", "params":["hiveio"], "id":1}' https://api.hive.blog

condenser_api.get_potential_signatures

This method will return the set of all public keys that could possibly sign for a given transaction.

Also see: database_api.get_potential_signatures

Query Parameters JSON
[
  {
    "ref_block_num": 0,
    "ref_block_prefix": 0,
    "expiration": "1970-01-01T00:00:00",
    "operations": [],
    "extensions": [],
    "signatures": []
  }
]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_potential_signatures", "params":[{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[["pow",{"worker_account":"cloop3","block_id":"00000449f7860b82b4fbe2f317c670e9f01d6d9a","nonce":3899,"work":{"worker":"STM7P5TDnA87Pj9T4mf6YHrhzjC1KbPZpNxLWCcVcHxNYXakpoT4F","input":"ae8e7c677119d22385f8c48026fee7aad7bba693bf788d7f27047f40b47738c0","signature":"1f38fe9a3f9989f84bd94aa5bbc88beaf09b67f825aa4450cf5105d111149ba6db560b582c7dbb026c7fc9c2eb5051815a72b17f6896ed59d3851d9a0f9883ca7a","work":"000e7b209d58f2e64b36e9bf12b999c6c7af168cc3fc41eb7f8a4bf796c174c3"},"props":{"account_creation_fee":{"amount":"100000","precision":3,"nai":"@@000000021"},"maximum_block_size":131072,"hbd_interest_rate":1000}}]],"extensions":[],"signatures":[]}], "id":1}' https://api.hive.blog

condenser_api.get_reblogged_by

Returns a list of authors that have reblogged a post. Parameters: author:string; permlink:string

author (string) permlink (string)  
"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
Query Parameters JSON
["", ""]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_reblogged_by", "params":["hiveio","firstpost"], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_reblogged_by", "params":["alice","a-post-by-alice"], "id":1}' https://api.hive.blog

condenser_api.get_recent_trades

Returns the most recent trades for the internal HBD:HIVE market. Parameters: limit:int up to 1000

limit (int)  
10 Queries up to 10 latest trades.
500 Queries up to 500 latest trades.

Also see: market_history_api.get_recent_trades

Query Parameters JSON
[1]
Expected Response JSON
[
  {
    "date": "1970-01-01T00:00:00",
    "current_pays": "0.0 HBD",
    "open_pays": "0.0 HIVE"
  }
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_recent_trades", "params":[10], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_recent_trades", "params":[500], "id":1}' https://api.hive.blog

condenser_api.get_recovery_request

Returns the recovery request for an account. Parameters: account:string

account (string)  
"hiveio" Queries the recovery requests for account named “hiveio”.

Also see: database_api.list_account_recovery_requests

Query Parameters JSON
[""]
Expected Response JSON
null
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_recovery_request", "params":["hiveio"], "id":1}' https://api.hive.blog

condenser_api.get_required_signatures

This API will take a partially signed transaction and a set of public keys that the owner has the ability to sign for and return the minimal subset of public keys that should add signatures to the transaction. Parameters: trx:object; available_keys:[string]

Also see: database_api.get_required_signatures

Query Parameters JSON
[
  {
    "ref_block_num": 0,
    "ref_block_prefix": 0,
    "expiration": "1970-01-01T00:00:00",
    "operations": [],
    "extensions": [],
    "signatures": []
  },
  []
]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_required_signatures", "params":[{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[["pow",{"worker_account":"cloop3","block_id":"00000449f7860b82b4fbe2f317c670e9f01d6d9a","nonce":3899,"work":{"worker":"STM7P5TDnA87Pj9T4mf6YHrhzjC1KbPZpNxLWCcVcHxNYXakpoT4F","input":"ae8e7c677119d22385f8c48026fee7aad7bba693bf788d7f27047f40b47738c0","signature":"1f38fe9a3f9989f84bd94aa5bbc88beaf09b67f825aa4450cf5105d111149ba6db560b582c7dbb026c7fc9c2eb5051815a72b17f6896ed59d3851d9a0f9883ca7a","work":"000e7b209d58f2e64b36e9bf12b999c6c7af168cc3fc41eb7f8a4bf796c174c3"},"props":{"account_creation_fee":{"amount":"100000","precision":3,"nai":"@@000000021"},"maximum_block_size":131072,"hbd_interest_rate":1000}}]],"extensions":[],"signatures":[]},[]], "id":1}' https://api.hive.blog

condenser_api.get_reward_fund

Returns information about the current reward funds.

Also see: database_api.get_reward_funds

Query Parameters JSON
["post"]
Expected Response JSON
{
  "id": 0,
  "name": "",
  "reward_balance": "0.000 HIVE",
  "recent_claims": "0",
  "last_update": "1970-01-01T00:00:00",
  "content_constant": "0",
  "percent_curation_rewards": 0,
  "percent_content_rewards": 0,
  "author_reward_curve": "quadratic",
  "curation_reward_curve": "34723648"
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_reward_fund", "params":["post"], "id":1}' https://api.hive.blog

condenser_api.get_savings_withdraw_from

Returns savings withdraw from an account. Parameters: account:string

account (string)  
"hiveio" Queries the savings withdraw for account named “hiveio”.

Also see: database_api.list_savings_withdrawals

Query Parameters JSON
[""]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_savings_withdraw_from", "params":["hiveio"], "id":1}' https://api.hive.blog

condenser_api.get_savings_withdraw_to

Returns the savings withdraw to an account. Parameters: account:string

account (string)  
"hiveio" Queries the savings withdraw for account named “hiveio”.

Also see: database_api.list_savings_withdrawals

Query Parameters JSON
[""]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_savings_withdraw_to", "params":["hiveio"], "id":1}' https://api.hive.blog

condenser_api.get_ticker

Returns the market ticker for the internal HBD:HIVE market.

Also see: market_history_api.get_ticker

Query Parameters JSON
[]
Expected Response JSON
{
  "latest": "0.00000000000000000",
  "lowest_ask": "0.00000000000000000",
  "highest_bid": "0.00000000000000000",
  "percent_change": "0.00000000000000000",
  "hive_volume": "0.000 HIVE",
  "hbd_volume": "0.000 HIVE"
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_ticker", "params":[], "id":1}' https://api.hive.blog

condenser_api.get_trade_history

Returns the trade history for the internal HBD:HIVE market. Parameters: start:timestamp; end:timestamp; limit:int up to 1000

start (timestamp) end (timestamp) limit (int)  
"2018-01-01T00:00:00" "2018-01-02T00:00:00" 10 Queries up to 10 trades between January 1st, 2018 and January 2nd, 2018.

Also see: market_history_api.get_trade_history

Query Parameters JSON
[
  "1970-01-01T00:00:00",
  "1970-01-01T00:00:00",
  1000
]
Expected Response JSON
[
  {
    "date": "1970-01-01T00:00:00",
    "current_pays": "0.000 HBD",
    "open_pays": "0.000 HIVE"
  }
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_trade_history", "params":["2018-01-01T00:00:00","2018-01-02T00:00:00",10], "id":1}' https://api.hive.blog

condenser_api.get_transaction

Returns the details of a transaction based on a transaction id. Parameters: trx_id:string

trx_id (string)  
"6fde0190a97835ea6d9e651293e90c89911f933c" Queries for this exact transaction id.

Also see: account_history_api.get_transaction

Query Parameters JSON
[""]
Expected Response JSON
{
  "ref_block_num": 0,
  "ref_block_prefix": 0,
  "expiration": "1970-01-01T00:00:00",
  "operations": [],
  "extensions": [],
  "signatures": [],
  "transaction_id": "0000000000000000000000000000000000000000",
  "block_num": 0,
  "transaction_num": 0
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_transaction", "params":["6fde0190a97835ea6d9e651293e90c89911f933c"], "id":1}' https://api.hive.blog

condenser_api.get_transaction_hex

Returns a hexdump of the serialized binary form of a transaction.

Also see: database_api.get_transaction_hex

Query Parameters JSON
[
  {
    "ref_block_num": 0,
    "ref_block_prefix": 0,
    "expiration": "1970-01-01T00:00:00",
    "operations": [],
    "extensions": [],
    "signatures": []
  }
]
Expected Response JSON
""
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_transaction_hex", "params":[{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[["pow",{"worker_account":"cloop3","block_id":"00000449f7860b82b4fbe2f317c670e9f01d6d9a","nonce":3899,"work":{"worker":"STM7P5TDnA87Pj9T4mf6YHrhzjC1KbPZpNxLWCcVcHxNYXakpoT4F","input":"ae8e7c677119d22385f8c48026fee7aad7bba693bf788d7f27047f40b47738c0","signature":"1f38fe9a3f9989f84bd94aa5bbc88beaf09b67f825aa4450cf5105d111149ba6db560b582c7dbb026c7fc9c2eb5051815a72b17f6896ed59d3851d9a0f9883ca7a","work":"000e7b209d58f2e64b36e9bf12b999c6c7af168cc3fc41eb7f8a4bf796c174c3"},"props":{"account_creation_fee":{"amount":"100000","precision":3,"nai":"@@000000021"},"maximum_block_size":131072,"hbd_interest_rate":1000}}]],"extensions":[],"signatures":[]}], "id":1}' https://api.hive.blog

Returns the list of trending tags. Parameter: start_tag:string; limit:int up to 100

tag (string) limit (int)  
null 100 Queries the top 100 trending tags.
"hive" 10 Queries the tags after “hive”, up to 10 tags.

Also see: Paginated API Methods

["", 1]
[
  {
    "name": "",
    "total_payouts": "0.000 HBD",
    "net_votes": 0,
    "top_posts": 0,
    "comments": 0,
    "trending": ""
  }
]
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_trending_tags", "params":[null,100], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_trending_tags", "params":["hive",10], "id":1}' https://api.hive.blog

condenser_api.get_version

Returns the versions of blockchain, hive, and FC.

Also see: database_api.get_version, Paginated API Methods

Query Parameters JSON
[]
Expected Response JSON
{
  "blockchain_version": "",
  "hive_revision": "",
  "fc_revision": ""
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_version", "params":[], "id":1}' https://api.hive.blog

condenser_api.get_vesting_delegations

Returns the vesting delegations by an account. Parameters: delegator_account:string; start_account:string; limit:int up to 1000

delegator_account (string) start_account (string) limit (int)  
"hiveio" null 10 Queries up to 10 vesting delegations by “hiveio”.

Also see: database_api.list_vesting_delegations, Paginated API Methods

Query Parameters JSON
["", "", 1]
Expected Response JSON
[
  {
    "id": 0,
    "delegator": "",
    "delegatee": "",
    "vesting_shares": "0.000000 VESTS",
    "min_delegation_time": "1970-01-01T00:00:00"
  }
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_vesting_delegations", "params":["hiveio",null,10], "id":1}' https://api.hive.blog

condenser_api.get_volume

Returns the market volume for the past 24 hours.

Also see: market_history_api.get_volume

Query Parameters JSON
[]
Expected Response JSON
{
  "hive_volume": "0.000 HIVE",
  "hbd_volume": "0.000 HIVE"
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_volume", "params":[], "id":1}' https://api.hive.blog

condenser_api.get_withdraw_routes

Returns the withdraw routes for an account. Parameters: account:string; type:string

account (string) type (string)  
"hiveio" "outgoing" Queries outgoing withdraw routes by “hiveio”.
"hiveio" "incoming" Queries incoming withdraw routes by “hiveio”.
"hiveio" "all" Queries all withdraw routes by “hiveio”.

Also see: database_api.list_withdraw_vesting_routes

Query Parameters JSON
["", ""]
Expected Response JSON
[
  {
    "id": 0,
    "from_account": "",
    "to_account": "",
    "percent": 0,
    "auto_vest": false
  }
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_withdraw_routes", "params":["hiveio","outgoing"], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_withdraw_routes", "params":["hiveio","incoming"], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_withdraw_routes", "params":["hiveio","all"], "id":1}' https://api.hive.blog

condenser_api.get_witness_by_account

Returns the witness of an account. Parameters: account:string

account (string)  
"hiveio" Queries witness account of “hiveio” (of null if none exists).

Also see: database_api.list_witnesses

Query Parameters JSON
[""]
Expected Response JSON
{
  "id": 0,
  "owner": "",
  "created": "1970-01-01T00:00:00",
  "url": "",
  "votes": "0",
  "virtual_last_update": "0",
  "virtual_position": "0",
  "virtual_scheduled_time": "0",
  "total_missed": 0,
  "last_aslot": 0,
  "last_confirmed_block_num": 0,
  "pow_worker": 0,
  "signing_key": "",
  "props": {
    "account_creation_fee": "0.000 HIVE",
    "maximum_block_size": 65536,
    "hbd_interest_rate": 0
  },
  "hbd_exchange_rate": {"base": "0.000 HBD", "quote": "0.000 HIVE"},
  "last_hbd_exchange_update": "1970-01-01T00:00:00",
  "last_work": "",
  "running_version": "",
  "hardfork_version_vote": "",
  "hardfork_time_vote": "1970-01-01T00:00:00"
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_witness_by_account", "params":["hiveio"], "id":1}' https://api.hive.blog

condenser_api.get_witness_count

Query Parameters JSON
[]
Expected Response JSON
0
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_witness_count", "params":[], "id":1}' https://api.hive.blog

condenser_api.get_witness_schedule

Returns the current witness schedule.

Also see: database_api.get_witness_schedule

Query Parameters JSON
[]
Expected Response JSON
{
  "id": 0,
  "current_virtual_time": "0",
  "next_shuffle_block_num": 1,
  "current_shuffled_witnesses": [],
  "num_scheduled_witnesses": 1,
  "top19_weight": 1,
  "timeshare_weight": 5,
  "miner_weight": 1,
  "witness_pay_normalization_factor": 25,
  "median_props": {
    "account_creation_fee": "0.000 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
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_witness_schedule", "params":[], "id":1}' https://api.hive.blog

condenser_api.get_witnesses

Returns current witnesses.

Also see: database_api.list_witnesses

Query Parameters JSON
[[0]]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_witnesses", "params":[[28]], "id":1}' https://api.hive.blog

condenser_api.get_witnesses_by_vote

Returns current witnesses by vote. Parameters: start_name:string; limit:int up to 1000

account (string) limit (int)  
null 21 Queries top 21 witness votes.
"a" 1 Queries top 10 witness votes starting with “a”.

Also see: database_api.list_witnesses

Query Parameters JSON
["", 1000]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_witnesses_by_vote", "params":[null, 21], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.get_witnesses_by_vote", "params":["a", 1], "id":1}' https://api.hive.blog

condenser_api.lookup_account_names

Looks up account names. Parameters: accounts:[string]; delayed_votes_active:boolean

Also see: database_api.find_accounts

Query Parameters JSON
[["hiveio", true]]
Expected Response JSON
{
  "id": 1370484,
  "name": "hiveio",
  "owner": {
    "weight_threshold": 1,
    "account_auths": [],
    "key_auths": [
      [
        "STM65PUAPA4yC4RgPtGgsPupxT6yJtMhmT5JHFdsT3uoCbR8WJ25s",
        1
      ]
    ]
  },
  "active": {
    "weight_threshold": 1,
    "account_auths": [],
    "key_auths": [
      [
        "STM69zfrFGnZtU3gWFWpQJ6GhND1nz7TJsKBTjcWfebS1JzBEweQy",
        1
      ]
    ]
  },
  "posting": {
    "weight_threshold": 1,
    "account_auths": [["threespeak", 1], ["vimm.app", 1]],
    "key_auths": [
      [
        "STM6vJmrwaX5TjgTS9dPH8KsArso5m91fVodJvv91j7G765wqcNM9",
        1
      ]
    ]
  },
  "memo_key": "STM7wrsg1BZogeK7X3eG4ivxmLaH69FomR8rLkBbepb3z3hm5SbXu",
  "json_metadata": "",
  "posting_json_metadata": "{\"profile\":{\"pinned\":\"none\",\"version\":2,\"website\":\"hive.io\",\"profile_image\":\"https://files.peakd.com/file/peakd-hive/hiveio/Jp2YHc6Q-hive-logo.png\",\"cover_image\":\"https://files.peakd.com/file/peakd-hive/hiveio/Xe1TcEBi-hive-banner.png\"}}",
  "proxy": "",
  "last_owner_update": "1970-01-01T00:00:00",
  "last_account_update": "2020-11-12T01:20:48",
  "created": "2020-03-06T12:22:48",
  "mined": false,
  "recovery_account": "steempeak",
  "last_account_recovery": "1970-01-01T00:00:00",
  "reset_account": "null",
  "comment_count": 0,
  "lifetime_vote_count": 0,
  "post_count": 31,
  "can_vote": true,
  "voting_manabar": {
    "current_mana": "598442432741",
    "last_update_time": 1591297380
  },
  "downvote_manabar": {
    "current_mana": "149610608184",
    "last_update_time": 1591297380
  },
  "voting_power": 0,
  "balance": "11.682 HIVE",
  "savings_balance": "0.000 HIVE",
  "hbd_balance": "43.575 HBD",
  "hbd_seconds": "0",
  "hbd_seconds_last_update": "2020-10-21T02:45:12",
  "hbd_last_interest_payment": "2020-10-21T02:45:12",
  "savings_hbd_balance": "0.000 HBD",
  "savings_hbd_seconds": "0",
  "savings_hbd_seconds_last_update": "1970-01-01T00:00:00",
  "savings_hbd_last_interest_payment": "1970-01-01T00:00:00",
  "savings_withdraw_requests": 0,
  "reward_hbd_balance": "0.000 HBD",
  "reward_hive_balance": "0.000 HIVE",
  "reward_vesting_balance": "0.000000 VESTS",
  "reward_vesting_hive": "0.000 HIVE",
  "vesting_shares": "598442.432741 VESTS",
  "delegated_vesting_shares": "0.000000 VESTS",
  "received_vesting_shares": "0.000000 VESTS",
  "vesting_withdraw_rate": "0.000000 VESTS",
  "post_voting_power": "598442.432741 VESTS",
  "next_vesting_withdrawal": "1969-12-31T23:59:59",
  "withdrawn": 0,
  "to_withdraw": 0,
  "withdraw_routes": 0,
  "pending_transfers": 0,
  "curation_rewards": 0,
  "posting_rewards": 604589,
  "proxied_vsf_votes": [0, 0, 0, 0],
  "witnesses_voted_for": 0,
  "last_post": "2021-03-23T18:05:48",
  "last_root_post": "2021-03-23T18:05:48",
  "last_vote_time": "1970-01-01T00:00:00",
  "post_bandwidth": 0,
  "pending_claimed_accounts": 0,
  "delayed_votes": [
    {
      "time": "2021-02-24T05:08:21",
      "val": "11550765516955"
    },
    {
      "time": "2021-02-26T15:46:06",
      "val": "633465684569"
    },
    {
      "time": "2021-03-07T17:54:39",
      "val": "1000000037683"
    },
    {
      "time": "2021-03-16T05:54:33",
      "val": "999978763511"
    },
    {
      "time": "2021-03-18T06:06:00",
      "val": "1000000171317"
    }
  ],
  "vesting_balance": "0.000 HIVE",
  "reputation": "88826789432105",
  "transfer_history": [],
  "market_history": [],
  "post_history": [],
  "vote_history": [],
  "other_history": [],
  "witness_votes": [],
  "tags_usage": [],
  "guest_bloggers": []
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.lookup_account_names", "params":[["hiveio"]], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.lookup_account_names", "params":[["hiveio"], false], "id":1}' https://api.hive.blog

condenser_api.lookup_accounts

Looks up accounts starting with name. Parameterslower_bound_name:string; limit:int up to 1000

lower_bound_name (string) limit (int)  
"a" 10 Queries up to 10 accounts that start with “a”.

Also see: database_api.list_accounts

Query Parameters JSON
["", 1]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.lookup_accounts", "params":["a",10], "id":1}' https://api.hive.blog

condenser_api.lookup_witness_accounts

Looks up witness accounts starting with name. Parameters: lower_bound_name:string; limit:int up to 1000

lower_bound_name (string) limit (int)  
"a" 10 Queries up to 10 witnesses that start with “a”.

Also see: database_api.list_witnesses

Query Parameters JSON
["", 1]
Expected Response JSON
[]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.lookup_witness_accounts", "params":["a",10], "id":1}' https://api.hive.blog

condenser_api.verify_authority

Returns true if the transaction has all of the required signatures.

Also see: database_api.verify_authority

Query Parameters JSON
[
  {
    "ref_block_num": 0,
    "ref_block_prefix": 0,
    "expiration": "1970-01-01T00:00:00",
    "operations": [],
    "extensions": [],
    "signatures": []
  }
]
Expected Response JSON
false
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.verify_authority", "params":[{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[["pow",{"worker_account":"cloop3","block_id":"00000449f7860b82b4fbe2f317c670e9f01d6d9a","nonce":3899,"work":{"worker":"STM7P5TDnA87Pj9T4mf6YHrhzjC1KbPZpNxLWCcVcHxNYXakpoT4F","input":"ae8e7c677119d22385f8c48026fee7aad7bba693bf788d7f27047f40b47738c0","signature":"1f38fe9a3f9989f84bd94aa5bbc88beaf09b67f825aa4450cf5105d111149ba6db560b582c7dbb026c7fc9c2eb5051815a72b17f6896ed59d3851d9a0f9883ca7a","work":"000e7b209d58f2e64b36e9bf12b999c6c7af168cc3fc41eb7f8a4bf796c174c3"},"props":{"account_creation_fee":{"amount":"100000","precision":3,"nai":"@@000000021"},"maximum_block_size":131072,"hbd_interest_rate":1000}}]],"extensions":[],"signatures":[]}], "id":1}' https://api.hive.blog

condenser_api.find_proposals

Finds proposals by proposal.id (not proposal.proposal_id).

Also see: database_api.find_proposals

Query Parameters JSON
[0]
Expected Response JSON
[
  {
    "id": 0,
    "proposal_id": "139924505899904",
    "creator": "alice",
    "receiver": "bob",
    "start_date": "2019-07-01T00:00:00",
    "end_date": "2019-08-01T23:59:59",
    "daily_pay": "4800.000 HBD",
    "subject": "My Proposal",
    "permlink": "creator-proposal-permlink",
    "total_votes": "77351826710",
    "status": "active"
  }
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.find_proposals", "params":[[0]], "id":1}' https://api.hive.blog

condenser_api.list_proposal_votes

Returns all proposal votes, starting with the specified voter or proposal.id. Parameters: start:array; limit:int; order:string; order_direction:string; status:string

start (array) limit (int) order (string) order_direction (string) status (string)  
["alice"] 10 by_voter_proposal ascending active list 10 proposals with active status, ordered by voter, ascending
[10] 1000 by_proposal_voter ascending votable list 1000 votes on proposal 10, ordered by proposal.id, ascending

Also see: database_api.list_proposals

Query Parameters JSON
[[], 0, "by_name", "ascending", "all"]
Expected Response JSON
[
  {
    "id": 0,
    "voter": "charlie",
    "proposal": {
      "id": 0,
      "proposal_id": 0,
      "creator": "alice",
      "receiver": "bob",
      "start_date": "2019-07-01T00:00:00",
      "end_date": "2019-08-01T23:59:59",
      "daily_pay": {
        "amount": "4800000",
        "precision": 3,
        "nai": "@@000000013"
      },
      "subject": "My Proposal",
      "permlink": "creator-proposal-permlink",
      "total_votes": "77351826710",
      "status": "active"
    }
  }
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.list_proposal_votes", "params":[[""], 10, "by_voter_proposal", "ascending", "active"], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.list_proposal_votes", "params":[[0], 10, "by_proposal_voter", "ascending", "active"], "id":1}' https://api.hive.blog

condenser_api.list_proposals

Returns all proposals, starting with the specified creator or start date. Parameters: start:array; limit:int; order:string; order_direction:string; status:string

start (array) limit (int) order (string) order_direction (string) status (string)  
[""] 10 by_creator ascending active list 10 proposals with active status, ordered by creator, ascending
["2019-08-07T16:54:03"] 1000 by_start_date ascending inactive list 1000 proposals with inactive status, ordered by start date, ascending, since 2019-08-07T16:54:03
["a"] 1 by_creator ascending expired list 1 proposal with expired status, ordered by creator, ascending, by accounts starting with “a”
["alice"] 10 by_creator ascending all list 10 proposals with any status, ordered by creator, ascending, by alice
[""] 1000 by_creator ascending votable list 1000 votable proposals, ordered by creator, ascending
[10] 1000 by_total_votes ascending votable list 1000 votable proposals, ordered by creator, ascending, having at least 10 votes

Also see: datbase_api.list_proposals

Query Parameters JSON
[[], 0, "by_name", "ascending", "all"]
Expected Response JSON
[
  {
    "id": 0,
    "proposal_id": "1103806595072",
    "creator": "alice",
    "receiver": "bob",
    "start_date": "2019-07-01T00:00:00",
    "end_date": "2019-08-01T23:59:59",
    "daily_pay": "4800.000 HBD",
    "subject": "My Proposal",
    "permlink": "creator-proposal-permlink",
    "total_votes": "77351826710",
    "status": "active"
  }
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.list_proposals", "params":[[""], 10, "by_creator", "ascending", "active"], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.list_proposals", "params":[["2019-08-07T16:54:03"], 1000, "order_direction": "ascending", "inactive"], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.list_proposals", "params":[["a"], 1, "by_creator", "ascending", "expired"], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.list_proposals", "params":[["alice"], 10, "by_creator", "ascending", "all"], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.list_proposals", "params":[[""], 1000, "by_creator", "ascending", "votable"], "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.list_proposals", "params":[[10], 1000, "by_total_votes", "ascending", "votable"], "id":1}' https://api.hive.blog

condenser_api.is_known_transaction

Only return true if the transaction has not expired or been invalidated. If this method is called with a VERY old transaction we will return false, use account_history_api.get_transaction.

Also see: transaction_status_api.find_transaction, account_history_api.get_transaction

Query Parameters JSON
["0000000000000000000000000000000000000000"]
Expected Response JSON
false
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.is_known_transaction", "params":["0000000000000000000000000000000000000000"]}, "id":1}' https://api.hive.blog

condenser_api.get_collateralized_conversion_requests

Returns objects corresponding with collateralized_convert operations.

 

 

 

Query Parameters JSON
[]
Expected Response JSON
[]

condenser_api.find_recurrent_transfers

Finds transfers of any liquid asset every fixed amount of time from one account to another.

Also see: recurrent_transfer_operation

Query Parameters JSON
[""]
Expected Response JSON
[
  {
    "id": 3,
    "trigger_date": "2021-07-02T18:11:51",
    "from": "alice",
    "to": "bob",
    "amount": {
      "amount": "1000",
      "precision": 3,
      "nai": "@@000000021"
    },
    "memo": "Payroll",
    "recurrence": 26,
    "consecutive_failures": 0,
    "remaining_executions": 3
  }
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.find_recurrent_transfers", "params":["alice"], "id":1}' https://api.hive.blog

condenser_api.find_rc_accounts

Returns the available resource credits of accounts.

Query Parameters 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
  }
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.find_rc_accounts", "params":[["alice","demo"]], "id":1}' https://api.hive.blog

condenser_api.list_rc_accounts

Find accounts and their RC delegations

Query Parameters 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
  }
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.list_rc_accounts", "params":["ecency",10], "id":1}' https://api.hive.blog

condenser_api.list_rc_direct_delegations

Get list of “from” “to” which account how much RC was delegated.

Query Parameters JSON
[]
Expected Response JSON
[
  {
    "delegated_rc": 15000000000,
    "from": "ecency",
    "to": "raitakun501"
  },
  {
    "delegated_rc": 15000000000,
    "from": "ecency",
    "to": "vivianemitola"
  }
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"condenser_api.list_rc_direct_delegations", "params":[["ecency",""],2], "id":1}' https://api.hive.blog

Database API

Methods:

Used to query information about accounts, transactions, and blockchain data.

To enable this API for hived, the following is required in config.ini by specifying:

plugin = database_api

These AppBase API methods are still under development and subject to change.

database_api.find_account_recovery_requests

Returns a list of account recovery requests. Parameters: account:string

account (string)  
"hiveio" Queries the recovery requests for account named “hiveio”.
Query Parameters JSON
{"accounts": []}
Expected Response JSON
{"requests": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_account_recovery_requests", "params": {"accounts":["hiveio"]}, "id":1}' https://api.hive.blog

database_api.find_accounts

Returns accounts, queried by name. Parameters: account:string array; delayed_votes_active:boolean

account (string array) delayed_votes_active (boolean)  
["hiveio"]   Queries for account named “hiveio”.
["hiveio", "alice"] false Queries for accounts named “hiveio” and “alice” with delayed_votes hidden.
Query Parameters JSON
{"accounts": [], "delayed_votes_active": true}
Expected Response JSON
{
  "accounts": [
    {
      "id": 1370484,
      "name": "hiveio",
      "owner": {
        "weight_threshold": 1,
        "account_auths": [],
        "key_auths": [
          [
            "STM65PUAPA4yC4RgPtGgsPupxT6yJtMhmT5JHFdsT3uoCbR8WJ25s",
            1
          ]
        ]
      },
      "active": {
        "weight_threshold": 1,
        "account_auths": [],
        "key_auths": [
          [
            "STM69zfrFGnZtU3gWFWpQJ6GhND1nz7TJsKBTjcWfebS1JzBEweQy",
            1
          ]
        ]
      },
      "posting": {
        "weight_threshold": 1,
        "account_auths": [["threespeak", 1], ["vimm.app", 1]],
        "key_auths": [
          [
            "STM6vJmrwaX5TjgTS9dPH8KsArso5m91fVodJvv91j7G765wqcNM9",
            1
          ]
        ]
      },
      "memo_key": "STM7wrsg1BZogeK7X3eG4ivxmLaH69FomR8rLkBbepb3z3hm5SbXu",
      "json_metadata": "",
      "posting_json_metadata": "{\"profile\":{\"pinned\":\"none\",\"version\":2,\"website\":\"hive.io\",\"profile_image\":\"https://files.peakd.com/file/peakd-hive/hiveio/Jp2YHc6Q-hive-logo.png\",\"cover_image\":\"https://files.peakd.com/file/peakd-hive/hiveio/Xe1TcEBi-hive-banner.png\"}}",
      "proxy": "",
      "last_owner_update": "1970-01-01T00:00:00",
      "last_account_update": "2020-11-12T01:20:48",
      "created": "2020-03-06T12:22:48",
      "mined": false,
      "recovery_account": "steempeak",
      "last_account_recovery": "1970-01-01T00:00:00",
      "reset_account": "null",
      "comment_count": 0,
      "lifetime_vote_count": 0,
      "post_count": 31,
      "can_vote": true,
      "voting_manabar": {
        "current_mana": "598442432741",
        "last_update_time": 1591297380
      },
      "downvote_manabar": {
        "current_mana": "149610608184",
        "last_update_time": 1591297380
      },
      "balance": {
        "amount": "11682",
        "precision": 3,
        "nai": "@@000000021"
      },
      "savings_balance": {
        "amount": "0",
        "precision": 3,
        "nai": "@@000000021"
      },
      "hbd_balance": {
        "amount": "43575",
        "precision": 3,
        "nai": "@@000000013"
      },
      "hbd_seconds": "0",
      "hbd_seconds_last_update": "2020-10-21T02:45:12",
      "hbd_last_interest_payment": "2020-10-21T02:45:12",
      "savings_hbd_balance": {
        "amount": "0",
        "precision": 3,
        "nai": "@@000000013"
      },
      "savings_hbd_seconds": "0",
      "savings_hbd_seconds_last_update": "1970-01-01T00:00:00",
      "savings_hbd_last_interest_payment": "1970-01-01T00:00:00",
      "savings_withdraw_requests": 0,
      "reward_hbd_balance": {
        "amount": "0",
        "precision": 3,
        "nai": "@@000000013"
      },
      "reward_hive_balance": {
        "amount": "0",
        "precision": 3,
        "nai": "@@000000021"
      },
      "reward_vesting_balance": {
        "amount": "0",
        "precision": 6,
        "nai": "@@000000037"
      },
      "reward_vesting_hive": {
        "amount": "0",
        "precision": 3,
        "nai": "@@000000021"
      },
      "vesting_shares": {
        "amount": "598442432741",
        "precision": 6,
        "nai": "@@000000037"
      },
      "delegated_vesting_shares": {
        "amount": "0",
        "precision": 6,
        "nai": "@@000000037"
      },
      "received_vesting_shares": {
        "amount": "0",
        "precision": 6,
        "nai": "@@000000037"
      },
      "vesting_withdraw_rate": {
        "amount": "0",
        "precision": 6,
        "nai": "@@000000037"
      },
      "post_voting_power": {
        "amount": "598442432741",
        "precision": 6,
        "nai": "@@000000037"
      },
      "next_vesting_withdrawal": "1969-12-31T23:59:59",
      "withdrawn": 0,
      "to_withdraw": 0,
      "withdraw_routes": 0,
      "pending_transfers": 0,
      "curation_rewards": 0,
      "posting_rewards": 604589,
      "proxied_vsf_votes": [0, 0, 0, 0],
      "witnesses_voted_for": 0,
      "last_post": "2021-03-23T18:05:48",
      "last_root_post": "2021-03-23T18:05:48",
      "last_post_edit": "2021-03-23T18:05:48",
      "last_vote_time": "1970-01-01T00:00:00",
      "post_bandwidth": 0,
      "pending_claimed_accounts": 0,
      "is_smt": false,
      "delayed_votes": [
        {
          "time": "2021-02-24T05:08:21",
          "val": "11550765516955"
        },
        {
          "time": "2021-02-26T15:46:06",
          "val": "633465684569"
        },
        {
          "time": "2021-03-07T17:54:39",
          "val": "1000000037683"
        },
        {
          "time": "2021-03-16T05:54:33",
          "val": "999978763511"
        },
        {
          "time": "2021-03-18T06:06:00",
          "val": "1000000171317"
        }
      ]
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_accounts", "params": {"accounts":["hiveio"]}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_accounts", "params": {"accounts":["hiveio", "alice"], "delayed_votes_active": false}, "id":1}' https://api.hive.blog

database_api.find_change_recovery_account_requests

Returns a list of requests to change the recovery account. Parameters: account:array

account (array)  
["hiveio"] Queries the recovery requests for account named “hiveio”.
Query Parameters JSON
{"accounts": []}
Expected Response JSON
{
  "requests": [
    {
      "id": 0,
      "account_to_recover": "",
      "recovery_account": "",
      "effective_on": "2020-01-08T00:45:18"
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_change_recovery_account_requests", "params": {"accounts":["hiveio"]}, "id":1}' https://api.hive.blog

database_api.find_comments

Search for comments by author/permlink.

Query Parameters JSON
{"comments": [["author", "permlink"]]}
Expected Response JSON
{"comments": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_comments", "params": {"comments":[["hiveio", "around-the-hive-reflections"]]}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_comments", "params": {"comments":[["alice", "a-post-by-alice"]]}, "id":1}' https://api.hive.blog

database_api.find_decline_voting_rights_requests

Returns a list of requests to decline voting rights.

Query Parameters JSON
{"accounts": []}
Expected Response JSON
{"requests": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_decline_voting_rights_requests", "params": {"accounts":["temp","null"]}, "id":1}' https://api.hive.blog

database_api.find_escrows

Returns a list of escrows.

Query Parameters JSON
{"from": ""}
Expected Response JSON
{
  "escrows": [
    {
      "id": 143,
      "escrow_id": 12345,
      "from": "temp",
      "to": "guest123",
      "agent": "smitop",
      "ratification_deadline": "2038-01-19T03:14:06",
      "escrow_expiration": "2038-01-19T03:14:07",
      "hbd_balance": {
        "amount": "0",
        "precision": 3,
        "nai": "@@000000013"
      },
      "hive_balance": {
        "amount": "1",
        "precision": 3,
        "nai": "@@000000021"
      },
      "pending_fee": {
        "amount": "1",
        "precision": 3,
        "nai": "@@000000021"
      },
      "to_approved": false,
      "agent_approved": false,
      "disputed": false
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_escrows", "params": {"from": "temp"}, "id":1}' https://api.hive.blog

database_api.find_limit_orders

Returns a list of limit orders.

Query Parameters JSON
{"account": ""}
Expected Response JSON
{
  "orders": [
    {
      "id": 0,
      "created": "2019-12-14T04:05:39",
      "expiration": "2019-12-15T05:05:21",
      "seller": "",
      "orderid": 0,
      "for_sale": 0,
      "sell_price": {
        "base": {
          "amount": "0",
          "precision": 3,
          "nai": "@@000000013"
        },
        "quote": {
          "amount": "0",
          "precision": 3,
          "nai": "@@000000021"
        }
      }
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_limit_orders", "params": {"account":"temp"}, "id":1}' https://api.hive.blog

database_api.find_owner_histories

Returns owner authority history. Parameters: owner:string

owner (string)  
"hiveio" Queries the owner history for account named “hiveio”.
"alice" Queries the owner history for account named “alice”.
Query Parameters JSON
{"owner": ""}
Expected Response JSON
{"owner_auths": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_owner_histories", "params": {"owner":"hiveio"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_owner_histories", "params": {"owner":"alice"}, "id":1}' https://api.hive.blog

database_api.find_savings_withdrawals

Returns the list of savings withdrawls for an account. Parameters: account:string

account (string)  
"hiveio" Queries the savings withdraw for account named “hiveio”.
Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{"withdrawals": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_savings_withdrawals", "params": {"start":"temp"}, "id":1}' https://api.hive.blog

database_api.find_hbd_conversion_requests

Returns the list of HBD conversion requests for an account. Parameters: account:string

account (string)  
"hiveio" Queries a conversion request for hiveio.
"alice" Queries a conversion request for alice.
Query Parameters JSON
{"account": ""}
Expected Response JSON
{"requests": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_hbd_conversion_requests", "params": {"account":"hiveio"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_hbd_conversion_requests", "params": {"account":"alice"}, "id":1}' https://api.hive.blog

database_api.find_vesting_delegation_expirations

Returns the expiring vesting delegations for an account. Parameters: account:string

account (string)    
"hiveio"   Queries for expiring vesting for hiveio.
"alice"   Queries for expiring vesting for alice.
Query Parameters JSON
{"account": ""}
Expected Response JSON
{
  "delegations": [
    {
      "id": 3077902,
      "delegator": "hiveio",
      "vesting_shares": {
        "amount": "201417615",
        "precision": 6,
        "nai": "@@000000037"
      },
      "expiration": "2018-12-05T21:46:48"
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_vesting_delegation_expirations", "params": {"account":"hiveio"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_vesting_delegation_expirations", "params": {"account":"alice"}, "id":1}' https://api.hive.blog

database_api.find_vesting_delegations

Returns the list of vesting delegations for an account. Parameters: account:string

account (string)    
"hiveio"   Queries for vesting for hiveio.
"alice"   Queries for vesting for alice.
Query Parameters JSON
{"account": ""}
Expected Response JSON
{
  "delegations": [
    {
      "id": 0,
      "delegator": "",
      "delegatee": "",
      "vesting_shares": {
        "amount": "0",
        "precision": 6,
        "nai": "@@000000037"
      },
      "min_delegation_time": "2018-02-28T15:36:51"
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_vesting_delegations", "params": {"account":"hiveio"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_vesting_delegations", "params": {"account":"alice"}, "id":1}' https://api.hive.blog

database_api.find_votes

Returns all votes for the given post. Required (non-empty) parameters: author:string; permlink:string

author (string) permlink (string)  
"hiveio" "announcing-the-launch-of-hive-blockchain" Queries votes for content with a slug @hiveio/announcing-the-launch-of-hive-blockchain
"alice" "a-post-by-alice" Queries votes for content with a slug @alice/a-post-by-alice
Query Parameters JSON
{
  "author": "hiveio",
  "permlink": "announcing-the-launch-of-hive-blockchain"
}
Expected Response JSON
{
  "votes": [
    {
      "id": 0,
      "voter": "",
      "author": "",
      "permlink": "",
      "weight": "0",
      "rshares": 0,
      "vote_percent": 0,
      "last_update": "2016-04-07T19:15:36",
      "num_changes": -1
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_votes", "params": {"author":"hiveio", "permlink":"announcing-the-launch-of-hive-blockchain"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_votes", "params": {"author":"alice", "permlink":"a-post-by-alice"}, "id":1}' https://api.hive.blog

database_api.find_withdraw_vesting_routes

Returns the list of vesting withdraw routes for an account.

Query Parameters JSON
{"account": "", "order": "by_name"}
Expected Response JSON
{
  "routes": [
    {
      "id": 0,
      "from_account": "",
      "to_account": "",
      "percent": 0,
      "auto_vest": true
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_withdraw_vesting_routes", "params": {"account":"temp", "order":"by_destination"}, "id":1}' https://api.hive.blog

database_api.find_witnesses

Search for witnesses.

Query Parameters JSON
{"owners": []}
Expected Response JSON
{
  "witnesses": [
    {
      "id": 0,
      "owner": "initminer",
      "created": "1970-01-01T00:00:00",
      "url": "",
      "votes": 0,
      "virtual_last_update": "225400650183277777230188182",
      "virtual_position": "28933178228158941342755574680549120",
      "virtual_scheduled_time": "340253433742935705172215129634317850517",
      "total_missed": 88,
      "last_aslot": 1202,
      "last_confirmed_block_num": 1092,
      "pow_worker": 0,
      "signing_key": "STM8GC13uCZbP44HzMLV6zPZGwVQ8Nt4Kji8PapsPiNq1BK153XTX",
      "props": {
        "account_creation_fee": {
          "amount": "1",
          "precision": 3,
          "nai": "@@000000021"
        },
        "maximum_block_size": 131072,
        "hbd_interest_rate": 1000,
        "account_subsidy_budget": 797,
        "account_subsidy_decay": 347321
      },
      "hbd_exchange_rate": {
        "base": {
          "amount": "0",
          "precision": 3,
          "nai": "@@000000021"
        },
        "quote": {
          "amount": "0",
          "precision": 3,
          "nai": "@@000000021"
        }
      },
      "last_hbd_exchange_update": "1970-01-01T00:00:00",
      "last_work": "0000000000000000000000000000000000000000000000000000000000000000",
      "running_version": "0.23.0",
      "hardfork_version_vote": "0.23.0",
      "hardfork_time_vote": "2019-10-14T15:00:00",
      "available_witness_account_subsidies": 9379874
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_witnesses", "params": {"owners":["initminer"]}, "id":1}' https://api.hive.blog

database_api.get_active_witnesses

Returns the list of active witnesses.

Query Parameters JSON
{}
Expected Response JSON
{
  "witnesses": [
    "lukestokes.mhth",
    "gtg",
    "ausbitbank",
    "clayop",
    "yabapmatt",
    "curie",
    "thecryptodrive",
    "roelandp",
    "followbtcnews",
    "timcliff",
    "smooth.witness",
    "bhuz",
    "aggroed",
    "blocktrades",
    "cervantes",
    "utopian-io",
    "anyx",
    "jesta",
    "drakos",
    "someguy123",
    "good-karma"
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_active_witnesses", "id":1}' https://api.hive.blog

database_api.get_config

Returns information about compile-time constants. Some properties may not be present. See: Understanding Configuration Values

Query Parameters JSON
{}
Expected Response JSON
{
  "IS_TEST_NET": true,
  "TESTNET_BLOCK_LIMIT": 3000000,
  "SMT_MAX_VOTABLE_ASSETS": 2,
  "SMT_VESTING_WITHDRAW_INTERVAL_SECONDS": 604800,
  "SMT_UPVOTE_LOCKOUT": 43200,
  "SMT_EMISSION_MIN_INTERVAL_SECONDS": 21600,
  "SMT_EMIT_INDEFINITELY": 4294967295,
  "SMT_MAX_NOMINAL_VOTES_PER_DAY": 1000,
  "SMT_MAX_VOTES_PER_REGENERATION": 7000,
  "SMT_DEFAULT_VOTES_PER_REGEN_PERIOD": 50,
  "SMT_DEFAULT_PERCENT_CURATION_REWARDS": 2500,
  "SMT_INITIAL_VESTING_PER_UNIT": 1000000,
  "SMT_BALLAST_SUPPLY_PERCENT": 10,
  "SMT_MAX_ICO_TIERS": 10,
  "HBD_SYMBOL": {"nai": "@@000000013", "precision": 3},
  "HIVE_INITIAL_VOTE_POWER_RATE": 40,
  "HIVE_REDUCED_VOTE_POWER_RATE": 10,
  "HIVE_100_PERCENT": 10000,
  "HIVE_1_PERCENT": 100,
  "HIVE_ACCOUNT_RECOVERY_REQUEST_EXPIRATION_PERIOD": 12000000,
  "HIVE_ACTIVE_CHALLENGE_COOLDOWN": "86400000000",
  "HIVE_ACTIVE_CHALLENGE_FEE": {
    "amount": "2000",
    "precision": 3,
    "nai": "@@000000021"
  },
  "HIVE_ADDRESS_PREFIX": "TST",
  "HIVE_APR_PERCENT_MULTIPLY_PER_BLOCK": "102035135585887",
  "HIVE_APR_PERCENT_MULTIPLY_PER_HOUR": "119577151364285",
  "HIVE_APR_PERCENT_MULTIPLY_PER_ROUND": "133921203762304",
  "HIVE_APR_PERCENT_SHIFT_PER_BLOCK": 87,
  "HIVE_APR_PERCENT_SHIFT_PER_HOUR": 77,
  "HIVE_APR_PERCENT_SHIFT_PER_ROUND": 83,
  "HIVE_BANDWIDTH_AVERAGE_WINDOW_SECONDS": 604800,
  "HIVE_BANDWIDTH_PRECISION": 1000000,
  "HIVE_BENEFICIARY_LIMIT": 128,
  "HIVE_BLOCKCHAIN_PRECISION": 1000,
  "HIVE_BLOCKCHAIN_PRECISION_DIGITS": 3,
  "HIVE_BLOCKCHAIN_HARDFORK_VERSION": "0.23.0",
  "HIVE_BLOCKCHAIN_VERSION": "0.23.0",
  "HIVE_BLOCK_INTERVAL": 3,
  "HIVE_BLOCKS_PER_DAY": 28800,
  "HIVE_BLOCKS_PER_HOUR": 1200,
  "HIVE_BLOCKS_PER_YEAR": 10512000,
  "HIVE_CASHOUT_WINDOW_SECONDS": 3600,
  "HIVE_CASHOUT_WINDOW_SECONDS_PRE_HF12": 3600,
  "HIVE_CASHOUT_WINDOW_SECONDS_PRE_HF17": 3600,
  "HIVE_CHAIN_ID": "18dcf0a285365fc58b71f18b3d3fec954aa0c141c44e4e5cb4cf777b9eab274e",
  "HIVE_COMMENT_REWARD_FUND_NAME": "comment",
  "HIVE_COMMENT_TITLE_LIMIT": 256,
  "HIVE_CONTENT_APR_PERCENT": 3875,
  "HIVE_CONTENT_CONSTANT_HF0": "2000000000000",
  "HIVE_CONTENT_CONSTANT_HF21": "2000000000000",
  "HIVE_CONTENT_REWARD_PERCENT_HF16": 7500,
  "HIVE_CONTENT_REWARD_PERCENT_HF21": 6500,
  "HIVE_CONVERSION_DELAY": "302400000000",
  "HIVE_CONVERSION_DELAY_PRE_HF_16": "604800000000",
  "HIVE_CREATE_ACCOUNT_DELEGATION_RATIO": 5,
  "HIVE_CREATE_ACCOUNT_DELEGATION_TIME": "2592000000000",
  "HIVE_CREATE_ACCOUNT_WITH_HIVE_MODIFIER": 30,
  "HIVE_CURATE_APR_PERCENT": 3875,
  "HIVE_CUSTOM_OP_DATA_MAX_LENGTH": 8192,
  "HIVE_CUSTOM_OP_ID_MAX_LENGTH": 32,
  "HIVE_DEFAULT_HBD_INTEREST_RATE": 1000,
  "HIVE_DOWNVOTE_POOL_PERCENT_HF21": 2500,
  "HIVE_EQUIHASH_K": 6,
  "HIVE_EQUIHASH_N": 140,
  "HIVE_FEED_HISTORY_WINDOW": 84,
  "HIVE_FEED_HISTORY_WINDOW_PRE_HF_16": 168,
  "HIVE_FEED_INTERVAL_BLOCKS": 1200,
  "HIVE_GENESIS_TIME": "2016-01-01T00:00:00",
  "HIVE_HARDFORK_REQUIRED_WITNESSES": 17,
  "HIVE_HF21_CONVERGENT_LINEAR_RECENT_CLAIMS": "503600561838938636",
  "HIVE_INFLATION_NARROWING_PERIOD": 250000,
  "HIVE_INFLATION_RATE_START_PERCENT": 978,
  "HIVE_INFLATION_RATE_STOP_PERCENT": 95,
  "HIVE_INIT_MINER_NAME": "initminer",
  "HIVE_INIT_PUBLIC_KEY_STR": "TST6LLegbAgLAy28EHrffBVuANFWcFgmqRMW13wBmTExqFE9SCkg4",
  "HIVE_INIT_SUPPLY": "250000000000",
  "HIVE_HBD_INIT_SUPPLY": "7000000000",
  "HIVE_INIT_TIME": "1970-01-01T00:00:00",
  "HIVE_IRREVERSIBLE_THRESHOLD": 7500,
  "HIVE_LIQUIDITY_APR_PERCENT": 750,
  "HIVE_LIQUIDITY_REWARD_BLOCKS": 1200,
  "HIVE_LIQUIDITY_REWARD_PERIOD_SEC": 3600,
  "HIVE_LIQUIDITY_TIMEOUT_SEC": "604800000000",
  "HIVE_MAX_ACCOUNT_CREATION_FEE": 1000000000,
  "HIVE_MAX_ACCOUNT_NAME_LENGTH": 16,
  "HIVE_MAX_ACCOUNT_WITNESS_VOTES": 30,
  "HIVE_MAX_ASSET_WHITELIST_AUTHORITIES": 10,
  "HIVE_MAX_AUTHORITY_MEMBERSHIP": 40,
  "HIVE_MAX_BLOCK_SIZE": 393216000,
  "HIVE_SOFT_MAX_BLOCK_SIZE": 2097152,
  "HIVE_MAX_CASHOUT_WINDOW_SECONDS": 86400,
  "HIVE_MAX_COMMENT_DEPTH": 65535,
  "HIVE_MAX_COMMENT_DEPTH_PRE_HF17": 6,
  "HIVE_MAX_FEED_AGE_SECONDS": 604800,
  "HIVE_MAX_INSTANCE_ID": "281474976710655",
  "HIVE_MAX_MEMO_SIZE": 2048,
  "HIVE_MAX_WITNESSES": 21,
  "HIVE_MAX_MINER_WITNESSES_HF0": 1,
  "HIVE_MAX_MINER_WITNESSES_HF17": 0,
  "HIVE_MAX_PERMLINK_LENGTH": 256,
  "HIVE_MAX_PROXY_RECURSION_DEPTH": 4,
  "HIVE_MAX_RATION_DECAY_RATE": 1000000,
  "HIVE_MAX_RESERVE_RATIO": 20000,
  "HIVE_MAX_RUNNER_WITNESSES_HF0": 1,
  "HIVE_MAX_RUNNER_WITNESSES_HF17": 1,
  "HIVE_MAX_SATOSHIS": "4611686018427387903",
  "HIVE_MAX_SHARE_SUPPLY": "1000000000000000",
  "HIVE_MAX_SIG_CHECK_DEPTH": 2,
  "HIVE_MAX_SIG_CHECK_ACCOUNTS": 125,
  "HIVE_MAX_TIME_UNTIL_EXPIRATION": 3600,
  "HIVE_MAX_TRANSACTION_SIZE": 65536,
  "HIVE_MAX_UNDO_HISTORY": 10000,
  "HIVE_MAX_URL_LENGTH": 127,
  "HIVE_MAX_VOTE_CHANGES": 5,
  "HIVE_MAX_VOTED_WITNESSES_HF0": 19,
  "HIVE_MAX_VOTED_WITNESSES_HF17": 20,
  "HIVE_MAX_WITHDRAW_ROUTES": 10,
  "HIVE_MAX_WITNESS_URL_LENGTH": 2048,
  "HIVE_MIN_ACCOUNT_CREATION_FEE": 0,
  "HIVE_MIN_ACCOUNT_NAME_LENGTH": 3,
  "HIVE_MIN_BLOCK_SIZE_LIMIT": 65536,
  "HIVE_MIN_BLOCK_SIZE": 115,
  "HIVE_MIN_CONTENT_REWARD": {
    "amount": "1000",
    "precision": 3,
    "nai": "@@000000021"
  },
  "HIVE_MIN_CURATE_REWARD": {
    "amount": "1000",
    "precision": 3,
    "nai": "@@000000021"
  },
  "HIVE_MIN_PERMLINK_LENGTH": 0,
  "HIVE_MIN_REPLY_INTERVAL": 20000000,
  "HIVE_MIN_REPLY_INTERVAL_HF20": 3000000,
  "HIVE_MIN_ROOT_COMMENT_INTERVAL": 300000000,
  "HIVE_MIN_COMMENT_EDIT_INTERVAL": 3000000,
  "HIVE_MIN_VOTE_INTERVAL_SEC": 3,
  "HIVE_MINER_ACCOUNT": "miners",
  "HIVE_MINER_PAY_PERCENT": 100,
  "HIVE_MIN_FEEDS": 7,
  "HIVE_MINING_REWARD": {
    "amount": "1000",
    "precision": 3,
    "nai": "@@000000021"
  },
  "HIVE_MINING_TIME": "2016-01-01T00:00:00",
  "HIVE_MIN_LIQUIDITY_REWARD": {
    "amount": "1200000",
    "precision": 3,
    "nai": "@@000000021"
  },
  "HIVE_MIN_LIQUIDITY_REWARD_PERIOD_SEC": 60000000,
  "HIVE_MIN_PAYOUT_HBD": {
    "amount": "20",
    "precision": 3,
    "nai": "@@000000013"
  },
  "HIVE_MIN_POW_REWARD": {
    "amount": "1000",
    "precision": 3,
    "nai": "@@000000021"
  },
  "HIVE_MIN_PRODUCER_REWARD": {
    "amount": "1000",
    "precision": 3,
    "nai": "@@000000021"
  },
  "HIVE_MIN_TRANSACTION_EXPIRATION_LIMIT": 15,
  "HIVE_MIN_TRANSACTION_SIZE_LIMIT": 1024,
  "HIVE_MIN_UNDO_HISTORY": 10,
  "HIVE_NULL_ACCOUNT": "null",
  "HIVE_NUM_INIT_MINERS": 1,
  "HIVE_OWNER_AUTH_HISTORY_TRACKING_START_BLOCK_NUM": 1,
  "HIVE_OWNER_AUTH_RECOVERY_PERIOD": 60000000,
  "HIVE_OWNER_CHALLENGE_COOLDOWN": "86400000000",
  "HIVE_OWNER_CHALLENGE_FEE": {
    "amount": "30000",
    "precision": 3,
    "nai": "@@000000021"
  },
  "HIVE_OWNER_UPDATE_LIMIT": 0,
  "HIVE_POST_AVERAGE_WINDOW": 86400,
  "HIVE_POST_REWARD_FUND_NAME": "post",
  "HIVE_POST_WEIGHT_CONSTANT": 1600000000,
  "HIVE_POW_APR_PERCENT": 750,
  "HIVE_PRODUCER_APR_PERCENT": 750,
  "HIVE_PROXY_TO_SELF_ACCOUNT": "",
  "HIVE_HBD_INTEREST_COMPOUND_INTERVAL_SEC": 2592000,
  "HIVE_SECONDS_PER_YEAR": 31536000,
  "HIVE_PROPOSAL_FUND_PERCENT_HF0": 0,
  "HIVE_PROPOSAL_FUND_PERCENT_HF21": 1000,
  "HIVE_RECENT_RSHARES_DECAY_TIME_HF19": "1296000000000",
  "HIVE_RECENT_RSHARES_DECAY_TIME_HF17": "2592000000000",
  "HIVE_REVERSE_AUCTION_WINDOW_SECONDS_HF6": 1800,
  "HIVE_REVERSE_AUCTION_WINDOW_SECONDS_HF20": 900,
  "HIVE_REVERSE_AUCTION_WINDOW_SECONDS_HF21": 300,
  "HIVE_ROOT_POST_PARENT": "",
  "HIVE_SAVINGS_WITHDRAW_REQUEST_LIMIT": 100,
  "HIVE_SAVINGS_WITHDRAW_TIME": "259200000000",
  "HIVE_HBD_START_PERCENT_HF14": 200,
  "HIVE_HBD_START_PERCENT_HF20": 900,
  "HIVE_HBD_STOP_PERCENT_HF14": 500,
  "HIVE_HBD_STOP_PERCENT_HF20": 1000,
  "HIVE_SECOND_CASHOUT_WINDOW": 259200,
  "HIVE_SOFT_MAX_COMMENT_DEPTH": 255,
  "HIVE_START_MINER_VOTING_BLOCK": 864000,
  "HIVE_START_VESTING_BLOCK": 201600,
  "HIVE_TEMP_ACCOUNT": "temp",
  "HIVE_UPVOTE_LOCKOUT_HF7": 60000000,
  "HIVE_UPVOTE_LOCKOUT_HF17": 300000000,
  "HIVE_UPVOTE_LOCKOUT_SECONDS": 300,
  "HIVE_VESTING_FUND_PERCENT_HF16": 1500,
  "HIVE_VESTING_WITHDRAW_INTERVALS": 13,
  "HIVE_VESTING_WITHDRAW_INTERVALS_PRE_HF_16": 104,
  "HIVE_VESTING_WITHDRAW_INTERVAL_SECONDS": 604800,
  "HIVE_VOTE_DUST_THRESHOLD": 50000000,
  "HIVE_VOTING_MANA_REGENERATION_SECONDS": 432000,
  "HIVE_SYMBOL": {"nai": "@@000000021", "precision": 3},
  "VESTS_SYMBOL": {"nai": "@@000000037", "precision": 6},
  "HIVE_VIRTUAL_SCHEDULE_LAP_LENGTH": "18446744073709551615",
  "HIVE_VIRTUAL_SCHEDULE_LAP_LENGTH2": "340282366920938463463374607431768211455",
  "HIVE_VOTES_PER_PERIOD_SMT_HF": 50,
  "HIVE_MAX_LIMIT_ORDER_EXPIRATION": 2419200,
  "HIVE_DELEGATION_RETURN_PERIOD_HF0": 3600,
  "HIVE_DELEGATION_RETURN_PERIOD_HF20": 432000,
  "HIVE_RD_MIN_DECAY_BITS": 6,
  "HIVE_RD_MAX_DECAY_BITS": 32,
  "HIVE_RD_DECAY_DENOM_SHIFT": 36,
  "HIVE_RD_MAX_POOL_BITS": 64,
  "HIVE_RD_MAX_BUDGET_1": "17179869183",
  "HIVE_RD_MAX_BUDGET_2": 268435455,
  "HIVE_RD_MAX_BUDGET_3": 2147483647,
  "HIVE_RD_MAX_BUDGET": 268435455,
  "HIVE_RD_MIN_DECAY": 64,
  "HIVE_RD_MIN_BUDGET": 1,
  "HIVE_RD_MAX_DECAY": 4294967295,
  "HIVE_ACCOUNT_SUBSIDY_PRECISION": 10000,
  "HIVE_WITNESS_SUBSIDY_BUDGET_PERCENT": 12500,
  "HIVE_WITNESS_SUBSIDY_DECAY_PERCENT": 210000,
  "HIVE_DEFAULT_ACCOUNT_SUBSIDY_DECAY": 347321,
  "HIVE_DEFAULT_ACCOUNT_SUBSIDY_BUDGET": 797,
  "HIVE_DECAY_BACKSTOP_PERCENT": 9000,
  "HIVE_BLOCK_GENERATION_POSTPONED_TX_LIMIT": 5,
  "HIVE_PENDING_TRANSACTION_EXECUTION_LIMIT": 200000,
  "HIVE_TREASURY_ACCOUNT": "hive.fund",
  "HIVE_TREASURY_FEE": 10000,
  "HIVE_PROPOSAL_MAINTENANCE_PERIOD": 3600,
  "HIVE_PROPOSAL_MAINTENANCE_CLEANUP": 86400,
  "HIVE_PROPOSAL_SUBJECT_MAX_LENGTH": 80,
  "HIVE_PROPOSAL_MAX_IDS_NUMBER": 5,
  "HIVE_NETWORK_TYPE": "testnet",
  "HIVE_DB_FORMAT_VERSION": "1"
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_config", "id":1}' https://api.hive.blog

database_api.get_current_price_feed

Returns the current price feed.

Query Parameters JSON
{}
Expected Response JSON
{
  "base": {
    "amount": "1",
    "precision": 3,
    "nai": "@@000000013"
  },
  "quote": {
    "amount": "1",
    "precision": 3,
    "nai": "@@000000021"
  }
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_current_price_feed", "id":1}' https://api.hive.blog

database_api.get_dynamic_global_properties

Returns the current dynamic global properties. See: Understanding Dynamic Global Properties

Query Parameters JSON
{}
Expected Response JSON
{
  "id": 0,
  "head_block_number": 293261,
  "head_block_id": "0004798df7357f23b9e6d4b6739e4ca9eac2f403",
  "time": "2019-12-14T22:58:51",
  "current_witness": "init-0",
  "total_pow": "18446744073709551615",
  "num_pow_witnesses": 0,
  "virtual_supply": {
    "amount": "286041551516",
    "precision": 3,
    "nai": "@@000000021"
  },
  "current_supply": {
    "amount": "250990841260",
    "precision": 3,
    "nai": "@@000000021"
  },
  "confidential_supply": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000021"
  },
  "init_hbd_supply": {
    "amount": "7000000000",
    "precision": 3,
    "nai": "@@000000013"
  },
  "current_hbd_supply": {
    "amount": "35050710256",
    "precision": 3,
    "nai": "@@000000013"
  },
  "confidential_hbd_supply": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000013"
  },
  "total_vesting_fund_hive": {
    "amount": "146016220388",
    "precision": 3,
    "nai": "@@000000021"
  },
  "total_vesting_shares": {
    "amount": "52556676118700",
    "precision": 6,
    "nai": "@@000000037"
  },
  "total_reward_fund_hive": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000021"
  },
  "total_reward_shares2": "0",
  "pending_rewarded_vesting_shares": {
    "amount": "55809356614",
    "precision": 6,
    "nai": "@@000000037"
  },
  "pending_rewarded_vesting_hive": {
    "amount": "154999023",
    "precision": 3,
    "nai": "@@000000021"
  },
  "hbd_interest_rate": 1000,
  "hbd_print_rate": 0,
  "maximum_block_size": 131072,
  "required_actions_partition_percent": 2500,
  "current_aslot": 41585977,
  "recent_slots_filled": "340282366920938463463374607431768211455",
  "participation_count": 128,
  "last_irreversible_block_num": 293240,
  "target_votes_per_period": 50,
  "delegation_return_period": 432000,
  "reverse_auction_seconds": 300,
  "available_account_subsidies": 120334411,
  "hbd_stop_percent": 1000,
  "hbd_start_percent": 900,
  "next_maintenance_time": "2019-12-14T23:18:24",
  "last_budget_time": "2019-12-14T22:18:24",
  "content_reward_percent": 6500,
  "vesting_reward_percent": 1500,
  "sps_fund_percent": 1000,
  "sps_interval_ledger": {
    "amount": "213590",
    "precision": 3,
    "nai": "@@000000013"
  },
  "downvote_pool_percent": 2500,
  "smt_creation_fee": {
    "amount": "1000",
    "precision": 3,
    "nai": "@@000000013"
  }
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_dynamic_global_properties", "id":1}' https://api.hive.blog

database_api.get_feed_history

Returns the history of price feed values.

Query Parameters JSON
{}
Expected Response JSON
{
  "id": 0,
  "current_median_history": {
    "base": {
      "amount": "1",
      "precision": 3,
      "nai": "@@000000013"
    },
    "quote": {
      "amount": "1",
      "precision": 3,
      "nai": "@@000000021"
    }
  },
  "price_history": []
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_feed_history", "id":1}' https://api.hive.blog

database_api.get_hardfork_properties

Returns the current properties about the blockchain’s hardforks.

See: condenser_api.get_next_scheduled_hardfork, hardfork

Query Parameters JSON
{}
Expected Response JSON
{
  "id": 0,
  "processed_hardforks": [
    "2016-03-24T16:00:00",
    "2016-04-25T17:30:00",
    "2016-04-26T18:00:00",
    "2016-04-27T13:00:00",
    "2016-04-30T15:00:00",
    "2016-05-31T17:00:00",
    "2016-06-30T14:00:00",
    "2016-07-04T00:00:00",
    "2016-07-04T01:00:00",
    "2016-07-14T00:00:00",
    "2016-07-15T12:00:00",
    "2016-07-17T15:00:00",
    "2016-07-26T15:00:00",
    "2016-08-15T14:00:00",
    "2016-09-20T15:00:00",
    "2016-11-08T16:00:00",
    "2016-12-06T16:00:00",
    "2017-03-30T15:00:00",
    "2017-03-30T15:00:00",
    "2017-06-20T15:00:00",
    "2018-09-25T15:00:00",
    "2019-08-27T15:00:00",
    "2019-08-29T15:00:00",
    "2020-03-20T14:00:00",
    "2020-10-06T14:00:00",
    "2021-06-30T14:00:00",
    "2022-10-11T12:00:00"
  ],
  "last_hardfork": 26,
  "current_hardfork_version": "1.26.0",
  "next_hardfork": "1.26.0",
  "next_hardfork_time": "2022-10-11T12:00:00"
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_hardfork_properties", "id":1}' https://api.hive.blog

database_api.get_order_book

Returns the order book.

Query Parameters JSON
{
  "limit": 0,
  "base": {
    "amount": "1000",
    "precision": 3,
    "nai": "@@000000021"
  },
  "quote": {
    "amount": "1",
    "precision": 3,
    "nai": "@@000000013"
  }
}
Expected Response JSON
{"asks": [], "bids": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_order_book", "params":{"limit":10,"base":{"amount":"1000","precision":3,"nai":"@@000000021"},"quote":{"amount":"1","precision":3,"nai":"@@000000013"}}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_order_book", "params":{"limit":50,"base":{"amount":"1000","precision":3,"nai":"@@000000021"},"quote":{"amount":"1","precision":3,"nai":"@@000000013"}}, "id":1}' https://api.hive.blog

database_api.get_potential_signatures

This method will return the set of all public keys that could possibly sign for a given transaction. This call can be used by wallets to filter their set of public keys to just the relevant subset prior to calling get_required_signatures to get the minimum subset.

Query Parameters JSON
{
  "trx": {
    "ref_block_num": 0,
    "ref_block_prefix": 0,
    "expiration": "1970-01-01T00:00:00",
    "operations": [],
    "extensions": [],
    "signatures": []
  }
}
Expected Response JSON
{"keys": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_potential_signatures", "params":{"trx":{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[{"type":"pow_operation","value":{"worker_account":"cloop3","block_id":"00000449f7860b82b4fbe2f317c670e9f01d6d9a","nonce":3899,"work":{"worker":"STM7P5TDnA87Pj9T4mf6YHrhzjC1KbPZpNxLWCcVcHxNYXakpoT4F","input":"ae8e7c677119d22385f8c48026fee7aad7bba693bf788d7f27047f40b47738c0","signature":"1f38fe9a3f9989f84bd94aa5bbc88beaf09b67f825aa4450cf5105d111149ba6db560b582c7dbb026c7fc9c2eb5051815a72b17f6896ed59d3851d9a0f9883ca7a","work":"000e7b209d58f2e64b36e9bf12b999c6c7af168cc3fc41eb7f8a4bf796c174c3"},"props":{"account_creation_fee":{"amount":"100000","precision":3,"nai":"@@000000021"},"maximum_block_size":131072,"hbd_interest_rate":1000}}}],"extensions":[],"signatures":[]}}, "id":1}' https://api.hive.blog

database_api.get_required_signatures

This API will take a partially signed transaction and a set of public keys that the owner has the ability to sign for and return the minimal subset of public keys that should add signatures to the transaction.

Query Parameters JSON
{
  "trx": {
    "ref_block_num": 0,
    "ref_block_prefix": 0,
    "expiration": "1970-01-01T00:00:00",
    "operations": [],
    "extensions": [],
    "signatures": []
  },
  "available_keys": []
}
Expected Response JSON
{"keys": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_required_signatures", "params":{"trx":{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[{"type":"pow_operation","value":{"worker_account":"cloop3","block_id":"00000449f7860b82b4fbe2f317c670e9f01d6d9a","nonce":3899,"work":{"worker":"STM7P5TDnA87Pj9T4mf6YHrhzjC1KbPZpNxLWCcVcHxNYXakpoT4F","input":"ae8e7c677119d22385f8c48026fee7aad7bba693bf788d7f27047f40b47738c0","signature":"1f38fe9a3f9989f84bd94aa5bbc88beaf09b67f825aa4450cf5105d111149ba6db560b582c7dbb026c7fc9c2eb5051815a72b17f6896ed59d3851d9a0f9883ca7a","work":"000e7b209d58f2e64b36e9bf12b999c6c7af168cc3fc41eb7f8a4bf796c174c3"},"props":{"account_creation_fee":{"amount":"100000","precision":3,"nai":"@@000000021"},"maximum_block_size":131072,"hbd_interest_rate":1000}}}],"extensions":[],"signatures":[]},"available_keys":[]}, "id ":1}' https://api.hive.blog

database_api.get_reward_funds

Returns information about the current reward funds.

Query Parameters JSON
{}
Expected Response JSON
{
  "funds": [
    {
      "id": 0,
      "name": "post",
      "reward_balance": {
        "amount": "189101553",
        "precision": 3,
        "nai": "@@000000021"
      },
      "recent_claims": "2723043883497",
      "last_update": "2019-12-14T23:10:42",
      "content_constant": "2000000000000",
      "percent_curation_rewards": 5000,
      "percent_content_rewards": 10000,
      "author_reward_curve": "convergent_linear",
      "curation_reward_curve": "convergent_square_root"
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_reward_funds", "id":1}' https://api.hive.blog

database_api.get_transaction_hex

Returns a hexdump of the serialized binary form of a transaction.

Query Parameters JSON
{
  "trx": {
    "ref_block_num": 0,
    "ref_block_prefix": 0,
    "expiration": "1970-01-01T00:00:00",
    "operations": [],
    "extensions": [],
    "signatures": []
  }
}
Expected Response JSON
{"hex": "00000000000000000000000000"}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_transaction_hex", "params":{"trx":{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[{"type":"pow_operation","value":{"worker_account":"cloop3","block_id":"00000449f7860b82b4fbe2f317c670e9f01d6d9a","nonce":3899,"work":{"worker":"STM7P5TDnA87Pj9T4mf6YHrhzjC1KbPZpNxLWCcVcHxNYXakpoT4F","input":"ae8e7c677119d22385f8c48026fee7aad7bba693bf788d7f27047f40b47738c0","signature":"1f38fe9a3f9989f84bd94aa5bbc88beaf09b67f825aa4450cf5105d111149ba6db560b582c7dbb026c7fc9c2eb5051815a72b17f6896ed59d3851d9a0f9883ca7a","work":"000e7b209d58f2e64b36e9bf12b999c6c7af168cc3fc41eb7f8a4bf796c174c3"},"props":{"account_creation_fee":{"amount":"100000","precision":3,"nai":"@@000000021"},"maximum_block_size":131072,"hbd_interest_rate":1000}}}],"extensions":[],"signatures":[]}}, "id":1}' https://api.hive.blog

database_api.get_version

Returns the compile time versions of blockchain, hived, FC. Also returns the boot time version of the chain id (may be different from compile time value only when looking at a testnet)

Query Parameters JSON
{}
Expected Response JSON
{
  "blockchain_version": "0.23.0",
  "hive_revision": "5cda10a488cf77f68549ec6d3a6be9af2ea9351b",
  "fc_revision": "5cda10a488cf77f68549ec6d3a6be9af2ea9351b",
  "chain_id": "beeab0de00000000000000000000000000000000000000000000000000000000"
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_version", "id":1}' https://api.hive.blog

database_api.get_witness_schedule

Returns the current witness schedule.

Query Parameters JSON
{}
Expected Response JSON
{
  "id": 0,
  "current_virtual_time": "55892543567970911424442556665819",
  "next_shuffle_block_num": 293580,
  "current_shuffled_witnesses": [
    "init-2",
    "init-11",
    "init-18",
    "init-16",
    "init-1",
    "init-10",
    "init-0",
    "init-14",
    "init-13",
    "gandalf",
    "init-3",
    "init-12",
    "init-5",
    "init-17",
    "initminer",
    "init-19",
    "init-4",
    "init-15",
    "drakos",
    "gtg",
    "init-7"
  ],
  "num_scheduled_witnesses": 21,
  "elected_weight": 1,
  "timeshare_weight": 5,
  "miner_weight": 1,
  "witness_pay_normalization_factor": 25,
  "median_props": {
    "account_creation_fee": {
      "amount": "0",
      "precision": 3,
      "nai": "@@000000021"
    },
    "maximum_block_size": 131072,
    "hbd_interest_rate": 1000,
    "account_subsidy_budget": 797,
    "account_subsidy_decay": 347321
  },
  "majority_version": "0.23.0",
  "max_voted_witnesses": 20,
  "max_miner_witnesses": 0,
  "max_runner_witnesses": 1,
  "hardfork_required_witnesses": 17,
  "account_subsidy_rd": {
    "resource_unit": 10000,
    "budget_per_time_unit": 797,
    "pool_eq": 157691079,
    "max_pool_size": 157691079,
    "decay_params": {
      "decay_per_time_unit": 347321,
      "decay_per_time_unit_denom_shift": 36
    },
    "min_decay": 0
  },
  "account_subsidy_witness_rd": {
    "resource_unit": 10000,
    "budget_per_time_unit": 996,
    "pool_eq": 9384019,
    "max_pool_size": 9384019,
    "decay_params": {
      "decay_per_time_unit": 7293741,
      "decay_per_time_unit_denom_shift": 36
    },
    "min_decay": 612
  },
  "min_witness_account_subsidy_decay": 0
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_witness_schedule", "id":1}' https://api.hive.blog

database_api.list_account_recovery_requests

Returns a list of account recovery requests. Parameters: start:string, limit:int, order:string

account (string) limit (int) order (string)  
"hiveio" 10 "by_account" Queries the recovery requests for account named “hiveio”, ordered by account name.
["1960-01-01T00:00:00"] 10 "by_expiration" Queries the recovery requests for date, ordered by expiration.
Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{"requests": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_account_recovery_requests", "params": {"start":"", "limit":10, "order":"by_account"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_account_recovery_requests", "params": {"start":["1960-01-01T00:00:00"], "limit":10, "order":"by_expiration"}, "id":1}' https://api.hive.blog

database_api.list_accounts

List accounts ordered by specified key. Parameters: start:object, limit:int, order:string, delayed_votes_active:boolean

start (object) limit (int) order (string) delayed_votes_active (boolean)
"" 10 "by_name" Queries for up to 10 accounts starting at the beginning, sorted by name.  
["", ""] 10 "by_proxy" Queries for up to 10 accounts starting at the beginning, sorted by proxy.  
["1960-01-01T00:00:00", ""] 10 "by_next_vesting_withdrawal" Queries for up to 10 accounts starting at the beginning, sorted by next vesting withdrawl. false

Also see: Paginated API Methods

Query Parameters JSON
{
  "start": null,
  "limit": 0,
  "order": "by_name",
  "delayed_votes_active": true
}
Expected Response JSON
{
  "accounts": [
    {
      "id": 7184,
      "name": "a-0",
      "owner": {
        "weight_threshold": 1,
        "account_auths": [],
        "key_auths": [
          [
            "STM5RrTRNDhhrMaA24SzSeE5AvmUcutb1q1VZp1imnT8p871s3UjN",
            1
          ]
        ]
      },
      "active": {
        "weight_threshold": 1,
        "account_auths": [],
        "key_auths": [
          [
            "STM5RrTRNDhhrMaA24SzSeE5AvmUcutb1q1VZp1imnT8p871s3UjN",
            1
          ]
        ]
      },
      "posting": {
        "weight_threshold": 1,
        "account_auths": [],
        "key_auths": [
          [
            "STM5RrTRNDhhrMaA24SzSeE5AvmUcutb1q1VZp1imnT8p871s3UjN",
            1
          ]
        ]
      },
      "memo_key": "STM5RrTRNDhhrMaA24SzSeE5AvmUcutb1q1VZp1imnT8p871s3UjN",
      "json_metadata": "",
      "posting_json_metadata": "",
      "proxy": "",
      "last_owner_update": "1970-01-01T00:00:00",
      "last_account_update": "1970-01-01T00:00:00",
      "created": "2016-04-30T12:27:12",
      "mined": true,
      "recovery_account": "hiveio",
      "last_account_recovery": "1970-01-01T00:00:00",
      "reset_account": "null",
      "comment_count": 0,
      "lifetime_vote_count": 0,
      "post_count": 0,
      "can_vote": true,
      "voting_manabar": {
        "current_mana": 10000,
        "last_update_time": 1462019232
      },
      "downvote_manabar": {
        "current_mana": 0,
        "last_update_time": 1462019232
      },
      "balance": {
        "amount": "1",
        "precision": 3,
        "nai": "@@000000021"
      },
      "savings_balance": {
        "amount": "0",
        "precision": 3,
        "nai": "@@000000021"
      },
      "hbd_balance": {
        "amount": "0",
        "precision": 3,
        "nai": "@@000000013"
      },
      "hbd_seconds": "0",
      "hbd_seconds_last_update": "1970-01-01T00:00:00",
      "hbd_last_interest_payment": "1970-01-01T00:00:00",
      "savings_hbd_balance": {
        "amount": "0",
        "precision": 3,
        "nai": "@@000000013"
      },
      "savings_hbd_seconds": "0",
      "savings_hbd_seconds_last_update": "1970-01-01T00:00:00",
      "savings_hbd_last_interest_payment": "1970-01-01T00:00:00",
      "savings_withdraw_requests": 0,
      "reward_hbd_balance": {
        "amount": "0",
        "precision": 3,
        "nai": "@@000000013"
      },
      "reward_hive_balance": {
        "amount": "0",
        "precision": 3,
        "nai": "@@000000021"
      },
      "reward_vesting_balance": {
        "amount": "0",
        "precision": 6,
        "nai": "@@000000037"
      },
      "reward_vesting_hive": {
        "amount": "0",
        "precision": 3,
        "nai": "@@000000021"
      },
      "vesting_shares": {
        "amount": "13873020360",
        "precision": 6,
        "nai": "@@000000037"
      },
      "delegated_vesting_shares": {
        "amount": "0",
        "precision": 6,
        "nai": "@@000000037"
      },
      "received_vesting_shares": {
        "amount": "0",
        "precision": 6,
        "nai": "@@000000037"
      },
      "vesting_withdraw_rate": {
        "amount": "0",
        "precision": 6,
        "nai": "@@000000037"
      },
      "post_voting_power": {
        "amount": "13873020360",
        "precision": 6,
        "nai": "@@000000037"
      },
      "next_vesting_withdrawal": "1969-12-31T23:59:59",
      "withdrawn": 0,
      "to_withdraw": 0,
      "withdraw_routes": 0,
      "pending_transfers": 0,
      "curation_rewards": 0,
      "posting_rewards": 0,
      "proxied_vsf_votes": [0, 0, 0, 0],
      "witnesses_voted_for": 0,
      "last_post": "1970-01-01T00:00:00",
      "last_root_post": "1970-01-01T00:00:00",
      "last_post_edit": "1970-01-01T00:00:00",
      "last_vote_time": "1970-01-01T00:00:00",
      "post_bandwidth": 0,
      "pending_claimed_accounts": 0,
      "is_smt": false,
      "delayed_votes": [
        {
          "time": "2021-02-24T05:08:21",
          "val": "11550765516955"
        },
        {
          "time": "2021-02-26T15:46:06",
          "val": "633465684569"
        },
        {
          "time": "2021-03-07T17:54:39",
          "val": "1000000037683"
        },
        {
          "time": "2021-03-16T05:54:33",
          "val": "999978763511"
        },
        {
          "time": "2021-03-18T06:06:00",
          "val": "1000000171317"
        }
      ]
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_accounts", "params": {"start":"", "limit":10, "order":"by_name"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_accounts", "params": {"start":["", ""], "limit":10, "order":"by_proxy"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_accounts", "params": {"start":["1960-01-01T00:00:00", ""], "limit":10, "order":"by_next_vesting_withdrawal","delayed_votes_active":false}, "id":1}' https://api.hive.blog

database_api.list_change_recovery_account_requests

Returns a list of recovery account change requests. Parameters: start:object, limit:int, order:string

start (object) limit (int) order (string)  
"" 10 "by_account" Queries first 10 requests, sort by account
["1960-01-01T00:00:00", ""] 10 "by_effective_date" Queries first 10 requests, sort by effective date

Also see: Paginated API Methods

Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{
  "requests": [
    {
      "id": 99,
      "account_to_recover": "alice",
      "recovery_account": "bob",
      "effective_on": "1960-01-01T00:00:00"
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_change_recovery_account_requests", "params": {"start":"alice", "limit":10, "order":"by_account"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_change_recovery_account_requests", "params": {"start":["1960-01-01T00:00:00",""], "limit":10, "order":"by_effective_date"}, "id":1}' https://api.hive.blog

database_api.list_comments

Returns all comments, starting with the specified options. Parameters: start:array; limit:int; order:string

start (array) limit (int) order (string)  
["1970-01-01T00:00:00", "", ""] 10 "by_cashout_time" Queries first 10 comments, sort by cashout time
["", ""] 10 "by_permlink" Queries first 10 comments, sort by permlink
["hiveio","announcing-the-launch-of-hive-blockchain", "", ""] 10 "by_root" Queries next 10 comments starting at @hiveio/firstpost, sort by root
["hiveio","announcing-the-launch-of-hive-blockchain", "", ""] 10 "by_parent" Queries next 10 comments starting at @hiveio/firstpost, sort by parent
["hiveio","1970-01-01T00:00:00", "", ""] 10 "by_last_update" Queries next 10 comments starting at @hiveio’s updates since timpstamp, sort by last update
["hiveio","1970-01-01T00:00:00", "", ""] 10 "by_author_last_update" Queries next 10 comments starting at @hiveio’s updates since timestamp, sort by author’s last update

Also see: Paginated API Methods

Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{
  "comments": [
    {
      "active": "2020-03-18T16:45:21",
      "author_rewards": 11835,
      "id": 96448425,
      "author": "berniesanders",
      "permlink": "q7d2ue",
      "category": "communityfork",
      "title": "",
      "body": "https://media.giphy.com/media/xjLlSxM5Z61FJh9wMC/giphy.gif",
      "json_metadata": "{\"image\":[\"https://media.giphy.com/media/xjLlSxM5Z61FJh9wMC/giphy.gif\"],\"app\":\"steemit/0.2\"}",
      "created": "2020-03-17T23:35:06",
      "last_update": "2020-03-17T23:35:06",
      "depth": 1,
      "children": 5,
      "last_payout": "2020-03-24T23:35:06",
      "cashout_time": "1969-12-31T23:59:59",
      "max_cashout_time": "1969-12-31T23:59:59",
      "curator_payout_value": {
        "amount": "2120",
        "nai": "@@000000013",
        "precision": 3
      },
      "total_payout_value": {
        "amount": "2247",
        "nai": "@@000000013",
        "precision": 3
      },
      "reward_weight": 10000,
      "root_author": "hiveio",
      "root_permlink": "announcing-the-launch-of-hive-blockchain",
      "allow_replies": true,
      "allow_votes": true,
      "allow_curation_rewards": true,
      "parent_author": "hiveio",
      "parent_permlink": "announcing-the-launch-of-hive-blockchain",
      "beneficiaries": [],
      "max_accepted_payout": {
        "amount": "1000000000",
        "nai": "@@000000013",
        "precision": 3
      },
      "percent_hbd": 10000,
      "net_votes": 30,
      "total_vote_weight": 0,
      "vote_rshares": 0,
      "net_rshares": 0,
      "abs_rshares": 0,
      "children_abs_rshares": 0
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_comments", "params": {"start":["1970-01-01T00:00:00","",""], "limit":10, "order":"by_cashout_time"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_comments", "params": {"start":["",""], "limit":10, "order":"by_permlink"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_comments", "params": {"start":["hiveio","announcing-the-launch-of-hive-blockchain","",""], "limit":10, "order":"by_root"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_comments", "params": {"start":["hiveio","announcing-the-launch-of-hive-blockchain","",""], "limit":10, "order":"by_parent"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_comments", "params": {"start":["hiveio","1970-01-01T00:00:00","",""], "limit":10, "order":"by_last_update"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_comments", "params": {"start":["hiveio","1970-01-01T00:00:00","",""], "limit":10, "order":"by_author_last_update"}, "id":1}' https://api.hive.blog

database_api.list_decline_voting_rights_requests

Returns a list of decline voting rights requests. Parameters: start:object; limit:int; order:string

start (object) limit (int) order (string)  
"" 10 "by_account" Queries first 10 requests, sort by account
["1960-01-01T00:00:00", ""] 10 "by_effective_date" Queries first 10 requests, sort by effective date

Also see: Paginated API Methods

Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{"requests": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_decline_voting_rights_requests", "params": {"start":"", "limit":10, "order":"by_account"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_decline_voting_rights_requests", "params": {"start":["1970-01-01T00:00:00","",""], "limit":10, "order":"by_effective_date"}, "id":1}' https://api.hive.blog

database_api.list_escrows

Returns a list of escrows. Parameters: start:array; limit:int; order:string

start (array) limit (int) order (string)  
["alice", 99] 10 "by_from_id" Queries first 10 requests, sort by id
[true, "1960-01-01T00:00:00", 99] 10 "by_ratification_deadline" Queries first 10 requests, sort by ratification deadline

Also see: Paginated API Methods

Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{
  "escrows": [
    {
      "id": 158,
      "escrow_id": 1,
      "from": "addicttolife",
      "to": "fundition.help",
      "agent": "ongame",
      "ratification_deadline": "2018-11-23T17:31:26",
      "escrow_expiration": "2018-11-24T17:31:26",
      "hbd_balance": {
        "amount": "0",
        "precision": 3,
        "nai": "@@000000013"
      },
      "hive_balance": {
        "amount": "4832",
        "precision": 3,
        "nai": "@@000000021"
      },
      "pending_fee": {
        "amount": "0",
        "precision": 3,
        "nai": "@@000000021"
      },
      "to_approved": true,
      "agent_approved": true,
      "disputed": false
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_escrows", "params": {"start":["",0], "limit":10, "order":"by_from_id"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_escrows", "params": {"start":[true, "1970-01-01T00:00:00", 0], "limit":10, "order":"by_ratification_deadline"}, "id":1}' https://api.hive.blog

database_api.list_limit_orders

Returns a list of limit orders. Parameters: start:array; limit:int; order:string

start (array) limit (int) order (string)  
[{"base": {"amount": "85405", "precision": 3, "nai": "@@000000021"}, "quote": {"amount": "17192", "precision": 3, "nai": "@@000000013"}}, 0] 10 "by_price" Queries first 10 requests, sort by price
["alice", 0] 10 "by_account" Queries first 10 requests, sort by account

Also see: Paginated API Methods

Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{
  "orders": [
    {
      "id": 3155591,
      "created": "2018-12-05T06:34:21",
      "expiration": "2018-12-15T06:34:20",
      "seller": "teamsmooth-mm",
      "orderid": 2000,
      "for_sale": 197714,
      "sell_price": {
        "base": {
          "amount": "198513",
          "precision": 3,
          "nai": "@@000000021"
        },
        "quote": {
          "amount": "80000",
          "precision": 3,
          "nai": "@@000000013"
        }
      }
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_limit_orders", "params": {"start":[{"base":{"amount":"1000","precision":3,"nai":"@@000000021"},"quote":{"amount":"1","precision":3,"nai":"@@000000013"}},0], "limit":10, "order":"by_price"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_limit_orders", "params": {"start":["alice",0], "limit":10, "order":"by_account"}, "id":1}' https://api.hive.blog

database_api.list_owner_histories

Returns a list of owner authority histories. Parameters: start:array, limit:int

start (array) limit (int)  
["hiveio", "1970-01-01T00:00:00"] 10 Queries the owner history starting from account named “hiveio” on “1970-01-01T00:00:00”, limit 10 results.
["alice", "1970-01-01T00:00:00"] 10 Queries the owner history starting from account named “alice”, limit 10 results.

Also see: Paginated API Methods

Query Parameters JSON
{"start": null, "limit": 0}
Expected Response JSON
{
  "owner_auths": [
    {
      "id": 129742,
      "account": "a-m",
      "previous_owner_authority": {
        "weight_threshold": 1,
        "account_auths": [],
        "key_auths": [
          [
            "STM7J6gXoztfTscNzmzL11DFtTPCFCTeZzsFtFxsQrQw91KnN1YxQ",
            1
          ]
        ]
      },
      "last_valid_time": "2018-11-24T02:35:27"
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_owner_histories", "params": {"start":["hiveio","1970-01-01T00:00:00"], "limit":10}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_owner_histories", "params": {"start":["alice","1970-01-01T00:00:00"], "limit":10}, "id":1}' https://api.hive.blog

database_api.list_savings_withdrawals

Returns a list of savings withdrawls. Parameters: start:object, limit:int, order:string

start (object) limit (int) order (string)  
[0] 10 "by_from_id" Queries the savings withdraw for id.
["2018-12-07T16:54:03", "hiveio", 0] 10 "by_complete_from_id" Queries the savings withdraw for id (completed).
["", "1970-01-01T00:00:00", 0] 10 "by_to_complete" Queries the savings withdraw completed.

Also see: Paginated API Methods

Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{
  "withdrawals": [
    {
      "id": 120083,
      "from": "adafnnys",
      "to": "adafnnys",
      "memo": "",
      "request_id": 1543942411,
      "amount": {
        "amount": "2413",
        "precision": 3,
        "nai": "@@000000013"
      },
      "complete": "2018-12-07T16:54:03"
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_savings_withdrawals", "params": {"start":[0], "limit":10, "order":"by_from_id"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_savings_withdrawals", "params": {"start":["2018-12-07T16:54:03", "hiveio", 0], "limit":10, "order":"by_complete_from_id"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_savings_withdrawals", "params": {"start":["", "1970-01-01T00:00:00", 0], "limit":10, "order":"by_to_complete"}, "id":1}' https://api.hive.blog

database_api.list_hbd_conversion_requests

Returns the list of HBD conversion requests for an account. Parameters: start:array, limit:int, order:string

start (array) limit (int) order (string)  
["hiveio", 0] 10 by_account Queries a conversion request for hiveio, limit to 10 results, order by account name.
["2018-12-07T16:54:03", 0] 10 by_conversion_date Queries a conversion request from this date, limit to 10 results, order by conversion date.

Also see: Paginated API Methods

Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{
  "requests": [
    {
      "id": 75677,
      "owner": "adenijiadeshina",
      "requestid": 3,
      "amount": {
        "amount": "311",
        "precision": 3,
        "nai": "@@000000013"
      },
      "conversion_date": "2018-12-06T20:42:42"
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_hbd_conversion_requests", "params": {"start":["hiveio", 0], "limit":10, "order":"by_account"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_hbd_conversion_requests", "params": {"start":["2018-12-07T16:54:03", 0], "limit":10, "order":"by_conversion_date"}, "id":1}' https://api.hive.blog

database_api.list_vesting_delegation_expirations

Returns a list of vesting delegation expirations. Parameters: start:array, limit:int, order:string

start (array) limit (int) order (string)  
["1970-01-01T00:00:00", 0] 10 by_expiration Queries delegations, limit to 10 results, order by expiration.
["alice", "1970-01-01T00:00:00", 0] 10 by_account_expiration Queries delegation from this date, limit to 10 results, order by account expiration.

Also see: Paginated API Methods

Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{
  "delegations": [
    {
      "id": 3076685,
      "delegator": "anonsteem",
      "vesting_shares": {
        "amount": "6050629930",
        "precision": 6,
        "nai": "@@000000037"
      },
      "expiration": "2018-12-05T07:07:15"
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_vesting_delegation_expirations", "params": {"start":["1970-01-01T00:00:00",0], "limit":10, "order":"by_expiration"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_vesting_delegation_expirations", "params": {"start":["alice", "1970-01-01T00:00:00",0], "limit":10, "order":"by_account_expiration"}, "id":1}' https://api.hive.blog

database_api.list_vesting_delegations

Returns a list of vesting delegations. Parameters: start:array, limit:int, order:string

start (array) limit (int) order (string)  
["", ""] 10 by_delegation Queries delegations, limit to 10 results, order by delegations.

Also see: Paginated API Methods

Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{
  "delegations": [
    {
      "id": 554317,
      "delegator": "a-0-0-0",
      "delegatee": "a-0-0",
      "vesting_shares": {
        "amount": "6141067173",
        "precision": 6,
        "nai": "@@000000037"
      },
      "min_delegation_time": "2018-01-24T22:23:54"
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_vesting_delegations", "params": {"start":["",""], "limit":10, "order":"by_delegation"}, "id":1}' https://api.hive.blog

database_api.list_votes

Returns all votes, starting with the specified voter and/or author and permlink. Parameters: start:array; limit:int; order:string

start (array) limit (int) order (string)  
["", "", ""] 10 "by_comment_voter" Queries first 10 votes, sort by comment voter
["", "", ""] 10 "by_voter_comment" Queries first 10 votes, sort by voter comment
["xeroc", "vanteem-config", ""] 10 "by_comment_voter" Queries next 10 votes starting on the post @xeroc/vanteem-config, sort by comment voter
["alice", "xeroc", "vanteem-config"] 10 "by_voter_comment" Queries next 10 votes starting at alice on the post @xeroc/vanteem-config, sort by voter comment

Also see: Paginated API Methods

Query Parameters JSON
{
  "start": null,
  "limit": 0,
  "order": "by_comment_voter"
}
Expected Response JSON
{
  "votes": [
    {
      "id": 9,
      "voter": "dantheman",
      "author": "hiveio",
      "permlink": "firstpost",
      "weight": "32866333630",
      "rshares": 375241,
      "vote_percent": 100,
      "last_update": "2016-04-07T19:15:36",
      "num_changes": -1
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_votes", "params": {"start":["", "", ""], "limit":10, "order":"by_comment_voter"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_votes", "params": {"start":["", "", ""], "limit":10, "order":"by_voter_comment"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_votes", "params": {"start":["", "", "hiveio"], "limit":10, "order":"by_comment_voter"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_votes", "params": {"start":["alice", "xeroc", "vanteem-config"], "limit":10, "order":"by_voter_comment"}, "id":1}' https://api.hive.blog

database_api.list_withdraw_vesting_routes

Returns a list of vesting withdraw routes. Parameters: start:array; limit:int; order:string

start (array) limit (int) order (string)  
["temp", ""] 10 "by_withdraw_route" Queries first 10 routes, sort by withdraw route
["", 0] 10 "by_destination" Queries first 10 routes, sort by destination

Also see: Paginated API Methods

Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{
  "routes": [
    {
      "id": 39503,
      "from_account": "temperature",
      "to_account": "luckdiver",
      "percent": 10000,
      "auto_vest": false
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_withdraw_vesting_routes", "params": {"start":["temp",""], "limit":10, "order":"by_withdraw_route"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_withdraw_vesting_routes", "params": {"start":["",0], "limit":10, "order":"by_destination"}, "id":1}' https://api.hive.blog

database_api.list_witness_votes

Returns a list of witness votes. Parameters: start:array; limit:int; order:string

start (array) limit (int) order (string)  
["", ""] 10 "by_withdraw_route" Queries first 10 votes, sort by account witness
["", ""] 10 "by_destination" Queries first 10 votes, sort by witness account

Also see: Paginated API Methods

Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{
  "votes": [
    {
      "id": 428961,
      "witness": "aggroed",
      "account": "a-0magic"
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_witness_votes", "params": {"start":["",""], "limit":10, "order":"by_account_witness"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_witness_votes", "params": {"start":["",""], "limit":10, "order":"by_witness_account"}, "id":1}' https://api.hive.blog

database_api.list_witnesses

Returns the list of witnesses. Parameters: start:object; limit:int; order:string

start (object) limit (int) order (string)  
"" 10 "by_name" Queries first 10 witnesses, sort by account name
[0, ""] 10 "by_vote_name" Queries first 10 witnesses, sort by votes
["473718186844702107410533306", "alice"] 10 "by_schedule_time" Queries first 10 witnesses, sort by schedule

Also see: Paginated API Methods

Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{
  "witnesses": [
    {
      "id": 6950,
      "owner": "a-0",
      "created": "1970-01-01T00:00:00",
      "url": "",
      "votes": 0,
      "virtual_last_update": "0",
      "virtual_position": "0",
      "virtual_scheduled_time": "340282366920938463463374607431768211455",
      "total_missed": 0,
      "last_aslot": 1063323,
      "last_confirmed_block_num": 1040423,
      "pow_worker": 0,
      "signing_key": "STM5RrTRNDhhrMaA24SzSeE5AvmUcutb1q1VZp1imnT8p871s3UjN",
      "props": {
        "account_creation_fee": {
          "amount": "1",
          "precision": 3,
          "nai": "@@000000021"
        },
        "maximum_block_size": 131072,
        "hbd_interest_rate": 1000,
        "account_subsidy_budget": 797,
        "account_subsidy_decay": 347321
      },
      "hbd_exchange_rate": {
        "base": {
          "amount": "0",
          "precision": 3,
          "nai": "@@000000021"
        },
        "quote": {
          "amount": "0",
          "precision": 3,
          "nai": "@@000000021"
        }
      },
      "last_hbd_exchange_update": "1970-01-01T00:00:00",
      "last_work": "000000127cb0e335667f30100bc1a061175c2d789f808e0e9ac82ee70fa8e604",
      "running_version": "0.0.0",
      "hardfork_version_vote": "0.0.0",
      "hardfork_time_vote": "2016-03-24T16:00:00",
      "available_witness_account_subsidies": 0
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_witnesses", "params": {"start":"", "limit":10, "order":"by_name"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_witnesses", "params": {"start":[0,""], "limit":10, "order":"by_vote_name"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_witnesses", "params": {"start":["473718186844702107410533306","alice"], "limit":10, "order":"by_schedule_time"}, "id":1}' https://api.hive.blog

database_api.verify_account_authority

Not Implemented

Query Parameters JSON
{"account": "", "signers": []}
Expected Response JSON
{"valid": false}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.verify_account_authority", "params":{"account":"temp","signers":["STM8GC13uCZbP44HzMLV6zPZGwVQ8Nt4Kji8PapsPiNq1BK153XTX"]}, "id":1}' https://api.hive.blog

database_api.verify_authority

Returns true if the transaction has all of the required signatures, otherwise throws an exception.

Query Parameters JSON
{
  "trx": {
    "ref_block_num": 0,
    "ref_block_prefix": 0,
    "expiration": "1970-01-01T00:00:00",
    "operations": [],
    "extensions": [],
    "signatures": []
  },
  "pack": "legacy"
}
Expected Response JSON
{"valid": false}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.verify_authority", "params":{"trx":{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[{"type":"pow_operation","value":{"worker_account":"cloop3","block_id":"00000449f7860b82b4fbe2f317c670e9f01d6d9a","nonce":3899,"work":{"worker":"STM7P5TDnA87Pj9T4mf6YHrhzjC1KbPZpNxLWCcVcHxNYXakpoT4F","input":"ae8e7c677119d22385f8c48026fee7aad7bba693bf788d7f27047f40b47738c0","signature":"1f38fe9a3f9989f84bd94aa5bbc88beaf09b67f825aa4450cf5105d111149ba6db560b582c7dbb026c7fc9c2eb5051815a72b17f6896ed59d3851d9a0f9883ca7a","work":"000e7b209d58f2e64b36e9bf12b999c6c7af168cc3fc41eb7f8a4bf796c174c3"},"props":{"account_creation_fee":{"amount":"100000","precision":3,"nai":"@@000000021"},"maximum_block_size":131072,"hbd_interest_rate":1000}}}],"extensions":[],"signatures":[]}}, "id":1}' https://api.hive.blog

database_api.verify_signatures

This method validates if transaction was signed by person listed in required_owner, required_active or required_posting parameter. Hash is a mix of chain_id and transaction data.

Query Parameters JSON
{
  "hash": "0000000000000000000000000000000000000000000000000000000000000000",
  "signatures": [],
  "required_owner": [],
  "required_active": [],
  "required_posting": [],
  "required_other": []
}
Expected Response JSON
{"valid": false}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.verify_signatures", "params":{"hash": "0000000000000000000000000000000000000000000000000000000000000000", "signatures": [], "required_owner": [], "required_active": [], "required_posting": [], "required_other": []}, "id":1}' https://api.hive.blog

database_api.find_proposals

Finds proposals by proposal.id (not proposal.proposal_id).

Query Parameters JSON
{"proposal_ids": [0]}
Expected Response JSON
{
  "proposals": [
    {
      "id": 0,
      "proposal_id": "139925218365120",
      "creator": "alice",
      "receiver": "bob",
      "start_date": "2019-07-01T00:00:00",
      "end_date": "2019-08-01T23:59:59",
      "daily_pay": {
        "amount": "4800000",
        "precision": 3,
        "nai": "@@000000013"
      },
      "subject": "My Proposal",
      "permlink": "creator-proposal-permlink",
      "total_votes": "77351826710",
      "status": "active"
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_proposals", "params":{"proposal_ids": [0]}, "id":1}' https://api.hive.blog

database_api.list_proposal_votes

Returns all proposal votes, starting with the specified voter or proposal.id. Parameters: start:array; limit:int; order:string; order_direction:string; status:string

start (array) limit (int) order (string) order_direction (string) status (string)  
["alice"] 10 by_voter_proposal ascending active list 10 proposals with active status, ordered by voter, ascending
[10] 1000 by_proposal_voter ascending votable list 1000 votes on proposal 10, ordered by proposal.id, ascending

Also see: Paginated API Methods

Query Parameters JSON
{
  "start": null,
  "limit": 0,
  "order": "by_name",
  "order_direction": "ascending",
  "status": "all"
}
Expected Response JSON
{
  "proposal_votes": [
    {
      "id": 0,
      "voter": "charlie",
      "proposal": {
        "id": 0,
        "proposal_id": 0,
        "creator": "alice",
        "receiver": "bob",
        "start_date": "2019-07-01T00:00:00",
        "end_date": "2019-08-01T23:59:59",
        "daily_pay": {
          "amount": "4800000",
          "precision": 3,
          "nai": "@@000000013"
        },
        "subject": "My Proposal",
        "permlink": "creator-proposal-permlink",
        "total_votes": "77351826710",
        "status": "active"
      }
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_proposal_votes", "params":{"start": [""], "limit": 10, "order": "by_voter_proposal", "order_direction": "ascending", "status": "active"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_proposal_votes", "params":{"start": [0], "limit": 10, "order": "by_proposal_voter", "order_direction": "ascending", "status": "active"}, "id":1}' https://api.hive.blog

database_api.list_proposals

Returns all proposals, starting with the specified creator or start date. Parameters: start:array; limit:int; order:string; order_direction:string; status:string

start (array) limit (int) order (string) order_direction (string) status (string)  
[""] 10 by_creator ascending active list 10 proposals with active status, ordered by creator, ascending
["2019-08-07T16:54:03"] 1000 by_start_date ascending inactive list 1000 proposals with inactive status, ordered by start date, ascending, since 2019-08-07T16:54:03
["a"] 1 by_creator ascending expired list 1 proposal with expired status, ordered by creator, ascending, by accounts starting with “a”
["alice"] 10 by_creator ascending all list 10 proposals with any status, ordered by creator, ascending, by alice
[""] 1000 by_creator ascending votable list 1000 votable proposals, ordered by creator, ascending
[10] 1000 by_total_votes ascending votable list 1000 votable proposals, ordered by creator, ascending, having at least 10 votes
Proposal Structure:

Also see: Paginated API Methods

Query Parameters JSON
{
  "start": null,
  "limit": 0,
  "order": "by_name",
  "order_direction": "ascending",
  "status": "all"
}
Expected Response JSON
{
  "proposals": [
    {
      "id": 0,
      "proposal_id": "1103806595072",
      "creator": "alice",
      "receiver": "bob",
      "start_date": "2019-07-01T00:00:00",
      "end_date": "2019-08-01T23:59:59",
      "daily_pay": {
        "amount": "4800000",
        "precision": 3,
        "nai": "@@000000013"
      },
      "subject": "My Proposal",
      "permlink": "creator-proposal-permlink",
      "total_votes": "77351826710",
      "status": "active"
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_proposals", "params":{"start": [""], "limit": 10, "order": "by_creator", "order_direction": "ascending", "status": "active"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_proposals", "params":{"start": ["2019-08-07T16:54:03"], "limit": 1000, "order": "by_start_date", "order_direction": "ascending", "status": "inactive"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_proposals", "params":{"start": ["a"], "limit": 1, "order": "by_creator", "order_direction": "ascending", "status": "expired"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_proposals", "params":{"start": ["alice"], "limit": 10, "order": "by_creator", "order_direction": "ascending", "status": "all"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_proposals", "params":{"start": [""], "limit": 1000, "order": "by_creator", "order_direction": "ascending", "status": "votable"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.list_proposals", "params":{"start": [10], "limit": 1000, "order": "by_total_votes", "order_direction": "ascending", "status": "votable"}, "id":1}' https://api.hive.blog

database_api.get_comment_pending_payouts

Get comment pending payout data.

Parameters:

comments (array:string)  
[["hbd.funder", "upvote-this-post-to-fund-hbdstabilizer-qr2j7n"]] Returns comment info for a single post.
[["hbd.funder", "upvote-this-post-to-fund-hbdstabilizer-qr2j7n"], ["arcange", "hivesql-proposal-unfunded-information-and-reaction"]] Returns comment info for multiple posts.
Query Parameters JSON
{
  "comments": [
    [
      "hbd.funder",
      "upvote-this-post-to-fund-hbdstabilizer-qr2j7n"
    ]
  ]
}
Expected Response JSON
{
  "cashout_infos": [
    {
      "author": "hbd.funder",
      "permlink": "upvote-this-post-to-fund-hbdstabilizer-qr2j7n",
      "cashout_info": {
        "total_vote_weight": 22841196,
        "total_payout_value": {
          "amount": "0",
          "precision": 3,
          "nai": "@@000000013"
        },
        "curator_payout_value": {
          "amount": "0",
          "precision": 3,
          "nai": "@@000000013"
        },
        "max_accepted_payout": {
          "amount": "1000000000",
          "precision": 3,
          "nai": "@@000000013"
        },
        "author_rewards": 0,
        "children_abs_rshares": "606511906476641",
        "net_rshares": "571577939879762",
        "abs_rshares": "594467432989642",
        "vote_rshares": "583007369825359",
        "net_votes": 378,
        "active": "2021-04-06T15:29:03",
        "last_payout": "1970-01-01T00:00:00",
        "cashout_time": "2021-04-12T02:07:00",
        "max_cashout_time": "1969-12-31T23:59:59",
        "percent_hbd": 10000,
        "reward_weight": 10000,
        "allow_replies": false,
        "allow_votes": true,
        "allow_curation_rewards": true
      }
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_comment_pending_payouts", "params":{"comments":[["hbd.funder", "upvote-this-post-to-fund-hbdstabilizer-qr2j7n"]]}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.get_comment_pending_payouts", "params":{"comments":[["hbd.funder", "upvote-this-post-to-fund-hbdstabilizer-qr2j7n"], ["arcange", "hivesql-proposal-unfunded-information-and-reaction"]]}, "id":1}' https://api.hive.blog

database_api.is_known_transaction

Only return true if the transaction has not expired or been invalidated. If this method is called with a VERY old transaction we will return false, use account_history_api.get_transaction.

Also see: transaction_status_api.find_transaction, account_history_api.get_transaction

Query Parameters JSON
{"id": "0000000000000000000000000000000000000000"}
Expected Response JSON
{"is_known": false}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.is_known_transaction", "params":{"id":"0000000000000000000000000000000000000000"}, "id":1}' https://api.hive.blog

database_api.find_collateralized_conversion_requests

Returns objects corresponding with collateralized_convert operations.

 

 

 

Query Parameters JSON
{"account": ""}
Expected Response JSON
{"requests": []}

database_api.list_collateralized_conversion_requests

Returns objects corresponding with collateralized_convert operations.

 

 

 

Query Parameters JSON
{"start": null, "limit": 0, "order": "by_name"}
Expected Response JSON
{"requests": []}

database_api.find_recurrent_transfers

Finds transfers of any liquid asset every fixed amount of time from one account to another.

Also see: recurrent_transfer_operation

Query Parameters JSON
{"from": ""}
Expected Response JSON
{
  "recurrent_transfers": [
    {
      "id": 3,
      "trigger_date": "2021-07-02T18:11:51",
      "from": "alice",
      "to": "bob",
      "amount": {
        "amount": "1000",
        "precision": 3,
        "nai": "@@000000021"
      },
      "memo": "Payroll",
      "recurrence": 26,
      "consecutive_failures": 0,
      "remaining_executions": 3
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"database_api.find_recurrent_transfers", "params":{"from":"alice"}, "id":1}' https://api.hive.blog

Debug Node API

Methods:

This plugin allows all sorts of creative “what-if” experiments with the chain.

See: debug_node_plugin.md

debug_node_api.debug_generate_blocks

Generate blocks locally.

Query Parameters JSON
{
  "debug_key": "",
  "count": 0,
  "skip": 0,
  "miss_blocks": 0,
  "edit_if_needed": true
}
Expected Response JSON
{"blocks": 0}

debug_node_api.debug_generate_blocks_until

Generate blocks locally until a specified head block time. Can generate them sparsely.

Query Parameters JSON
{
  "debug_key": "",
  "head_block_time": "1970-01-01T00:00:00",
  "generate_sparsely": true
}
Expected Response JSON
{"blocks": 0}

debug_node_api.debug_get_hardfork_property_object

Query Parameters JSON
{}
Expected Response JSON
{
  "id": 0,
  "processed_hardforks": [],
  "last_hardfork": 0,
  "current_hardfork_version": "0.0.0",
  "next_hardfork": "0.0.0",
  "next_hardfork_time": "1970-01-01T00:00:00"
}

debug_node_api.debug_get_json_schema

Query Parameters JSON
{}
Expected Response JSON
{"schema": ""}

debug_node_api.debug_get_witness_schedule

Query Parameters JSON
{}
Expected Response JSON
{
  "id": 0,
  "current_virtual_time": "0",
  "next_shuffle_block_num": 21573344,
  "current_shuffled_witnesses": [],
  "num_scheduled_witnesses": 192,
  "elected_weight": 49,
  "timeshare_weight": 73,
  "miner_weight": 1,
  "witness_pay_normalization_factor": 0,
  "median_props": {
    "account_creation_fee": {
      "amount": "0",
      "precision": 3,
      "nai": "@@000000021"
    },
    "maximum_block_size": 131072,
    "hbd_interest_rate": 1000,
    "account_subsidy_budget": 797,
    "account_subsidy_decay": 347321
  },
  "majority_version": "0.0.0",
  "max_voted_witnesses": 128,
  "max_miner_witnesses": 131,
  "max_runner_witnesses": 191,
  "hardfork_required_witnesses": 4,
  "account_subsidy_rd": {
    "resource_unit": 0,
    "budget_per_time_unit": 0,
    "pool_eq": 0,
    "max_pool_size": 0,
    "decay_params": {
      "decay_per_time_unit": 0,
      "decay_per_time_unit_denom_shift": 0
    },
    "min_decay": 0
  },
  "account_subsidy_witness_rd": {
    "resource_unit": 0,
    "budget_per_time_unit": 0,
    "pool_eq": 0,
    "max_pool_size": 0,
    "decay_params": {
      "decay_per_time_unit": 0,
      "decay_per_time_unit_denom_shift": 0
    },
    "min_decay": 0
  },
  "min_witness_account_subsidy_decay": 0
}

debug_node_api.debug_has_hardfork

Query Parameters JSON
{"hardfork_id": 0}
Expected Response JSON
{"has_hardfork": false}

debug_node_api.debug_pop_block

Pop a block from the blockchain, returning it.

Query Parameters JSON
{}
Expected Response JSON
{}

debug_node_api.debug_push_blocks

Push blocks from existing database.

Query Parameters JSON
{
  "src_filename": "",
  "count": 0,
  "skip_validate_invariants": false
}
Expected Response JSON
{"blocks": 0}

debug_node_api.debug_set_hardfork

Query Parameters JSON
{"hardfork_id": 0}
Expected Response JSON
{}

Follow API

Methods:

Used to lookup information related to reputation and account follow operations. These AppBase API methods are still under development and subject to change.

follow_api.get_account_reputations

Returns a list of account reputations.

Also see: Paginated API Methods

Query Parameters JSON
{"account_lower_bound": "", "limit": 1000}
Expected Response JSON
{
  "reputations": [{"account": "", "reputation": 0}]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"follow_api.get_account_reputations", "params":{"account_lower_bound":"hiveio", "limit":1}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"follow_api.get_account_reputations", "params":{"account_lower_bound":"a", "limit":10}, "id":1}' https://api.hive.blog

follow_api.get_blog

Removed since HF24 Use: condenser_api.get_blog

Also see: Paginated API Methods

 

 

 

 


follow_api.get_blog_authors

Removed since HF24 Use: condenser_api.get_blog_authors

 

 

 

 

 


follow_api.get_blog_entries

Removed since HF24 Use: condenser_api.get_blog_entries

Also see: Paginated API Methods

 

 

 

 


follow_api.get_feed

Removed since HF24 Use: condenser_api.get_feed

Also see: Paginated API Methods

 

 

 

 

 


follow_api.get_feed_entries

Removed since HF24 Use: condenser_api.get_feed_entries

Also see: Paginated API Methods

 

 

 

 

 

 

</p>


follow_api.get_follow_count

Removed since HF24 Use: condenser_api.get_follow_count

 

 

 

 

 

 


follow_api.get_followers

Removed since HF24 Use: condenser_api.get_followers

Also see: Paginated API Methods

 

 

 

 

 

 


follow_api.get_following

Removed since HF24 Use: condenser_api.get_following

Also see: Paginated API Methods

 

 

 

 

 

 


follow_api.get_reblogged_by

Removed since HF24 Use: condenser_api.get_reblogged_by

 

 

 

 

 

 


JSON RPC

Methods:

Used to lookup information about the JSON RPC API. These AppBase API methods are still under development and subject to change.

jsonrpc.get_methods

Returns a list of methods supported by the JSON RPC API.

Query Parameters JSON
{}
Expected Response JSON
[
  "account_by_key_api.get_key_references",
  "account_history_api.enum_virtual_ops",
  "account_history_api.get_account_history",
  "account_history_api.get_ops_in_block",
  "account_history_api.get_transaction",
  "block_api.get_block",
  "block_api.get_block_header",
  "condenser_api.broadcast_block",
  "condenser_api.broadcast_transaction",
  "condenser_api.broadcast_transaction_synchronous",
  "condenser_api.find_proposals",
  "condenser_api.get_account_count",
  "condenser_api.get_account_history",
  "condenser_api.get_account_references",
  "condenser_api.get_account_reputations",
  "condenser_api.get_account_votes",
  "condenser_api.get_accounts",
  "condenser_api.get_active_votes",
  "condenser_api.get_active_witnesses",
  "condenser_api.get_block",
  "condenser_api.get_block_header",
  "condenser_api.get_blog",
  "condenser_api.get_blog_authors",
  "condenser_api.get_blog_entries",
  "condenser_api.get_chain_properties",
  "condenser_api.get_comment_discussions_by_payout",
  "condenser_api.get_config",
  "condenser_api.get_content",
  "condenser_api.get_content_replies",
  "condenser_api.get_conversion_requests",
  "condenser_api.get_current_median_history_price",
  "condenser_api.get_discussions_by_active",
  "condenser_api.get_discussions_by_author_before_date",
  "condenser_api.get_discussions_by_blog",
  "condenser_api.get_discussions_by_cashout",
  "condenser_api.get_discussions_by_children",
  "condenser_api.get_discussions_by_comments",
  "condenser_api.get_discussions_by_created",
  "condenser_api.get_discussions_by_feed",
  "condenser_api.get_discussions_by_hot",
  "condenser_api.get_discussions_by_promoted",
  "condenser_api.get_discussions_by_trending",
  "condenser_api.get_discussions_by_votes",
  "condenser_api.get_dynamic_global_properties",
  "condenser_api.get_escrow",
  "condenser_api.get_expiring_vesting_delegations",
  "condenser_api.get_feed",
  "condenser_api.get_feed_entries",
  "condenser_api.get_feed_history",
  "condenser_api.get_follow_count",
  "condenser_api.get_followers",
  "condenser_api.get_following",
  "condenser_api.get_hardfork_version",
  "condenser_api.get_key_references",
  "condenser_api.get_market_history",
  "condenser_api.get_market_history_buckets",
  "condenser_api.get_nai_pool",
  "condenser_api.get_next_scheduled_hardfork",
  "condenser_api.get_open_orders",
  "condenser_api.get_ops_in_block",
  "condenser_api.get_order_book",
  "condenser_api.get_owner_history",
  "condenser_api.get_post_discussions_by_payout",
  "condenser_api.get_potential_signatures",
  "condenser_api.get_reblogged_by",
  "condenser_api.get_recent_trades",
  "condenser_api.get_recovery_request",
  "condenser_api.get_replies_by_last_update",
  "condenser_api.get_required_signatures",
  "condenser_api.get_reward_fund",
  "condenser_api.get_savings_withdraw_from",
  "condenser_api.get_savings_withdraw_to",
  "condenser_api.get_state",
  "condenser_api.get_tags_used_by_author",
  "condenser_api.get_ticker",
  "condenser_api.get_trade_history",
  "condenser_api.get_transaction",
  "condenser_api.get_transaction_hex",
  "condenser_api.get_trending_tags",
  "condenser_api.get_version",
  "condenser_api.get_vesting_delegations",
  "condenser_api.get_volume",
  "condenser_api.get_withdraw_routes",
  "condenser_api.get_witness_by_account",
  "condenser_api.get_witness_count",
  "condenser_api.get_witness_schedule",
  "condenser_api.get_witnesses",
  "condenser_api.get_witnesses_by_vote",
  "condenser_api.list_proposal_votes",
  "condenser_api.list_proposals",
  "condenser_api.lookup_account_names",
  "condenser_api.lookup_accounts",
  "condenser_api.lookup_witness_accounts",
  "condenser_api.verify_account_authority",
  "condenser_api.verify_authority",
  "database_api.find_account_recovery_requests",
  "database_api.find_accounts",
  "database_api.find_change_recovery_account_requests",
  "database_api.find_comments",
  "database_api.find_decline_voting_rights_requests",
  "database_api.find_escrows",
  "database_api.find_limit_orders",
  "database_api.find_owner_histories",
  "database_api.find_proposals",
  "database_api.find_savings_withdrawals",
  "database_api.find_hbd_conversion_requests",
  "database_api.find_smt_contributions",
  "database_api.find_smt_token_emissions",
  "database_api.find_smt_tokens",
  "database_api.find_vesting_delegation_expirations",
  "database_api.find_vesting_delegations",
  "database_api.find_votes",
  "database_api.find_withdraw_vesting_routes",
  "database_api.find_witnesses",
  "database_api.get_active_witnesses",
  "database_api.get_config",
  "database_api.get_current_price_feed",
  "database_api.get_dynamic_global_properties",
  "database_api.get_feed_history",
  "database_api.get_hardfork_properties",
  "database_api.get_nai_pool",
  "database_api.get_order_book",
  "database_api.get_potential_signatures",
  "database_api.get_required_signatures",
  "database_api.get_reward_funds",
  "database_api.get_transaction_hex",
  "database_api.get_version",
  "database_api.get_witness_schedule",
  "database_api.list_account_recovery_requests",
  "database_api.list_accounts",
  "database_api.list_change_recovery_account_requests",
  "database_api.list_comments",
  "database_api.list_decline_voting_rights_requests",
  "database_api.list_escrows",
  "database_api.list_limit_orders",
  "database_api.list_owner_histories",
  "database_api.list_proposal_votes",
  "database_api.list_proposals",
  "database_api.list_savings_withdrawals",
  "database_api.list_hbd_conversion_requests",
  "database_api.list_smt_contributions",
  "database_api.list_smt_token_emissions",
  "database_api.list_smt_tokens",
  "database_api.list_vesting_delegation_expirations",
  "database_api.list_vesting_delegations",
  "database_api.list_votes",
  "database_api.list_withdraw_vesting_routes",
  "database_api.list_witness_votes",
  "database_api.list_witnesses",
  "database_api.verify_account_authority",
  "database_api.verify_authority",
  "database_api.verify_signatures",
  "follow_api.get_account_reputations",
  "follow_api.get_blog",
  "follow_api.get_blog_authors",
  "follow_api.get_blog_entries",
  "follow_api.get_feed",
  "follow_api.get_feed_entries",
  "follow_api.get_follow_count",
  "follow_api.get_followers",
  "follow_api.get_following",
  "follow_api.get_reblogged_by",
  "jsonrpc.get_methods",
  "jsonrpc.get_signature",
  "market_history_api.get_market_history",
  "market_history_api.get_market_history_buckets",
  "market_history_api.get_order_book",
  "market_history_api.get_recent_trades",
  "market_history_api.get_ticker",
  "market_history_api.get_trade_history",
  "market_history_api.get_volume",
  "network_broadcast_api.broadcast_block",
  "network_broadcast_api.broadcast_transaction",
  "rc_api.find_rc_accounts",
  "rc_api.get_resource_params",
  "rc_api.get_resource_pool",
  "tags_api.get_active_votes",
  "tags_api.get_comment_discussions_by_payout",
  "tags_api.get_content_replies",
  "tags_api.get_discussion",
  "tags_api.get_discussions_by_active",
  "tags_api.get_discussions_by_author_before_date",
  "tags_api.get_discussions_by_blog",
  "tags_api.get_discussions_by_cashout",
  "tags_api.get_discussions_by_children",
  "tags_api.get_discussions_by_comments",
  "tags_api.get_discussions_by_created",
  "tags_api.get_discussions_by_feed",
  "tags_api.get_discussions_by_hot",
  "tags_api.get_discussions_by_promoted",
  "tags_api.get_discussions_by_trending",
  "tags_api.get_discussions_by_votes",
  "tags_api.get_post_discussions_by_payout",
  "tags_api.get_replies_by_last_update",
  "tags_api.get_tags_used_by_author",
  "tags_api.get_trending_tags"
]
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"jsonrpc.get_methods", "id":1}' https://api.hive.blog

jsonrpc.get_signature

Returns the signature information for a JSON RPC method including the arguments and expected response JSON.

Query Parameters JSON
{"method": ""}
Expected Response JSON
{"args": {}, "ret": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"jsonrpc.get_signature", "params":{"method":"jsonrpc.get_methods"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"jsonrpc.get_signature", "params":{"method":"jsonrpc.get_signature"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"jsonrpc.get_signature", "params":{"method":"condenser_api.get_dynamic_global_properties"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"jsonrpc.get_signature", "params":{"method":"database_api.get_dynamic_global_properties"}, "id":1}' https://api.hive.blog

Market History API

Methods:

Used to lookup market history information. These AppBase API methods are still under development and subject to change.

market_history_api.get_market_history

Returns the market history for the internal HBD:HIVE market.

Query Parameters JSON
{
  "bucket_seconds": 0,
  "start": "1970-01-01T00:00:00",
  "end": "1970-01-01T00:00:00"
}
Expected Response JSON
{
  "buckets": [
    {
      "id": 0,
      "open": "2019-12-18T01:51:15",
      "seconds": 15,
      "hive": {
        "high": 100000,
        "low": 100000,
        "open": 100000,
        "close": 100000,
        "volume": 100000
      },
      "symbol": {"nai": "@@000000013", "precision": 3},
      "non_hive": {
        "high": 100000,
        "low": 100000,
        "open": 100000,
        "close": 100000,
        "volume": 100000
      }
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"market_history_api.get_market_history", "params":{"bucket_seconds":15,"start":"2018-01-01T00:00:00","end":"2018-01-02T00:00:00"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"market_history_api.get_market_history", "params":{"bucket_seconds":60,"start":"2018-01-01T00:00:00","end":"2018-01-02T00:00:00"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"market_history_api.get_market_history", "params":{"bucket_seconds":300,"start":"2018-01-01T00:00:00","end":"2018-01-02T00:00:00"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"market_history_api.get_market_history", "params":{"bucket_seconds":3600,"start":"2018-01-01T00:00:00","end":"2018-01-02T00:00:00"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"market_history_api.get_market_history", "params":{"bucket_seconds":86400,"start":"2018-01-01T00:00:00","end":"2018-01-02T00:00:00"}, "id":1}' https://api.hive.blog

market_history_api.get_market_history_buckets

Returns the bucket seconds being tracked by the plugin.

Query Parameters JSON
{}
Expected Response JSON
{"bucket_sizes": [15, 60, 300, 3600, 86400]}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"market_history_api.get_market_history_buckets", "id":1}' https://api.hive.blog

market_history_api.get_order_book

Returns the internal market order book.

Query Parameters JSON
{"limit": 500}
Expected Response JSON
{
  "bids": [],
  "asks": [
    {
      "order_price": {
        "base": {
          "amount": "1000",
          "precision": 3,
          "nai": "@@000000021"
        },
        "quote": {
          "amount": "100",
          "precision": 6,
          "nai": "@@100042205"
        }
      },
      "real_price": "0.10000000000000001",
      "hive": 100000,
      "hbd": 10000,
      "created": "2019-12-18T01:24:42"
    },
    {
      "order_price": {
        "base": {
          "amount": "1000",
          "precision": 3,
          "nai": "@@000000021"
        },
        "quote": {
          "amount": "1000",
          "precision": 6,
          "nai": "@@100041380"
        }
      },
      "real_price": "1.00000000000000000",
      "hive": 1000,
      "hbd": 1000,
      "created": "2019-12-18T01:22:12"
    },
    {
      "order_price": {
        "base": {
          "amount": "1000",
          "precision": 3,
          "nai": "@@000000021"
        },
        "quote": {
          "amount": "100000000000",
          "precision": 11,
          "nai": "@@100037284"
        }
      },
      "real_price": "100000000.00000000000000000",
      "hive": 1000,
      "hbd": "100000000000",
      "created": "2019-12-18T01:20:21"
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"market_history_api.get_order_book", "params":{"limit":10}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"market_history_api.get_order_book", "params":{"limit":50}, "id":1}' https://api.hive.blog

market_history_api.get_recent_trades

Returns the most recent trades for the internal HBD:HIVE market.

Query Parameters JSON
{"limit": 1000}
Expected Response JSON
{
  "trades": [
    {
      "date": "2019-12-18T01:51:24",
      "current_pays": {
        "amount": "100000",
        "precision": 3,
        "nai": "@@000000013"
      },
      "open_pays": {
        "amount": "100000",
        "precision": 3,
        "nai": "@@000000021"
      }
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"market_history_api.get_recent_trades", "params":{"limit":10}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"market_history_api.get_recent_trades", "params":{"limit":500}, "id":1}' https://api.hive.blog

market_history_api.get_ticker

Returns the market ticker for the internal HBD:HIVE market.

Query Parameters JSON
{}
Expected Response JSON
{
  "latest": "1.00000000000000000",
  "lowest_ask": "0.10000000000000001",
  "highest_bid": "0.00000000000000000",
  "percent_change": "0.00000000000000000",
  "hive_volume": {
    "amount": "100000",
    "precision": 3,
    "nai": "@@000000021"
  },
  "hbd_volume": {
    "amount": "100000",
    "precision": 3,
    "nai": "@@000000013"
  }
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"market_history_api.get_ticker", "id":1}' https://api.hive.blog

market_history_api.get_trade_history

Returns the trade history for the internal HBD:HIVE market.

Query Parameters JSON
{
  "start": "1970-01-01T00:00:00",
  "end": "1970-01-01T00:00:00",
  "limit": 1000
}
Expected Response JSON
{
  "trades": [
    {
      "date": "2019-12-18T01:51:24",
      "current_pays": {
        "amount": "100000",
        "precision": 3,
        "nai": "@@000000013"
      },
      "open_pays": {
        "amount": "100000",
        "precision": 3,
        "nai": "@@000000021"
      }
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"market_history_api.get_trade_history", "params":{"start":"2018-01-01T00:00:00","end":"2018-01-02T00:00:00","limit":10}, "id":1}' https://api.hive.blog

market_history_api.get_volume

Returns the market volume for the past 24 hours.

Query Parameters JSON
{}
Expected Response JSON
{
  "hive_volume": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000021"
  },
  "hbd_volume": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000013"
  }
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"market_history_api.get_volume", "id":1}' https://api.hive.blog

Network Broadcast API

Methods:

Used to broadcast transactions and blocks. These AppBase API methods are still under development and subject to change.

Also see: Blockchain Ops

network_broadcast_api.broadcast_block

Removed: HF26

Used to broadcast a block.

Query Parameters JSON
{
  "block": {
    "previous": "0000000000000000000000000000000000000000",
    "timestamp": "1970-01-01T00:00:00",
    "witness": "",
    "transaction_merkle_root": "0000000000000000000000000000000000000000",
    "extensions": [],
    "witness_signature": "0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
    "transactions": []
  }
}
Expected Response JSON
{}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"network_broadcast_api.broadcast_block", "params":{"block":{"previous":"0000000000000000000000000000000000000000","timestamp":"1970-01-01T00:00:00","witness":"","transaction_merkle_root":"0000000000000000000000000000000000000000","extensions":[],"witness_signature":"0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000","transactions":[]}}, "id":1}' https://api.hive.blog

network_broadcast_api.broadcast_transaction

Used to broadcast a transaction.

Query Parameters JSON
{
  "trx": {
    "ref_block_num": 0,
    "ref_block_prefix": 0,
    "expiration": "1970-01-01T00:00:00",
    "operations": [],
    "extensions": [],
    "signatures": []
  },
  "max_block_age": -1
}
Expected Response JSON
{}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"network_broadcast_api.broadcast_transaction", "params":{"trx":{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[{"type":"vote_operation","value":{"voter":"hiveio","author":"alice","permlink":"a-post-by-alice","weight":10000}}],"extensions":[],"signatures":[]},"max_block_age":50}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"network_broadcast_api.broadcast_transaction", "params":{"trx":{"ref_block_num":1097,"ref_block_prefix":2181793527,"expiration":"2016-03-24T18:00:21","operations":[{"type":"pow_operation","value":{"worker_account":"cloop3","block_id":"00000449f7860b82b4fbe2f317c670e9f01d6d9a","nonce":3899,"work":{"worker":"STM7P5TDnA87Pj9T4mf6YHrhzjC1KbPZpNxLWCcVcHxNYXakpoT4F","input":"ae8e7c677119d22385f8c48026fee7aad7bba693bf788d7f27047f40b47738c0","signature":"1f38fe9a3f9989f84bd94aa5bbc88beaf09b67f825aa4450cf5105d111149ba6db560b582c7dbb026c7fc9c2eb5051815a72b17f6896ed59d3851d9a0f9883ca7a","work":"000e7b209d58f2e64b36e9bf12b999c6c7af168cc3fc41eb7f8a4bf796c174c3"},"props":{"account_creation_fee":{"amount":"100000","precision":3,"nai":"@@000000021"},"maximum_block_size":131072,"hbd_interest_rate":1000}}}],"extensions":[],"signatures":[]},"max_block_age":50}, "id":1}' https://api.hive.blog

RC API

Methods:

Allows querying of various Resource Credit metrics. See: RC Bandwidth System, 0.20.2 Release Notes, Developer Guide: Resource Credit System

rc_api.find_rc_accounts

Returns the available resource credits of accounts. Parameters: accounts:string array

accounts (string)  
"hiveio" Query the available resource credits for the account named “hiveio”.
"alice" Query the available resource credits for the accounts named “alice” and “bob”.
Query Parameters JSON
{"accounts": []}
Expected Response JSON
{
  "rc_accounts": [
    {
      "account": "",
      "rc_manabar": {"current_mana": "0", "last_update_time": 0},
      "max_rc_creation_adjustment": {
        "amount": "0",
        "precision": 6,
        "nai": "@@000000037"
      },
      "max_rc": "0"
    }
  ]
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"rc_api.find_rc_accounts", "params":{"accounts":["hiveio"]}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"rc_api.find_rc_accounts", "params":{"accounts":["alice","bob"]}, "id":1}' https://api.hive.blog

rc_api.get_resource_params

Exports all relevant resource size constants, in particular the measurement-based execution time parameters.

See: #2980

Query Parameters JSON
{}
Expected Response JSON
{
  "resource_names": [
    "resource_history_bytes",
    "resource_new_accounts",
    "resource_market_bytes",
    "resource_state_bytes",
    "resource_execution_time"
  ],
  "resource_params": {
    "resource_history_bytes": {
      "resource_dynamics_params": {
        "resource_unit": 1,
        "budget_per_time_unit": 43403,
        "pool_eq": "27050539251",
        "max_pool_size": "54101078501",
        "decay_params": {
          "decay_per_time_unit": 3613026481,
          "decay_per_time_unit_denom_shift": 51
        },
        "min_decay": 0
      },
      "price_curve_params": {
        "coeff_a": "14034213032882683904",
        "coeff_b": 211332338,
        "shift": 52
      }
    },
    "resource_new_accounts": {
      "resource_dynamics_params": {
        "resource_unit": 10000,
        "budget_per_time_unit": 797,
        "pool_eq": 157691079,
        "max_pool_size": 157691079,
        "decay_params": {
          "decay_per_time_unit": 347321,
          "decay_per_time_unit_denom_shift": 36
        },
        "min_decay": 0
      },
      "price_curve_params": {
        "coeff_a": "16484671763857882971",
        "coeff_b": 1231961,
        "shift": 51
      }
    },
    "resource_market_bytes": {
      "resource_dynamics_params": {
        "resource_unit": 10,
        "budget_per_time_unit": 72338,
        "pool_eq": 2003755169,
        "max_pool_size": 4007510337,
        "decay_params": {
          "decay_per_time_unit": 2540365427,
          "decay_per_time_unit_denom_shift": 46
        },
        "min_decay": 0
      },
      "price_curve_params": {
        "coeff_a": "9979884823383242752",
        "coeff_b": 15654337,
        "shift": 56
      }
    },
    "resource_state_bytes": {
      "resource_dynamics_params": {
        "resource_unit": 1,
        "budget_per_time_unit": 34722222,
        "pool_eq": "21640431400373",
        "max_pool_size": "43280862800744",
        "decay_params": {
          "decay_per_time_unit": 3613026481,
          "decay_per_time_unit_denom_shift": 51
        },
        "min_decay": 0
      },
      "price_curve_params": {
        "coeff_a": "14034213032882683904",
        "coeff_b": "169065870315",
        "shift": 52
      }
    },
    "resource_execution_time": {
      "resource_dynamics_params": {
        "resource_unit": 1,
        "budget_per_time_unit": 10273973,
        "pool_eq": "6403196140384",
        "max_pool_size": "12806392280766",
        "decay_params": {
          "decay_per_time_unit": 3613026481,
          "decay_per_time_unit_denom_shift": 51
        },
        "min_decay": 0
      },
      "price_curve_params": {
        "coeff_a": "14034213032882683904",
        "coeff_b": "50024969847",
        "shift": 52
      }
    }
  },
  "size_info": {
    "resource_state_bytes": {
      "authority_base_size": 40000,
      "authority_account_member_size": 180000,
      "authority_key_member_size": 350000,
      "account_object_base_size": 4800000,
      "account_authority_object_base_size": 400000,
      "account_recovery_request_object_base_size": 320000,
      "comment_object_base_size": 2010000,
      "comment_object_permlink_char_size": 10000,
      "comment_object_parent_permlink_char_size": 20000,
      "comment_object_beneficiaries_member_size": 180000,
      "comment_vote_object_base_size": 24675,
      "convert_request_object_base_size": 480000,
      "decline_voting_rights_request_object_base_size": 280000,
      "escrow_object_base_size": 1190000,
      "limit_order_object_base_size": 147440,
      "savings_withdraw_object_byte_size": 14656,
      "transaction_object_base_size": 6090,
      "transaction_object_byte_size": 174,
      "vesting_delegation_object_base_size": 600000,
      "vesting_delegation_expiration_object_base_size": 440000,
      "withdraw_vesting_route_object_base_size": 430000,
      "witness_object_base_size": 2660000,
      "witness_object_url_char_size": 10000,
      "witness_vote_object_base_size": 400000,
      "proposal_object_base_size": 680000,
      "proposal_vote_object_base_size": 240000,
      "proposal_vote_object_member_size": 80000,
      "smt_token_object_size": 2400000,
      "smt_ico_object_size": 403520,
      "smt_token_emissions_object_size": 1040000,
      "smt_ico_tier_object_size": 186240,
      "smt_contribution_object_size": 108640,
      "votable_assets_item_size": 200000,
      "STATE_BYTES_SCALE": 10000
    },
    "resource_execution_time": {
      "account_create_operation_exec_time": 57700,
      "account_create_with_delegation_operation_exec_time": 57700,
      "account_update_operation_exec_time": 14000,
      "account_update2_operation_exec_time": 14000,
      "account_witness_proxy_operation_exec_time": 117000,
      "account_witness_vote_operation_exec_time": 23000,
      "cancel_transfer_from_savings_operation_exec_time": 11500,
      "change_recovery_account_operation_exec_time": 12000,
      "claim_account_operation_exec_time": 10000,
      "claim_reward_balance_operation_exec_time": 50300,
      "comment_operation_exec_time": 114100,
      "comment_options_operation_exec_time": 13200,
      "convert_operation_exec_time": 15700,
      "create_claimed_account_operation_exec_time": 57700,
      "custom_operation_exec_time": 11400,
      "custom_json_operation_exec_time": 11400,
      "custom_binary_operation_exec_time": 11400,
      "decline_voting_rights_operation_exec_time": 5300,
      "delegate_vesting_shares_operation_exec_time": 19900,
      "delete_comment_operation_exec_time": 51100,
      "escrow_approve_operation_exec_time": 9900,
      "escrow_dispute_operation_exec_time": 11500,
      "escrow_release_operation_exec_time": 17200,
      "escrow_transfer_operation_exec_time": 19100,
      "feed_publish_operation_exec_time": 6200,
      "limit_order_cancel_operation_exec_time": 9600,
      "limit_order_create_operation_exec_time": 31700,
      "limit_order_create2_operation_exec_time": 31700,
      "request_account_recovery_operation_exec_time": 54400,
      "set_withdraw_vesting_route_operation_exec_time": 17900,
      "transfer_from_savings_operation_exec_time": 17500,
      "transfer_operation_exec_time": 9600,
      "transfer_to_savings_operation_exec_time": 6400,
      "transfer_to_vesting_operation_exec_time": 44400,
      "vote_operation_exec_time": 26500,
      "withdraw_vesting_operation_exec_time": 10400,
      "witness_set_properties_operation_exec_time": 9500,
      "witness_update_operation_exec_time": 9500,
      "claim_reward_balance2_operation_exec_time": 50300,
      "smt_setup_operation_exec_time": 41000,
      "smt_setup_emissions_operation_exec_time": 13000,
      "smt_set_setup_parameters_operation_exec_time": 40000,
      "smt_set_runtime_parameters_operation_exec_time": 39000,
      "smt_create_operation_exec_time": 50000,
      "smt_contribute_operation_exec_time": 32000,
      "smt_setup_ico_tier_operation_exec_time": 13000,
      "smt_contributor_payout_action_exec_time": 60000,
      "smt_founder_payout_action_exec_time": 69000,
      "smt_token_launch_action_exec_time": 31000,
      "smt_ico_evaluation_action_exec_time": 21000,
      "smt_ico_launch_action_exec_time": 18000,
      "smt_token_emission_action_exec_time": 2400,
      "create_proposal_operation_exec_time": 31700,
      "update_proposal_votes_operation_exec_time": 12000,
      "remove_proposal_operation_exec_time": 12000
    }
  }
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"rc_api.get_resource_params", "id":1}' https://api.hive.blog

rc_api.get_resource_pool

Work in progress. See: #2563, PR#2678

Query Parameters JSON
{}
Expected Response JSON
{
  "resource_pool": {
    "resource_history_bytes": {"pool": "22530662270"},
    "resource_new_accounts": {"pool": 17589594},
    "resource_market_bytes": {"pool": 1919726127},
    "resource_state_bytes": {"pool": "17720687726725"},
    "resource_execution_time": {"pool": "5835324988127"}
  }
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"rc_api.get_resource_pool", "id":1}' https://api.hive.blog

rc_api.list_rc_accounts

Query Parameters JSON
{"start": null, "limit": 0}
Expected Response JSON
{"rc_accounts": []}

rc_api.list_rc_direct_delegations

Query Parameters JSON
{"start": null, "limit": 0}
Expected Response JSON
{"rc_direct_delegations": []}

Reputation API

Methods:

Needed by condenser_api to optionally use follow_api or reputation_api for account reputations (the latter if hivemind is fronting follow_api)

reputation_api.get_account_reputations

Returns the reputation of accounts. Parameters: account:string; limit:int

account (string) limit (int)  
"hiveio" 10 Queries the reputation for account named “hiveio”.

See #1425

Also see: Paginated API Methods

Query Parameters JSON
{"account_lower_bound": "", "limit": 1000}
Expected Response JSON
{"account": "hive", "reputation": 0}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"reputation_api.get_account_reputations", "params": {"account_lower_bound": "hive"}, "id":1}' https://api.hive.blog

Rewards API

Methods:

Returns the simulated curve for payouts. Parameters: curve:string; var1:string

Note: The rewards_api plugin is for testing purposes only, do not run in production.

curve (string) var1 (string)  
"quadratic" “2000000000000”  
"bounded_curation" “2000000000000”  
"linear" “2000000000000”  
"square_root" “2000000000000”  
"convergent_linear" “2000000000000”  
"convergent_square_root" “2000000000000”  

See: #3325

rewards_api.simulate_curve_payouts

Query Parameters JSON
{"curve": "quadratic", "var1": "2000000000000"}
Expected Response JSON
{"recent_claims": "", "payouts": []}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"rewards_api.simulate_curve_payouts", "params": {"curve": "quadratic", "var1": "2000000000000"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"rewards_api.simulate_curve_payouts", "params": {"curve": "bounded_curation", "var1": "2000000000000"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"rewards_api.simulate_curve_payouts", "params": {"curve": "linear", "var1": "2000000000000"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"rewards_api.simulate_curve_payouts", "params": {"curve": "square_root", "var1": "2000000000000"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"rewards_api.simulate_curve_payouts", "params": {"curve": "convergent_linear", "var1": "2000000000000"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"rewards_api.simulate_curve_payouts", "params": {"curve": "convergent_square_root", "var1": "2000000000000"}, "id":1}' https://api.hive.blog

Tags API

Methods:

Used to lookup information about tags, posts, and discussions. These AppBase API methods are still under development and subject to change.

tags_api.get_active_votes

Removed since HF24 Use: condenser_api.get_active_votes

 

 

 

 

 

 


tags_api.get_comment_discussions_by_payout

Removed since HF24 Use: condenser_api.get_comment_discussions_by_payout

 

 

 

 

 

 


tags_api.get_content_replies

Removed since HF24 Use: condenser_api.get_content_replies

 

 

 

 

 

 


tags_api.get_discussion

Returns the discussion given an author and permlink.

Also see: bridge.get_discussion

Query Parameters JSON
{"author": "", "permlink": ""}
Expected Response JSON
{
  "id": 0,
  "author": "",
  "permlink": "",
  "category": "",
  "parent_author": "",
  "parent_permlink": "",
  "title": "",
  "body": "",
  "json_metadata": "",
  "last_update": "1970-01-01T00:00:00",
  "created": "1970-01-01T00:00:00",
  "active": "1970-01-01T00:00:00",
  "last_payout": "1970-01-01T00:00:00",
  "depth": 0,
  "children": 0,
  "net_rshares": 0,
  "abs_rshares": 0,
  "vote_rshares": 0,
  "children_abs_rshares": 0,
  "cashout_time": "1970-01-01T00:00:00",
  "max_cashout_time": "1970-01-01T00:00:00",
  "total_vote_weight": 0,
  "reward_weight": 0,
  "total_payout_value": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000021"
  },
  "curator_payout_value": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000021"
  },
  "author_rewards": 0,
  "net_votes": 0,
  "root_author": "",
  "root_permlink": "",
  "max_accepted_payout": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000021"
  },
  "percent_hbd": 0,
  "allow_replies": false,
  "allow_votes": false,
  "allow_curation_rewards": false,
  "beneficiaries": [],
  "url": "",
  "root_title": "",
  "pending_payout_value": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000021"
  },
  "total_pending_payout_value": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000021"
  },
  "active_votes": [],
  "replies": [],
  "author_reputation": 0,
  "promoted": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000013"
  },
  "body_length": 0,
  "reblogged_by": []
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"tags_api.get_discussion", "params":{"author":"hiveio", "permlink":"firstpost"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"tags_api.get_discussion", "params":{"author":"alice", "permlink":"a-post-by-alice"}, "id":1}' https://api.hive.blog

tags_api.get_discussions_by_active

Removed since HF24 Use: condenser_api.get_discussions_by_active

 

 

 

 

 

 


tags_api.get_discussions_by_author_before_date

Removed since HF24 Use: condenser_api.get_discussions_by_author_before_date

Also see: Paginated API Methods

 

 

 

 

 

 


tags_api.get_discussions_by_blog

Removed since HF24 Use: condenser_api.get_discussions_by_blog

 

 

 

 

 

 


tags_api.get_discussions_by_cashout

Removed since HF24 Use: condenser_api.get_discussions_by_cashout

 

 

 

 

 

 


tags_api.get_discussions_by_children

Removed since HF24 Use: condenser_api.get_discussions_by_children

Returns a list of discussions by children.

 

 

 

 

 

 


tags_api.get_discussions_by_comments

Removed since HF24 Use: condenser_api.get_discussions_by_comments

 

 

 

 

 

 


tags_api.get_discussions_by_created

Removed since HF24 Use: condenser_api.get_discussions_by_created

 

 

 

 

 

 


tags_api.get_discussions_by_feed

Removed since HF24 Use: condenser_api.get_discussions_by_feed

 

 

 

 

 

 


tags_api.get_discussions_by_hot

Removed since HF24 Use: condenser_api.get_discussions_by_hot

 

 

 

 

 

 


tags_api.get_discussions_by_promoted

Removed since HF24 Use: condenser_api.get_discussions_by_promoted

 

 

 

 

 

 


Removed since HF24 Use: condenser_api.get_discussions_by_trending

 

 

 

 

 

 


tags_api.get_discussions_by_votes

Removed since HF24 Use: condenser_api.get_discussions_by_votes

 

 

 

 

 

 


tags_api.get_post_discussions_by_payout

Removed since HF24 Use: condenser_api.get_post_discussions_by_payout

 

 

 

 

 

 


tags_api.get_replies_by_last_update

Removed since HF24 Use: condenser_api.get_replies_by_last_update

 

 

 

 

 

 


tags_api.get_tags_used_by_author

Removed since HF24 Use: condenser_api.get_tags_used_by_author

 

 

 

 

 

 


Removed since HF24 Use: condenser_api.get_trending_tags

 

 

 

 

 

 


Transaction Status API

Methods:

This API is intended to evaluate a transaction status after calling condenser_api.broadcast_transaction.

To enable this API for hived, the following is required in config.ini by specifying:

plugin = transaction_status_api

See: #3060

transaction_status_api.find_transaction

Returns the status of a given transaction id. Parameters: trx_id:string; expiration:timestamp (optional)

The result will contain one of the following status values:

Status Meaning
unknown Expiration time in future, transaction not included in block or mempool
within_mempool Transaction in mempool
within_reversible_block Transaction has been included in block, block not irreversible
within_irreversible_block Transaction has been included in block, block is irreversible
expired_reversible Transaction has expired, transaction is not irreversible (transaction could be in a fork)
expired_irreversible Transaction has expired, transaction is irreversible (transaction cannot be in a fork)
too_old Transaction is too old, I don’t know about it
Query Parameters JSON
{
  "transaction_id": "0000000000000000000000000000000000000000",
  "expiration": "2016-03-24T18:00:21"
}
Expected Response JSON
{"status": "unknown"}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"transaction_status_api.find_transaction", "params": {"transaction_id": "0000000000000000000000000000000000000000"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"transaction_status_api.find_transaction", "params": {"transaction_id": "0000000000000000000000000000000000000000", "expiration":"2016-03-24T18:00:21"}, "id":1}' https://api.hive.blog

Wallet Bridge API

Methods:

Required for cli_wallet interactions. Remember that you need to add plugin = wallet_bridge_api in your config.ini file if you are going to use cli_wallet.

See: Hive HardFork 26 Jump Starter Kit

wallet_bridge_api.broadcast_transaction

Query Parameters JSON
null
Expected Response JSON
{}

wallet_bridge_api.broadcast_transaction_synchronous

Query Parameters JSON
null
Expected Response JSON
{
  "id": "0000000000000000000000000000000000000000",
  "block_num": 0,
  "trx_num": 0,
  "expired": false
}

wallet_bridge_api.find_proposals

Query Parameters JSON
null
Expected Response JSON
{"proposals": []}

wallet_bridge_api.find_rc_accounts

Query Parameters JSON
null
Expected Response JSON
[]

wallet_bridge_api.find_recurrent_transfers

Query Parameters JSON
null
Expected Response JSON
[]

wallet_bridge_api.get_account

Query Parameters JSON
null
Expected Response JSON
null

wallet_bridge_api.get_account_history

Query Parameters JSON
null
Expected Response JSON
[]

wallet_bridge_api.get_accounts

Query Parameters JSON
null
Expected Response JSON
[]

wallet_bridge_api.get_active_witnesses

Query Parameters JSON
null
Expected Response JSON
{"witnesses": []}

wallet_bridge_api.get_block

Query Parameters JSON
null
Expected Response JSON
{}

wallet_bridge_api.get_chain_properties

Query Parameters JSON
null
Expected Response JSON
{
  "account_creation_fee": {
    "amount": "1",
    "precision": 3,
    "nai": "@@000000021"
  },
  "maximum_block_size": 131072,
  "hbd_interest_rate": 1000,
  "account_subsidy_budget": 797,
  "account_subsidy_decay": 347321
}

wallet_bridge_api.get_collateralized_conversion_requests

Query Parameters JSON
null
Expected Response JSON
[]

wallet_bridge_api.get_conversion_requests

Query Parameters JSON
null
Expected Response JSON
[]

wallet_bridge_api.get_current_median_history_price

Query Parameters JSON
null
Expected Response JSON
{
  "base": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000021"
  },
  "quote": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000021"
  }
}

wallet_bridge_api.get_dynamic_global_properties

Query Parameters JSON
null
Expected Response JSON
{
  "id": 0,
  "head_block_number": 0,
  "head_block_id": "0000000000000000000000000000000000000000",
  "time": "1970-01-01T00:00:00",
  "current_witness": "",
  "total_pow": 0,
  "num_pow_witnesses": 0,
  "virtual_supply": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000021"
  },
  "current_supply": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000021"
  },
  "init_hbd_supply": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000021"
  },
  "current_hbd_supply": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000021"
  },
  "total_vesting_fund_hive": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000021"
  },
  "total_vesting_shares": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000021"
  },
  "total_reward_fund_hive": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000021"
  },
  "total_reward_shares2": "0",
  "pending_rewarded_vesting_shares": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000021"
  },
  "pending_rewarded_vesting_hive": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000021"
  },
  "hbd_interest_rate": 0,
  "hbd_print_rate": 0,
  "maximum_block_size": 0,
  "required_actions_partition_percent": 0,
  "current_aslot": 0,
  "recent_slots_filled": "0",
  "participation_count": 0,
  "last_irreversible_block_num": 0,
  "vote_power_reserve_rate": 0,
  "delegation_return_period": 0,
  "reverse_auction_seconds": 0,
  "available_account_subsidies": 0,
  "hbd_stop_percent": 0,
  "hbd_start_percent": 0,
  "next_maintenance_time": "1970-01-01T00:00:00",
  "last_budget_time": "1970-01-01T00:00:00",
  "next_daily_maintenance_time": "1970-01-01T00:00:00",
  "content_reward_percent": 0,
  "vesting_reward_percent": 0,
  "proposal_fund_percent": 0,
  "dhf_interval_ledger": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000021"
  },
  "downvote_pool_percent": 0,
  "current_remove_threshold": 0,
  "early_voting_seconds": 0,
  "mid_voting_seconds": 0,
  "max_consecutive_recurrent_transfer_failures": 10,
  "max_recurrent_transfer_end_date": 730,
  "min_recurrent_transfers_recurrence": 24,
  "max_open_recurrent_transfers": 255
}

wallet_bridge_api.get_feed_history

Query Parameters JSON
null
Expected Response JSON
{
  "id": 0,
  "current_median_history": {
    "base": {
      "amount": "0",
      "precision": 3,
      "nai": "@@000000021"
    },
    "quote": {
      "amount": "0",
      "precision": 3,
      "nai": "@@000000021"
    }
  },
  "market_median_history": {
    "base": {
      "amount": "0",
      "precision": 3,
      "nai": "@@000000021"
    },
    "quote": {
      "amount": "0",
      "precision": 3,
      "nai": "@@000000021"
    }
  },
  "current_min_history": {
    "base": {
      "amount": "0",
      "precision": 3,
      "nai": "@@000000021"
    },
    "quote": {
      "amount": "0",
      "precision": 3,
      "nai": "@@000000021"
    }
  },
  "current_max_history": {
    "base": {
      "amount": "0",
      "precision": 3,
      "nai": "@@000000021"
    },
    "quote": {
      "amount": "0",
      "precision": 3,
      "nai": "@@000000021"
    }
  },
  "price_history": []
}

wallet_bridge_api.get_hardfork_version

Query Parameters JSON
null
Expected Response JSON
"0.0.0"

wallet_bridge_api.get_open_orders

Query Parameters JSON
null
Expected Response JSON
[]

wallet_bridge_api.get_ops_in_block

Query Parameters JSON
null
Expected Response JSON
{"ops": []}

wallet_bridge_api.get_order_book

Query Parameters JSON
null
Expected Response JSON
{"bids": [], "asks": []}

wallet_bridge_api.get_owner_history

Query Parameters JSON
null
Expected Response JSON
{"owner_auths": []}

wallet_bridge_api.get_reward_fund

Query Parameters JSON
null
Expected Response JSON
{
  "id": 0,
  "name": "",
  "reward_balance": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000021"
  },
  "recent_claims": "0",
  "last_update": "1970-01-01T00:00:00",
  "content_constant": "0",
  "percent_curation_rewards": 0,
  "percent_content_rewards": 0,
  "author_reward_curve": "quadratic",
  "curation_reward_curve": "quadratic"
}

wallet_bridge_api.get_transaction

Query Parameters JSON
null
Expected Response JSON
{
  "ref_block_num": 0,
  "ref_block_prefix": 0,
  "expiration": "1970-01-01T00:00:00",
  "operations": [],
  "extensions": [],
  "signatures": [],
  "transaction_id": "0000000000000000000000000000000000000000",
  "block_num": 0,
  "transaction_num": 0
}

wallet_bridge_api.get_version

Query Parameters JSON
null
Expected Response JSON
{}

wallet_bridge_api.get_withdraw_routes

Query Parameters JSON
null
Expected Response JSON
[]

wallet_bridge_api.get_witness

Query Parameters JSON
null
Expected Response JSON
null

wallet_bridge_api.get_witness_schedule

Query Parameters JSON
null
Expected Response JSON
{
  "id": 0,
  "current_virtual_time": "0",
  "next_shuffle_block_num": 944743200,
  "current_shuffled_witnesses": [],
  "num_scheduled_witnesses": 8,
  "elected_weight": 226,
  "timeshare_weight": 142,
  "miner_weight": 10,
  "witness_pay_normalization_factor": 32765,
  "median_props": {
    "account_creation_fee": {
      "amount": "1",
      "precision": 3,
      "nai": "@@000000021"
    },
    "maximum_block_size": 131072,
    "hbd_interest_rate": 1000,
    "account_subsidy_budget": 797,
    "account_subsidy_decay": 347321
  },
  "majority_version": "0.0.0",
  "max_voted_witnesses": 32,
  "max_miner_witnesses": 41,
  "max_runner_witnesses": 203,
  "hardfork_required_witnesses": 52,
  "account_subsidy_rd": {
    "resource_unit": 0,
    "budget_per_time_unit": 0,
    "pool_eq": 0,
    "max_pool_size": 0,
    "decay_params": {
      "decay_per_time_unit": 0,
      "decay_per_time_unit_denom_shift": 0
    },
    "min_decay": 0
  },
  "account_subsidy_witness_rd": {
    "resource_unit": 0,
    "budget_per_time_unit": 0,
    "pool_eq": 0,
    "max_pool_size": 0,
    "decay_params": {
      "decay_per_time_unit": 0,
      "decay_per_time_unit_denom_shift": 0
    },
    "min_decay": 0
  },
  "min_witness_account_subsidy_decay": 0
}

wallet_bridge_api.is_known_transaction

Query Parameters JSON
null
Expected Response JSON
false

wallet_bridge_api.list_accounts

Query Parameters JSON
null
Expected Response JSON
[]

wallet_bridge_api.list_my_accounts

Query Parameters JSON
null
Expected Response JSON
[]

wallet_bridge_api.list_proposal_votes

Query Parameters JSON
null
Expected Response JSON
{"proposal_votes": []}

wallet_bridge_api.list_proposals

Query Parameters JSON
null
Expected Response JSON
{"proposals": []}

wallet_bridge_api.list_rc_accounts

Query Parameters JSON
null
Expected Response JSON
[]

wallet_bridge_api.list_rc_direct_delegations

Query Parameters JSON
null
Expected Response JSON
[]

wallet_bridge_api.list_witnesses

Query Parameters JSON
null
Expected Response JSON
{"witnesses": []}

Witness API

Methods:

API removed in 0.20.6, see: #3029

witness_api.get_account_bandwidth

Disabled since 0.20.6, see: #3029

Returns the available bandwidth of an account. See: Forum/Market Bandwidth

Query Parameters JSON
{"account": "", "type": "post"}
Expected Response JSON
{}

witness_api.get_reserve_ratio

Disabled since 0.20.6, see: #3029

Returns the current reserve ratio.

Query Parameters JSON
{}
Expected Response JSON
{
  "id": 0,
  "average_block_size": 0,
  "current_reserve_ratio": 1,
  "max_virtual_bandwidth": "0"
}
Example curl
curl -s --data '{"jsonrpc":"2.0", "method":"witness_api.get_account_bandwidth", "params":{"account":"hiveio","type":"forum"}, "id":1}' https://api.hive.blog
curl -s --data '{"jsonrpc":"2.0", "method":"witness_api.get_account_bandwidth", "params":{"account":"alice","type":"market"}, "id":1}' https://api.hive.blog

Broadcast OPS

Ops:

Virtual Ops:

An operation on Hive is a way of expressing intention on the blockchain. They are also known as Broadcast Operations. They have types, like vote or comment. They pass parameters like author and permlink, depending on what their purpose is.

Operations are grouped into transactions and passed as parameters to methods like network_broadcast_api.broadcast_transaction, in the operations array. Transactions must be signed in order for the blockchain to accept them. Here is an example of a transaction that contains one operation (shown without signatures).

{
   "jsonrpc":"2.0",
   "method":"condenser_api.broadcast_transaction",
   "params":{
      "trx":{
         "ref_block_num":1097,
         "ref_block_prefix":2181793527,
         "expiration":"2016-03-24T18:00:21",
         "operations":[
            [
               "vote",
               {
                  "voter":"hiveio",
                  "author":"alice",
                  "permlink":"a-post-by-alice",
                  "weight":10000
               }
            ]
         ],
         "extensions":[],
         "signatures":[]
      }
   },
   "id":1
}

Also see: Broadcast Transaction

vote

This operation is used to cast a vote on a post/comment. The primary purpose of voting is to express Proof-of-Brain about content to the blockchain. When a vote is cast, the content is considered in the consensus rules involving author and curation rewards.

A secondary aspect to voting involves reputation, which is not part of consensus.

Reputation Rules:

  1. Must have non-negative reputation to effect another user’s reputation.
  2. If you are down voting another user, you must have more reputation than them to impact their reputation.

Notes:

Roles: posting active owner
Parameters: voter author permlink weight
Example Op:
[
  "vote",
  {
    "voter": "hiveio",
    "author": "alice",
    "permlink": "a-post-by-alice",
    "weight": 10000
  }
]

comment

Creates a post/comment.

Parameters:

Rules:

Additional Parameter Definitions:

A typical comment operation would look similar to the below:

{
  "author": "Joe",
  "title": "A post by Joe",
  "body": "Look at my awesome post",
  "parent_author": "",
  "parent_permlink": "hiveio",
  "permlink": "a-post-by-joe",
  "json_metadata": "{\"tags\":[\"hiveio\",\"example\",\"tags\"]}"
}

Create vs. Update

When a comment is first broadcast, the permlink must be unique for the author. Otherwise, it is interpreted as an update operation. Updating will either replace the entire body with the latest operation or patch the body if using diff-match-patch.

For example, if we have a paragraph that has already been broadcast:

“It’s been quite a lot of fun working with these wonderful folk on the Open Hive Network”

And we want to change it to:

“It’s been quite a lot of fun working with these wonderful people on the Open Hive Network”

We can broadcast the comment operation with the following body:

- "@@ -406,12 +406,14 @@"
- ful
- -folk
- +people
- at

The blockchain will know that this means we have changed the word ‘folk’ to ‘people’ within that paragraph so when fetching this content, this diff will be applied.

In addition to body, the title and json_metadata fields will also be replaced by the latest operation.

See: comment_options, vote, custom_json

It should also be noted that a vote operation can accompany a comment and comment_options in the same transaction when the author self votes.

Roles: posting active owner
Parameters: parent_author parent_permlink author permlink title body json_metadata
Example Op:
[
  "comment",
  {
    "parent_author": "",
    "parent_permlink": "hiveio",
    "author": "alice",
    "permlink": "a-post-by-alice",
    "title": "A Post By Alice",
    "body": "This is my post.",
    "json_metadata": "{\"tags\":[\"hiveio\",\"example\",\"tags\"]}"
  }
]

transfer

Transfers asset from one account to another. The memo is plain-text, any encryption on the memo is up to a higher level protocol.

Notes:

Roles: active owner
Parameters: from to amount memo
Example Op:
[
  "transfer",
  {
    "from": "hiveio",
    "to": "alice",
    "amount": {
      "amount": "10",
      "precision": 3,
      "nai": "@@000000021"
    },
    "memo": "Thanks for all the fish."
  }
]

transfer_to_vesting

This operation converts HIVE into VFS (Vesting Fund Shares) at the current exchange rate. With this operation it is possible to give another account vesting shares so that faucets can pre-fund new accounts with vesting shares.

Notes:

See: delayed_voting

Roles: active owner
Parameters: from to amount
Example Op:
[
  "transfer_to_vesting",
  {
    "from": "alice",
    "to": "",
    "amount": {
      "amount": "357000",
      "precision": 3,
      "nai": "@@000000021"
    }
  }
]

withdraw_vesting

At any given point in time an account can be withdrawing from their vesting shares. A user may change the number of shares they wish to cash out at any time between 0 and their total vesting stake.

After applying this operation, vesting_shares will be withdrawn at a rate of vesting_shares/13 per week for 13 weeks starting one week after this operation is included in the blockchain.

This operation is not valid if the user has no vesting shares.

Notes:

Roles: active owner
Parameters: account vesting_shares
Example Op:
[
  "withdraw_vesting",
  {
    "account": "hiveio",
    "vesting_shares": {
      "amount": "200000000000",
      "precision": 6,
      "nai": "@@000000037"
    }
  }
]

limit_order_create

This operation creates a limit order and matches it against existing open orders. The maximum expiration time for any limit order is 28 days from head_block_time().

Roles: active owner
Parameters: owner orderid amount_to_sell min_to_receive fill_or_kill expiration
Example Op:
[
  "limit_order_create",
  {
    "owner": "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"
  }
]

limit_order_cancel

Cancels an internal market order and returns the balance to owner.

Roles: active owner
Parameters: owner orderid
Example Op:
[
  "limit_order_cancel",
  {"owner": "hiveio", "orderid": 10}
]

price

Roles: active owner
Parameters: base quote

feed_publish

Witnesses regularly publish a price feed that enables the blockchain to calculate a conversion ratio between HBD and HIVE.

Feeds can only be published by the top N witnesses which are included in every round and are used to define the exchange rate between HIVE and the US dollar.

Roles: active owner
Parameters: publisher exchange_rate
Example Op:
[
  "feed_publish",
  {
    "publisher": "alice",
    "exchange_rate": {
      "base": {
        "amount": "1000",
        "precision": 3,
        "nai": "@@000000013"
      },
      "quote": {
        "amount": "1000000",
        "precision": 3,
        "nai": "@@000000021"
      }
    }
  }
]

convert

This operation instructs the blockchain to start a conversion between HIVE and HBD, the funds are deposited after 3.5 days.

The identifier requestid will match the one found in fill_convert_request when the request is executed.

Roles: active owner
Parameters: owner requestid amount
Example Op:
[
  "convert",
  {
    "owner": "hiveio",
    "requestid": 1467592156,
    "amount": {
      "amount": "5000",
      "precision": 3,
      "nai": "@@000000013"
    }
  }
]

account_create

Broadcasted to the blockchain to create a new account.

Roles: active owner
Parameters: fee creator new_account_name owner active posting memo_key json_metadata
Example Op:
[
  "account_create",
  {
    "fee": {
      "amount": "0",
      "precision": 3,
      "nai": "@@000000021"
    },
    "creator": "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": "{}"
  }
]

account_update

Updates account information.

Roles: active owner
Parameters: account owner active posting memo_key json_metadata
Example Op:
[
  "account_update",
  {
    "account": "hiveio",
    "posting": {
      "weight_threshold": 1,
      "account_auths": [],
      "key_auths": [
        [
          "STM6FATHLohxTN8RWWkU9ZZwVywXo6MEDjHHui1jEBYkG2tTdvMYo",
          1
        ],
        [
          "STM76EQNV2RTA6yF9TnBvGSV71mW7eW36MM7XQp24JxdoArTfKA76",
          1
        ]
      ]
    },
    "memo_key": "STM6FATHLohxTN8RWWkU9ZZwVywXo6MEDjHHui1jEBYkG2tTdvMYo",
    "json_metadata": ""
  }
]

witness_update

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:

Roles: active owner
Parameters: owner url block_signing_key props fee
Example Op:
[
  "witness_update",
  {
    "owner": "alice",
    "url": "witness-category/my-witness",
    "block_signing_key": "STM8LoQjQqJHvotqBo7HjnqmUbFW9oJ2theyqonzUd9DdJ7YYHsvD",
    "props": {
      "account_creation_fee": {
        "amount": "100000",
        "precision": 3,
        "nai": "@@000000021"
      },
      "maximum_block_size": 131072,
      "hbd_interest_rate": 1000
    },
    "fee": {
      "amount": "0",
      "precision": 3,
      "nai": "@@000000021"
    }
  }
]

account_witness_vote

All accounts with a VFS (Vesting Fund Shares) can vote for or against any witness, up to 30 witnesses. See: HIVE_MAX_ACCOUNT_WITNESS_VOTES

If a proxy is specified then all existing votes are removed.

Roles: active owner
Parameters: account witness approve
Example Op:
[
  "account_witness_vote",
  {
    "account": "alice",
    "witness": "bob",
    "approve": true
  }
]

account_witness_proxy

Allows one account to delegate witness votes to another account.

If a proxy is specified then all existing witness votes are removed.

Note, as of HF21, setting a witness proxy also applies to 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.

Roles: active owner
Parameters: account proxy
Example Op:
[
  "account_witness_proxy",
  {"account": "alice", "proxy": "bob"}
]

pow

Disabled in HF14.

Roles: active owner
Parameters: worker input signature work
Example Op:
[
  "pow",
  {
    "worker_account": "admin",
    "block_id": "000004433bd4602cf5f74dbb564183837df9cef8",
    "nonce": 82,
    "work": {
      "worker": "STM65wH1LZ7BfSHcK69SShnqCAH5xdoSZpGkUjmzHJ5GCuxEK9V5G",
      "input": "59b009f89477919f95914151cef06f28bf344dd6fb7670aca1c1f4323c80446b",
      "signature": "1f3f83209097efcd01b7d6f27ce726164323d503d6fcf4d55bfb7cb3032796f6766738b36062b5850d69447fdf9c091cbc70825df5eeacc4710a0b11ffdbf0912a",
      "work": "0b62f4837801cd857f01d6a541faeb13d6bb95f1c36c6b4b14a47df632aa6c92"
    },
    "props": {
      "account_creation_fee": {
        "amount": "100000",
        "precision": 3,
        "nai": "@@000000021"
      },
      "maximum_block_size": 131072,
      "hbd_interest_rate": 1000
    }
  }
]

custom

Provides a generic way to add higher level protocols on top of witness consensus.

There is no validation for this operation other than that required auths are valid.

Roles: active owner
Parameters: required_auths id data
Example Op:
[
  "custom",
  {
    "required_auths": ["bytemaster"],
    "id": 777,
    "data": "0a627974656d617374657207737465656d697402a3d13897d82114466ad87a74b73a53292d8331d1bd1d3082da6bfbcff19ed097029db013797711c88cccca3692407f9ff9b9ce7221aaa2d797f1692be2215d0a5f6d2a8cab6832050078bc5729201e3ea24ea9f7873e6dbdc65a6bd9899053b9acda876dc69f11a13df9ca8b26b6"
  }
]

witness_block_approve

This is an operation for witnesses to approve the block quicker

Roles: witness_signature
Parameters: required_auths witness block_id

delete_comment

A post or comment can only be deleted when it has no positive rshares applied (i.e., has no pending payout from upvotes) and has no replies. They are not really deleted from the blockchain as they are still recorded in the original block.

Roles: posting active owner
Parameters: author permlink
Example Op:
[
  "delete_comment",
  {
    "author": "alice",
    "permlink": "a-post-by-alice"
  }
]

custom_json

Serves the same purpose as custom but also supports required posting authorities. Unlike custom, this operation is designed to be human readable/developer friendly.

follow

As of HF9, the follow plugin will track follow/unfollow/ignore events.

reblog

As of HF14, allows users to share blogs they find with those who follow them. This change implemented entirely outside the blockchain consensus which means that reblogging does not create a new post, it merely shares an existing post with people who follow you.

witness

As of HF18, the witness plugin has a custom operation called enable_content_editing that allows a user to signal they want to edit their content. By consensus, content is editable indefinitely, but is soft forked to be frozen after payout. This operation requires an active key and is designed to prevent vandalism if a posting key is compromised. #1017

Roles: posting active owner
Parameters: required_auths required_posting_auths id json
Example Op:
[
  "custom_json",
  {
    "required_auths": [],
    "required_posting_auths": ["hiveio"],
    "id": "follow",
    "json": "[\"follow\",{\"follower\":\"hiveio\",\"following\":\"alice\",\"what\":[\"blog\"]}]"
  }
]
[
  "custom_json",
  {
    "required_auths": [],
    "required_posting_auths": ["alice"],
    "id": "follow",
    "json": "[\"follow\",{\"follower\":\"alice\",\"following\":\"eve\",\"what\":[\"ignore\"]}]"
  }
]
[
  "custom_json",
  {
    "required_auths": [],
    "required_posting_auths": ["bob"],
    "id": "reblog",
    "json": "[\"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\"}]"
  }
]

comment_options

Authors of posts may not want all of the benefits that come from creating a post. This operation allows authors to update properties associated with their post.

Typically, these options will accompany a comment operation in the same transaction.

As of HF17, content can specify beneficiaries to receive a part of their author rewards. The beneficiaries are specified in the extension field of the comment_options_operation and is a sorted vector (by account name) of account name, weight pairs. The beneficiaries can only be specified once and must be specified before any votes are cast on the comment. Most apps are already adding a comment_options in the transaction that creates the comment, so this should not be much of a challenge to add to existing apps.

Notes:

Roles: posting active owner
Parameters: author permlink max_accepted_payout percent_hbd allow_votes allow_curation_rewards extensions
Example Op:
[
  "comment_options",
  {
    "author": "alice",
    "permlink": "a-post-by-alice",
    "max_accepted_payout": {
      "amount": "1000000",
      "precision": 3,
      "nai": "@@000000013"
    },
    "percent_hbd": 5000,
    "allow_votes": true,
    "allow_curation_rewards": true,
    "extensions": []
  }
]
[
  "comment_options",
  {
    "author": "bob",
    "permlink": "a-post-with-a-beneficiary",
    "max_accepted_payout": {
      "amount": "1000000",
      "precision": 3,
      "nai": "@@000000013"
    },
    "percent_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}
          ]
        }
      ]
    ]
  }
]

set_withdraw_vesting_route

Allows an account to setup a vesting withdraw but with the additional request for the funds to be transferred directly to another account’s balance rather than the withdrawing account. In addition, those funds can be immediately vested again, circumventing the conversion from vests to hive and back, guaranteeing they maintain their value.

Notes:

Roles: active owner
Parameters: from_account to_account percent auto_vest
Example Op:
[
  "set_withdraw_vesting_route",
  {
    "from_account": "alice",
    "to_account": "bob",
    "percent": 10000,
    "auto_vest": true
  }
]

limit_order_create2

This operation is identical to limit_order_create except it serializes the price rather than calculating it from other fields. The maximum expiration time for any limit order is 28 days from head_block_time().

See: #1573

Roles: active owner
Parameters: owner orderid amount_to_sell exchange_rate fill_or_kill expiration
Example Op:
[
  "limit_order_create2",
  {
    "owner": "alice",
    "orderid": 492991,
    "amount_to_sell": {
      "amount": "1",
      "precision": 3,
      "nai": "@@000000013"
    },
    "exchange_rate": {
      "base": {
        "amount": "1",
        "precision": 3,
        "nai": "@@000000013"
      },
      "quote": {
        "amount": "10",
        "precision": 3,
        "nai": "@@000000021"
      }
    },
    "fill_or_kill": false,
    "expiration": "2017-05-12T23:11:13"
  }
]

claim_account

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

Roles: active owner
Parameters: fee creator extensions
Example Op:
[
  "claim_account",
  {
    "fee": {
      "amount": "0",
      "precision": 3,
      "nai": "@@000000021"
    },
    "creator": "hiveio",
    "extensions": []
  }
]

create_claimed_account

When used with claim_account, works identically to account_create. See: 0.20.2 Release Notes

Roles: active owner
Parameters: creator new_account_name owner active posting memo_key json_metadata
Example Op:
[
  "create_claimed_account",
  {
    "creator": "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": "{}"
  }
]

request_account_recovery

All account recovery requests come from a listed recovery account. This is secure based on the assumption that only a trusted account should be a recovery account. It is the responsibility of the recovery account to verify the identity of the account holder of the account to recover by whichever means they have agreed upon. The blockchain assumes identity has been verified when this operation is broadcast.

This operation creates an account recovery request which the account to recover has 24 hours to respond to before the request expires and is invalidated.

There can only be one active recovery request per account at any one time. Pushing this operation for an account to recover when it already has an active request will either update the request to a new new owner authority and extend the request expiration to 24 hours from the current head block time or it will delete the request. To cancel a request, simply set the weight threshold of the new owner authority to 0, making it an open authority.

Additionally, the new owner authority must be satisfiable. In other words, the sum of the key weights must be greater than or equal to the weight threshold.

This operation only needs to be signed by the the recovery account. The account to recover confirms its identity to the blockchain in the recover account operation.

Notes:

See: #169

Roles: active owner
Parameters: recovery_account account_to_recover new_owner_authority extensions
Example Op:
[
  "request_account_recovery",
  {
    "recovery_account": "hiveio",
    "account_to_recover": "alice",
    "new_owner_authority": {
      "weight_threshold": 1,
      "account_auths": [],
      "key_auths": [
        [
          "STM6LYxj96zdypHYqgDdD6Nyh2NxerN3P1Mp3ddNm7gci63nfrSuZ",
          1
        ]
      ]
    },
    "extensions": []
  }
]

recover_account

Broadcasted to the blockchain by the hacked account’s owner to confirm the account recovery request sent by its Recovery Account.

Roles: owner
Parameters: account_to_recover new_owner_authority recent_owner_authority extensions
Example Op:
[
  "recover_account",
  {
    "account_to_recover": "alice",
    "new_owner_authority": {
      "weight_threshold": 1,
      "account_auths": [],
      "key_auths": [
        [
          "STM7j3nhkhHTpXqLEvdx2yEGhQeeorTcxSV6WDL2DZGxwUxYGrHvh",
          1
        ]
      ]
    },
    "recent_owner_authority": {
      "weight_threshold": 1,
      "account_auths": [],
      "key_auths": [
        [
          "STM78Xth94gNxp8nmByFV2vNAhg9bsSdviJ6fQXUTFikySLK3uTxC",
          1
        ]
      ]
    },
    "extensions": []
  }
]

change_recovery_account

Each account lists another account as their recovery account. The recovery account has the ability to create account_recovery_requests for the account to recover. An account can change their recovery account at any time with a 30 day delay. This delay is to prevent an attacker from changing the recovery account to a malicious account during an attack. These 30 days match the 30 days that an owner authority is valid for recovery purposes.

On account creation the recovery account is set either to the creator of the account (The account that pays the creation fee and is a signer on the transaction) or to the empty string if the account was mined. An account with no recovery has the top voted witness as a recovery account, at the time the recover request is created. Note: This does mean the effective recovery account of an account with no listed recovery account can change at any time as witness vote weights. The top voted witness is explicitly the most trusted witness according to stake.

See: #169, PY: Account Recovery

Roles: owner
Parameters: account_to_recover new_recovery_account extensions
Example Op:
[
  "change_recovery_account",
  {
    "account_to_recover": "alice",
    "new_recovery_account": "bob",
    "extensions": []
  }
]

escrow_transfer

The purpose of this operation is to enable someone to send money contingently to another individual. The funds leave the from account and go into a temporary balance where they are held until from releases it to to or to refunds it to from.

In the event of a dispute the agent can divide the funds between the to/from account. Disputes can be raised any time before or on the dispute deadline time, after the escrow has been approved by all parties.

This operation only creates a proposed escrow transfer. Both the agent and to must agree to the terms of the arrangement by approving the escrow.

The escrow agent is paid the fee on approval of all parties. It is up to the escrow agent to determine the fee.

Escrow transactions are uniquely identified by from and escrow_id, the escrow_id is defined by the sender.

See: hive_operations.hpp:299

Roles: active owner
Parameters: from to agent escrow_id hbd_amount hive_amount fee ratification_deadline escrow_expiration json_meta
Example Op:
[
  "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"
  }
]

escrow_dispute

If either the sender or receiver of an escrow payment has an issue, they can raise it for dispute. Once a payment is in dispute, the agent has authority over who gets what.

See: hive_operations.hpp:299

Roles: active owner
Parameters: from to agent who escrow_id
Example Op:
[
  "escrow_dispute",
  {
    "from": "alice",
    "to": "bob",
    "agent": "charlie",
    "who": "alice",
    "escrow_id": 72526562
  }
]

escrow_release

This operation can be used by anyone associated with the escrow transfer to release funds if they have permission.

The permission scheme is as follows:

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

Roles: active owner
Parameters: from to agent who receiver escrow_id hbd_amount hive_amount
Example Op:
[
  "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"
    }
  }
]

pow2

Disabled in HF17.

Roles: active owner
Parameters: input pow_summary
Example Op:
[
  "pow2",
  {
    "work": [
      0,
      {
        "input": {
          "worker_account": "alice",
          "prev_block": "003ea604345523c344fbadab605073ea712dd76f",
          "nonce": "1052853013628665497"
        },
        "pow_summary": 3817904373
      }
    ],
    "props": {
      "account_creation_fee": {
        "amount": "1",
        "precision": 3,
        "nai": "@@000000021"
      },
      "maximum_block_size": 131072,
      "hbd_interest_rate": 1000
    }
  }
]

escrow_approve

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

Roles: active owner
Parameters: from to agent who escrow_id approve
Example Op:
[
  "escrow_approve",
  {
    "from": "alice",
    "to": "bob",
    "agent": "charlie",
    "who": "charlie",
    "escrow_id": 59102208,
    "approve": true
  }
]

transfer_to_savings

For time locked savings accounts. A user can place Hive and Hive Dollars into time locked savings balances. Funds can be withdrawn from these balances after a three day delay. The point of this addition is to mitigate loss from hacked and compromised account. The max a user can lose instantaneously is the sum of what the hold in liquid balances. Assuming an account can be recovered quickly, loss in such situations can be kept to a minimum.

See: hive_operations.hpp:988

Roles: active owner
Parameters: from to amount memo
Example Op:
[
  "transfer_to_savings",
  {
    "from": "alice",
    "to": "alice",
    "amount": {
      "amount": "1000",
      "precision": 3,
      "nai": "@@000000013"
    },
    "memo": ""
  }
]

transfer_from_savings

Funds withdrawals from the savings to an account take three days. Their execution is recorded in the blockchain with the fill_transfer_from_savings virtual operation.

Roles: active owner
Parameters: from request_id to amount memo
Example Op:
[
  "transfer_from_savings",
  {
    "from": "alice",
    "request_id": 101,
    "to": "alice",
    "amount": {
      "amount": "1000",
      "precision": 3,
      "nai": "@@000000013"
    },
    "memo": ""
  }
]

cancel_transfer_from_savings

Funds withdrawals from the savings can be canceled at any time before it is executed.

Roles: active owner
Parameters: from request_id
Example Op:
[
  "cancel_transfer_from_savings",
  {"from": "alice", "request_id": 1}
]

decline_voting_rights

An account can chose to decline their voting rights after a 30 day delay. This includes voting on content and witnesses. The voting rights cannot be acquired again once they have been declined. This is only to formalize a smart contract between certain accounts and the community that currently only exists as a social contract.

See: hive_operations.hpp:1020

Roles: owner
Parameters: account decline
Example Op:
[
  "decline_voting_rights",
  {"account": "judy", "decline": true}
]

claim_reward_balance

Author and curator rewards are not automatically transferred to the account’s balances. One has to issue a claim_reward_balance operation to trigger the transfer from the reward pool to its balance.

Roles: posting active owner
Parameters: account reward_hive reward_hbd reward_vests
Example Op:
[
  "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"
    }
  }
]

delegate_vesting_shares

Delegate vesting shares from one account to the other. The vesting shares are still owned by the original account, but content voting rights and resource credit are transferred to the receiving account. This sets the delegation to vesting_shares, increasing it or decreasing it as needed (i.e. a delegation of 0 removes the delegation).

When a delegation is removed the shares are placed in limbo for a week to prevent using them and voting on the same content twice.

Also see:

Roles: active owner
Parameters: delegator delegatee vesting_shares
Example Op:
[
  "delegate_vesting_shares",
  {
    "delegator": "alice",
    "delegatee": "bob",
    "vesting_shares": {
      "amount": "94599167138276",
      "precision": 6,
      "nai": "@@000000037"
    }
  }
]

account_create_with_delegation

Deprecated as of HF20 If an account creation service would still like to provide a delegation of Hive Power to the accounts they create, they can still follow the account creation operation with an additional call to delegate_vesting_shares to add a delegation of HP to the account.

Instead of paying the entire account creation fee with Hive, creators can now pay a smaller fee (30x less) and delegate some Hive Power for 30 days. The exact amount is 5 * min_fee + HIVE_POWER == 150 * min_fee. You can pay any combination of HIVE and Hive Power along that curve (so long as the minimum fee is paid).

The witness voted HIVE fee is now the minimum required HIVE fee for 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:

Roles: active owner
Parameters: fee delegation creator new_account_name owner active posting memo_key json_metadata extensions
Example Op:
[
  "account_create_with_delegation",
  {
    "fee": {
      "amount": "3000",
      "precision": 3,
      "nai": "@@000000021"
    },
    "delegation": {
      "amount": "0",
      "precision": 6,
      "nai": "@@000000037"
    },
    "creator": "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": []
  }
]

witness_set_properties

Added in HF20 to replace the witness_update which was not easily extendable. While it is recommended to use witness_set_properties, witness_update will continue to work. See: Witness Parameters

Roles: block_signing active owner
Parameters: owner props extensions
Example Op:
[
  "witness_set_properties",
  {
    "owner": "alice",
    "props": {
      "account_creation_fee": "0.000 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": []
  }
]

account_update2

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

Roles: posting active owner
Parameters: account owner active posting memo_key json_metadata posting_json_metadata
Example Op:
[
  "account_update",
  {
    "account": "hiveio",
    "posting_json_metadata": ""
  }
]

create_proposal

Creates a new proposal.

Roles: postingactive owner
Parameters: creator receiver start_date end_date daily_pay subject permlink
Example Op:
[
  "create_proposal",
  {
    "creator": "alice",
    "receiver": "bob",
    "start_date": "2019-08-26T11:22:39",
    "end_date": "2019-08-26T11:22:39",
    "daily_pay": {
      "amount": "3000",
      "precision": 3,
      "nai": "@@000000013"
    },
    "subject": "subject",
    "permlink": "creator-proposal-permlink"
  }
]

update_proposal_votes

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
Parameters: voter proposal_ids approve
Example Op:
[
  "update_proposal_votes",
  {
    "voter": "alice",
    "proposal_ids": [0],
    "approve": true,
    "extensions": []
  }
]

remove_proposal

Removes proposal using proposal.id of a given proposal.

Roles: posting active owner
Parameters: creator proposal_ids
Example Op:
[
  "remove_proposal",
  {"creator": "alice", "proposal_ids": [0]}
]

update_proposal

Update a proposal using proposal.id of a given proposal. Allows creator to lower daily_pay but not increase it, change subject, and point to a new permlink.

Roles: posting active owner
Parameters: proposal_id creator daily_pay subject permlink
Example Op:
[
  "update_proposal",
  {
    "proposal_id": 0,
    "creator": "alice",
    "daily_pay": {
      "amount": "3000",
      "precision": 3,
      "nai": "@@000000013"
    },
    "subject": "New Subject",
    "permlink": "creator-proposal-permlink"
  }
]

collateralized_convert

The collateralized_convert operation is similar to convert operation (see: convert), 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:
Parameters: owner requestid amount
Example Op:
[
  "collateralized_convert",
  {
    "owner": "hiveio",
    "requestid": 1467592156,
    "amount": {
      "amount": "5000",
      "precision": 3,
      "nai": "@@000000021"
    }
  }
]

recurrent_transfer

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

Roles:
Parameters: from to amount memo recurrence executions extensions

prove_authority

 

 

 

 

Roles: active owner
Parameters: challenged require_owner

custom_binary

The semmantics for this operation are the same as the custom_json operation, but with a binary payload. The json deserialization has a non-trivial cost associated with it. This operation will allow for binary deserialization of plugin operations and should improve overall performance of plugins that chose to use it.

See: hive_operations.hpp:604

Roles: posting active owner
Parameters: id data
Example Op:
["custom_binary", {"id": 0, "data": ""}]

claim_reward_balance2

Differs with original operation with extensions field and a container of tokens that will be rewarded to an account.

Note: The reward tokens are required to be unique and sorted (both by asset symbol) in ascending order. Otherwise operation validation will fail.

See: #1859

Roles: posting active owner
Parameters: account reward_tokens extensions
Example Op:
[
  "claim_reward_balance2",
  {
    "account": "alice",
    "reward_tokens": [
      {
        "amount": "1",
        "precision": 0,
        "nai": "@@904705667"
      }
    ],
    "extensions": []
  }
]

vote2

This operation is used to cast a vote on a post/comment using multiple votable assets.

See: #2748, SMT Voting Mana Deep Dive

Roles: posting active owner
Parameters: voter author permlink weight extensions
Example Op:
[
  "vote2",
  {
    "voter": "hiveio",
    "author": "alice",
    "permlink": "a-post-by-alice",
    "rshares": [[{"nai": "@@904705667", "decimals": 0}, 0]],
    "extensions": []
  }
]

smt_setup

Setup a Smart Media Token. Each SMT has an associated descriptor object which has permanent configuration data. This data cannot be changed after launch.

Parameters:

Example Initial Generation Policy JSON:

{"type": "smt_capped_generation_policy", "value": {
  "pre_soft_cap_unit": {
    "hive_unit": [["alice", 100]],
    "token_unit": [["$from", 5], ["alice", 1]]
  },
  "post_soft_cap_unit": {
    "hive_unit": [["alice", 100]],
    "token_unit": [["$from", 5], ["alice", 1]]
  },
  "min_hive_units_commitment": {
    "lower_bound": 1,
    "upper_bound": 1,
    "hash": "32edb6022c0921d99aa347e9cda5dc2db413f5574eebaaa8592234308ffebd2b"
  },
  "hard_cap_hive_units_commitment": {
    "lower_bound": "166666666666",
    "upper_bound": "166666666666",
    "hash": "93c5a6b892de788c5b54b63b91c4b692e36099b05d3af0d16d01c854723dda21"
  },
  "soft_cap_percent": 10000,
  "min_unit_ratio": 1000,
  "max_unit_ratio": 1000,
  "extensions": []
}}

See #3455, SMT Setup

Structure

Roles: active owner
Parameters: control_account symbol contribution_begin_time contribution_end_time launch_time max_supply hive_units_hard_cap hive_units_soft_cap hive_units_min initial_generation_policy extensions
Example Op:
[
  "smt_setup",
  {
    "control_account": "alice",
    "symbol": {"nai": "@@000000000", "decimals": 0},
    "contribution_begin_time": "2019-08-26T11:22:39",
    "contribution_end_time": "2019-08-26T11:22:39",
    "launch_time": "2019-09-26T11:22:39",
    "max_supply": 1000000000000000,
    "hive_units_hard_cap": 10000,
    "hive_units_soft_cap": 1000,
    "hive_units_min": 0,
    "initial_generation_policy": "{\"type\":\"smt_capped_generation_policy\",\"value\":{\"pre_soft_cap_unit\":{\"hive_unit\":[[\"alice\",100]],\"token_unit\":[[\"$from\",5],[\"alice\",1]]},\"post_soft_cap_unit\":{\"hive_unit\":[[\"alice\",100]],\"token_unit\":[[\"$from\",5],[\"alice\",1]]},\"min_hive_units_commitment\":{\"lower_bound\":1,\"upper_bound\":1,\"hash\":\"32edb6022c0921d99aa347e9cda5dc2db413f5574eebaaa8592234308ffebd2b\"},\"hard_cap_hive_units_commitment\":{\"lower_bound\":\"166666666666\",\"upper_bound\":\"166666666666\",\"hash\":\"93c5a6b892de788c5b54b63b91c4b692e36099b05d3af0d16d01c854723dda21\"},\"soft_cap_percent\":10000,\"min_unit_ratio\":1000,\"max_unit_ratio\":1000,\"extensions\":[]}}",
    "extensions": []
  }
]

smt_setup_emissions

Create Smart Media Token emissions (inflation).

Parameters:

See: #1513, #2738, SMT Pre-Setup, Inflation Operations, Full JSON Examples, Inflation FAQ

Structure

Roles: active owner
Parameters: control_account symbol emissions_unit interval_seconds interval_count lep_time rep_time lep_abs_amount rep_abs_amount lep_rel_amount_numerator rep_rel_amount_numerator rel_amount_denom_bits remove floor_emissions
Example Op:
[
  "smt_setup_emissions",
  {
    "control_account": "alice",
    "symbol": {"nai": "@@904705667", "decimals": 0},
    "schedule_time": "2019-08-26T11:22:39",
    "emissions_unit": {"token_unit": [["alice", 1]]},
    "interval_seconds": 21600,
    "interval_count": 1,
    "lep_time": "2019-08-26T11:22:39",
    "rep_time": "2019-08-26T11:22:39",
    "lep_abs_amount": {
      "amount": "1",
      "precision": 0,
      "nai": "@@904705667"
    },
    "rep_abs_amount": {
      "amount": "1",
      "precision": 0,
      "nai": "@@904705667"
    },
    "lep_rel_amount_numerator": 0,
    "rep_rel_amount_numerator": 0,
    "rel_amount_denom_bits": 0,
    "remove": false,
    "floor_emissions": false,
    "extensions": []
  }
]

smt_set_setup_parameters

Creates Smart Media Token setup parameters.

Parameters:

See: #2727, Named Token Parameters

Structure

Roles: active owner
Parameters: control_account symbol setup_parameters
Example Op:
[
  "smt_set_setup_parameters",
  {
    "control_account": "alice",
    "symbol": {"nai": "@@000000000", "decimals": 0},
    "setup_parameters": [
      {
        "type": "smt_param_allow_voting",
        "value": {"value": true}
      }
    ],
    "extensions": []
  }
]

smt_set_runtime_parameters

Creates Smart Media Token runtime parameters.

Parameters:

Allowed Author Reward Curves:

Allowed Curation Reward Curves:

See: Named Token Parameters

Structure

Roles: active owner
Parameters: control_account symbol runtime_parameters
Example Op:
[
  "smt_set_runtime_parameters",
  {
    "control_account": "alice",
    "symbol": {"nai": "@@000000000", "decimals": 0},
    "runtime_parameters": [
      {
        "type": "smt_param_windows_v1",
        "value": {
          "cashout_window_seconds": 90001,
          "reverse_auction_window_seconds": 110
        }
      },
      {
        "type": "smt_param_vote_regeneration_period_seconds_v1",
        "value": {
          "vote_regeneration_period_seconds": 7000,
          "votes_per_regeneration_period": 1
        }
      },
      {
        "type": "smt_param_rewards_v1",
        "value": {
          "content_constant": 9005,
          "percent_curation_rewards": 9006,
          "author_reward_curve": "quadratic",
          "curation_reward_curve": "bounded_curation"
        }
      },
      {
        "type": "smt_param_allow_downvotes",
        "value": {"value": true}
      }
    ],
    "extensions": []
  }
]

smt_create

Create a Smart Media Token.

This operation introduces new SMT into blockchain as identified by Numerical Asset Identifier (NAI). Also the SMT precision (decimal points) is explicitly provided.

Initial Case

The first operation to be executed is an smt_create operation. This operation creates an SMT object in the blockchain state. After executing this operation, the newly created SMT object is not yet fully configured.

Most of the configuration occurs in subsequent operations (smt_set_setup_parameters, smt_setup_inflation, and smt_setup). These later operations may occur in the same transaction, but they may also occur at any later point in time.

Reset Case

Re-issuing smt_create with zero smt_creation_fee and the NAI of a token in the initial setup will reset emmisions and setup state. This is useful for token creators who have put their token in an unlaunchable state.

This will allow deleting of emission schedules with and changing of precision if there are no emission objects already created.

Parameters:

See: SMT Object Creation

Structure

Roles: active owner
Parameters: control_account symbol smt_creation_fee precision
Example Op:
[
  "smt_create",
  {
    "control_account": "alice",
    "symbol": {"nai": "@@000000000", "decimals": 0},
    "smt_creation_fee": {
      "amount": "3000",
      "precision": 3,
      "nai": "@@000000013"
    },
    "precision": 0,
    "extensions": []
  }
]

smt_contribute

Contribute to a token ICO.

Parameters:

See: #2730, Token Units

Structure

Roles: active owner
Parameters: contributor symbol contribution_id contribution
Example Op:
[
  "smt_contribute",
  {
    "contributor": "alice",
    "symbol": {"nai": "@@422838704", "decimals": 0},
    "contribution_id": 0,
    "contribution": {
      "amount": "1000",
      "precision": 3,
      "nai": "@@000000021"
    },
    "extensions": []
  }
]

clear_null_account_balance

For per-block processing that clears null account balances.

See: #2627, #3556 (possibly planned for deprecation with SMT Hardfork, if implemented)

Roles: active owner
Parameters: total_cleared
Example Op:
[
  "clear_null_account_balance",
  {
    "total_cleared": [
      {
        "amount": "3000",
        "precision": 3,
        "nai": "@@000000021"
      }
    ]
  }
]

proposal_pay

Dedicated operation to be generated during proposal payment phase to provide info in Account History related to funds transfer.

This virtual operation is issued every hour during a proposal payment phase.

Proposals without any votes are not considered active and do not receive any payment.

If the payment of a proposal exceeds the amount of the available daily budget, it will receive a partial payment with what’s left in the daily budget.

Roles: active owner
Parameters: receiver payment trx_id op_in_trx
Example Op:
[
  "proposal_pay",
  {
    "receiver": "hive.fund",
    "payment": "1.637 HBD",
    "trx_id": "0000000000000000000000000000000000000000",
    "op_in_trx": 0
  }
]

sps_fund

Created once per maintenance interval to document how much HBD was added to the threasury from inflation in that maintenance interval (i.e., to track the funding of the DHF).

Roles: active owner
Parameters: additional_funds
Example Op:
["sps_fund", {"additional_funds": "71.460 HBD"}]

fill_convert_request

Fills when conversion requests with a conversion date before the head block time and then converts them to/from HIVE/HBD at the current median price feed history price times the premium.

Roles: active owner
Parameters: owner requestid amount_in amount_out
Example Op:
[
  "fill_convert_request",
  {
    "owner": "titofit",
    "requestid": 3347004874,
    "amount_in": {
      "amount": "3770",
      "precision": 3,
      "nai": "@@000000013"
    },
    "amount_out": {
      "amount": "8849",
      "precision": 3,
      "nai": "@@000000021"
    }
  }
]

author_reward

Triggered after the payout period on posts and comments.

Roles: posting active owner
Parameters: author permlink hbd_payout hive_payout vesting_payout curators_vesting_payout
Example Op:
[
  "author_reward",
  {
    "author": "dianadora",
    "permlink": "actifit-dianadora-20210527t193130754z",
    "hbd_payout": {
      "amount": "11",
      "precision": 3,
      "nai": "@@000000013"
    },
    "hive_payout": {
      "amount": "0",
      "precision": 3,
      "nai": "@@000000021"
    },
    "vesting_payout": {
      "amount": "52734247",
      "precision": 6,
      "nai": "@@000000037"
    },
    "curators_vesting_payout": {
      "amount": "96051664",
      "precision": 6,
      "nai": "@@000000037"
    }
  }
]

curation_reward

Issued by the blockchain after the payout period on posts and comments.

Roles: posting active owner
Parameters: curator reward comment_author comment_permlink
Example Op:
[
  "curation_reward",
  {
    "curator": "hendrikdegrote",
    "reward": {
      "amount": "9349621710",
      "precision": 6,
      "nai": "@@000000037"
    },
    "comment_author": "crypt0",
    "comment_permlink": "metropolis-by-end-of-june-swt-token-now-trading-on-bittrex-roger-ver-offering-his-own-btc"
  }
]

comment_reward

Issued after the payout period on posts and comments.

The value of this operation is the global payout value for the post or comment. A separate virtual operation is issued for the author, the curators and the beneficiaries (see author_reward, comment_benefactor_reward and curation_reward).

The value is the equivalent HBD value of the payout even if no HBD will be effectively paid to the author, curators, or beneficiaries.

See: #774

Roles: posting active owner
Parameters: author permlink payout author_rewards curator_payout_value beneficiary_payout_value
Example Op:
[
  "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"
    }
  }
]

interest

Issued when interests are paid on HBD or HBD saving.

Roles: active owner
Parameters: owner interest
Example Op:
[
  "interest",
  {"owner": "alice", "interest": "0.001 HBD"}
]

fill_vesting_withdraw

Issued when each week after a user has initiated a withdrawal from VESTS to HIVE (see: withdraw_vesting).

See: #78

Roles: active owner
Parameters: from_account to_account withdrawn deposited
Example Op:
[
  "fill_vesting_withdraw",
  {
    "from_account": "alice",
    "to_account": "alice",
    "withdrawn": "0.026475 VESTS",
    "deposited": "0.710 HIVE"
  }
]

fill_order

Issued when orders on the internal market are filled (see: limit_order_create).

Roles: posting active owner
Parameters: current_owner current_orderid current_pays open_owner open_orderid open_pays
Example Op:
[
  "fill_order",
  {
    "current_owner": "alice",
    "current_orderid": 42896,
    "current_pays": "94.999 HBD",
    "open_owner": "bob",
    "open_orderid": 10001,
    "open_pays": "500.000 HIVE"
  }
]

shutdown_witness

This virtual operation was previously issued when the system automatically disables a witness because it was missing too many blocks.

This operation has been introduced with HF14 and deprecated with HF20.

See: #278

Roles: posting active owner
Parameters: owner
Example Op:
["shutdown_witness", {"owner": "alice"}]

fill_transfer_from_savings

Issued when the delay for a transfer request from a savings balance is complete and the transfer is effectively executed (see: transfer_from_savings)

Roles: posting active owner
Parameters: from to amount request_id memo
Example Op:
[
  "fill_transfer_from_savings",
  {
    "from": "learngerman",
    "to": "learngerman",
    "amount": {
      "amount": "1000",
      "precision": 3,
      "nai": "@@000000021"
    },
    "request_id": 1618177172,
    "memo": ""
  }
]

hardfork

Tracks hardfork activation.

Hardfork Sheduled Hardfork Time Actual Block
HF0 2016-03-24 16:00:00 UTC 1
HF1 2016-04-25 17:30:00 UTC 905693
HF2 2016-04-26 18:00:00 UTC 934585
HF3 2016-04-27 13:00:00 UTC 953363
HF4 2016-04-30 15:00:00 UTC 1041497
HF5 2016-05-31 17:00:00 UTC 1934236
HF6 2016-06-30 14:00:00 UTC 2790882
HF7 2016-07-04 00:00:00 UTC 2889019
HF8 2016-07-04 01:00:00 UTC 2889959
HF9 2016-07-14 00:00:00 UTC 3202773
HF10 2016-07-15 12:00:00 UTC 3239649
HF11 2016-07-17 15:00:00 UTC 3276913
HF12 2016-07-26 15:00:00 UTC 3533567
HF13 2016-08-15 14:00:00 UTC 4105155
HF14 2016-09-20 15:00:00 UTC 5137542
HF15 2016-11-08 16:00:00 UTC 6547932
HF16 2016-12-06 16:00:00 UTC 7353249
HF17 2017-03-30 15:00:00 UTC 10629455
HF18 2017-03-30 15:00:00 UTC 10629486
HF19 2017-06-20 15:00:00 UTC 12988978
HF20 2018-09-25 15:00:00 UTC 26256743
HF21 2019-08-27 15:00:00 UTC 35921786
HF22 2019-08-29 15:00:00 UTC 35974326
HF23 2020-03-20 14:00:00 UTC 41818752
HF24 2020-10-06 14:00:00 UTC 47797680
HF25 2021-06-30 14:00:00 UTC 55235767
HF26 2022-10-11 12:00:00 UTC 68676505

See: PR2616, database_api.get_hardfork_properties, condenser_api.get_next_scheduled_hardfork

Roles: posting active owner
Parameters: hardfork_id

comment_payout_update

Issued when a post or comment reaches the end of the payout windows and its final payout values are computed.

Roles: posting active owner
Parameters: author permlink
Example Op:
[
  "comment_payout_update",
  {
    "author": "pinmapple",
    "permlink": "pinmapple162222420235626"
  }
]

return_vesting_delegation

Occurs when the Hive Power that has been previously delegated by an account to another account comes back to the original owner. When a user cancels its delegation, it takes 7 days to complete (see: delegate_vesting_shares).

Roles: posting active owner
Parameters: account vesting_shares
Example Op:
[
  "return_vesting_delegation",
  {
    "account": "artemisha",
    "vesting_shares": {
      "amount": "18833102935",
      "precision": 6,
      "nai": "@@000000037"
    }
  }
]

comment_benefactor_reward

Triggered after the payout period on posts and comments if the original author has decided to share his reward with other users.

Roles: posting active owner
Parameters: benefactor author permlink hbd_payout hive_payout vesting_payout
Example Op:
[
  "comment_benefactor_reward",
  {
    "benefactor": "hiveonboard",
    "author": "yossaeluz",
    "permlink": "importance-of-the-implementation-of-continuous-improvement-in-processes",
    "hbd_payout": {
      "amount": "40",
      "precision": 3,
      "nai": "@@000000013"
    },
    "hive_payout": {
      "amount": "0",
      "precision": 3,
      "nai": "@@000000021"
    },
    "vesting_payout": {
      "amount": "178904599",
      "precision": 6,
      "nai": "@@000000037"
    }
  }
]

producer_reward

Occurs each time a block is produced. It contains the rewards that are given to witnesses (and previously miners) for their work.

Witness rewards for block signing are hard to account for. Making these rewards visible will help witnesses and prospective witnesses by providing them with more complete and accurate information to guide their decisions to invest in the platform.

Roles: posting active owner
Parameters: producer vesting_shares
Example Op:
[
  "producer_reward",
  {
    "producer": "alice",
    "vesting_shares": "14403.626449 VESTS"
  }
]

hardfork_hive

At the point of the Hive hardfork, the only accounts who were not included in the initial airdrop were those containing the Steemit, Inc. ninja-mined stake and those who actively contributed to (and publicly declared support for) the centralization of the Steem Blockchain.

This virual operation tracks the initial consolidation of stake into the treasury, on the above criteria.

Also represents the moment Hive forked from the previous chain.

See: Hive Announcement, Block No. 41818752, e9f2f73

Roles: posting active owner
Parameters: account treasury hbd_transferred hive_transferred vests_converted total_hive_from_vests
Example Op:
[
  "hardfork_hive",
  {
    "account": "steem",
    "treasury": "steem.dao",
    "hbd_transferred": {
      "amount": "861823",
      "precision": 3,
      "nai": "@@000000013"
    },
    "hive_transferred": {
      "amount": "40590",
      "precision": 3,
      "nai": "@@000000021"
    },
    "vests_converted": {
      "amount": "22870822335791719",
      "precision": 6,
      "nai": "@@000000037"
    },
    "total_hive_from_vests": {
      "amount": "11678135805",
      "precision": 3,
      "nai": "@@000000021"
    }
  }
]

hardfork_hive_restore

To restore the liquid balance of accounts that were not airdropped in the original Hive hardfork.

VESTS were restored in a later transaction:

https://hiveblocks.com/tx/1d600db22fc6f9b362db36d9f0fc521b95f8894f

See: Block No. 47797680, !19, 5edf4f0, restore.js

Roles:
Parameters:
Example Op:
[
  "hardfork_hive_restore",
  {
    "account": "yellowbird",
    "treasury": "steem.dao",
    "hbd_transferred": {
      "amount": "0",
      "precision": 3,
      "nai": "@@000000013"
    },
    "hive_transferred": {
      "amount": "1280",
      "precision": 3,
      "nai": "@@000000021"
    }
  }
]

delayed_voting

Tracks when newly powered up VESTS become counted towards witness and DHF proposals (after a 30 day delay is complete).

See: transfer_to_vesting, fa63145, 5, !21

Roles:
Parameters:
Example Op:
[
  "delayed_voting",
  {"voter": "fordummies", "votes": 191547046}
]

consolidate_treasury_balance

Tracks when balances move from old treasury account to current one, on an ongoing basis. Note that the obsolete account is still considered a treasury (cannot be reused for other purposes), but all funds and actions are redirected to new one.

For example, if an author designates the obsolete account as beneficiary, the reward will briefly exist in the obsolete account until consoldated to the new account.

See: 2074917, OBSOLETE_TREASURY_ACCOUNT, NEW_HIVE_TREASURY_ACCOUNT

Roles: posting active owner
Parameters: total_moved
Example Op:
[
  "consolidate_treasury_balance",
  {
    "total_moved": [
      {
        "amount": "8853",
        "precision": 3,
        "nai": "@@000000013"
      }
    ]
  }
]

effective_comment_vote

This virtual operation is issued when a vote on a post or comment becomes effective (see: vote)

Needed by hivemind to index estimated pending_payout from a given vote.

See: 2074917

Roles: posting active owner
Parameters: voter author permlink weight rshares total_vote_weight pending_payout
Example Op:
[
  "effective_comment_vote",
  {
    "voter": "hivebuzz",
    "author": "papilloncharity",
    "permlink": "re-hivebuzz-qrevvy",
    "weight": 3658,
    "rshares": "7332260842",
    "total_vote_weight": 3658,
    "pending_payout": {
      "amount": "4",
      "precision": 3,
      "nai": "@@000000013"
    }
  }
]

ineffective_delete_comment

Track comments that were intended to be removed but weren’t due to having a payout due to net positive votes. This operation is used to communicate to hivemind in order to avoid hiding comments with payout.

See: !94

Roles:
Parameters:

sps_convert

Issued when a Proposals Fund (DHF) conversion from HIVE to HBD occurs.

When the Hardfork that created Hive happened back in March 2020, the Steemit Inc ninja-mined funds were moved into the @hive.fund account as a development fund. As proposals are paid in HBD and most of the moved funds were in HIVE, an automatic conversion process has been put in place.

See: 96254ae

Roles:
Parameters: fund_account hive_amount_in hbd_amount_out
Example Op:
[
  "sps_convert",
  {
    "fund_account": "hive.fund",
    "hive_amount_in": {
      "amount": "37111024",
      "precision": 3,
      "nai": "@@000000021"
    },
    "hbd_amount_out": {
      "amount": "15735074",
      "precision": 3,
      "nai": "@@000000013"
    }
  }
]

account_created

Issued each time a new account has been successfully created.

Roles:
Parameters: new_account_name creator initial_vesting_shares initial_delegation
Example Op:
[
  "account_created",
  {
    "new_account_name": "init-2",
    "creator": "initminer",
    "initial_vesting_shares": {
      "amount": "0",
      "precision": 6,
      "nai": "@@000000037"
    },
    "initial_delegation": {
      "amount": "0",
      "precision": 6,
      "nai": "@@000000037"
    }
  }
]

changed_recovery_account

Issued when the blockchain effectively changes the recovery account of an account after it issued such request (see: change_recovery_account).

Roles:
Parameters: account old_recovery_account new_recovery_account
Example Op:
[
  "changed_recovery_account",
  {
    "account": "alice",
    "old_recovery_account": "eve",
    "new_recovery_account": "bob"
  }
]

expired_account_notification

Issued when governance votes for an account have expired and are removed.

Roles:
Parameters: account
Example Op:
[
  "expired_account_notification",
  {"account": "init-2"}
]

failed_recurrent_transfer

Issued when a recurrent transfer has failed to be executed (see: recurrent_transfer).

 

 

 

Roles:
Parameters: from to amount memo consecutive_failures remaining_executions deleted

fill_collateralized_convert_request

Issued when a HIVE to HBD conversion is completed (see: recurrent_transfer).

 

 

 

Roles:
Parameters: owner requestid amount_in amount_out excess_collateral

fill_recurrent_transfer

Issued when a recurrent transfer is executed (see: recurrent_transfer).

 

 

 

Roles:
Parameters: from to amount memo remaining_executions

transfer_to_vesting_completed

Issued when a power-up is finally taken into account for governance votes (see: transfer_to_vesting).

See: #111

 

 

Roles:
Parameters: from_account to_account hive_vested vesting_shares_received

Broadcast OPS Custom

Ops:

To interact with the communities framework, use custom_json operations with the an id of community. Communities also intepret other ids like follow and reblog.

See: communities.md

Also see: Bridge, Broadcast Transaction, custom_json

setRole

Sets a role for a given account in a community.

Roles: posting
Parameters: community account role
Example Op:
[
  "custom_json",
  {
    "required_auths": [],
    "required_posting_auths": ["alice"],
    "id": "community",
    "json": "[\"setRole\", {\"community\": \"hive-123456\", \"account\": \"bob\", \"role\": \"admin\"}]"
  }
]
[
  "custom_json",
  {
    "required_auths": [],
    "required_posting_auths": ["alice"],
    "id": "community",
    "json": "[\"setRole\", {\"community\": \"hive-123456\", \"account\": \"charlie\", \"role\": \"mod\"}]"
  }
]
[
  "custom_json",
  {
    "required_auths": [],
    "required_posting_auths": ["alice"],
    "id": "community",
    "json": "[\"setRole\", {\"community\": \"hive-123456\", \"account\": \"dave\", \"role\": \"guest\"}]"
  }
]
[
  "custom_json",
  {
    "required_auths": [],
    "required_posting_auths": ["alice"],
    "id": "community",
    "json": "[\"setRole\", {\"community\": \"hive-123456\", \"account\": \"edward\", \"role\": \"member\"}]"
  }
]

setUserTitle

Sets a title (badge) for a given account in a community (Mods or higher).

Roles: posting
Parameters: community account title
Example Op:
[
  "custom_json",
  {
    "required_auths": [],
    "required_posting_auths": ["alice"],
    "id": "community",
    "json": "[\"setUserTitle\", {\"community\": \"hive-123456\", \"account\": \"alice\", \"title\": \"Founder\"}]"
  }
]

mutePost

Mute a post (Mods or higher). Can be a topic or a comment.

Note: Any posts muted for spam should contain simply the string spam in the notes field. This standardized label will help train automated spam detection.

Roles:
Parameters:
Example Op:
[
  "custom_json",
  {
    "required_auths": [],
    "required_posting_auths": ["alice"],
    "id": "community",
    "json": "[\"mutePost\",{\"community\":\"hive-123456\",\"account\":\"eve\",\"permlink\":\"re-eve-comment-1564339652z\",\"notes\":\"Off Topic\"}]"
  }
]

unmutePost

Unmute a post (Mods or higher).

Roles:
Parameters:
Example Op:
[
  "custom_json",
  {
    "required_auths": [],
    "required_posting_auths": ["alice"],
    "id": "community",
    "json": "[\"unmutePost\",{\"community\":\"hive-123456\",\"account\":\"eve\",\"permlink\":\"re-eve-comment-1564339652z\",\"notes\":\"On Topic (on second thought)\"}]"
  }
]

updateProps

Roles:
Parameters:
Example Op:
[
  "custom_json",
  {
    "required_auths": [],
    "required_posting_auths": ["alice"],
    "id": "community",
    "json": "[\"updateProps\",{\"community\":\"hive-123456\",\"props\":{\"title\":\"Anti-Knitting\",\"about\":\"A community against knitting.\",\"is_nsfw\":false,\"description\":\"If you like to knitting, go away.\",\"flag_text\":\"Must hate knitting or else you will be muted.\"}}]"
  }
]

subscribe

Allows a user to signify they want this community shown on their personal trending feed and to be shown in their navigation menu.

Roles:
Parameters:
Example Op:
[
  "custom_json",
  {
    "required_auths": [],
    "required_posting_auths": ["alice"],
    "id": "community",
    "json": "[\"subscribe\",{\"community\":\"hive-123456\"}]"
  }
]

pinPost

Stickies a post to the top of the community homepage (Mods or higher). If multiple posts are stickied, the newest ones are shown first.

Roles:
Parameters:
Example Op:
[
  "custom_json",
  {
    "required_auths": [],
    "required_posting_auths": ["alice"],
    "id": "community",
    "json": "[\"pinPost\",{\"community\":\"hive-123456\",\"account\":\"alice\",\"permlink\":\"a-post-by-alice\"}]"
  }
]

unsubscribe

Allows a user to signify they no longer want this community shown on their personal trending feed or to be shown in their navigation menu.

Roles:
Parameters:
Example Op:
[
  "custom_json",
  {
    "required_auths": [],
    "required_posting_auths": ["alice"],
    "id": "community",
    "json": "[\"unsubscribe\",{\"community\":\"hive-123456\"}]"
  }
]

unpinPost

Removes a post to the top of the community homepage (Mods or higher).

Roles:
Parameters:
Example Op:
[
  "custom_json",
  {
    "required_auths": [],
    "required_posting_auths": ["alice"],
    "id": "community",
    "json": "[\"unpinPost\",{\"community\":\"hive-123456\",\"account\":\"alice\",\"permlink\":\"a-post-by-alice\"}]"
  }
]

flagPost

Used by guests to suggest a post for the review queue. It’s up to the community to define what constitutes flagging.

Roles:
Parameters:
Example Op:
[
  "custom_json",
  {
    "required_auths": [],
    "required_posting_auths": ["alice"],
    "id": "community",
    "json": "[\"flagPost\",{\"community\":\"hive-123456\",\"account\":\"eve\",\"permlink\":\"a-post-by-eve\",\"notes\":\"Warning\"}]"
  }
]