This repository was archived by the owner on Apr 28, 2026. It is now read-only.

Repository files navigation

Hyperion HTTP API Javascript library

Installation

Using Yarn:

yarn add @proton/hyperion

or using NPM:

npm install --save @proton/hyperion

Quick Start

CommonJS

const{ JsonRpc }=require("@proton/hyperion")constfetch=require("isomorphic-fetch")constendpoint="https://eos.hyperion.eosrio.io"constrpc=newJsonRpc(endpoint,{ fetch })

TypeScript

import{JsonRpc}from"@proton/hyperion"importfetchfrom"isomorphic-fetch"constendpoint="https://eos.hyperion.eosrio.io"constrpc=newJsonRpc(endpoint,{ fetch })

ENV Variables

HYPERION_ENDPOINT=<Enter Hyperion Endpoint># "https://eos.hyperion.eosrio.io"

Supported Endpoints

# State
/v2/state/alive
/v2/state/get_key_accounts
/v2/state/get_tokens
/v2/state/get_voters
/v2/state/get_links
# History
/v2/history/get_abi_snapshot
/v2/history/get_actions
/v2/history/get_created_accounts
/v2/history/get_creator
/v2/history/get_deltas
/v2/history/get_transacted_accounts
/v2/history/get_transaction
/v2/history/get_transfers

API

Table of Contents

JsonRpc

JsonRpc

Parameters

  • endpointstring hyperion endpoint

Examples

constendpoint="https://br.eosrio.io"constrpc=newJsonRpc(endpoint,{ fetch })

alive

GET /v2/state/alive

simple server healthcheck

Examples
constresponse=awaitrpc.alive();console.log(response);// => {"status": "OK"}

Returns Promise<Alive> alive

get_abi_snapshot

GET /v2/history/get_abi_snapshot

fetch contract abi at specific block

Parameters
  • contractstring contract account
  • block
  • numbernumber target block
Examples
constresponse=awaitrpc.get_abi_snapshot("eosio",200);console.log(response.version);// => "eosio::abi/1.0"for(consttableofresponse.tables){console.log(table);// => { name: 'producers', index_type: 'i64', key_names: [ 'owner' ], key_types: [ 'uint64' ], type: 'producer_info' }}

Returns Promise<GetAbiSnapshot> abi snapshot

get_voters

GET /v2/state/get_voters

get voters

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.producerstring? filter by voted producer (comma separated)
    • options.proxyboolean? true or false
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
Examples
constresponse=awaitrpc.get_voters({producer: "eoscafeblock",limit: 100});console.log(response.voters);// => "[{// "account": "guzdkmrtgage",// "weight": 78434695236505280,// "last_vote": 64804768// }]"

Returns Promise<GetVoters> voters

get_links

GET /v2/state/get_links

get voters

Parameters
  • accountstring? account to get links for
Examples
constresponse=awaitrpc.get_links("eoscafeblock");console.log(response.links);// => "[{"block_num":26088072,"timestamp":"2019-11-22T23:17:42.000","account":"eosriobrazil","permission":"claim2","code":"eosio","action":"voteproducer"}]"

Returns Promise<GetLinks> links

get_proposals

GET /v2/state/get_proposals

get proposals

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.proposerstring? filter by proposer
    • options.proposalstring? filter by proposal name
    • options.accountstring? filter by either requested or provided account
    • options.requestedstring? filter by requested account
    • options.providedstring? filter by provided account
    • options.trackstring? total results to track (count) [number or true]
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
  • accountstring? account to get proposals for

Returns Promise<GetProposals> proposals

get_actions

GET /v2/history/get_actions

get actions based on notified account

Parameters
  • accountstring notified account
  • optionsobject Optional parameters (optional, default {})
    • options.filterstring? code::name filter
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
    • options.sortstring? sort direction
    • options.afterstring? filter after specified date (ISO8601)
    • options.beforestring? filter before specified date (ISO8601)
    • options.transfer_tostring? transfer filter to
    • options.transfer_fromstring? transfer filter from
    • options.transfer_symbolstring? transfer filter symbol
    • options.act_namestring? act name
    • options.act_accountstring? act account
Examples
constresponse=awaitrpc.get_actions("eoscafeblock",{filter: "eosio.token:*",skip: 100,limit: 100,});for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio.token', name: 'transfer', ... }}}

Returns Promise<GetActions> get actions

get_created_accounts

GET /v2/history/get_created_accounts

get created accounts

Parameters
Examples
constresponse=awaitrpc.get_created_accounts("eosnationftw");console.log(response);// => {"accounts": [{"name":"eosnationdsp","trx_id":"728d4a4da36a98d9048080461dacaf975ad083e8158ef84edea60cc755ab2c1a","timestamp":"2019-02-28T22:36:45.000"}, ... ]}

Returns Promise<GetCreatedAccounts> get creator

get_creator

GET /v2/history/get_creator

get creator

Parameters
Examples
constresponse=awaitrpc.get_creator("eosnationftw");console.log(response);// => { account: 'eosnationftw', creator: 'gyztcmrvgqge', timestamp: '2018-06-10T13:06:43.500', ... }

Returns Promise<GetCreator> get creator

get_deltas

GET /v2/history/get_deltas

get deltas

Parameters
Examples
constresponse=awaitrpc.get_deltas("eosio.token","eosnationftw","accounts","eosnationftw");console.log(response);// => { "query_time": 19, "total": { "value": 486, "relation": "eq" }, "deltas": [ ... ] }

Returns Promise<GetDeltas> get deltas

get_table_state

[GET /v2/history/get_table_state](https://eos.hyperion.eosrio.io/v2/docs/static/index.html#/history/get_v2_history_get_table_state

get table state

Parameters
Examples
constresponse=awaitrpc.get_table_state("eosio.token","stat","1000","");console.log(response);// => { "query_time": 19, "code": "eosio.token", "table": "stat", "block_num": 1000, "next_key": "........ehbo5-5459781",, "results": [ ... ] }

Returns Promise<GetTableState> get table state

get_key_accounts

GET/v2/state/get_key_accounts

get account by public key

Parameters
  • public_keystring Contract account targeted by the action.
Examples
constresponse=awaitrpc.get_key_accounts("EOS5Mto3Km6BCVxowb6LkkFaT9oaUwLVgswgcxvY4Qgc4rhHry4Tv");console.log(response.account_names);// => [ 'eoscafeblock' ]

Returns Promise<GetKeyAccounts> key accounts

get_tokens

GET /v2/state/get_tokens

get tokens

Parameters
Examples
constresponse=awaitrpc.get_tokens("eosnationftw");for(consttokenofresponse.tokens){console.log(token);// => { symbol: 'ZOS', precision: 4, amount: 140, contract: 'zosdiscounts' }}

Returns Promise<GetTokens> get tokens

get_transaction

GET /v2/history/get_transaction

get all actions belonging to the same transaction

Parameters
Examples
constresponse=awaitrpc.get_transaction("42dacd5722001b734be46a2140917e06cd21d42425f927f506c07b4388b07f62");for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio', name: 'buyrambytes', ... }}}

Returns Promise<GetTransaction> transaction

JsonRpc

alive

GET /v2/state/alive

simple server healthcheck

Examples
constresponse=awaitrpc.alive();console.log(response);// => {"status": "OK"}

Returns Promise<Alive> alive

get_abi_snapshot

GET /v2/history/get_abi_snapshot

fetch contract abi at specific block

Parameters
  • contractstring contract account
  • block
  • numbernumber target block
Examples
constresponse=awaitrpc.get_abi_snapshot("eosio",200);console.log(response.version);// => "eosio::abi/1.0"for(consttableofresponse.tables){console.log(table);// => { name: 'producers', index_type: 'i64', key_names: [ 'owner' ], key_types: [ 'uint64' ], type: 'producer_info' }}

Returns Promise<GetAbiSnapshot> abi snapshot

get_voters

GET /v2/state/get_voters

get voters

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.producerstring? filter by voted producer (comma separated)
    • options.proxyboolean? true or false
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
Examples
constresponse=awaitrpc.get_voters({producer: "eoscafeblock",limit: 100});console.log(response.voters);// => "[{// "account": "guzdkmrtgage",// "weight": 78434695236505280,// "last_vote": 64804768// }]"

Returns Promise<GetVoters> voters

get_links

GET /v2/state/get_links

get voters

Parameters
  • accountstring? account to get links for
Examples
constresponse=awaitrpc.get_links("eoscafeblock");console.log(response.links);// => "[{"block_num":26088072,"timestamp":"2019-11-22T23:17:42.000","account":"eosriobrazil","permission":"claim2","code":"eosio","action":"voteproducer"}]"

Returns Promise<GetLinks> links

get_proposals

GET /v2/state/get_proposals

get proposals

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.proposerstring? filter by proposer
    • options.proposalstring? filter by proposal name
    • options.accountstring? filter by either requested or provided account
    • options.requestedstring? filter by requested account
    • options.providedstring? filter by provided account
    • options.trackstring? total results to track (count) [number or true]
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
  • accountstring? account to get proposals for

Returns Promise<GetProposals> proposals

get_actions

GET /v2/history/get_actions

get actions based on notified account

Parameters
  • accountstring notified account
  • optionsobject Optional parameters (optional, default {})
    • options.filterstring? code::name filter
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
    • options.sortstring? sort direction
    • options.afterstring? filter after specified date (ISO8601)
    • options.beforestring? filter before specified date (ISO8601)
    • options.transfer_tostring? transfer filter to
    • options.transfer_fromstring? transfer filter from
    • options.transfer_symbolstring? transfer filter symbol
    • options.act_namestring? act name
    • options.act_accountstring? act account
Examples
constresponse=awaitrpc.get_actions("eoscafeblock",{filter: "eosio.token:*",skip: 100,limit: 100,});for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio.token', name: 'transfer', ... }}}

Returns Promise<GetActions> get actions

get_created_accounts

GET /v2/history/get_created_accounts

get created accounts

Parameters
Examples
constresponse=awaitrpc.get_created_accounts("eosnationftw");console.log(response);// => {"accounts": [{"name":"eosnationdsp","trx_id":"728d4a4da36a98d9048080461dacaf975ad083e8158ef84edea60cc755ab2c1a","timestamp":"2019-02-28T22:36:45.000"}, ... ]}

Returns Promise<GetCreatedAccounts> get creator

get_creator

GET /v2/history/get_creator

get creator

Parameters
Examples
constresponse=awaitrpc.get_creator("eosnationftw");console.log(response);// => { account: 'eosnationftw', creator: 'gyztcmrvgqge', timestamp: '2018-06-10T13:06:43.500', ... }

Returns Promise<GetCreator> get creator

get_deltas

GET /v2/history/get_deltas

get deltas

Parameters
Examples
constresponse=awaitrpc.get_deltas("eosio.token","eosnationftw","accounts","eosnationftw");console.log(response);// => { "query_time": 19, "total": { "value": 486, "relation": "eq" }, "deltas": [ ... ] }

Returns Promise<GetDeltas> get deltas

get_table_state

[GET /v2/history/get_table_state](https://eos.hyperion.eosrio.io/v2/docs/static/index.html#/history/get_v2_history_get_table_state

get table state

Parameters
Examples
constresponse=awaitrpc.get_table_state("eosio.token","stat","1000","");console.log(response);// => { "query_time": 19, "code": "eosio.token", "table": "stat", "block_num": 1000, "next_key": "........ehbo5-5459781",, "results": [ ... ] }

Returns Promise<GetTableState> get table state

get_key_accounts

GET/v2/state/get_key_accounts

get account by public key

Parameters
  • public_keystring Contract account targeted by the action.
Examples
constresponse=awaitrpc.get_key_accounts("EOS5Mto3Km6BCVxowb6LkkFaT9oaUwLVgswgcxvY4Qgc4rhHry4Tv");console.log(response.account_names);// => [ 'eoscafeblock' ]

Returns Promise<GetKeyAccounts> key accounts

get_tokens

GET /v2/state/get_tokens

get tokens

Parameters
Examples
constresponse=awaitrpc.get_tokens("eosnationftw");for(consttokenofresponse.tokens){console.log(token);// => { symbol: 'ZOS', precision: 4, amount: 140, contract: 'zosdiscounts' }}

Returns Promise<GetTokens> get tokens

get_transaction

GET /v2/history/get_transaction

get all actions belonging to the same transaction

Parameters
Examples
constresponse=awaitrpc.get_transaction("42dacd5722001b734be46a2140917e06cd21d42425f927f506c07b4388b07f62");for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio', name: 'buyrambytes', ... }}}

Returns Promise<GetTransaction> transaction

RpcError

RpcStatusError

About

Hyperion History HTTP API

Resources

Stars

30 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
This repository was archived by the owner on Apr 28, 2026. It is now read-only.

Repository files navigation

Hyperion HTTP API Javascript library

Installation

Using Yarn:

yarn add @proton/hyperion

or using NPM:

npm install --save @proton/hyperion

Quick Start

CommonJS

const{ JsonRpc }=require("@proton/hyperion")constfetch=require("isomorphic-fetch")constendpoint="https://eos.hyperion.eosrio.io"constrpc=newJsonRpc(endpoint,{ fetch })

TypeScript

import{JsonRpc}from"@proton/hyperion"importfetchfrom"isomorphic-fetch"constendpoint="https://eos.hyperion.eosrio.io"constrpc=newJsonRpc(endpoint,{ fetch })

ENV Variables

HYPERION_ENDPOINT=<Enter Hyperion Endpoint># "https://eos.hyperion.eosrio.io"

Supported Endpoints

# State
/v2/state/alive
/v2/state/get_key_accounts
/v2/state/get_tokens
/v2/state/get_voters
/v2/state/get_links
# History
/v2/history/get_abi_snapshot
/v2/history/get_actions
/v2/history/get_created_accounts
/v2/history/get_creator
/v2/history/get_deltas
/v2/history/get_transacted_accounts
/v2/history/get_transaction
/v2/history/get_transfers

API

Table of Contents

JsonRpc

JsonRpc

Parameters

  • endpointstring hyperion endpoint

Examples

constendpoint="https://br.eosrio.io"constrpc=newJsonRpc(endpoint,{ fetch })

alive

GET /v2/state/alive

simple server healthcheck

Examples
constresponse=awaitrpc.alive();console.log(response);// => {"status": "OK"}

Returns Promise<Alive> alive

get_abi_snapshot

GET /v2/history/get_abi_snapshot

fetch contract abi at specific block

Parameters
  • contractstring contract account
  • block
  • numbernumber target block
Examples
constresponse=awaitrpc.get_abi_snapshot("eosio",200);console.log(response.version);// => "eosio::abi/1.0"for(consttableofresponse.tables){console.log(table);// => { name: 'producers', index_type: 'i64', key_names: [ 'owner' ], key_types: [ 'uint64' ], type: 'producer_info' }}

Returns Promise<GetAbiSnapshot> abi snapshot

get_voters

GET /v2/state/get_voters

get voters

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.producerstring? filter by voted producer (comma separated)
    • options.proxyboolean? true or false
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
Examples
constresponse=awaitrpc.get_voters({producer: "eoscafeblock",limit: 100});console.log(response.voters);// => "[{// "account": "guzdkmrtgage",// "weight": 78434695236505280,// "last_vote": 64804768// }]"

Returns Promise<GetVoters> voters

get_links

GET /v2/state/get_links

get voters

Parameters
  • accountstring? account to get links for
Examples
constresponse=awaitrpc.get_links("eoscafeblock");console.log(response.links);// => "[{"block_num":26088072,"timestamp":"2019-11-22T23:17:42.000","account":"eosriobrazil","permission":"claim2","code":"eosio","action":"voteproducer"}]"

Returns Promise<GetLinks> links

get_proposals

GET /v2/state/get_proposals

get proposals

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.proposerstring? filter by proposer
    • options.proposalstring? filter by proposal name
    • options.accountstring? filter by either requested or provided account
    • options.requestedstring? filter by requested account
    • options.providedstring? filter by provided account
    • options.trackstring? total results to track (count) [number or true]
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
  • accountstring? account to get proposals for

Returns Promise<GetProposals> proposals

get_actions

GET /v2/history/get_actions

get actions based on notified account

Parameters
  • accountstring notified account
  • optionsobject Optional parameters (optional, default {})
    • options.filterstring? code::name filter
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
    • options.sortstring? sort direction
    • options.afterstring? filter after specified date (ISO8601)
    • options.beforestring? filter before specified date (ISO8601)
    • options.transfer_tostring? transfer filter to
    • options.transfer_fromstring? transfer filter from
    • options.transfer_symbolstring? transfer filter symbol
    • options.act_namestring? act name
    • options.act_accountstring? act account
Examples
constresponse=awaitrpc.get_actions("eoscafeblock",{filter: "eosio.token:*",skip: 100,limit: 100,});for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio.token', name: 'transfer', ... }}}

Returns Promise<GetActions> get actions

get_created_accounts

GET /v2/history/get_created_accounts

get created accounts

Parameters
Examples
constresponse=awaitrpc.get_created_accounts("eosnationftw");console.log(response);// => {"accounts": [{"name":"eosnationdsp","trx_id":"728d4a4da36a98d9048080461dacaf975ad083e8158ef84edea60cc755ab2c1a","timestamp":"2019-02-28T22:36:45.000"}, ... ]}

Returns Promise<GetCreatedAccounts> get creator

get_creator

GET /v2/history/get_creator

get creator

Parameters
Examples
constresponse=awaitrpc.get_creator("eosnationftw");console.log(response);// => { account: 'eosnationftw', creator: 'gyztcmrvgqge', timestamp: '2018-06-10T13:06:43.500', ... }

Returns Promise<GetCreator> get creator

get_deltas

GET /v2/history/get_deltas

get deltas

Parameters
Examples
constresponse=awaitrpc.get_deltas("eosio.token","eosnationftw","accounts","eosnationftw");console.log(response);// => { "query_time": 19, "total": { "value": 486, "relation": "eq" }, "deltas": [ ... ] }

Returns Promise<GetDeltas> get deltas

get_table_state

[GET /v2/history/get_table_state](https://eos.hyperion.eosrio.io/v2/docs/static/index.html#/history/get_v2_history_get_table_state

get table state

Parameters
Examples
constresponse=awaitrpc.get_table_state("eosio.token","stat","1000","");console.log(response);// => { "query_time": 19, "code": "eosio.token", "table": "stat", "block_num": 1000, "next_key": "........ehbo5-5459781",, "results": [ ... ] }

Returns Promise<GetTableState> get table state

get_key_accounts

GET/v2/state/get_key_accounts

get account by public key

Parameters
  • public_keystring Contract account targeted by the action.
Examples
constresponse=awaitrpc.get_key_accounts("EOS5Mto3Km6BCVxowb6LkkFaT9oaUwLVgswgcxvY4Qgc4rhHry4Tv");console.log(response.account_names);// => [ 'eoscafeblock' ]

Returns Promise<GetKeyAccounts> key accounts

get_tokens

GET /v2/state/get_tokens

get tokens

Parameters
Examples
constresponse=awaitrpc.get_tokens("eosnationftw");for(consttokenofresponse.tokens){console.log(token);// => { symbol: 'ZOS', precision: 4, amount: 140, contract: 'zosdiscounts' }}

Returns Promise<GetTokens> get tokens

get_transaction

GET /v2/history/get_transaction

get all actions belonging to the same transaction

Parameters
Examples
constresponse=awaitrpc.get_transaction("42dacd5722001b734be46a2140917e06cd21d42425f927f506c07b4388b07f62");for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio', name: 'buyrambytes', ... }}}

Returns Promise<GetTransaction> transaction

JsonRpc

alive

GET /v2/state/alive

simple server healthcheck

Examples
constresponse=awaitrpc.alive();console.log(response);// => {"status": "OK"}

Returns Promise<Alive> alive

get_abi_snapshot

GET /v2/history/get_abi_snapshot

fetch contract abi at specific block

Parameters
  • contractstring contract account
  • block
  • numbernumber target block
Examples
constresponse=awaitrpc.get_abi_snapshot("eosio",200);console.log(response.version);// => "eosio::abi/1.0"for(consttableofresponse.tables){console.log(table);// => { name: 'producers', index_type: 'i64', key_names: [ 'owner' ], key_types: [ 'uint64' ], type: 'producer_info' }}

Returns Promise<GetAbiSnapshot> abi snapshot

get_voters

GET /v2/state/get_voters

get voters

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.producerstring? filter by voted producer (comma separated)
    • options.proxyboolean? true or false
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
Examples
constresponse=awaitrpc.get_voters({producer: "eoscafeblock",limit: 100});console.log(response.voters);// => "[{// "account": "guzdkmrtgage",// "weight": 78434695236505280,// "last_vote": 64804768// }]"

Returns Promise<GetVoters> voters

get_links

GET /v2/state/get_links

get voters

Parameters
  • accountstring? account to get links for
Examples
constresponse=awaitrpc.get_links("eoscafeblock");console.log(response.links);// => "[{"block_num":26088072,"timestamp":"2019-11-22T23:17:42.000","account":"eosriobrazil","permission":"claim2","code":"eosio","action":"voteproducer"}]"

Returns Promise<GetLinks> links

get_proposals

GET /v2/state/get_proposals

get proposals

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.proposerstring? filter by proposer
    • options.proposalstring? filter by proposal name
    • options.accountstring? filter by either requested or provided account
    • options.requestedstring? filter by requested account
    • options.providedstring? filter by provided account
    • options.trackstring? total results to track (count) [number or true]
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
  • accountstring? account to get proposals for

Returns Promise<GetProposals> proposals

get_actions

GET /v2/history/get_actions

get actions based on notified account

Parameters
  • accountstring notified account
  • optionsobject Optional parameters (optional, default {})
    • options.filterstring? code::name filter
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
    • options.sortstring? sort direction
    • options.afterstring? filter after specified date (ISO8601)
    • options.beforestring? filter before specified date (ISO8601)
    • options.transfer_tostring? transfer filter to
    • options.transfer_fromstring? transfer filter from
    • options.transfer_symbolstring? transfer filter symbol
    • options.act_namestring? act name
    • options.act_accountstring? act account
Examples
constresponse=awaitrpc.get_actions("eoscafeblock",{filter: "eosio.token:*",skip: 100,limit: 100,});for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio.token', name: 'transfer', ... }}}

Returns Promise<GetActions> get actions

get_created_accounts

GET /v2/history/get_created_accounts

get created accounts

Parameters
Examples
constresponse=awaitrpc.get_created_accounts("eosnationftw");console.log(response);// => {"accounts": [{"name":"eosnationdsp","trx_id":"728d4a4da36a98d9048080461dacaf975ad083e8158ef84edea60cc755ab2c1a","timestamp":"2019-02-28T22:36:45.000"}, ... ]}

Returns Promise<GetCreatedAccounts> get creator

get_creator

GET /v2/history/get_creator

get creator

Parameters
Examples
constresponse=awaitrpc.get_creator("eosnationftw");console.log(response);// => { account: 'eosnationftw', creator: 'gyztcmrvgqge', timestamp: '2018-06-10T13:06:43.500', ... }

Returns Promise<GetCreator> get creator

get_deltas

GET /v2/history/get_deltas

get deltas

Parameters
Examples
constresponse=awaitrpc.get_deltas("eosio.token","eosnationftw","accounts","eosnationftw");console.log(response);// => { "query_time": 19, "total": { "value": 486, "relation": "eq" }, "deltas": [ ... ] }

Returns Promise<GetDeltas> get deltas

get_table_state

[GET /v2/history/get_table_state](https://eos.hyperion.eosrio.io/v2/docs/static/index.html#/history/get_v2_history_get_table_state

get table state

Parameters
Examples
constresponse=awaitrpc.get_table_state("eosio.token","stat","1000","");console.log(response);// => { "query_time": 19, "code": "eosio.token", "table": "stat", "block_num": 1000, "next_key": "........ehbo5-5459781",, "results": [ ... ] }

Returns Promise<GetTableState> get table state

get_key_accounts

GET/v2/state/get_key_accounts

get account by public key

Parameters
  • public_keystring Contract account targeted by the action.
Examples
constresponse=awaitrpc.get_key_accounts("EOS5Mto3Km6BCVxowb6LkkFaT9oaUwLVgswgcxvY4Qgc4rhHry4Tv");console.log(response.account_names);// => [ 'eoscafeblock' ]

Returns Promise<GetKeyAccounts> key accounts

get_tokens

GET /v2/state/get_tokens

get tokens

Parameters
Examples
constresponse=awaitrpc.get_tokens("eosnationftw");for(consttokenofresponse.tokens){console.log(token);// => { symbol: 'ZOS', precision: 4, amount: 140, contract: 'zosdiscounts' }}

Returns Promise<GetTokens> get tokens

get_transaction

GET /v2/history/get_transaction

get all actions belonging to the same transaction

Parameters
Examples
constresponse=awaitrpc.get_transaction("42dacd5722001b734be46a2140917e06cd21d42425f927f506c07b4388b07f62");for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio', name: 'buyrambytes', ... }}}

Returns Promise<GetTransaction> transaction

RpcError

RpcStatusError

About

Hyperion History HTTP API

Resources

Stars

30 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
This repository was archived by the owner on Apr 28, 2026. It is now read-only.

Repository files navigation

Hyperion HTTP API Javascript library

Installation

Using Yarn:

yarn add @proton/hyperion

or using NPM:

npm install --save @proton/hyperion

Quick Start

CommonJS

const{ JsonRpc }=require("@proton/hyperion")constfetch=require("isomorphic-fetch")constendpoint="https://eos.hyperion.eosrio.io"constrpc=newJsonRpc(endpoint,{ fetch })

TypeScript

import{JsonRpc}from"@proton/hyperion"importfetchfrom"isomorphic-fetch"constendpoint="https://eos.hyperion.eosrio.io"constrpc=newJsonRpc(endpoint,{ fetch })

ENV Variables

HYPERION_ENDPOINT=<Enter Hyperion Endpoint># "https://eos.hyperion.eosrio.io"

Supported Endpoints

# State
/v2/state/alive
/v2/state/get_key_accounts
/v2/state/get_tokens
/v2/state/get_voters
/v2/state/get_links
# History
/v2/history/get_abi_snapshot
/v2/history/get_actions
/v2/history/get_created_accounts
/v2/history/get_creator
/v2/history/get_deltas
/v2/history/get_transacted_accounts
/v2/history/get_transaction
/v2/history/get_transfers

API

Table of Contents

JsonRpc

JsonRpc

Parameters

  • endpointstring hyperion endpoint

Examples

constendpoint="https://br.eosrio.io"constrpc=newJsonRpc(endpoint,{ fetch })

alive

GET /v2/state/alive

simple server healthcheck

Examples
constresponse=awaitrpc.alive();console.log(response);// => {"status": "OK"}

Returns Promise<Alive> alive

get_abi_snapshot

GET /v2/history/get_abi_snapshot

fetch contract abi at specific block

Parameters
  • contractstring contract account
  • block
  • numbernumber target block
Examples
constresponse=awaitrpc.get_abi_snapshot("eosio",200);console.log(response.version);// => "eosio::abi/1.0"for(consttableofresponse.tables){console.log(table);// => { name: 'producers', index_type: 'i64', key_names: [ 'owner' ], key_types: [ 'uint64' ], type: 'producer_info' }}

Returns Promise<GetAbiSnapshot> abi snapshot

get_voters

GET /v2/state/get_voters

get voters

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.producerstring? filter by voted producer (comma separated)
    • options.proxyboolean? true or false
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
Examples
constresponse=awaitrpc.get_voters({producer: "eoscafeblock",limit: 100});console.log(response.voters);// => "[{// "account": "guzdkmrtgage",// "weight": 78434695236505280,// "last_vote": 64804768// }]"

Returns Promise<GetVoters> voters

get_links

GET /v2/state/get_links

get voters

Parameters
  • accountstring? account to get links for
Examples
constresponse=awaitrpc.get_links("eoscafeblock");console.log(response.links);// => "[{"block_num":26088072,"timestamp":"2019-11-22T23:17:42.000","account":"eosriobrazil","permission":"claim2","code":"eosio","action":"voteproducer"}]"

Returns Promise<GetLinks> links

get_proposals

GET /v2/state/get_proposals

get proposals

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.proposerstring? filter by proposer
    • options.proposalstring? filter by proposal name
    • options.accountstring? filter by either requested or provided account
    • options.requestedstring? filter by requested account
    • options.providedstring? filter by provided account
    • options.trackstring? total results to track (count) [number or true]
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
  • accountstring? account to get proposals for

Returns Promise<GetProposals> proposals

get_actions

GET /v2/history/get_actions

get actions based on notified account

Parameters
  • accountstring notified account
  • optionsobject Optional parameters (optional, default {})
    • options.filterstring? code::name filter
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
    • options.sortstring? sort direction
    • options.afterstring? filter after specified date (ISO8601)
    • options.beforestring? filter before specified date (ISO8601)
    • options.transfer_tostring? transfer filter to
    • options.transfer_fromstring? transfer filter from
    • options.transfer_symbolstring? transfer filter symbol
    • options.act_namestring? act name
    • options.act_accountstring? act account
Examples
constresponse=awaitrpc.get_actions("eoscafeblock",{filter: "eosio.token:*",skip: 100,limit: 100,});for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio.token', name: 'transfer', ... }}}

Returns Promise<GetActions> get actions

get_created_accounts

GET /v2/history/get_created_accounts

get created accounts

Parameters
Examples
constresponse=awaitrpc.get_created_accounts("eosnationftw");console.log(response);// => {"accounts": [{"name":"eosnationdsp","trx_id":"728d4a4da36a98d9048080461dacaf975ad083e8158ef84edea60cc755ab2c1a","timestamp":"2019-02-28T22:36:45.000"}, ... ]}

Returns Promise<GetCreatedAccounts> get creator

get_creator

GET /v2/history/get_creator

get creator

Parameters
Examples
constresponse=awaitrpc.get_creator("eosnationftw");console.log(response);// => { account: 'eosnationftw', creator: 'gyztcmrvgqge', timestamp: '2018-06-10T13:06:43.500', ... }

Returns Promise<GetCreator> get creator

get_deltas

GET /v2/history/get_deltas

get deltas

Parameters
Examples
constresponse=awaitrpc.get_deltas("eosio.token","eosnationftw","accounts","eosnationftw");console.log(response);// => { "query_time": 19, "total": { "value": 486, "relation": "eq" }, "deltas": [ ... ] }

Returns Promise<GetDeltas> get deltas

get_table_state

[GET /v2/history/get_table_state](https://eos.hyperion.eosrio.io/v2/docs/static/index.html#/history/get_v2_history_get_table_state

get table state

Parameters
Examples
constresponse=awaitrpc.get_table_state("eosio.token","stat","1000","");console.log(response);// => { "query_time": 19, "code": "eosio.token", "table": "stat", "block_num": 1000, "next_key": "........ehbo5-5459781",, "results": [ ... ] }

Returns Promise<GetTableState> get table state

get_key_accounts

GET/v2/state/get_key_accounts

get account by public key

Parameters
  • public_keystring Contract account targeted by the action.
Examples
constresponse=awaitrpc.get_key_accounts("EOS5Mto3Km6BCVxowb6LkkFaT9oaUwLVgswgcxvY4Qgc4rhHry4Tv");console.log(response.account_names);// => [ 'eoscafeblock' ]

Returns Promise<GetKeyAccounts> key accounts

get_tokens

GET /v2/state/get_tokens

get tokens

Parameters
Examples
constresponse=awaitrpc.get_tokens("eosnationftw");for(consttokenofresponse.tokens){console.log(token);// => { symbol: 'ZOS', precision: 4, amount: 140, contract: 'zosdiscounts' }}

Returns Promise<GetTokens> get tokens

get_transaction

GET /v2/history/get_transaction

get all actions belonging to the same transaction

Parameters
Examples
constresponse=awaitrpc.get_transaction("42dacd5722001b734be46a2140917e06cd21d42425f927f506c07b4388b07f62");for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio', name: 'buyrambytes', ... }}}

Returns Promise<GetTransaction> transaction

JsonRpc

alive

GET /v2/state/alive

simple server healthcheck

Examples
constresponse=awaitrpc.alive();console.log(response);// => {"status": "OK"}

Returns Promise<Alive> alive

get_abi_snapshot

GET /v2/history/get_abi_snapshot

fetch contract abi at specific block

Parameters
  • contractstring contract account
  • block
  • numbernumber target block
Examples
constresponse=awaitrpc.get_abi_snapshot("eosio",200);console.log(response.version);// => "eosio::abi/1.0"for(consttableofresponse.tables){console.log(table);// => { name: 'producers', index_type: 'i64', key_names: [ 'owner' ], key_types: [ 'uint64' ], type: 'producer_info' }}

Returns Promise<GetAbiSnapshot> abi snapshot

get_voters

GET /v2/state/get_voters

get voters

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.producerstring? filter by voted producer (comma separated)
    • options.proxyboolean? true or false
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
Examples
constresponse=awaitrpc.get_voters({producer: "eoscafeblock",limit: 100});console.log(response.voters);// => "[{// "account": "guzdkmrtgage",// "weight": 78434695236505280,// "last_vote": 64804768// }]"

Returns Promise<GetVoters> voters

get_links

GET /v2/state/get_links

get voters

Parameters
  • accountstring? account to get links for
Examples
constresponse=awaitrpc.get_links("eoscafeblock");console.log(response.links);// => "[{"block_num":26088072,"timestamp":"2019-11-22T23:17:42.000","account":"eosriobrazil","permission":"claim2","code":"eosio","action":"voteproducer"}]"

Returns Promise<GetLinks> links

get_proposals

GET /v2/state/get_proposals

get proposals

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.proposerstring? filter by proposer
    • options.proposalstring? filter by proposal name
    • options.accountstring? filter by either requested or provided account
    • options.requestedstring? filter by requested account
    • options.providedstring? filter by provided account
    • options.trackstring? total results to track (count) [number or true]
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
  • accountstring? account to get proposals for

Returns Promise<GetProposals> proposals

get_actions

GET /v2/history/get_actions

get actions based on notified account

Parameters
  • accountstring notified account
  • optionsobject Optional parameters (optional, default {})
    • options.filterstring? code::name filter
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
    • options.sortstring? sort direction
    • options.afterstring? filter after specified date (ISO8601)
    • options.beforestring? filter before specified date (ISO8601)
    • options.transfer_tostring? transfer filter to
    • options.transfer_fromstring? transfer filter from
    • options.transfer_symbolstring? transfer filter symbol
    • options.act_namestring? act name
    • options.act_accountstring? act account
Examples
constresponse=awaitrpc.get_actions("eoscafeblock",{filter: "eosio.token:*",skip: 100,limit: 100,});for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio.token', name: 'transfer', ... }}}

Returns Promise<GetActions> get actions

get_created_accounts

GET /v2/history/get_created_accounts

get created accounts

Parameters
Examples
constresponse=awaitrpc.get_created_accounts("eosnationftw");console.log(response);// => {"accounts": [{"name":"eosnationdsp","trx_id":"728d4a4da36a98d9048080461dacaf975ad083e8158ef84edea60cc755ab2c1a","timestamp":"2019-02-28T22:36:45.000"}, ... ]}

Returns Promise<GetCreatedAccounts> get creator

get_creator

GET /v2/history/get_creator

get creator

Parameters
Examples
constresponse=awaitrpc.get_creator("eosnationftw");console.log(response);// => { account: 'eosnationftw', creator: 'gyztcmrvgqge', timestamp: '2018-06-10T13:06:43.500', ... }

Returns Promise<GetCreator> get creator

get_deltas

GET /v2/history/get_deltas

get deltas

Parameters
Examples
constresponse=awaitrpc.get_deltas("eosio.token","eosnationftw","accounts","eosnationftw");console.log(response);// => { "query_time": 19, "total": { "value": 486, "relation": "eq" }, "deltas": [ ... ] }

Returns Promise<GetDeltas> get deltas

get_table_state

[GET /v2/history/get_table_state](https://eos.hyperion.eosrio.io/v2/docs/static/index.html#/history/get_v2_history_get_table_state

get table state

Parameters
Examples
constresponse=awaitrpc.get_table_state("eosio.token","stat","1000","");console.log(response);// => { "query_time": 19, "code": "eosio.token", "table": "stat", "block_num": 1000, "next_key": "........ehbo5-5459781",, "results": [ ... ] }

Returns Promise<GetTableState> get table state

get_key_accounts

GET/v2/state/get_key_accounts

get account by public key

Parameters
  • public_keystring Contract account targeted by the action.
Examples
constresponse=awaitrpc.get_key_accounts("EOS5Mto3Km6BCVxowb6LkkFaT9oaUwLVgswgcxvY4Qgc4rhHry4Tv");console.log(response.account_names);// => [ 'eoscafeblock' ]

Returns Promise<GetKeyAccounts> key accounts

get_tokens

GET /v2/state/get_tokens

get tokens

Parameters
Examples
constresponse=awaitrpc.get_tokens("eosnationftw");for(consttokenofresponse.tokens){console.log(token);// => { symbol: 'ZOS', precision: 4, amount: 140, contract: 'zosdiscounts' }}

Returns Promise<GetTokens> get tokens

get_transaction

GET /v2/history/get_transaction

get all actions belonging to the same transaction

Parameters
Examples
constresponse=awaitrpc.get_transaction("42dacd5722001b734be46a2140917e06cd21d42425f927f506c07b4388b07f62");for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio', name: 'buyrambytes', ... }}}

Returns Promise<GetTransaction> transaction

RpcError

RpcStatusError

About

Hyperion History HTTP API

Resources

Stars

30 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
This repository was archived by the owner on Apr 28, 2026. It is now read-only.

Repository files navigation

Hyperion HTTP API Javascript library

Installation

Using Yarn:

yarn add @proton/hyperion

or using NPM:

npm install --save @proton/hyperion

Quick Start

CommonJS

const{ JsonRpc }=require("@proton/hyperion")constfetch=require("isomorphic-fetch")constendpoint="https://eos.hyperion.eosrio.io"constrpc=newJsonRpc(endpoint,{ fetch })

TypeScript

import{JsonRpc}from"@proton/hyperion"importfetchfrom"isomorphic-fetch"constendpoint="https://eos.hyperion.eosrio.io"constrpc=newJsonRpc(endpoint,{ fetch })

ENV Variables

HYPERION_ENDPOINT=<Enter Hyperion Endpoint># "https://eos.hyperion.eosrio.io"

Supported Endpoints

# State
/v2/state/alive
/v2/state/get_key_accounts
/v2/state/get_tokens
/v2/state/get_voters
/v2/state/get_links
# History
/v2/history/get_abi_snapshot
/v2/history/get_actions
/v2/history/get_created_accounts
/v2/history/get_creator
/v2/history/get_deltas
/v2/history/get_transacted_accounts
/v2/history/get_transaction
/v2/history/get_transfers

API

Table of Contents

JsonRpc

JsonRpc

Parameters

  • endpointstring hyperion endpoint

Examples

constendpoint="https://br.eosrio.io"constrpc=newJsonRpc(endpoint,{ fetch })

alive

GET /v2/state/alive

simple server healthcheck

Examples
constresponse=awaitrpc.alive();console.log(response);// => {"status": "OK"}

Returns Promise<Alive> alive

get_abi_snapshot

GET /v2/history/get_abi_snapshot

fetch contract abi at specific block

Parameters
  • contractstring contract account
  • block
  • numbernumber target block
Examples
constresponse=awaitrpc.get_abi_snapshot("eosio",200);console.log(response.version);// => "eosio::abi/1.0"for(consttableofresponse.tables){console.log(table);// => { name: 'producers', index_type: 'i64', key_names: [ 'owner' ], key_types: [ 'uint64' ], type: 'producer_info' }}

Returns Promise<GetAbiSnapshot> abi snapshot

get_voters

GET /v2/state/get_voters

get voters

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.producerstring? filter by voted producer (comma separated)
    • options.proxyboolean? true or false
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
Examples
constresponse=awaitrpc.get_voters({producer: "eoscafeblock",limit: 100});console.log(response.voters);// => "[{// "account": "guzdkmrtgage",// "weight": 78434695236505280,// "last_vote": 64804768// }]"

Returns Promise<GetVoters> voters

get_links

GET /v2/state/get_links

get voters

Parameters
  • accountstring? account to get links for
Examples
constresponse=awaitrpc.get_links("eoscafeblock");console.log(response.links);// => "[{"block_num":26088072,"timestamp":"2019-11-22T23:17:42.000","account":"eosriobrazil","permission":"claim2","code":"eosio","action":"voteproducer"}]"

Returns Promise<GetLinks> links

get_proposals

GET /v2/state/get_proposals

get proposals

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.proposerstring? filter by proposer
    • options.proposalstring? filter by proposal name
    • options.accountstring? filter by either requested or provided account
    • options.requestedstring? filter by requested account
    • options.providedstring? filter by provided account
    • options.trackstring? total results to track (count) [number or true]
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
  • accountstring? account to get proposals for

Returns Promise<GetProposals> proposals

get_actions

GET /v2/history/get_actions

get actions based on notified account

Parameters
  • accountstring notified account
  • optionsobject Optional parameters (optional, default {})
    • options.filterstring? code::name filter
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
    • options.sortstring? sort direction
    • options.afterstring? filter after specified date (ISO8601)
    • options.beforestring? filter before specified date (ISO8601)
    • options.transfer_tostring? transfer filter to
    • options.transfer_fromstring? transfer filter from
    • options.transfer_symbolstring? transfer filter symbol
    • options.act_namestring? act name
    • options.act_accountstring? act account
Examples
constresponse=awaitrpc.get_actions("eoscafeblock",{filter: "eosio.token:*",skip: 100,limit: 100,});for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio.token', name: 'transfer', ... }}}

Returns Promise<GetActions> get actions

get_created_accounts

GET /v2/history/get_created_accounts

get created accounts

Parameters
Examples
constresponse=awaitrpc.get_created_accounts("eosnationftw");console.log(response);// => {"accounts": [{"name":"eosnationdsp","trx_id":"728d4a4da36a98d9048080461dacaf975ad083e8158ef84edea60cc755ab2c1a","timestamp":"2019-02-28T22:36:45.000"}, ... ]}

Returns Promise<GetCreatedAccounts> get creator

get_creator

GET /v2/history/get_creator

get creator

Parameters
Examples
constresponse=awaitrpc.get_creator("eosnationftw");console.log(response);// => { account: 'eosnationftw', creator: 'gyztcmrvgqge', timestamp: '2018-06-10T13:06:43.500', ... }

Returns Promise<GetCreator> get creator

get_deltas

GET /v2/history/get_deltas

get deltas

Parameters
Examples
constresponse=awaitrpc.get_deltas("eosio.token","eosnationftw","accounts","eosnationftw");console.log(response);// => { "query_time": 19, "total": { "value": 486, "relation": "eq" }, "deltas": [ ... ] }

Returns Promise<GetDeltas> get deltas

get_table_state

[GET /v2/history/get_table_state](https://eos.hyperion.eosrio.io/v2/docs/static/index.html#/history/get_v2_history_get_table_state

get table state

Parameters
Examples
constresponse=awaitrpc.get_table_state("eosio.token","stat","1000","");console.log(response);// => { "query_time": 19, "code": "eosio.token", "table": "stat", "block_num": 1000, "next_key": "........ehbo5-5459781",, "results": [ ... ] }

Returns Promise<GetTableState> get table state

get_key_accounts

GET/v2/state/get_key_accounts

get account by public key

Parameters
  • public_keystring Contract account targeted by the action.
Examples
constresponse=awaitrpc.get_key_accounts("EOS5Mto3Km6BCVxowb6LkkFaT9oaUwLVgswgcxvY4Qgc4rhHry4Tv");console.log(response.account_names);// => [ 'eoscafeblock' ]

Returns Promise<GetKeyAccounts> key accounts

get_tokens

GET /v2/state/get_tokens

get tokens

Parameters
Examples
constresponse=awaitrpc.get_tokens("eosnationftw");for(consttokenofresponse.tokens){console.log(token);// => { symbol: 'ZOS', precision: 4, amount: 140, contract: 'zosdiscounts' }}

Returns Promise<GetTokens> get tokens

get_transaction

GET /v2/history/get_transaction

get all actions belonging to the same transaction

Parameters
Examples
constresponse=awaitrpc.get_transaction("42dacd5722001b734be46a2140917e06cd21d42425f927f506c07b4388b07f62");for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio', name: 'buyrambytes', ... }}}

Returns Promise<GetTransaction> transaction

JsonRpc

alive

GET /v2/state/alive

simple server healthcheck

Examples
constresponse=awaitrpc.alive();console.log(response);// => {"status": "OK"}

Returns Promise<Alive> alive

get_abi_snapshot

GET /v2/history/get_abi_snapshot

fetch contract abi at specific block

Parameters
  • contractstring contract account
  • block
  • numbernumber target block
Examples
constresponse=awaitrpc.get_abi_snapshot("eosio",200);console.log(response.version);// => "eosio::abi/1.0"for(consttableofresponse.tables){console.log(table);// => { name: 'producers', index_type: 'i64', key_names: [ 'owner' ], key_types: [ 'uint64' ], type: 'producer_info' }}

Returns Promise<GetAbiSnapshot> abi snapshot

get_voters

GET /v2/state/get_voters

get voters

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.producerstring? filter by voted producer (comma separated)
    • options.proxyboolean? true or false
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
Examples
constresponse=awaitrpc.get_voters({producer: "eoscafeblock",limit: 100});console.log(response.voters);// => "[{// "account": "guzdkmrtgage",// "weight": 78434695236505280,// "last_vote": 64804768// }]"

Returns Promise<GetVoters> voters

get_links

GET /v2/state/get_links

get voters

Parameters
  • accountstring? account to get links for
Examples
constresponse=awaitrpc.get_links("eoscafeblock");console.log(response.links);// => "[{"block_num":26088072,"timestamp":"2019-11-22T23:17:42.000","account":"eosriobrazil","permission":"claim2","code":"eosio","action":"voteproducer"}]"

Returns Promise<GetLinks> links

get_proposals

GET /v2/state/get_proposals

get proposals

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.proposerstring? filter by proposer
    • options.proposalstring? filter by proposal name
    • options.accountstring? filter by either requested or provided account
    • options.requestedstring? filter by requested account
    • options.providedstring? filter by provided account
    • options.trackstring? total results to track (count) [number or true]
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
  • accountstring? account to get proposals for

Returns Promise<GetProposals> proposals

get_actions

GET /v2/history/get_actions

get actions based on notified account

Parameters
  • accountstring notified account
  • optionsobject Optional parameters (optional, default {})
    • options.filterstring? code::name filter
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
    • options.sortstring? sort direction
    • options.afterstring? filter after specified date (ISO8601)
    • options.beforestring? filter before specified date (ISO8601)
    • options.transfer_tostring? transfer filter to
    • options.transfer_fromstring? transfer filter from
    • options.transfer_symbolstring? transfer filter symbol
    • options.act_namestring? act name
    • options.act_accountstring? act account
Examples
constresponse=awaitrpc.get_actions("eoscafeblock",{filter: "eosio.token:*",skip: 100,limit: 100,});for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio.token', name: 'transfer', ... }}}

Returns Promise<GetActions> get actions

get_created_accounts

GET /v2/history/get_created_accounts

get created accounts

Parameters
Examples
constresponse=awaitrpc.get_created_accounts("eosnationftw");console.log(response);// => {"accounts": [{"name":"eosnationdsp","trx_id":"728d4a4da36a98d9048080461dacaf975ad083e8158ef84edea60cc755ab2c1a","timestamp":"2019-02-28T22:36:45.000"}, ... ]}

Returns Promise<GetCreatedAccounts> get creator

get_creator

GET /v2/history/get_creator

get creator

Parameters
Examples
constresponse=awaitrpc.get_creator("eosnationftw");console.log(response);// => { account: 'eosnationftw', creator: 'gyztcmrvgqge', timestamp: '2018-06-10T13:06:43.500', ... }

Returns Promise<GetCreator> get creator

get_deltas

GET /v2/history/get_deltas

get deltas

Parameters
Examples
constresponse=awaitrpc.get_deltas("eosio.token","eosnationftw","accounts","eosnationftw");console.log(response);// => { "query_time": 19, "total": { "value": 486, "relation": "eq" }, "deltas": [ ... ] }

Returns Promise<GetDeltas> get deltas

get_table_state

[GET /v2/history/get_table_state](https://eos.hyperion.eosrio.io/v2/docs/static/index.html#/history/get_v2_history_get_table_state

get table state

Parameters
Examples
constresponse=awaitrpc.get_table_state("eosio.token","stat","1000","");console.log(response);// => { "query_time": 19, "code": "eosio.token", "table": "stat", "block_num": 1000, "next_key": "........ehbo5-5459781",, "results": [ ... ] }

Returns Promise<GetTableState> get table state

get_key_accounts

GET/v2/state/get_key_accounts

get account by public key

Parameters
  • public_keystring Contract account targeted by the action.
Examples
constresponse=awaitrpc.get_key_accounts("EOS5Mto3Km6BCVxowb6LkkFaT9oaUwLVgswgcxvY4Qgc4rhHry4Tv");console.log(response.account_names);// => [ 'eoscafeblock' ]

Returns Promise<GetKeyAccounts> key accounts

get_tokens

GET /v2/state/get_tokens

get tokens

Parameters
Examples
constresponse=awaitrpc.get_tokens("eosnationftw");for(consttokenofresponse.tokens){console.log(token);// => { symbol: 'ZOS', precision: 4, amount: 140, contract: 'zosdiscounts' }}

Returns Promise<GetTokens> get tokens

get_transaction

GET /v2/history/get_transaction

get all actions belonging to the same transaction

Parameters
Examples
constresponse=awaitrpc.get_transaction("42dacd5722001b734be46a2140917e06cd21d42425f927f506c07b4388b07f62");for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio', name: 'buyrambytes', ... }}}

Returns Promise<GetTransaction> transaction

RpcError

RpcStatusError

About

Hyperion History HTTP API

Resources

Stars

30 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
This repository was archived by the owner on Apr 28, 2026. It is now read-only.

Repository files navigation

Hyperion HTTP API Javascript library

Installation

Using Yarn:

yarn add @proton/hyperion

or using NPM:

npm install --save @proton/hyperion

Quick Start

CommonJS

const{ JsonRpc }=require("@proton/hyperion")constfetch=require("isomorphic-fetch")constendpoint="https://eos.hyperion.eosrio.io"constrpc=newJsonRpc(endpoint,{ fetch })

TypeScript

import{JsonRpc}from"@proton/hyperion"importfetchfrom"isomorphic-fetch"constendpoint="https://eos.hyperion.eosrio.io"constrpc=newJsonRpc(endpoint,{ fetch })

ENV Variables

HYPERION_ENDPOINT=<Enter Hyperion Endpoint># "https://eos.hyperion.eosrio.io"

Supported Endpoints

# State
/v2/state/alive
/v2/state/get_key_accounts
/v2/state/get_tokens
/v2/state/get_voters
/v2/state/get_links
# History
/v2/history/get_abi_snapshot
/v2/history/get_actions
/v2/history/get_created_accounts
/v2/history/get_creator
/v2/history/get_deltas
/v2/history/get_transacted_accounts
/v2/history/get_transaction
/v2/history/get_transfers

API

Table of Contents

JsonRpc

JsonRpc

Parameters

  • endpointstring hyperion endpoint

Examples

constendpoint="https://br.eosrio.io"constrpc=newJsonRpc(endpoint,{ fetch })

alive

GET /v2/state/alive

simple server healthcheck

Examples
constresponse=awaitrpc.alive();console.log(response);// => {"status": "OK"}

Returns Promise<Alive> alive

get_abi_snapshot

GET /v2/history/get_abi_snapshot

fetch contract abi at specific block

Parameters
  • contractstring contract account
  • block
  • numbernumber target block
Examples
constresponse=awaitrpc.get_abi_snapshot("eosio",200);console.log(response.version);// => "eosio::abi/1.0"for(consttableofresponse.tables){console.log(table);// => { name: 'producers', index_type: 'i64', key_names: [ 'owner' ], key_types: [ 'uint64' ], type: 'producer_info' }}

Returns Promise<GetAbiSnapshot> abi snapshot

get_voters

GET /v2/state/get_voters

get voters

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.producerstring? filter by voted producer (comma separated)
    • options.proxyboolean? true or false
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
Examples
constresponse=awaitrpc.get_voters({producer: "eoscafeblock",limit: 100});console.log(response.voters);// => "[{// "account": "guzdkmrtgage",// "weight": 78434695236505280,// "last_vote": 64804768// }]"

Returns Promise<GetVoters> voters

get_links

GET /v2/state/get_links

get voters

Parameters
  • accountstring? account to get links for
Examples
constresponse=awaitrpc.get_links("eoscafeblock");console.log(response.links);// => "[{"block_num":26088072,"timestamp":"2019-11-22T23:17:42.000","account":"eosriobrazil","permission":"claim2","code":"eosio","action":"voteproducer"}]"

Returns Promise<GetLinks> links

get_proposals

GET /v2/state/get_proposals

get proposals

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.proposerstring? filter by proposer
    • options.proposalstring? filter by proposal name
    • options.accountstring? filter by either requested or provided account
    • options.requestedstring? filter by requested account
    • options.providedstring? filter by provided account
    • options.trackstring? total results to track (count) [number or true]
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
  • accountstring? account to get proposals for

Returns Promise<GetProposals> proposals

get_actions

GET /v2/history/get_actions

get actions based on notified account

Parameters
  • accountstring notified account
  • optionsobject Optional parameters (optional, default {})
    • options.filterstring? code::name filter
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
    • options.sortstring? sort direction
    • options.afterstring? filter after specified date (ISO8601)
    • options.beforestring? filter before specified date (ISO8601)
    • options.transfer_tostring? transfer filter to
    • options.transfer_fromstring? transfer filter from
    • options.transfer_symbolstring? transfer filter symbol
    • options.act_namestring? act name
    • options.act_accountstring? act account
Examples
constresponse=awaitrpc.get_actions("eoscafeblock",{filter: "eosio.token:*",skip: 100,limit: 100,});for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio.token', name: 'transfer', ... }}}

Returns Promise<GetActions> get actions

get_created_accounts

GET /v2/history/get_created_accounts

get created accounts

Parameters
Examples
constresponse=awaitrpc.get_created_accounts("eosnationftw");console.log(response);// => {"accounts": [{"name":"eosnationdsp","trx_id":"728d4a4da36a98d9048080461dacaf975ad083e8158ef84edea60cc755ab2c1a","timestamp":"2019-02-28T22:36:45.000"}, ... ]}

Returns Promise<GetCreatedAccounts> get creator

get_creator

GET /v2/history/get_creator

get creator

Parameters
Examples
constresponse=awaitrpc.get_creator("eosnationftw");console.log(response);// => { account: 'eosnationftw', creator: 'gyztcmrvgqge', timestamp: '2018-06-10T13:06:43.500', ... }

Returns Promise<GetCreator> get creator

get_deltas

GET /v2/history/get_deltas

get deltas

Parameters
Examples
constresponse=awaitrpc.get_deltas("eosio.token","eosnationftw","accounts","eosnationftw");console.log(response);// => { "query_time": 19, "total": { "value": 486, "relation": "eq" }, "deltas": [ ... ] }

Returns Promise<GetDeltas> get deltas

get_table_state

[GET /v2/history/get_table_state](https://eos.hyperion.eosrio.io/v2/docs/static/index.html#/history/get_v2_history_get_table_state

get table state

Parameters
Examples
constresponse=awaitrpc.get_table_state("eosio.token","stat","1000","");console.log(response);// => { "query_time": 19, "code": "eosio.token", "table": "stat", "block_num": 1000, "next_key": "........ehbo5-5459781",, "results": [ ... ] }

Returns Promise<GetTableState> get table state

get_key_accounts

GET/v2/state/get_key_accounts

get account by public key

Parameters
  • public_keystring Contract account targeted by the action.
Examples
constresponse=awaitrpc.get_key_accounts("EOS5Mto3Km6BCVxowb6LkkFaT9oaUwLVgswgcxvY4Qgc4rhHry4Tv");console.log(response.account_names);// => [ 'eoscafeblock' ]

Returns Promise<GetKeyAccounts> key accounts

get_tokens

GET /v2/state/get_tokens

get tokens

Parameters
Examples
constresponse=awaitrpc.get_tokens("eosnationftw");for(consttokenofresponse.tokens){console.log(token);// => { symbol: 'ZOS', precision: 4, amount: 140, contract: 'zosdiscounts' }}

Returns Promise<GetTokens> get tokens

get_transaction

GET /v2/history/get_transaction

get all actions belonging to the same transaction

Parameters
Examples
constresponse=awaitrpc.get_transaction("42dacd5722001b734be46a2140917e06cd21d42425f927f506c07b4388b07f62");for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio', name: 'buyrambytes', ... }}}

Returns Promise<GetTransaction> transaction

JsonRpc

alive

GET /v2/state/alive

simple server healthcheck

Examples
constresponse=awaitrpc.alive();console.log(response);// => {"status": "OK"}

Returns Promise<Alive> alive

get_abi_snapshot

GET /v2/history/get_abi_snapshot

fetch contract abi at specific block

Parameters
  • contractstring contract account
  • block
  • numbernumber target block
Examples
constresponse=awaitrpc.get_abi_snapshot("eosio",200);console.log(response.version);// => "eosio::abi/1.0"for(consttableofresponse.tables){console.log(table);// => { name: 'producers', index_type: 'i64', key_names: [ 'owner' ], key_types: [ 'uint64' ], type: 'producer_info' }}

Returns Promise<GetAbiSnapshot> abi snapshot

get_voters

GET /v2/state/get_voters

get voters

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.producerstring? filter by voted producer (comma separated)
    • options.proxyboolean? true or false
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
Examples
constresponse=awaitrpc.get_voters({producer: "eoscafeblock",limit: 100});console.log(response.voters);// => "[{// "account": "guzdkmrtgage",// "weight": 78434695236505280,// "last_vote": 64804768// }]"

Returns Promise<GetVoters> voters

get_links

GET /v2/state/get_links

get voters

Parameters
  • accountstring? account to get links for
Examples
constresponse=awaitrpc.get_links("eoscafeblock");console.log(response.links);// => "[{"block_num":26088072,"timestamp":"2019-11-22T23:17:42.000","account":"eosriobrazil","permission":"claim2","code":"eosio","action":"voteproducer"}]"

Returns Promise<GetLinks> links

get_proposals

GET /v2/state/get_proposals

get proposals

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.proposerstring? filter by proposer
    • options.proposalstring? filter by proposal name
    • options.accountstring? filter by either requested or provided account
    • options.requestedstring? filter by requested account
    • options.providedstring? filter by provided account
    • options.trackstring? total results to track (count) [number or true]
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
  • accountstring? account to get proposals for

Returns Promise<GetProposals> proposals

get_actions

GET /v2/history/get_actions

get actions based on notified account

Parameters
  • accountstring notified account
  • optionsobject Optional parameters (optional, default {})
    • options.filterstring? code::name filter
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
    • options.sortstring? sort direction
    • options.afterstring? filter after specified date (ISO8601)
    • options.beforestring? filter before specified date (ISO8601)
    • options.transfer_tostring? transfer filter to
    • options.transfer_fromstring? transfer filter from
    • options.transfer_symbolstring? transfer filter symbol
    • options.act_namestring? act name
    • options.act_accountstring? act account
Examples
constresponse=awaitrpc.get_actions("eoscafeblock",{filter: "eosio.token:*",skip: 100,limit: 100,});for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio.token', name: 'transfer', ... }}}

Returns Promise<GetActions> get actions

get_created_accounts

GET /v2/history/get_created_accounts

get created accounts

Parameters
Examples
constresponse=awaitrpc.get_created_accounts("eosnationftw");console.log(response);// => {"accounts": [{"name":"eosnationdsp","trx_id":"728d4a4da36a98d9048080461dacaf975ad083e8158ef84edea60cc755ab2c1a","timestamp":"2019-02-28T22:36:45.000"}, ... ]}

Returns Promise<GetCreatedAccounts> get creator

get_creator

GET /v2/history/get_creator

get creator

Parameters
Examples
constresponse=awaitrpc.get_creator("eosnationftw");console.log(response);// => { account: 'eosnationftw', creator: 'gyztcmrvgqge', timestamp: '2018-06-10T13:06:43.500', ... }

Returns Promise<GetCreator> get creator

get_deltas

GET /v2/history/get_deltas

get deltas

Parameters
Examples
constresponse=awaitrpc.get_deltas("eosio.token","eosnationftw","accounts","eosnationftw");console.log(response);// => { "query_time": 19, "total": { "value": 486, "relation": "eq" }, "deltas": [ ... ] }

Returns Promise<GetDeltas> get deltas

get_table_state

[GET /v2/history/get_table_state](https://eos.hyperion.eosrio.io/v2/docs/static/index.html#/history/get_v2_history_get_table_state

get table state

Parameters
Examples
constresponse=awaitrpc.get_table_state("eosio.token","stat","1000","");console.log(response);// => { "query_time": 19, "code": "eosio.token", "table": "stat", "block_num": 1000, "next_key": "........ehbo5-5459781",, "results": [ ... ] }

Returns Promise<GetTableState> get table state

get_key_accounts

GET/v2/state/get_key_accounts

get account by public key

Parameters
  • public_keystring Contract account targeted by the action.
Examples
constresponse=awaitrpc.get_key_accounts("EOS5Mto3Km6BCVxowb6LkkFaT9oaUwLVgswgcxvY4Qgc4rhHry4Tv");console.log(response.account_names);// => [ 'eoscafeblock' ]

Returns Promise<GetKeyAccounts> key accounts

get_tokens

GET /v2/state/get_tokens

get tokens

Parameters
Examples
constresponse=awaitrpc.get_tokens("eosnationftw");for(consttokenofresponse.tokens){console.log(token);// => { symbol: 'ZOS', precision: 4, amount: 140, contract: 'zosdiscounts' }}

Returns Promise<GetTokens> get tokens

get_transaction

GET /v2/history/get_transaction

get all actions belonging to the same transaction

Parameters
Examples
constresponse=awaitrpc.get_transaction("42dacd5722001b734be46a2140917e06cd21d42425f927f506c07b4388b07f62");for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio', name: 'buyrambytes', ... }}}

Returns Promise<GetTransaction> transaction

RpcError

RpcStatusError

About

Hyperion History HTTP API

Resources

Stars

30 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
This repository was archived by the owner on Apr 28, 2026. It is now read-only.

Repository files navigation

Hyperion HTTP API Javascript library

Installation

Using Yarn:

yarn add @proton/hyperion

or using NPM:

npm install --save @proton/hyperion

Quick Start

CommonJS

const{ JsonRpc }=require("@proton/hyperion")constfetch=require("isomorphic-fetch")constendpoint="https://eos.hyperion.eosrio.io"constrpc=newJsonRpc(endpoint,{ fetch })

TypeScript

import{JsonRpc}from"@proton/hyperion"importfetchfrom"isomorphic-fetch"constendpoint="https://eos.hyperion.eosrio.io"constrpc=newJsonRpc(endpoint,{ fetch })

ENV Variables

HYPERION_ENDPOINT=<Enter Hyperion Endpoint># "https://eos.hyperion.eosrio.io"

Supported Endpoints

# State
/v2/state/alive
/v2/state/get_key_accounts
/v2/state/get_tokens
/v2/state/get_voters
/v2/state/get_links
# History
/v2/history/get_abi_snapshot
/v2/history/get_actions
/v2/history/get_created_accounts
/v2/history/get_creator
/v2/history/get_deltas
/v2/history/get_transacted_accounts
/v2/history/get_transaction
/v2/history/get_transfers

API

Table of Contents

JsonRpc

JsonRpc

Parameters

  • endpointstring hyperion endpoint

Examples

constendpoint="https://br.eosrio.io"constrpc=newJsonRpc(endpoint,{ fetch })

alive

GET /v2/state/alive

simple server healthcheck

Examples
constresponse=awaitrpc.alive();console.log(response);// => {"status": "OK"}

Returns Promise<Alive> alive

get_abi_snapshot

GET /v2/history/get_abi_snapshot

fetch contract abi at specific block

Parameters
  • contractstring contract account
  • block
  • numbernumber target block
Examples
constresponse=awaitrpc.get_abi_snapshot("eosio",200);console.log(response.version);// => "eosio::abi/1.0"for(consttableofresponse.tables){console.log(table);// => { name: 'producers', index_type: 'i64', key_names: [ 'owner' ], key_types: [ 'uint64' ], type: 'producer_info' }}

Returns Promise<GetAbiSnapshot> abi snapshot

get_voters

GET /v2/state/get_voters

get voters

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.producerstring? filter by voted producer (comma separated)
    • options.proxyboolean? true or false
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
Examples
constresponse=awaitrpc.get_voters({producer: "eoscafeblock",limit: 100});console.log(response.voters);// => "[{// "account": "guzdkmrtgage",// "weight": 78434695236505280,// "last_vote": 64804768// }]"

Returns Promise<GetVoters> voters

get_links

GET /v2/state/get_links

get voters

Parameters
  • accountstring? account to get links for
Examples
constresponse=awaitrpc.get_links("eoscafeblock");console.log(response.links);// => "[{"block_num":26088072,"timestamp":"2019-11-22T23:17:42.000","account":"eosriobrazil","permission":"claim2","code":"eosio","action":"voteproducer"}]"

Returns Promise<GetLinks> links

get_proposals

GET /v2/state/get_proposals

get proposals

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.proposerstring? filter by proposer
    • options.proposalstring? filter by proposal name
    • options.accountstring? filter by either requested or provided account
    • options.requestedstring? filter by requested account
    • options.providedstring? filter by provided account
    • options.trackstring? total results to track (count) [number or true]
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
  • accountstring? account to get proposals for

Returns Promise<GetProposals> proposals

get_actions

GET /v2/history/get_actions

get actions based on notified account

Parameters
  • accountstring notified account
  • optionsobject Optional parameters (optional, default {})
    • options.filterstring? code::name filter
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
    • options.sortstring? sort direction
    • options.afterstring? filter after specified date (ISO8601)
    • options.beforestring? filter before specified date (ISO8601)
    • options.transfer_tostring? transfer filter to
    • options.transfer_fromstring? transfer filter from
    • options.transfer_symbolstring? transfer filter symbol
    • options.act_namestring? act name
    • options.act_accountstring? act account
Examples
constresponse=awaitrpc.get_actions("eoscafeblock",{filter: "eosio.token:*",skip: 100,limit: 100,});for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio.token', name: 'transfer', ... }}}

Returns Promise<GetActions> get actions

get_created_accounts

GET /v2/history/get_created_accounts

get created accounts

Parameters
Examples
constresponse=awaitrpc.get_created_accounts("eosnationftw");console.log(response);// => {"accounts": [{"name":"eosnationdsp","trx_id":"728d4a4da36a98d9048080461dacaf975ad083e8158ef84edea60cc755ab2c1a","timestamp":"2019-02-28T22:36:45.000"}, ... ]}

Returns Promise<GetCreatedAccounts> get creator

get_creator

GET /v2/history/get_creator

get creator

Parameters
Examples
constresponse=awaitrpc.get_creator("eosnationftw");console.log(response);// => { account: 'eosnationftw', creator: 'gyztcmrvgqge', timestamp: '2018-06-10T13:06:43.500', ... }

Returns Promise<GetCreator> get creator

get_deltas

GET /v2/history/get_deltas

get deltas

Parameters
Examples
constresponse=awaitrpc.get_deltas("eosio.token","eosnationftw","accounts","eosnationftw");console.log(response);// => { "query_time": 19, "total": { "value": 486, "relation": "eq" }, "deltas": [ ... ] }

Returns Promise<GetDeltas> get deltas

get_table_state

[GET /v2/history/get_table_state](https://eos.hyperion.eosrio.io/v2/docs/static/index.html#/history/get_v2_history_get_table_state

get table state

Parameters
Examples
constresponse=awaitrpc.get_table_state("eosio.token","stat","1000","");console.log(response);// => { "query_time": 19, "code": "eosio.token", "table": "stat", "block_num": 1000, "next_key": "........ehbo5-5459781",, "results": [ ... ] }

Returns Promise<GetTableState> get table state

get_key_accounts

GET/v2/state/get_key_accounts

get account by public key

Parameters
  • public_keystring Contract account targeted by the action.
Examples
constresponse=awaitrpc.get_key_accounts("EOS5Mto3Km6BCVxowb6LkkFaT9oaUwLVgswgcxvY4Qgc4rhHry4Tv");console.log(response.account_names);// => [ 'eoscafeblock' ]

Returns Promise<GetKeyAccounts> key accounts

get_tokens

GET /v2/state/get_tokens

get tokens

Parameters
Examples
constresponse=awaitrpc.get_tokens("eosnationftw");for(consttokenofresponse.tokens){console.log(token);// => { symbol: 'ZOS', precision: 4, amount: 140, contract: 'zosdiscounts' }}

Returns Promise<GetTokens> get tokens

get_transaction

GET /v2/history/get_transaction

get all actions belonging to the same transaction

Parameters
Examples
constresponse=awaitrpc.get_transaction("42dacd5722001b734be46a2140917e06cd21d42425f927f506c07b4388b07f62");for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio', name: 'buyrambytes', ... }}}

Returns Promise<GetTransaction> transaction

JsonRpc

alive

GET /v2/state/alive

simple server healthcheck

Examples
constresponse=awaitrpc.alive();console.log(response);// => {"status": "OK"}

Returns Promise<Alive> alive

get_abi_snapshot

GET /v2/history/get_abi_snapshot

fetch contract abi at specific block

Parameters
  • contractstring contract account
  • block
  • numbernumber target block
Examples
constresponse=awaitrpc.get_abi_snapshot("eosio",200);console.log(response.version);// => "eosio::abi/1.0"for(consttableofresponse.tables){console.log(table);// => { name: 'producers', index_type: 'i64', key_names: [ 'owner' ], key_types: [ 'uint64' ], type: 'producer_info' }}

Returns Promise<GetAbiSnapshot> abi snapshot

get_voters

GET /v2/state/get_voters

get voters

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.producerstring? filter by voted producer (comma separated)
    • options.proxyboolean? true or false
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
Examples
constresponse=awaitrpc.get_voters({producer: "eoscafeblock",limit: 100});console.log(response.voters);// => "[{// "account": "guzdkmrtgage",// "weight": 78434695236505280,// "last_vote": 64804768// }]"

Returns Promise<GetVoters> voters

get_links

GET /v2/state/get_links

get voters

Parameters
  • accountstring? account to get links for
Examples
constresponse=awaitrpc.get_links("eoscafeblock");console.log(response.links);// => "[{"block_num":26088072,"timestamp":"2019-11-22T23:17:42.000","account":"eosriobrazil","permission":"claim2","code":"eosio","action":"voteproducer"}]"

Returns Promise<GetLinks> links

get_proposals

GET /v2/state/get_proposals

get proposals

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.proposerstring? filter by proposer
    • options.proposalstring? filter by proposal name
    • options.accountstring? filter by either requested or provided account
    • options.requestedstring? filter by requested account
    • options.providedstring? filter by provided account
    • options.trackstring? total results to track (count) [number or true]
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
  • accountstring? account to get proposals for

Returns Promise<GetProposals> proposals

get_actions

GET /v2/history/get_actions

get actions based on notified account

Parameters
  • accountstring notified account
  • optionsobject Optional parameters (optional, default {})
    • options.filterstring? code::name filter
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
    • options.sortstring? sort direction
    • options.afterstring? filter after specified date (ISO8601)
    • options.beforestring? filter before specified date (ISO8601)
    • options.transfer_tostring? transfer filter to
    • options.transfer_fromstring? transfer filter from
    • options.transfer_symbolstring? transfer filter symbol
    • options.act_namestring? act name
    • options.act_accountstring? act account
Examples
constresponse=awaitrpc.get_actions("eoscafeblock",{filter: "eosio.token:*",skip: 100,limit: 100,});for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio.token', name: 'transfer', ... }}}

Returns Promise<GetActions> get actions

get_created_accounts

GET /v2/history/get_created_accounts

get created accounts

Parameters
Examples
constresponse=awaitrpc.get_created_accounts("eosnationftw");console.log(response);// => {"accounts": [{"name":"eosnationdsp","trx_id":"728d4a4da36a98d9048080461dacaf975ad083e8158ef84edea60cc755ab2c1a","timestamp":"2019-02-28T22:36:45.000"}, ... ]}

Returns Promise<GetCreatedAccounts> get creator

get_creator

GET /v2/history/get_creator

get creator

Parameters
Examples
constresponse=awaitrpc.get_creator("eosnationftw");console.log(response);// => { account: 'eosnationftw', creator: 'gyztcmrvgqge', timestamp: '2018-06-10T13:06:43.500', ... }

Returns Promise<GetCreator> get creator

get_deltas

GET /v2/history/get_deltas

get deltas

Parameters
Examples
constresponse=awaitrpc.get_deltas("eosio.token","eosnationftw","accounts","eosnationftw");console.log(response);// => { "query_time": 19, "total": { "value": 486, "relation": "eq" }, "deltas": [ ... ] }

Returns Promise<GetDeltas> get deltas

get_table_state

[GET /v2/history/get_table_state](https://eos.hyperion.eosrio.io/v2/docs/static/index.html#/history/get_v2_history_get_table_state

get table state

Parameters
Examples
constresponse=awaitrpc.get_table_state("eosio.token","stat","1000","");console.log(response);// => { "query_time": 19, "code": "eosio.token", "table": "stat", "block_num": 1000, "next_key": "........ehbo5-5459781",, "results": [ ... ] }

Returns Promise<GetTableState> get table state

get_key_accounts

GET/v2/state/get_key_accounts

get account by public key

Parameters
  • public_keystring Contract account targeted by the action.
Examples
constresponse=awaitrpc.get_key_accounts("EOS5Mto3Km6BCVxowb6LkkFaT9oaUwLVgswgcxvY4Qgc4rhHry4Tv");console.log(response.account_names);// => [ 'eoscafeblock' ]

Returns Promise<GetKeyAccounts> key accounts

get_tokens

GET /v2/state/get_tokens

get tokens

Parameters
Examples
constresponse=awaitrpc.get_tokens("eosnationftw");for(consttokenofresponse.tokens){console.log(token);// => { symbol: 'ZOS', precision: 4, amount: 140, contract: 'zosdiscounts' }}

Returns Promise<GetTokens> get tokens

get_transaction

GET /v2/history/get_transaction

get all actions belonging to the same transaction

Parameters
Examples
constresponse=awaitrpc.get_transaction("42dacd5722001b734be46a2140917e06cd21d42425f927f506c07b4388b07f62");for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio', name: 'buyrambytes', ... }}}

Returns Promise<GetTransaction> transaction

RpcError

RpcStatusError

About

Hyperion History HTTP API

Resources

Stars

30 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
This repository was archived by the owner on Apr 28, 2026. It is now read-only.

Repository files navigation

Hyperion HTTP API Javascript library

Installation

Using Yarn:

yarn add @proton/hyperion

or using NPM:

npm install --save @proton/hyperion

Quick Start

CommonJS

const{ JsonRpc }=require("@proton/hyperion")constfetch=require("isomorphic-fetch")constendpoint="https://eos.hyperion.eosrio.io"constrpc=newJsonRpc(endpoint,{ fetch })

TypeScript

import{JsonRpc}from"@proton/hyperion"importfetchfrom"isomorphic-fetch"constendpoint="https://eos.hyperion.eosrio.io"constrpc=newJsonRpc(endpoint,{ fetch })

ENV Variables

HYPERION_ENDPOINT=<Enter Hyperion Endpoint># "https://eos.hyperion.eosrio.io"

Supported Endpoints

# State
/v2/state/alive
/v2/state/get_key_accounts
/v2/state/get_tokens
/v2/state/get_voters
/v2/state/get_links
# History
/v2/history/get_abi_snapshot
/v2/history/get_actions
/v2/history/get_created_accounts
/v2/history/get_creator
/v2/history/get_deltas
/v2/history/get_transacted_accounts
/v2/history/get_transaction
/v2/history/get_transfers

API

Table of Contents

JsonRpc

JsonRpc

Parameters

  • endpointstring hyperion endpoint

Examples

constendpoint="https://br.eosrio.io"constrpc=newJsonRpc(endpoint,{ fetch })

alive

GET /v2/state/alive

simple server healthcheck

Examples
constresponse=awaitrpc.alive();console.log(response);// => {"status": "OK"}

Returns Promise<Alive> alive

get_abi_snapshot

GET /v2/history/get_abi_snapshot

fetch contract abi at specific block

Parameters
  • contractstring contract account
  • block
  • numbernumber target block
Examples
constresponse=awaitrpc.get_abi_snapshot("eosio",200);console.log(response.version);// => "eosio::abi/1.0"for(consttableofresponse.tables){console.log(table);// => { name: 'producers', index_type: 'i64', key_names: [ 'owner' ], key_types: [ 'uint64' ], type: 'producer_info' }}

Returns Promise<GetAbiSnapshot> abi snapshot

get_voters

GET /v2/state/get_voters

get voters

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.producerstring? filter by voted producer (comma separated)
    • options.proxyboolean? true or false
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
Examples
constresponse=awaitrpc.get_voters({producer: "eoscafeblock",limit: 100});console.log(response.voters);// => "[{// "account": "guzdkmrtgage",// "weight": 78434695236505280,// "last_vote": 64804768// }]"

Returns Promise<GetVoters> voters

get_links

GET /v2/state/get_links

get voters

Parameters
  • accountstring? account to get links for
Examples
constresponse=awaitrpc.get_links("eoscafeblock");console.log(response.links);// => "[{"block_num":26088072,"timestamp":"2019-11-22T23:17:42.000","account":"eosriobrazil","permission":"claim2","code":"eosio","action":"voteproducer"}]"

Returns Promise<GetLinks> links

get_proposals

GET /v2/state/get_proposals

get proposals

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.proposerstring? filter by proposer
    • options.proposalstring? filter by proposal name
    • options.accountstring? filter by either requested or provided account
    • options.requestedstring? filter by requested account
    • options.providedstring? filter by provided account
    • options.trackstring? total results to track (count) [number or true]
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
  • accountstring? account to get proposals for

Returns Promise<GetProposals> proposals

get_actions

GET /v2/history/get_actions

get actions based on notified account

Parameters
  • accountstring notified account
  • optionsobject Optional parameters (optional, default {})
    • options.filterstring? code::name filter
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
    • options.sortstring? sort direction
    • options.afterstring? filter after specified date (ISO8601)
    • options.beforestring? filter before specified date (ISO8601)
    • options.transfer_tostring? transfer filter to
    • options.transfer_fromstring? transfer filter from
    • options.transfer_symbolstring? transfer filter symbol
    • options.act_namestring? act name
    • options.act_accountstring? act account
Examples
constresponse=awaitrpc.get_actions("eoscafeblock",{filter: "eosio.token:*",skip: 100,limit: 100,});for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio.token', name: 'transfer', ... }}}

Returns Promise<GetActions> get actions

get_created_accounts

GET /v2/history/get_created_accounts

get created accounts

Parameters
Examples
constresponse=awaitrpc.get_created_accounts("eosnationftw");console.log(response);// => {"accounts": [{"name":"eosnationdsp","trx_id":"728d4a4da36a98d9048080461dacaf975ad083e8158ef84edea60cc755ab2c1a","timestamp":"2019-02-28T22:36:45.000"}, ... ]}

Returns Promise<GetCreatedAccounts> get creator

get_creator

GET /v2/history/get_creator

get creator

Parameters
Examples
constresponse=awaitrpc.get_creator("eosnationftw");console.log(response);// => { account: 'eosnationftw', creator: 'gyztcmrvgqge', timestamp: '2018-06-10T13:06:43.500', ... }

Returns Promise<GetCreator> get creator

get_deltas

GET /v2/history/get_deltas

get deltas

Parameters
Examples
constresponse=awaitrpc.get_deltas("eosio.token","eosnationftw","accounts","eosnationftw");console.log(response);// => { "query_time": 19, "total": { "value": 486, "relation": "eq" }, "deltas": [ ... ] }

Returns Promise<GetDeltas> get deltas

get_table_state

[GET /v2/history/get_table_state](https://eos.hyperion.eosrio.io/v2/docs/static/index.html#/history/get_v2_history_get_table_state

get table state

Parameters
Examples
constresponse=awaitrpc.get_table_state("eosio.token","stat","1000","");console.log(response);// => { "query_time": 19, "code": "eosio.token", "table": "stat", "block_num": 1000, "next_key": "........ehbo5-5459781",, "results": [ ... ] }

Returns Promise<GetTableState> get table state

get_key_accounts

GET/v2/state/get_key_accounts

get account by public key

Parameters
  • public_keystring Contract account targeted by the action.
Examples
constresponse=awaitrpc.get_key_accounts("EOS5Mto3Km6BCVxowb6LkkFaT9oaUwLVgswgcxvY4Qgc4rhHry4Tv");console.log(response.account_names);// => [ 'eoscafeblock' ]

Returns Promise<GetKeyAccounts> key accounts

get_tokens

GET /v2/state/get_tokens

get tokens

Parameters
Examples
constresponse=awaitrpc.get_tokens("eosnationftw");for(consttokenofresponse.tokens){console.log(token);// => { symbol: 'ZOS', precision: 4, amount: 140, contract: 'zosdiscounts' }}

Returns Promise<GetTokens> get tokens

get_transaction

GET /v2/history/get_transaction

get all actions belonging to the same transaction

Parameters
Examples
constresponse=awaitrpc.get_transaction("42dacd5722001b734be46a2140917e06cd21d42425f927f506c07b4388b07f62");for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio', name: 'buyrambytes', ... }}}

Returns Promise<GetTransaction> transaction

JsonRpc

alive

GET /v2/state/alive

simple server healthcheck

Examples
constresponse=awaitrpc.alive();console.log(response);// => {"status": "OK"}

Returns Promise<Alive> alive

get_abi_snapshot

GET /v2/history/get_abi_snapshot

fetch contract abi at specific block

Parameters
  • contractstring contract account
  • block
  • numbernumber target block
Examples
constresponse=awaitrpc.get_abi_snapshot("eosio",200);console.log(response.version);// => "eosio::abi/1.0"for(consttableofresponse.tables){console.log(table);// => { name: 'producers', index_type: 'i64', key_names: [ 'owner' ], key_types: [ 'uint64' ], type: 'producer_info' }}

Returns Promise<GetAbiSnapshot> abi snapshot

get_voters

GET /v2/state/get_voters

get voters

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.producerstring? filter by voted producer (comma separated)
    • options.proxyboolean? true or false
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
Examples
constresponse=awaitrpc.get_voters({producer: "eoscafeblock",limit: 100});console.log(response.voters);// => "[{// "account": "guzdkmrtgage",// "weight": 78434695236505280,// "last_vote": 64804768// }]"

Returns Promise<GetVoters> voters

get_links

GET /v2/state/get_links

get voters

Parameters
  • accountstring? account to get links for
Examples
constresponse=awaitrpc.get_links("eoscafeblock");console.log(response.links);// => "[{"block_num":26088072,"timestamp":"2019-11-22T23:17:42.000","account":"eosriobrazil","permission":"claim2","code":"eosio","action":"voteproducer"}]"

Returns Promise<GetLinks> links

get_proposals

GET /v2/state/get_proposals

get proposals

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.proposerstring? filter by proposer
    • options.proposalstring? filter by proposal name
    • options.accountstring? filter by either requested or provided account
    • options.requestedstring? filter by requested account
    • options.providedstring? filter by provided account
    • options.trackstring? total results to track (count) [number or true]
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
  • accountstring? account to get proposals for

Returns Promise<GetProposals> proposals

get_actions

GET /v2/history/get_actions

get actions based on notified account

Parameters
  • accountstring notified account
  • optionsobject Optional parameters (optional, default {})
    • options.filterstring? code::name filter
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
    • options.sortstring? sort direction
    • options.afterstring? filter after specified date (ISO8601)
    • options.beforestring? filter before specified date (ISO8601)
    • options.transfer_tostring? transfer filter to
    • options.transfer_fromstring? transfer filter from
    • options.transfer_symbolstring? transfer filter symbol
    • options.act_namestring? act name
    • options.act_accountstring? act account
Examples
constresponse=awaitrpc.get_actions("eoscafeblock",{filter: "eosio.token:*",skip: 100,limit: 100,});for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio.token', name: 'transfer', ... }}}

Returns Promise<GetActions> get actions

get_created_accounts

GET /v2/history/get_created_accounts

get created accounts

Parameters
Examples
constresponse=awaitrpc.get_created_accounts("eosnationftw");console.log(response);// => {"accounts": [{"name":"eosnationdsp","trx_id":"728d4a4da36a98d9048080461dacaf975ad083e8158ef84edea60cc755ab2c1a","timestamp":"2019-02-28T22:36:45.000"}, ... ]}

Returns Promise<GetCreatedAccounts> get creator

get_creator

GET /v2/history/get_creator

get creator

Parameters
Examples
constresponse=awaitrpc.get_creator("eosnationftw");console.log(response);// => { account: 'eosnationftw', creator: 'gyztcmrvgqge', timestamp: '2018-06-10T13:06:43.500', ... }

Returns Promise<GetCreator> get creator

get_deltas

GET /v2/history/get_deltas

get deltas

Parameters
Examples
constresponse=awaitrpc.get_deltas("eosio.token","eosnationftw","accounts","eosnationftw");console.log(response);// => { "query_time": 19, "total": { "value": 486, "relation": "eq" }, "deltas": [ ... ] }

Returns Promise<GetDeltas> get deltas

get_table_state

[GET /v2/history/get_table_state](https://eos.hyperion.eosrio.io/v2/docs/static/index.html#/history/get_v2_history_get_table_state

get table state

Parameters
Examples
constresponse=awaitrpc.get_table_state("eosio.token","stat","1000","");console.log(response);// => { "query_time": 19, "code": "eosio.token", "table": "stat", "block_num": 1000, "next_key": "........ehbo5-5459781",, "results": [ ... ] }

Returns Promise<GetTableState> get table state

get_key_accounts

GET/v2/state/get_key_accounts

get account by public key

Parameters
  • public_keystring Contract account targeted by the action.
Examples
constresponse=awaitrpc.get_key_accounts("EOS5Mto3Km6BCVxowb6LkkFaT9oaUwLVgswgcxvY4Qgc4rhHry4Tv");console.log(response.account_names);// => [ 'eoscafeblock' ]

Returns Promise<GetKeyAccounts> key accounts

get_tokens

GET /v2/state/get_tokens

get tokens

Parameters
Examples
constresponse=awaitrpc.get_tokens("eosnationftw");for(consttokenofresponse.tokens){console.log(token);// => { symbol: 'ZOS', precision: 4, amount: 140, contract: 'zosdiscounts' }}

Returns Promise<GetTokens> get tokens

get_transaction

GET /v2/history/get_transaction

get all actions belonging to the same transaction

Parameters
Examples
constresponse=awaitrpc.get_transaction("42dacd5722001b734be46a2140917e06cd21d42425f927f506c07b4388b07f62");for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio', name: 'buyrambytes', ... }}}

Returns Promise<GetTransaction> transaction

RpcError

RpcStatusError

About

Hyperion History HTTP API

Resources

Stars

30 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
This repository was archived by the owner on Apr 28, 2026. It is now read-only.

Repository files navigation

Hyperion HTTP API Javascript library

Installation

Using Yarn:

yarn add @proton/hyperion

or using NPM:

npm install --save @proton/hyperion

Quick Start

CommonJS

const{ JsonRpc }=require("@proton/hyperion")constfetch=require("isomorphic-fetch")constendpoint="https://eos.hyperion.eosrio.io"constrpc=newJsonRpc(endpoint,{ fetch })

TypeScript

import{JsonRpc}from"@proton/hyperion"importfetchfrom"isomorphic-fetch"constendpoint="https://eos.hyperion.eosrio.io"constrpc=newJsonRpc(endpoint,{ fetch })

ENV Variables

HYPERION_ENDPOINT=<Enter Hyperion Endpoint># "https://eos.hyperion.eosrio.io"

Supported Endpoints

# State
/v2/state/alive
/v2/state/get_key_accounts
/v2/state/get_tokens
/v2/state/get_voters
/v2/state/get_links
# History
/v2/history/get_abi_snapshot
/v2/history/get_actions
/v2/history/get_created_accounts
/v2/history/get_creator
/v2/history/get_deltas
/v2/history/get_transacted_accounts
/v2/history/get_transaction
/v2/history/get_transfers

API

Table of Contents

JsonRpc

JsonRpc

Parameters

  • endpointstring hyperion endpoint

Examples

constendpoint="https://br.eosrio.io"constrpc=newJsonRpc(endpoint,{ fetch })

alive

GET /v2/state/alive

simple server healthcheck

Examples
constresponse=awaitrpc.alive();console.log(response);// => {"status": "OK"}

Returns Promise<Alive> alive

get_abi_snapshot

GET /v2/history/get_abi_snapshot

fetch contract abi at specific block

Parameters
  • contractstring contract account
  • block
  • numbernumber target block
Examples
constresponse=awaitrpc.get_abi_snapshot("eosio",200);console.log(response.version);// => "eosio::abi/1.0"for(consttableofresponse.tables){console.log(table);// => { name: 'producers', index_type: 'i64', key_names: [ 'owner' ], key_types: [ 'uint64' ], type: 'producer_info' }}

Returns Promise<GetAbiSnapshot> abi snapshot

get_voters

GET /v2/state/get_voters

get voters

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.producerstring? filter by voted producer (comma separated)
    • options.proxyboolean? true or false
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
Examples
constresponse=awaitrpc.get_voters({producer: "eoscafeblock",limit: 100});console.log(response.voters);// => "[{// "account": "guzdkmrtgage",// "weight": 78434695236505280,// "last_vote": 64804768// }]"

Returns Promise<GetVoters> voters

get_links

GET /v2/state/get_links

get voters

Parameters
  • accountstring? account to get links for
Examples
constresponse=awaitrpc.get_links("eoscafeblock");console.log(response.links);// => "[{"block_num":26088072,"timestamp":"2019-11-22T23:17:42.000","account":"eosriobrazil","permission":"claim2","code":"eosio","action":"voteproducer"}]"

Returns Promise<GetLinks> links

get_proposals

GET /v2/state/get_proposals

get proposals

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.proposerstring? filter by proposer
    • options.proposalstring? filter by proposal name
    • options.accountstring? filter by either requested or provided account
    • options.requestedstring? filter by requested account
    • options.providedstring? filter by provided account
    • options.trackstring? total results to track (count) [number or true]
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
  • accountstring? account to get proposals for

Returns Promise<GetProposals> proposals

get_actions

GET /v2/history/get_actions

get actions based on notified account

Parameters
  • accountstring notified account
  • optionsobject Optional parameters (optional, default {})
    • options.filterstring? code::name filter
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
    • options.sortstring? sort direction
    • options.afterstring? filter after specified date (ISO8601)
    • options.beforestring? filter before specified date (ISO8601)
    • options.transfer_tostring? transfer filter to
    • options.transfer_fromstring? transfer filter from
    • options.transfer_symbolstring? transfer filter symbol
    • options.act_namestring? act name
    • options.act_accountstring? act account
Examples
constresponse=awaitrpc.get_actions("eoscafeblock",{filter: "eosio.token:*",skip: 100,limit: 100,});for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio.token', name: 'transfer', ... }}}

Returns Promise<GetActions> get actions

get_created_accounts

GET /v2/history/get_created_accounts

get created accounts

Parameters
Examples
constresponse=awaitrpc.get_created_accounts("eosnationftw");console.log(response);// => {"accounts": [{"name":"eosnationdsp","trx_id":"728d4a4da36a98d9048080461dacaf975ad083e8158ef84edea60cc755ab2c1a","timestamp":"2019-02-28T22:36:45.000"}, ... ]}

Returns Promise<GetCreatedAccounts> get creator

get_creator

GET /v2/history/get_creator

get creator

Parameters
Examples
constresponse=awaitrpc.get_creator("eosnationftw");console.log(response);// => { account: 'eosnationftw', creator: 'gyztcmrvgqge', timestamp: '2018-06-10T13:06:43.500', ... }

Returns Promise<GetCreator> get creator

get_deltas

GET /v2/history/get_deltas

get deltas

Parameters
Examples
constresponse=awaitrpc.get_deltas("eosio.token","eosnationftw","accounts","eosnationftw");console.log(response);// => { "query_time": 19, "total": { "value": 486, "relation": "eq" }, "deltas": [ ... ] }

Returns Promise<GetDeltas> get deltas

get_table_state

[GET /v2/history/get_table_state](https://eos.hyperion.eosrio.io/v2/docs/static/index.html#/history/get_v2_history_get_table_state

get table state

Parameters
Examples
constresponse=awaitrpc.get_table_state("eosio.token","stat","1000","");console.log(response);// => { "query_time": 19, "code": "eosio.token", "table": "stat", "block_num": 1000, "next_key": "........ehbo5-5459781",, "results": [ ... ] }

Returns Promise<GetTableState> get table state

get_key_accounts

GET/v2/state/get_key_accounts

get account by public key

Parameters
  • public_keystring Contract account targeted by the action.
Examples
constresponse=awaitrpc.get_key_accounts("EOS5Mto3Km6BCVxowb6LkkFaT9oaUwLVgswgcxvY4Qgc4rhHry4Tv");console.log(response.account_names);// => [ 'eoscafeblock' ]

Returns Promise<GetKeyAccounts> key accounts

get_tokens

GET /v2/state/get_tokens

get tokens

Parameters
Examples
constresponse=awaitrpc.get_tokens("eosnationftw");for(consttokenofresponse.tokens){console.log(token);// => { symbol: 'ZOS', precision: 4, amount: 140, contract: 'zosdiscounts' }}

Returns Promise<GetTokens> get tokens

get_transaction

GET /v2/history/get_transaction

get all actions belonging to the same transaction

Parameters
Examples
constresponse=awaitrpc.get_transaction("42dacd5722001b734be46a2140917e06cd21d42425f927f506c07b4388b07f62");for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio', name: 'buyrambytes', ... }}}

Returns Promise<GetTransaction> transaction

JsonRpc

alive

GET /v2/state/alive

simple server healthcheck

Examples
constresponse=awaitrpc.alive();console.log(response);// => {"status": "OK"}

Returns Promise<Alive> alive

get_abi_snapshot

GET /v2/history/get_abi_snapshot

fetch contract abi at specific block

Parameters
  • contractstring contract account
  • block
  • numbernumber target block
Examples
constresponse=awaitrpc.get_abi_snapshot("eosio",200);console.log(response.version);// => "eosio::abi/1.0"for(consttableofresponse.tables){console.log(table);// => { name: 'producers', index_type: 'i64', key_names: [ 'owner' ], key_types: [ 'uint64' ], type: 'producer_info' }}

Returns Promise<GetAbiSnapshot> abi snapshot

get_voters

GET /v2/state/get_voters

get voters

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.producerstring? filter by voted producer (comma separated)
    • options.proxyboolean? true or false
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
Examples
constresponse=awaitrpc.get_voters({producer: "eoscafeblock",limit: 100});console.log(response.voters);// => "[{// "account": "guzdkmrtgage",// "weight": 78434695236505280,// "last_vote": 64804768// }]"

Returns Promise<GetVoters> voters

get_links

GET /v2/state/get_links

get voters

Parameters
  • accountstring? account to get links for
Examples
constresponse=awaitrpc.get_links("eoscafeblock");console.log(response.links);// => "[{"block_num":26088072,"timestamp":"2019-11-22T23:17:42.000","account":"eosriobrazil","permission":"claim2","code":"eosio","action":"voteproducer"}]"

Returns Promise<GetLinks> links

get_proposals

GET /v2/state/get_proposals

get proposals

Parameters
  • optionsobject Optional parameters (optional, default {})
    • options.proposerstring? filter by proposer
    • options.proposalstring? filter by proposal name
    • options.accountstring? filter by either requested or provided account
    • options.requestedstring? filter by requested account
    • options.providedstring? filter by provided account
    • options.trackstring? total results to track (count) [number or true]
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
  • accountstring? account to get proposals for

Returns Promise<GetProposals> proposals

get_actions

GET /v2/history/get_actions

get actions based on notified account

Parameters
  • accountstring notified account
  • optionsobject Optional parameters (optional, default {})
    • options.filterstring? code::name filter
    • options.skipnumber? skip [n] actions (pagination)
    • options.limitnumber? limit of [n] actions per page
    • options.sortstring? sort direction
    • options.afterstring? filter after specified date (ISO8601)
    • options.beforestring? filter before specified date (ISO8601)
    • options.transfer_tostring? transfer filter to
    • options.transfer_fromstring? transfer filter from
    • options.transfer_symbolstring? transfer filter symbol
    • options.act_namestring? act name
    • options.act_accountstring? act account
Examples
constresponse=awaitrpc.get_actions("eoscafeblock",{filter: "eosio.token:*",skip: 100,limit: 100,});for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio.token', name: 'transfer', ... }}}

Returns Promise<GetActions> get actions

get_created_accounts

GET /v2/history/get_created_accounts

get created accounts

Parameters
Examples
constresponse=awaitrpc.get_created_accounts("eosnationftw");console.log(response);// => {"accounts": [{"name":"eosnationdsp","trx_id":"728d4a4da36a98d9048080461dacaf975ad083e8158ef84edea60cc755ab2c1a","timestamp":"2019-02-28T22:36:45.000"}, ... ]}

Returns Promise<GetCreatedAccounts> get creator

get_creator

GET /v2/history/get_creator

get creator

Parameters
Examples
constresponse=awaitrpc.get_creator("eosnationftw");console.log(response);// => { account: 'eosnationftw', creator: 'gyztcmrvgqge', timestamp: '2018-06-10T13:06:43.500', ... }

Returns Promise<GetCreator> get creator

get_deltas

GET /v2/history/get_deltas

get deltas

Parameters
Examples
constresponse=awaitrpc.get_deltas("eosio.token","eosnationftw","accounts","eosnationftw");console.log(response);// => { "query_time": 19, "total": { "value": 486, "relation": "eq" }, "deltas": [ ... ] }

Returns Promise<GetDeltas> get deltas

get_table_state

[GET /v2/history/get_table_state](https://eos.hyperion.eosrio.io/v2/docs/static/index.html#/history/get_v2_history_get_table_state

get table state

Parameters
Examples
constresponse=awaitrpc.get_table_state("eosio.token","stat","1000","");console.log(response);// => { "query_time": 19, "code": "eosio.token", "table": "stat", "block_num": 1000, "next_key": "........ehbo5-5459781",, "results": [ ... ] }

Returns Promise<GetTableState> get table state

get_key_accounts

GET/v2/state/get_key_accounts

get account by public key

Parameters
  • public_keystring Contract account targeted by the action.
Examples
constresponse=awaitrpc.get_key_accounts("EOS5Mto3Km6BCVxowb6LkkFaT9oaUwLVgswgcxvY4Qgc4rhHry4Tv");console.log(response.account_names);// => [ 'eoscafeblock' ]

Returns Promise<GetKeyAccounts> key accounts

get_tokens

GET /v2/state/get_tokens

get tokens

Parameters
Examples
constresponse=awaitrpc.get_tokens("eosnationftw");for(consttokenofresponse.tokens){console.log(token);// => { symbol: 'ZOS', precision: 4, amount: 140, contract: 'zosdiscounts' }}

Returns Promise<GetTokens> get tokens

get_transaction

GET /v2/history/get_transaction

get all actions belonging to the same transaction

Parameters
Examples
constresponse=awaitrpc.get_transaction("42dacd5722001b734be46a2140917e06cd21d42425f927f506c07b4388b07f62");for(constactionofresponse.actions){console.log(action);// => { act: { account: 'eosio', name: 'buyrambytes', ... }}}

Returns Promise<GetTransaction> transaction

RpcError

RpcStatusError

About

Hyperion History HTTP API

Resources

Stars

30 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages