Hive Developers logo

Hive Developer Portal

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.

Wallet Bridge methods receive one variant argument containing their positional argument array. For methods with arguments, JSON-RPC params therefore has the form [[...]]; zero-argument methods use [].

See: Hive HardFork 26 Jump Starter Kit

wallet_bridge_api.broadcast_transaction

Broadcasts a signed transaction without waiting for block inclusion.

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

wallet_bridge_api.broadcast_transaction_synchronous

Broadcasts a signed transaction and waits for block inclusion or expiration.

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,
  "rc_cost": null,
  "expired": false
}

wallet_bridge_api.find_proposals

Finds proposals by proposal id.

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

wallet_bridge_api.find_rc_accounts

Finds resource-credit account data for the requested account names.

Query Parameters JSON 
[[[""]]]
Expected Response JSON 
[]

wallet_bridge_api.find_recurrent_transfers

Finds recurrent transfers sent by an account.

Query Parameters JSON 
[[""]]
Expected Response JSON 
[]

wallet_bridge_api.get_account

Returns an account by name, or null when it does not exist.

Query Parameters JSON 
[[""]]
Expected Response JSON 
null

wallet_bridge_api.get_account_history

Returns an account history range.

Query Parameters JSON 
[["", 0, 1000]]
Expected Response JSON 
[]

wallet_bridge_api.get_accounts

Returns the accounts matching a list of names.

Query Parameters JSON 
[[[""]]]
Expected Response JSON 
[]

wallet_bridge_api.get_active_witnesses

Returns active witnesses, optionally including the future schedule.

Query Parameters JSON 
[[true]]
Expected Response JSON 
{"witnesses": [], "future_witnesses": []}

wallet_bridge_api.get_block

Returns a block by block number.

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

wallet_bridge_api.get_chain_properties

Returns the median witness chain properties.

Query Parameters JSON 
[]
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

Returns collateralized conversion requests for an account.

Query Parameters JSON 
[[""]]
Expected Response JSON 
[]

wallet_bridge_api.get_conversion_requests

Returns HBD conversion requests for an account.

Query Parameters JSON 
[[""]]
Expected Response JSON 
[]

wallet_bridge_api.get_current_median_history_price

Returns the current median history price.

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

wallet_bridge_api.get_dynamic_global_properties

Returns current dynamic global blockchain properties.

Query Parameters JSON 
[]
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": "@@000000013"
  },
  "current_hbd_supply": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000013"
  },
  "total_vesting_fund_hive": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000021"
  },
  "total_vesting_shares": {
    "amount": "0",
    "precision": 6,
    "nai": "@@000000037"
  },
  "pending_rewarded_vesting_shares": {
    "amount": "0",
    "precision": 6,
    "nai": "@@000000037"
  },
  "pending_rewarded_vesting_hive": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000021"
  },
  "hbd_interest_rate": 0,
  "hbd_print_rate": 0,
  "maximum_block_size": 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": "@@000000013"
  },
  "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,
  "total_reward_fund_hive": {
    "amount": "0",
    "precision": 3,
    "nai": "@@000000021"
  },
  "total_reward_shares2": "0"
}

wallet_bridge_api.get_feed_history

Returns the history of witness price feeds.

Query Parameters JSON 
[]
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

Returns the current hardfork version.

Query Parameters JSON 
[]
Expected Response JSON 
"0.0.0"

wallet_bridge_api.get_open_orders

Returns open limit orders for an account.

Query Parameters JSON 
[[""]]
Expected Response JSON 
[]

wallet_bridge_api.get_ops_in_block

Returns operations in a block, optionally limited to virtual operations.

Query Parameters JSON 
[[1, false]]
Expected Response JSON 
{"ops": []}

wallet_bridge_api.get_order_book

Returns the HIVE/HBD order book up to the requested limit.

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

wallet_bridge_api.get_owner_history

Returns owner authority history for an account.

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

wallet_bridge_api.get_reward_fund

Returns a reward fund by name.

Query Parameters JSON 
[["post"]]
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

Returns a transaction by transaction id.

Query Parameters JSON 
[["0000000000000000000000000000000000000000"]]
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

Returns the node, blockchain, HAF, and FC versions and chain id.

Query Parameters JSON 
[]
Expected Response JSON 
{
  "blockchain_version": "",
  "hive_revision": "",
  "fc_revision": "",
  "chain_id": "0000000000000000000000000000000000000000000000000000000000000000",
  "node_type": "hived",
  "haf_revision": ""
}

wallet_bridge_api.get_withdraw_routes

Returns incoming, outgoing, or all vesting withdrawal routes for an account.

Query Parameters JSON 
[["", "all"]]
Expected Response JSON 
[]

wallet_bridge_api.get_witness

Returns a witness by account name, or null when it does not exist.

Query Parameters JSON 
[[""]]
Expected Response JSON 
null

wallet_bridge_api.get_witness_schedule

Returns the witness schedule. Passing true includes future_shuffled_witnesses and any available future_changes; optional future fields are omitted when unavailable.

Query Parameters JSON 
[[true]]
Expected Response JSON 
{
  "id": 0,
  "current_virtual_time": "0",
  "next_shuffle_block_num": 944743200,
  "current_shuffled_witnesses": [],
  "future_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

Returns whether a transaction id is known to the node.

Query Parameters JSON 
[["0000000000000000000000000000000000000000"]]
Expected Response JSON 
false

wallet_bridge_api.list_accounts

Lists account names from a lower bound, up to a limit of 1000.

Query Parameters JSON 
[["", 1000]]
Expected Response JSON 
[]

wallet_bridge_api.list_my_accounts

Returns accounts controlled by any of the supplied public keys.

Query Parameters JSON 
[[["STM1111111111111111111111111111111114T1Anm"]]]
Expected Response JSON 
[]

wallet_bridge_api.list_proposal_votes

Lists proposal votes using positional pagination and ordering arguments.

Query Parameters JSON 
[[[""], 100, 33, 0, 0]]
Expected Response JSON 
{"proposal_votes": []}

wallet_bridge_api.list_proposals

Lists proposals using positional pagination and ordering arguments.

Query Parameters JSON 
[[[""], 100, 29, 0, 0]]
Expected Response JSON 
{"proposals": []}

wallet_bridge_api.list_rc_accounts

Lists resource-credit accounts from an account-name lower bound.

Query Parameters JSON 
[["", 100]]
Expected Response JSON 
[]

wallet_bridge_api.list_rc_direct_delegations

Lists direct RC delegations from a [delegator, delegatee] lower bound.

Query Parameters JSON 
[[["", ""], 100]]
Expected Response JSON 
[]

wallet_bridge_api.list_witnesses

Lists witnesses by account-name lower bound.

Query Parameters JSON 
[["", 100]]
Expected Response JSON 
{"witnesses": []}
Back to top