{ "swagger": "2.0", "info": { "title": "Hyperion History API for UPLAND Chain", "description": "\n\n### Scalable Full History API Solution for EOSIO based blockchains\n*Made with \u2665\ufe0f by [EOS Rio](https://eosrio.io/)*\n***\n#### Current Chain: UPLAND Chain \n#### Provided by [UPLAND](https://leaswb-us-east-hyp01.uplnd.net)\n#### Health API: https://10.0.3.200:7000/v2/health\n", "version": "3.3.10" }, "definitions": { "def-0": { "title": "Integer", "description": "Integer or String", "anyOf": [ { "type": "string", "pattern": "^\\d+$" }, { "type": "integer" } ] }, "def-1": { "type": "string", "description": "A symbol composed of capital letters between 1-7.", "pattern": "^([A-Z]{1,7})$", "title": "Symbol" }, "def-2": { "type": "string", "description": "String representation of an EOSIO compatible cryptographic signature", "pattern": "^SIG_([RK]1|WA)_[1-9A-HJ-NP-Za-km-z]+$", "title": "Signature" }, "def-3": { "description": "String representation of an EOSIO compatible account name", "anyOf": [ { "type": "string", "description": "String representation of privileged EOSIO name type", "pattern": "^(eosio[\\.][a-z1-5]{1,6})([a-j]{1})?$", "title": "NamePrivileged" }, { "type": "string", "description": "String representation of basic EOSIO name type, must be 12 characters and contain only a-z and 0-5", "pattern": "^([a-z]{1}[a-z1-5]{11})([a-j]{1})?$", "title": "NameBasic" }, { "type": "string", "description": "String representation of EOSIO bid name type, 1-12 characters and only a-z and 0-5 are allowed", "pattern": "^([a-z1-5]{1,12})([a-j]{1})?$", "title": "NameBid" }, { "type": "string", "description": "String representation of EOSIO name type", "pattern": "^([a-z1-5]{1}[a-z1-5\\.]{0,10}[a-z1-5]{1})([a-j]{1})?$", "title": "NameCatchAll" } ], "title": "Name" }, "def-4": { "description": "Time that transaction must be confirmed by.", "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$", "title": "DateTime" }, "def-5": { "type": "array", "items": { "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "title": "Extension" }, "def-6": { "type": "object", "additionalProperties": false, "minProperties": 5, "required": [ "account", "name", "authorization", "data", "hex_data" ], "properties": { "account": { "$ref": "#/definitions/def-3" }, "name": { "$ref": "#/definitions/def-3" }, "authorization": { "type": "array", "items": { "type": "object", "additionalProperties": false, "minProperties": 2, "required": [ "actor", "permission" ], "properties": { "actor": { "$ref": "#/definitions/def-3" }, "permission": { "$ref": "#/definitions/def-3" } }, "title": "Authority" } }, "data": { "type": "object", "additionalProperties": true }, "hex_data": { "type": "string" } }, "title": "Action" } }, "paths": { "/": { "get": { "responses": { "200": { "description": "Default Response" } } } }, "/v2/get_filters": { "get": { "summary": "Active Filters on the Indexer", "tags": [ "status" ], "responses": { "200": { "description": "Default Response" } } } }, "/v2/health": { "get": { "summary": "API Service Health Report", "tags": [ "status" ], "responses": { "200": { "description": "Default Response" } } } }, "/v2/history/check_transaction": { "get": { "summary": "check if a transaction was included in a block", "description": "check if a transaction was included in a block", "tags": [ "history" ], "parameters": [ { "description": "transaction id", "type": "string", "minLength": 64, "maxLength": 64, "required": true, "in": "query", "name": "id" } ], "responses": { "200": { "description": "Default Response", "schema": { "type": "object", "properties": { "query_time_ms": { "type": "number" }, "cached": { "type": "boolean" }, "hot_only": { "type": "boolean" }, "lib": { "type": "number" }, "last_indexed_block": { "type": "number" }, "last_indexed_block_time": { "type": "string" }, "total": { "type": "object", "properties": { "value": { "type": "number" }, "relation": { "type": "string" } } }, "id": { "type": "string" }, "status": { "type": "string" }, "block_num": { "type": "number" }, "root_action": { "type": "object", "properties": { "account": { "type": "string" }, "name": { "type": "string" }, "authorization": { "type": "array", "items": { "type": "object", "properties": { "actor": { "type": "string" }, "permission": { "type": "string" } } } }, "data": { "type": "string" } } }, "signatures": { "type": "array", "items": { "type": "string" } } } } } } } }, "/v2/history/get_abi_snapshot": { "get": { "summary": "fetch abi at specific block", "description": "fetch contract abi at specific block", "tags": [ "history" ], "parameters": [ { "description": "contract account", "type": "string", "minLength": 1, "maxLength": 12, "required": true, "in": "query", "name": "contract" }, { "description": "target block", "type": "integer", "minimum": 1, "required": false, "in": "query", "name": "block" }, { "description": "should fetch the ABI", "type": "boolean", "required": false, "in": "query", "name": "fetch" } ], "responses": { "200": { "description": "Default Response" } } } }, "/v2/history/get_actions": { "get": { "summary": "get root actions", "description": "get actions based on notified account. this endpoint also accepts generic filters based on indexed fields (e.g. act.authorization.actor=eosio or act.name=delegatebw), if included they will be combined with a AND operator", "tags": [ "history" ], "parameters": [ { "description": "limit of [n] results per page", "type": "integer", "minimum": 1, "required": false, "in": "query", "name": "limit" }, { "description": "skip [n] results", "type": "integer", "minimum": 0, "required": false, "in": "query", "name": "skip" }, { "description": "notified account", "type": "string", "minLength": 1, "maxLength": 12, "required": false, "in": "query", "name": "account" }, { "description": "total results to track (count) [number or true]", "type": "string", "required": false, "in": "query", "name": "track" }, { "description": "code:name filter", "type": "string", "minLength": 3, "required": false, "in": "query", "name": "filter" }, { "description": "sort direction", "enum": [ "desc", "asc", "1", "-1" ], "type": "string", "required": false, "in": "query", "name": "sort" }, { "description": "filter after specified date (ISO8601)", "type": "string", "required": false, "in": "query", "name": "after" }, { "description": "filter before specified date (ISO8601)", "type": "string", "required": false, "in": "query", "name": "before" }, { "description": "simplified output mode", "type": "boolean", "required": false, "in": "query", "name": "simple" }, { "description": "search only the latest hot index", "type": "boolean", "required": false, "in": "query", "name": "hot_only" }, { "description": "exclude large binary data", "type": "boolean", "required": false, "in": "query", "name": "noBinary" }, { "description": "perform reversibility check", "type": "boolean", "required": false, "in": "query", "name": "checkLib" } ], "responses": { "200": { "description": "Default Response", "schema": { "type": "object", "properties": { "query_time_ms": { "type": "number" }, "cached": { "type": "boolean" }, "hot_only": { "type": "boolean" }, "lib": { "type": "number" }, "last_indexed_block": { "type": "number" }, "last_indexed_block_time": { "type": "string" }, "total": { "type": "object", "properties": { "value": { "type": "number" }, "relation": { "type": "string" } } }, "simple_actions": { "type": "array", "items": { "type": "object", "properties": { "block": { "type": "number" }, "timestamp": { "type": "string" }, "irreversible": { "type": "boolean" }, "contract": { "type": "string" }, "action": { "type": "string" }, "actors": { "type": "string" }, "notified": { "type": "string" }, "transaction_id": { "type": "string" }, "data": { "additionalProperties": true, "type": "object" } } } }, "actions": { "type": "array", "items": { "type": "object", "properties": { "@timestamp": { "type": "string" }, "timestamp": { "type": "string" }, "block_num": { "type": "number" }, "block_id": { "type": "string" }, "trx_id": { "type": "string" }, "act": { "type": "object", "properties": { "account": { "type": "string" }, "name": { "type": "string" }, "authorization": { "type": "array", "items": { "type": "object", "properties": { "actor": { "type": "string" }, "permission": { "type": "string" } } } } }, "additionalProperties": true }, "receipts": { "type": "array", "items": { "type": "object", "properties": { "receiver": { "type": "string" }, "global_sequence": { "type": "number" }, "recv_sequence": { "type": "number" }, "auth_sequence": { "type": "array", "items": { "type": "object", "properties": { "account": { "type": "string" }, "sequence": { "type": "number" } } } } } } }, "cpu_usage_us": { "type": "number" }, "net_usage_words": { "type": "number" }, "account_ram_deltas": { "type": "array", "items": { "type": "object", "properties": { "account": { "type": "string" }, "delta": { "type": "number" } }, "additionalProperties": true } }, "global_sequence": { "type": "number" }, "producer": { "type": "string" }, "parent": { "type": "number" }, "action_ordinal": { "type": "number" }, "creator_action_ordinal": { "type": "number" }, "signatures": { "type": "array", "items": { "type": "string" } } } } } } } } } } }, "/v2/history/export_actions": { "get": { "summary": "request large action data export", "description": "request large action data export", "tags": [ "history" ], "responses": { "200": { "description": "Default Response" } } } }, "/v2/history/get_created_accounts": { "get": { "summary": "get created accounts", "description": "get all accounts created by one creator", "tags": [ "accounts" ], "parameters": [ { "description": "limit of [n] results per page", "type": "integer", "minimum": 1, "required": false, "in": "query", "name": "limit" }, { "description": "skip [n] results", "type": "integer", "minimum": 0, "required": false, "in": "query", "name": "skip" }, { "description": "creator account", "type": "string", "minLength": 1, "maxLength": 12, "required": true, "in": "query", "name": "account" } ], "responses": { "200": { "description": "Default Response", "schema": { "type": "object", "properties": { "query_time_ms": { "type": "number" }, "cached": { "type": "boolean" }, "hot_only": { "type": "boolean" }, "lib": { "type": "number" }, "last_indexed_block": { "type": "number" }, "last_indexed_block_time": { "type": "string" }, "total": { "type": "object", "properties": { "value": { "type": "number" }, "relation": { "type": "string" } } }, "query_time": { "type": "number" }, "accounts": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "timestamp": { "type": "string" }, "trx_id": { "type": "string" } } } } } } } } } }, "/v2/history/get_creator": { "get": { "summary": "get account creator", "description": "get account creator", "tags": [ "accounts" ], "parameters": [ { "description": "created account", "type": "string", "minLength": 1, "maxLength": 12, "required": true, "in": "query", "name": "account" } ], "responses": { "200": { "description": "Default Response", "schema": { "type": "object", "properties": { "query_time_ms": { "type": "number" }, "cached": { "type": "boolean" }, "hot_only": { "type": "boolean" }, "lib": { "type": "number" }, "last_indexed_block": { "type": "number" }, "last_indexed_block_time": { "type": "string" }, "total": { "type": "object", "properties": { "value": { "type": "number" }, "relation": { "type": "string" } } }, "account": { "type": "string" }, "creator": { "type": "string" }, "timestamp": { "type": "string" }, "block_num": { "type": "integer" }, "trx_id": { "type": "string" }, "indirect_creator": { "type": "string" } } } } } } }, "/v2/history/get_deltas": { "get": { "summary": "get state deltas", "description": "get state deltas", "tags": [ "history" ], "parameters": [ { "description": "limit of [n] results per page", "type": "integer", "minimum": 1, "required": false, "in": "query", "name": "limit" }, { "description": "skip [n] results", "type": "integer", "minimum": 0, "required": false, "in": "query", "name": "skip" }, { "description": "contract account", "type": "string", "required": false, "in": "query", "name": "code" }, { "description": "table scope", "type": "string", "required": false, "in": "query", "name": "scope" }, { "description": "table name", "type": "string", "required": false, "in": "query", "name": "table" }, { "description": "payer account", "type": "string", "required": false, "in": "query", "name": "payer" }, { "description": "filter after specified date (ISO8601)", "type": "string", "required": false, "in": "query", "name": "after" }, { "description": "filter before specified date (ISO8601)", "type": "string", "required": false, "in": "query", "name": "before" }, { "description": "delta present flag", "type": "number", "required": false, "in": "query", "name": "present" } ], "responses": { "200": { "description": "Default Response", "schema": { "type": "object", "properties": { "query_time_ms": { "type": "number" }, "cached": { "type": "boolean" }, "hot_only": { "type": "boolean" }, "lib": { "type": "number" }, "last_indexed_block": { "type": "number" }, "last_indexed_block_time": { "type": "string" }, "total": { "type": "object", "properties": { "value": { "type": "number" }, "relation": { "type": "string" } } }, "deltas": { "type": "array", "items": { "type": "object", "properties": { "timestamp": { "type": "string" }, "present": { "type": "number" }, "code": { "type": "string" }, "scope": { "type": "string" }, "table": { "type": "string" }, "primary_key": { "type": "string" }, "payer": { "type": "string" }, "block_num": { "type": "number" }, "block_id": { "type": "string" }, "data": { "type": "object", "additionalProperties": true } }, "additionalProperties": true } } } } } } } }, "/v2/history/get_schedule": { "get": { "summary": "get producer schedule by version", "description": "get producer schedule by version", "tags": [ "history" ], "parameters": [ { "description": "search by producer", "type": "string", "required": false, "in": "query", "name": "producer" }, { "description": "search by signing key", "type": "string", "required": false, "in": "query", "name": "key" }, { "description": "filter after specified date (ISO8601)", "type": "string", "required": false, "in": "query", "name": "after" }, { "description": "filter before specified date (ISO8601)", "type": "string", "required": false, "in": "query", "name": "before" }, { "description": "search mode (activated or proposed)", "type": "string", "required": false, "in": "query", "name": "mode" }, { "description": "schedule version", "type": "integer", "minimum": 1, "required": false, "in": "query", "name": "version" } ], "responses": { "200": { "description": "Default Response", "schema": { "type": "object", "properties": { "query_time_ms": { "type": "number" }, "cached": { "type": "boolean" }, "hot_only": { "type": "boolean" }, "lib": { "type": "number" }, "last_indexed_block": { "type": "number" }, "last_indexed_block_time": { "type": "string" }, "total": { "type": "object", "properties": { "value": { "type": "number" }, "relation": { "type": "string" } } }, "timestamp": { "type": "string" }, "block_num": { "type": "number" }, "proposed_block_num": { "type": "number" }, "version": { "type": "number" }, "producers": { "type": "array", "items": { "type": "object", "properties": { "producer_name": { "type": "string" }, "name": { "type": "string" }, "block_signing_key": { "type": "string" }, "legacy_key": { "type": "string" }, "keys": { "type": "array", "items": { "type": "string" } } } } } } } } } } }, "/v2/history/get_table_state": { "get": { "summary": "get table state at a specific block height", "description": "get table state at a specific block height", "tags": [ "history" ], "parameters": [ { "description": "search by contract", "type": "string", "required": true, "in": "query", "name": "code" }, { "description": "search by key", "type": "string", "required": true, "in": "query", "name": "table" }, { "description": "target block", "type": "integer", "minimum": 1, "required": false, "in": "query", "name": "block_num" }, { "description": "last key for pagination", "type": "string", "required": false, "in": "query", "name": "after_key" } ], "responses": { "200": { "description": "Default Response", "schema": { "type": "object", "properties": { "query_time_ms": { "type": "number" }, "cached": { "type": "boolean" }, "hot_only": { "type": "boolean" }, "lib": { "type": "number" }, "last_indexed_block": { "type": "number" }, "last_indexed_block_time": { "type": "string" }, "total": { "type": "object", "properties": { "value": { "type": "number" }, "relation": { "type": "string" } } }, "code": { "type": "string" }, "table": { "type": "string" }, "block_num": { "type": "number" }, "after_key": { "type": "string" }, "next_key": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "properties": { "scope": { "type": "string" }, "primary_key": { "type": "string" }, "payer": { "type": "string" }, "timestamp": { "type": "string" }, "block_num": { "type": "number" }, "block_id": { "type": "string" }, "present": { "type": "number" }, "data": { "type": "object", "additionalProperties": true } }, "additionalProperties": true } } } } } } } }, "/v2/history/get_transaction": { "get": { "summary": "get transaction by id", "description": "get all actions belonging to the same transaction", "tags": [ "history" ], "parameters": [ { "description": "transaction id", "type": "string", "required": true, "in": "query", "name": "id" }, { "description": "block hint to speed up tx recovery", "type": "integer", "required": false, "in": "query", "name": "block_hint" } ], "responses": { "200": { "description": "Default Response" } } } }, "/v2/history/get_transaction_legacy": { "get": { "summary": "get transaction by id", "description": "get all actions belonging to the same transaction", "tags": [ "history" ], "parameters": [ { "description": "transaction id", "type": "string", "required": true, "in": "query", "name": "id" } ], "responses": { "200": { "description": "Default Response" } } } }, "/v2/state/get_account": { "get": { "summary": "get account summary", "description": "get account data", "tags": [ "accounts" ], "parameters": [ { "description": "limit of [n] results per page", "type": "integer", "minimum": 1, "required": false, "in": "query", "name": "limit" }, { "description": "skip [n] results", "type": "integer", "minimum": 0, "required": false, "in": "query", "name": "skip" }, { "description": "account name", "type": "string", "minLength": 1, "maxLength": 12, "required": true, "in": "query", "name": "account" } ], "responses": { "200": { "description": "Default Response", "schema": { "type": "object", "properties": { "query_time_ms": { "type": "number" }, "cached": { "type": "boolean" }, "hot_only": { "type": "boolean" }, "lib": { "type": "number" }, "last_indexed_block": { "type": "number" }, "last_indexed_block_time": { "type": "string" }, "total": { "type": "object", "properties": { "value": { "type": "number" }, "relation": { "type": "string" } } }, "account": { "additionalProperties": true, "type": "object" }, "links": { "type": "array", "items": { "type": "object", "properties": { "timestamp": { "type": "string" }, "permission": { "type": "string" }, "code": { "type": "string" }, "action": { "type": "string" } } } }, "tokens": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string" }, "precision": { "type": "integer" }, "amount": { "type": "number" }, "contract": { "type": "string" } } } }, "total_actions": { "type": "number" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "@timestamp": { "type": "string" }, "timestamp": { "type": "string" }, "block_num": { "type": "number" }, "block_id": { "type": "string" }, "trx_id": { "type": "string" }, "act": { "type": "object", "properties": { "account": { "type": "string" }, "name": { "type": "string" }, "authorization": { "type": "array", "items": { "type": "object", "properties": { "actor": { "type": "string" }, "permission": { "type": "string" } } } } }, "additionalProperties": true }, "receipts": { "type": "array", "items": { "type": "object", "properties": { "receiver": { "type": "string" }, "global_sequence": { "type": "number" }, "recv_sequence": { "type": "number" }, "auth_sequence": { "type": "array", "items": { "type": "object", "properties": { "account": { "type": "string" }, "sequence": { "type": "number" } } } } } } }, "cpu_usage_us": { "type": "number" }, "net_usage_words": { "type": "number" }, "account_ram_deltas": { "type": "array", "items": { "type": "object", "properties": { "account": { "type": "string" }, "delta": { "type": "number" } }, "additionalProperties": true } }, "global_sequence": { "type": "number" }, "producer": { "type": "string" }, "parent": { "type": "number" }, "action_ordinal": { "type": "number" }, "creator_action_ordinal": { "type": "number" }, "signatures": { "type": "array", "items": { "type": "string" } } } } } } } } } } }, "/v2/state/get_key_accounts": { "get": { "summary": "get accounts by public key", "description": "get accounts by public key", "tags": [ "accounts" ], "parameters": [ { "description": "limit of [n] results per page", "type": "integer", "minimum": 1, "required": false, "in": "query", "name": "limit" }, { "description": "skip [n] results", "type": "integer", "minimum": 0, "required": false, "in": "query", "name": "skip" }, { "description": "public key", "type": "string", "required": true, "in": "query", "name": "public_key" }, { "description": "include permission details", "type": "boolean", "required": false, "in": "query", "name": "details" } ], "responses": { "200": { "description": "Default Response", "schema": { "type": "object", "properties": { "account_names": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "object", "properties": { "owner": { "type": "string" }, "block_num": { "type": "integer" }, "parent": { "type": "string" }, "last_updated": { "type": "string" }, "auth": {}, "name": { "type": "string" }, "present": { "type": "number" } } } } } } } } }, "post": { "summary": "get accounts by public key", "description": "get accounts by public key", "tags": [ "accounts", "state" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "public_key": { "description": "public key", "type": "string" } }, "required": [ "public_key" ] } } ], "responses": { "200": { "description": "Default Response", "schema": { "type": "object", "properties": { "account_names": { "type": "array", "items": { "type": "string" } } } } } } } }, "/v2/state/get_links": { "get": { "summary": "get permission links", "description": "get permission links", "tags": [ "accounts" ], "parameters": [ { "description": "account name", "type": "string", "required": false, "in": "query", "name": "account" }, { "description": "contract name", "type": "string", "required": false, "in": "query", "name": "code" }, { "description": "method name", "type": "string", "required": false, "in": "query", "name": "action" }, { "description": "permission name", "type": "string", "required": false, "in": "query", "name": "permission" } ], "responses": { "200": { "description": "Default Response", "schema": { "type": "object", "properties": { "query_time_ms": { "type": "number" }, "cached": { "type": "boolean" }, "hot_only": { "type": "boolean" }, "lib": { "type": "number" }, "last_indexed_block": { "type": "number" }, "last_indexed_block_time": { "type": "string" }, "total": { "type": "object", "properties": { "value": { "type": "number" }, "relation": { "type": "string" } } }, "links": { "type": "array", "items": { "type": "object", "properties": { "block_num": { "type": "number" }, "timestamp": { "type": "string" }, "account": { "type": "string" }, "permission": { "type": "string" }, "code": { "type": "string" }, "action": { "type": "string" }, "irreversible": { "type": "boolean" } } } } } } } } } }, "/v2/state/get_proposals": { "get": { "summary": "get proposals", "description": "get proposals", "tags": [ "system" ], "parameters": [ { "description": "filter by proposer", "type": "string", "required": false, "in": "query", "name": "proposer" }, { "description": "filter by proposal name", "type": "string", "required": false, "in": "query", "name": "proposal" }, { "description": "filter by either requested or provided account", "type": "string", "required": false, "in": "query", "name": "account" }, { "description": "filter by requested account", "type": "string", "required": false, "in": "query", "name": "requested" }, { "description": "filter by provided account", "type": "string", "required": false, "in": "query", "name": "provided" }, { "description": "filter by execution status", "type": "boolean", "required": false, "in": "query", "name": "executed" }, { "description": "total results to track (count) [number or true]", "type": "string", "required": false, "in": "query", "name": "track" }, { "description": "skip [n] actions (pagination)", "type": "integer", "minimum": 0, "required": false, "in": "query", "name": "skip" }, { "description": "limit of [n] actions per page", "type": "integer", "minimum": 1, "required": false, "in": "query", "name": "limit" } ], "responses": { "200": { "description": "Default Response" } } } }, "/v2/state/get_tokens": { "get": { "summary": "get all tokens", "description": "get tokens from an account", "tags": [ "accounts" ], "parameters": [ { "description": "limit of [n] results per page", "type": "integer", "minimum": 1, "required": false, "in": "query", "name": "limit" }, { "description": "skip [n] results", "type": "integer", "minimum": 0, "required": false, "in": "query", "name": "skip" }, { "description": "account name", "type": "string", "minLength": 1, "maxLength": 12, "required": true, "in": "query", "name": "account" } ], "responses": { "200": { "description": "Default Response" } } } }, "/v2/state/get_top_holders": { "get": { "summary": "get top token holders", "description": "get the list of top holders for a given token", "tags": [ "accounts" ], "parameters": [ { "description": "limit of [n] results per page", "type": "integer", "minimum": 1, "required": false, "in": "query", "name": "limit" }, { "description": "skip [n] results", "type": "integer", "minimum": 0, "required": false, "in": "query", "name": "skip" }, { "description": "token contract account name", "type": "string", "minLength": 1, "maxLength": 12, "required": true, "in": "query", "name": "contract" }, { "description": "filter by token symbol", "type": "string", "required": false, "in": "query", "name": "symbol" } ], "responses": { "200": { "description": "Default Response" } } } }, "/v2/state/get_voters": { "get": { "summary": "get voters", "description": "get voters", "tags": [ "system" ], "parameters": [ { "description": "limit of [n] results per page", "type": "integer", "minimum": 1, "required": false, "in": "query", "name": "limit" }, { "description": "skip [n] results", "type": "integer", "minimum": 0, "required": false, "in": "query", "name": "skip" }, { "description": "filter by voted producer (comma separated)", "type": "string", "minLength": 1, "maxLength": 12, "required": false, "in": "query", "name": "producer" } ], "responses": { "200": { "description": "Default Response", "schema": { "type": "object", "properties": { "query_time_ms": { "type": "number" }, "cached": { "type": "boolean" }, "hot_only": { "type": "boolean" }, "lib": { "type": "number" }, "last_indexed_block": { "type": "number" }, "last_indexed_block_time": { "type": "string" }, "total": { "type": "object", "properties": { "value": { "type": "number" }, "relation": { "type": "string" } } }, "voters": { "type": "array", "items": { "type": "object", "properties": { "account": { "type": "string" }, "weight": { "type": "number" }, "last_vote": { "type": "number" }, "data": { "additionalProperties": true, "type": "object" } } } } } } } } } }, "/v2/stats/get_action_usage": { "get": { "summary": "get action and transaction stats for a given period", "description": "get action and transaction stats for a given period", "tags": [ "stats" ], "parameters": [ { "description": "analysis period", "type": "string", "required": true, "in": "query", "name": "period" }, { "description": "final date", "type": "string", "required": false, "in": "query", "name": "end_date" }, { "description": "compute unique actors", "type": "boolean", "required": false, "in": "query", "name": "unique_actors" } ], "responses": { "200": { "description": "Default Response" } } } }, "/v2/stats/get_api_usage": { "get": { "summary": "get hyperion api usage statistics", "description": "get hyperion api usage statistics", "tags": [ "stats" ], "responses": { "200": { "description": "Default Response", "schema": { "type": "object", "properties": { "query_time_ms": { "type": "number" }, "cached": { "type": "boolean" }, "hot_only": { "type": "boolean" }, "lib": { "type": "number" }, "last_indexed_block": { "type": "number" }, "last_indexed_block_time": { "type": "string" }, "total": { "type": "object", "properties": { "responses": { "additionalProperties": true, "type": "object" } } }, "buckets": { "type": "array", "items": { "type": "object", "properties": { "timestamp": { "type": "string" }, "responses": { "additionalProperties": true, "type": "object" } } } } } } } } } }, "/v2/stats/get_missed_blocks": { "get": { "summary": "get missed blocks", "description": "get missed blocks", "tags": [ "stats" ], "parameters": [ { "description": "filter by producer", "type": "string", "required": false, "in": "query", "name": "producer" }, { "description": "filter after specified date (ISO8601)", "type": "string", "required": false, "in": "query", "name": "after" }, { "description": "filter before specified date (ISO8601)", "type": "string", "required": false, "in": "query", "name": "before" }, { "description": "min. blocks threshold", "type": "integer", "minimum": 1, "required": false, "in": "query", "name": "min_blocks" } ], "responses": { "200": { "description": "Default Response", "schema": { "type": "object", "properties": { "query_time_ms": { "type": "number" }, "cached": { "type": "boolean" }, "hot_only": { "type": "boolean" }, "lib": { "type": "number" }, "last_indexed_block": { "type": "number" }, "last_indexed_block_time": { "type": "string" }, "total": { "type": "object", "properties": { "value": { "type": "number" }, "relation": { "type": "string" } } }, "stats": { "type": "object", "properties": { "by_producer": {} } }, "events": { "type": "array", "items": { "type": "object", "properties": { "@timestamp": { "type": "string" }, "last_block": { "type": "number" }, "schedule_version": { "type": "number" }, "size": { "type": "number" }, "producer": { "type": "string" } } } } } } } } } }, "/v2/stats/get_resource_usage": { "get": { "summary": "get resource usage stats for a specific action", "description": "get resource usage stats for a specific action", "tags": [ "stats" ], "parameters": [ { "description": "contract", "type": "string", "required": true, "in": "query", "name": "code" }, { "description": "action name", "type": "string", "required": true, "in": "query", "name": "action" } ], "responses": { "200": { "description": "Default Response" } } } }, "/v1/history/get_actions": { "post": { "summary": "get actions", "description": "legacy get actions query", "tags": [ "history" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": [ "object", "string" ], "properties": { "account_name": { "description": "notified account", "type": "string", "minLength": 1, "maxLength": 12 }, "pos": { "description": "action position (pagination)", "type": "integer" }, "offset": { "description": "limit of [n] actions per page", "type": "integer" }, "filter": { "description": "code:name filter", "type": "string", "minLength": 3 }, "sort": { "description": "sort direction", "enum": [ "desc", "asc", "1", "-1" ], "type": "string" }, "after": { "description": "filter after specified date (ISO8601)", "type": "string", "format": "date-time" }, "before": { "description": "filter before specified date (ISO8601)", "type": "string", "format": "date-time" }, "parent": { "description": "filter by parent global sequence", "type": "integer", "minimum": 0 } } } } ], "responses": { "200": { "description": "Default Response", "schema": { "type": "object", "properties": { "query_time": { "type": "number" }, "last_irreversible_block": { "type": "number" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "account_action_seq": { "type": "number" }, "global_action_seq": { "type": "number" }, "block_num": { "type": "number" }, "block_time": { "type": "string" }, "action_trace": { "type": "object", "properties": { "action_ordinal": { "type": "number" }, "creator_action_ordinal": { "type": "number" }, "receipt": { "type": "object", "properties": { "receiver": { "type": "string" }, "global_sequence": { "type": "number" }, "recv_sequence": { "type": "number" }, "auth_sequence": { "type": "array", "items": { "type": "object", "properties": { "account": { "type": "string" }, "sequence": { "type": "number" } } } } } }, "receiver": { "type": "string" }, "act": { "type": "object", "properties": { "account": { "type": "string" }, "name": { "type": "string" }, "authorization": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "data": { "type": "object", "additionalProperties": true }, "hex_data": { "type": "string" } } }, "trx_id": { "type": "string" }, "block_num": { "type": "number" }, "block_time": { "type": "string" } } } } } } } } } } } }, "/v1/history/get_controlled_accounts": { "post": { "summary": "get controlled accounts by controlling accounts", "description": "get controlled accounts by controlling accounts", "tags": [ "accounts" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": [ "object", "string" ], "properties": { "controlling_account": { "description": "controlling account", "type": "string" } }, "required": [ "controlling_account" ] } } ], "responses": { "200": { "description": "Default Response", "schema": { "type": "object", "properties": { "controlled_accounts": { "type": "array", "items": { "type": "string" } } } } } } } }, "/v1/history/get_transaction": { "post": { "summary": "get transaction by id", "description": "get all actions belonging to the same transaction", "tags": [ "history" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": [ "object", "string" ], "properties": { "id": { "description": "transaction id", "type": "string" }, "block_num_hint": { "description": "block number hint", "type": "integer" } }, "required": [ "id" ] } } ], "responses": { "200": { "description": "Default Response" } } } }, "/v1/history/get_key_accounts": { "post": { "summary": "get accounts by public key", "description": "get accounts by public key", "tags": [ "accounts" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": [ "object", "string" ], "properties": { "public_key": { "description": "public key", "type": "string" } }, "required": [ "public_key" ] } } ], "responses": { "200": { "description": "Default Response", "schema": { "type": "object", "properties": { "account_names": { "type": "array", "items": { "type": "string" } } } } } } } }, "/v1/trace_api/get_block": { "post": { "summary": "get block traces", "description": "get block traces", "tags": [ "history" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": [ "object", "string" ], "properties": { "block_num": { "description": "block number", "type": "integer" }, "block_id": { "description": "block id", "type": "string" } } } } ], "responses": { "200": { "description": "Default Response", "schema": { "type": "object", "properties": { "query_time_ms": { "type": "number" }, "cached": { "type": "boolean" }, "hot_only": { "type": "boolean" }, "lib": { "type": "number" }, "last_indexed_block": { "type": "number" }, "last_indexed_block_time": { "type": "string" }, "total": { "type": "object", "properties": { "value": { "type": "number" }, "relation": { "type": "string" } } }, "id": { "type": "string" }, "number": { "type": "integer" }, "previous_id": { "type": "string" }, "status": { "type": "string" }, "timestamp": { "type": "string" }, "producer": { "type": "string" }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "receiver": { "type": "string" }, "account": { "type": "string" }, "action": { "type": "string" }, "authorization": { "type": "array", "items": { "type": "object", "properties": { "account": { "type": "string" }, "permission": { "type": "string" } } } }, "data": { "additionalProperties": true, "type": "object" } } } } } } } } } } } } }, "/v1/chain/abi_bin_to_json": { "get": { "summary": "Returns an object containing rows from the specified table.", "description": "Returns an object containing rows from the specified table.", "tags": [ "chain" ], "parameters": [ { "$ref": "#/definitions/def-3", "required": true, "in": "query", "name": "code" }, { "$ref": "#/definitions/def-3", "required": true, "in": "query", "name": "action" }, { "type": "string", "required": true, "in": "query", "name": "binargs" } ], "responses": { "200": { "description": "Default Response" } } }, "head": { "summary": "Returns an object containing rows from the specified table.", "description": "Returns an object containing rows from the specified table.", "tags": [ "chain" ], "parameters": [ { "$ref": "#/definitions/def-3", "required": true, "in": "query", "name": "code" }, { "$ref": "#/definitions/def-3", "required": true, "in": "query", "name": "action" }, { "type": "string", "required": true, "in": "query", "name": "binargs" } ], "responses": { "200": { "description": "Default Response" } } }, "post": { "summary": "Returns an object containing rows from the specified table.", "description": "Returns an object containing rows from the specified table.", "tags": [ "chain" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": [ "object", "string" ], "properties": { "code": { "$ref": "#/definitions/def-3" }, "action": { "$ref": "#/definitions/def-3" }, "binargs": { "type": "string" } }, "required": [ "code", "action", "binargs" ] } } ], "responses": { "200": { "description": "Default Response" } } } }, "/v1/chain/abi_json_to_bin": { "get": { "summary": "Convert JSON object to binary", "description": "Convert JSON object to binary", "tags": [ "chain" ], "parameters": [ { "$ref": "#/definitions/def-3", "required": true, "in": "query", "name": "code" }, { "$ref": "#/definitions/def-3", "required": true, "in": "query", "name": "action" }, { "type": "object", "additionalProperties": true, "required": true, "in": "query", "name": "args" } ], "responses": { "200": { "description": "Default Response" } } }, "head": { "summary": "Convert JSON object to binary", "description": "Convert JSON object to binary", "tags": [ "chain" ], "parameters": [ { "$ref": "#/definitions/def-3", "required": true, "in": "query", "name": "code" }, { "$ref": "#/definitions/def-3", "required": true, "in": "query", "name": "action" }, { "type": "object", "additionalProperties": true, "required": true, "in": "query", "name": "args" } ], "responses": { "200": { "description": "Default Response" } } }, "post": { "summary": "Convert JSON object to binary", "description": "Convert JSON object to binary", "tags": [ "chain" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": [ "object", "string" ], "properties": { "code": { "$ref": "#/definitions/def-3" }, "action": { "$ref": "#/definitions/def-3" }, "args": { "type": "object", "additionalProperties": true } }, "required": [ "code", "action", "args" ] } } ], "responses": { "200": { "description": "Default Response" } } } }, "/v1/chain/get_abi": { "get": { "summary": "Retrieves the ABI for a contract based on its account name", "description": "Retrieves the ABI for a contract based on its account name", "tags": [ "chain" ], "parameters": [ { "$ref": "#/definitions/def-3", "required": true, "in": "query", "name": "account_name" } ], "responses": { "200": { "description": "Default Response" } } }, "head": { "summary": "Retrieves the ABI for a contract based on its account name", "description": "Retrieves the ABI for a contract based on its account name", "tags": [ "chain" ], "parameters": [ { "$ref": "#/definitions/def-3", "required": true, "in": "query", "name": "account_name" } ], "responses": { "200": { "description": "Default Response" } } }, "post": { "summary": "Retrieves the ABI for a contract based on its account name", "description": "Retrieves the ABI for a contract based on its account name", "tags": [ "chain" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": [ "object", "string" ], "properties": { "account_name": { "$ref": "#/definitions/def-3" } }, "required": [ "account_name" ] } } ], "responses": { "200": { "description": "Default Response" } } } }, "/v1/chain/get_account": { "get": { "summary": "Returns an object containing various details about a specific account on the blockchain.", "description": "Returns an object containing various details about a specific account on the blockchain.", "tags": [ "chain" ], "parameters": [ { "$ref": "#/definitions/def-3", "required": true, "in": "query", "name": "account_name" } ], "responses": { "200": { "description": "Default Response" } } }, "head": { "summary": "Returns an object containing various details about a specific account on the blockchain.", "description": "Returns an object containing various details about a specific account on the blockchain.", "tags": [ "chain" ], "parameters": [ { "$ref": "#/definitions/def-3", "required": true, "in": "query", "name": "account_name" } ], "responses": { "200": { "description": "Default Response" } } }, "post": { "summary": "Returns an object containing various details about a specific account on the blockchain.", "description": "Returns an object containing various details about a specific account on the blockchain.", "tags": [ "chain" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": [ "object", "string" ], "properties": { "account_name": { "$ref": "#/definitions/def-3" } }, "required": [ "account_name" ] } } ], "responses": { "200": { "description": "Default Response" } } } }, "/v1/chain/get_activated_protocol_features": { "get": { "summary": "Retreives the activated protocol features for producer node", "description": "Retreives the activated protocol features for producer node", "tags": [ "chain" ], "parameters": [ { "type": "integer", "description": "Lower bound", "required": false, "in": "query", "name": "lower_bound" }, { "type": "integer", "description": "Upper bound", "required": false, "in": "query", "name": "upper_bound" }, { "type": "integer", "description": "The limit, default is 10", "required": false, "in": "query", "name": "limit" }, { "type": "boolean", "description": "Flag to indicate it is has to search by block number", "required": false, "in": "query", "name": "search_by_block_num" }, { "type": "boolean", "description": "Flag to indicate it has to search in reverse", "required": false, "in": "query", "name": "reverse" } ], "responses": { "200": { "description": "Default Response" } } }, "head": { "summary": "Retreives the activated protocol features for producer node", "description": "Retreives the activated protocol features for producer node", "tags": [ "chain" ], "parameters": [ { "type": "integer", "description": "Lower bound", "required": false, "in": "query", "name": "lower_bound" }, { "type": "integer", "description": "Upper bound", "required": false, "in": "query", "name": "upper_bound" }, { "type": "integer", "description": "The limit, default is 10", "required": false, "in": "query", "name": "limit" }, { "type": "boolean", "description": "Flag to indicate it is has to search by block number", "required": false, "in": "query", "name": "search_by_block_num" }, { "type": "boolean", "description": "Flag to indicate it has to search in reverse", "required": false, "in": "query", "name": "reverse" } ], "responses": { "200": { "description": "Default Response" } } }, "post": { "summary": "Retreives the activated protocol features for producer node", "description": "Retreives the activated protocol features for producer node", "tags": [ "chain" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": [ "object", "string" ], "properties": { "lower_bound": { "type": "integer", "description": "Lower bound" }, "upper_bound": { "type": "integer", "description": "Upper bound" }, "limit": { "type": "integer", "description": "The limit, default is 10" }, "search_by_block_num": { "type": "boolean", "description": "Flag to indicate it is has to search by block number" }, "reverse": { "type": "boolean", "description": "Flag to indicate it has to search in reverse" } } } } ], "responses": { "200": { "description": "Default Response" } } } }, "/v1/chain/get_block": { "get": { "summary": "Returns an object containing various details about a specific block on the blockchain.", "description": "Returns an object containing various details about a specific block on the blockchain.", "tags": [ "chain" ], "parameters": [ { "description": "Provide a `block number` or a `block id`", "type": "string", "required": true, "in": "query", "name": "block_num_or_id" } ], "responses": { "200": { "description": "Default Response" } } }, "head": { "summary": "Returns an object containing various details about a specific block on the blockchain.", "description": "Returns an object containing various details about a specific block on the blockchain.", "tags": [ "chain" ], "parameters": [ { "description": "Provide a `block number` or a `block id`", "type": "string", "required": true, "in": "query", "name": "block_num_or_id" } ], "responses": { "200": { "description": "Default Response" } } }, "post": { "summary": "Returns an object containing various details about a specific block on the blockchain.", "description": "Returns an object containing various details about a specific block on the blockchain.", "tags": [ "chain" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": [ "object", "string" ], "properties": { "block_num_or_id": { "description": "Provide a `block number` or a `block id`", "type": "string" } }, "required": [ "block_num_or_id" ] } } ], "responses": { "200": { "description": "Default Response" } } } }, "/v1/chain/get_block_header_state": { "get": { "summary": "Retrieves the block header state", "description": "Retrieves the block header state", "tags": [ "chain" ], "parameters": [ { "type": "string", "description": "Provide a block_number or a block_id", "required": true, "in": "query", "name": "block_num_or_id" } ], "responses": { "200": { "description": "Default Response" } } }, "head": { "summary": "Retrieves the block header state", "description": "Retrieves the block header state", "tags": [ "chain" ], "parameters": [ { "type": "string", "description": "Provide a block_number or a block_id", "required": true, "in": "query", "name": "block_num_or_id" } ], "responses": { "200": { "description": "Default Response" } } }, "post": { "summary": "Retrieves the block header state", "description": "Retrieves the block header state", "tags": [ "chain" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": [ "object", "string" ], "properties": { "block_num_or_id": { "type": "string", "description": "Provide a block_number or a block_id" } }, "required": [ "block_num_or_id" ] } } ], "responses": { "200": { "description": "Default Response" } } } }, "/v1/chain/get_code": { "get": { "summary": "Retrieves contract code", "description": "Retrieves contract code", "tags": [ "chain" ], "parameters": [ { "$ref": "#/definitions/def-3", "required": true, "in": "query", "name": "account_name" }, { "type": "integer", "default": 1, "description": "This must be 1 (true)", "required": true, "in": "query", "name": "code_as_wasm" } ], "responses": { "200": { "description": "Default Response" } } }, "head": { "summary": "Retrieves contract code", "description": "Retrieves contract code", "tags": [ "chain" ], "parameters": [ { "$ref": "#/definitions/def-3", "required": true, "in": "query", "name": "account_name" }, { "type": "integer", "default": 1, "description": "This must be 1 (true)", "required": true, "in": "query", "name": "code_as_wasm" } ], "responses": { "200": { "description": "Default Response" } } }, "post": { "summary": "Retrieves contract code", "description": "Retrieves contract code", "tags": [ "chain" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": [ "object", "string" ], "properties": { "account_name": { "$ref": "#/definitions/def-3" }, "code_as_wasm": { "type": "integer", "default": 1, "description": "This must be 1 (true)" } }, "required": [ "account_name", "code_as_wasm" ] } } ], "responses": { "200": { "description": "Default Response" } } } }, "/v1/chain/get_currency_balance": { "get": { "summary": "Retrieves the current balance", "description": "Retrieves the current balance", "tags": [ "chain" ], "parameters": [ { "$ref": "#/definitions/def-3", "required": true, "in": "query", "name": "code" }, { "$ref": "#/definitions/def-3", "required": true, "in": "query", "name": "account" }, { "$ref": "#/definitions/def-1", "required": true, "in": "query", "name": "symbol" } ], "responses": { "200": { "description": "Default Response" } } }, "head": { "summary": "Retrieves the current balance", "description": "Retrieves the current balance", "tags": [ "chain" ], "parameters": [ { "$ref": "#/definitions/def-3", "required": true, "in": "query", "name": "code" }, { "$ref": "#/definitions/def-3", "required": true, "in": "query", "name": "account" }, { "$ref": "#/definitions/def-1", "required": true, "in": "query", "name": "symbol" } ], "responses": { "200": { "description": "Default Response" } } }, "post": { "summary": "Retrieves the current balance", "description": "Retrieves the current balance", "tags": [ "chain" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": [ "object", "string" ], "properties": { "code": { "$ref": "#/definitions/def-3" }, "account": { "$ref": "#/definitions/def-3" }, "symbol": { "$ref": "#/definitions/def-1" } }, "required": [ "code", "account", "symbol" ] } } ], "responses": { "200": { "description": "Default Response" } } } }, "/v1/chain/get_currency_stats": { "get": { "summary": "Retrieves currency stats", "description": "Retrieves currency stats", "tags": [ "chain" ], "parameters": [ { "$ref": "#/definitions/def-3", "required": true, "in": "query", "name": "code" }, { "description": "token symbol", "type": "string", "required": true, "in": "query", "name": "symbol" } ], "responses": { "200": { "description": "Default Response" } } }, "head": { "summary": "Retrieves currency stats", "description": "Retrieves currency stats", "tags": [ "chain" ], "parameters": [ { "$ref": "#/definitions/def-3", "required": true, "in": "query", "name": "code" }, { "description": "token symbol", "type": "string", "required": true, "in": "query", "name": "symbol" } ], "responses": { "200": { "description": "Default Response" } } }, "post": { "summary": "Retrieves currency stats", "description": "Retrieves currency stats", "tags": [ "chain" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": [ "object", "string" ], "properties": { "code": { "$ref": "#/definitions/def-3" }, "symbol": { "description": "token symbol", "type": "string" } }, "required": [ "code", "symbol" ] } } ], "responses": { "200": { "description": "Default Response" } } } }, "/v1/chain/get_info": { "get": { "summary": "Returns an object containing various details about the blockchain.", "description": "Returns an object containing various details about the blockchain.", "tags": [ "chain" ], "responses": { "200": { "description": "Default Response" } } }, "head": { "summary": "Returns an object containing various details about the blockchain.", "description": "Returns an object containing various details about the blockchain.", "tags": [ "chain" ], "responses": { "200": { "description": "Default Response" } } }, "post": { "summary": "Returns an object containing various details about the blockchain.", "description": "Returns an object containing various details about the blockchain.", "tags": [ "chain" ], "responses": { "200": { "description": "Default Response" } } } }, "/v1/chain/get_raw_abi": { "get": { "summary": "Retrieves raw ABI for a contract based on account name", "description": "Retrieves raw ABI for a contract based on account name", "tags": [ "chain" ], "parameters": [ { "$ref": "#/definitions/def-3", "required": true, "in": "query", "name": "account_name" } ], "responses": { "200": { "description": "Default Response" } } }, "head": { "summary": "Retrieves raw ABI for a contract based on account name", "description": "Retrieves raw ABI for a contract based on account name", "tags": [ "chain" ], "parameters": [ { "$ref": "#/definitions/def-3", "required": true, "in": "query", "name": "account_name" } ], "responses": { "200": { "description": "Default Response" } } }, "post": { "summary": "Retrieves raw ABI for a contract based on account name", "description": "Retrieves raw ABI for a contract based on account name", "tags": [ "chain" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": [ "object", "string" ], "properties": { "account_name": { "$ref": "#/definitions/def-3" } }, "required": [ "account_name" ] } } ], "responses": { "200": { "description": "Default Response" } } } }, "/v1/chain/get_producers": { "get": { "summary": "Retrieves producers list", "description": "Retrieves producers list", "tags": [ "chain" ], "parameters": [ { "type": "string", "description": "total number of producers to retrieve", "required": false, "in": "query", "name": "limit" }, { "type": "string", "description": "In conjunction with limit can be used to paginate through the results. For example, limit=10 and lower_bound=10 would be page 2", "required": false, "in": "query", "name": "lower_bound" }, { "type": "boolean", "description": "return result in JSON format", "required": false, "in": "query", "name": "json" } ], "responses": { "200": { "description": "Default Response" } } }, "head": { "summary": "Retrieves producers list", "description": "Retrieves producers list", "tags": [ "chain" ], "parameters": [ { "type": "string", "description": "total number of producers to retrieve", "required": false, "in": "query", "name": "limit" }, { "type": "string", "description": "In conjunction with limit can be used to paginate through the results. For example, limit=10 and lower_bound=10 would be page 2", "required": false, "in": "query", "name": "lower_bound" }, { "type": "boolean", "description": "return result in JSON format", "required": false, "in": "query", "name": "json" } ], "responses": { "200": { "description": "Default Response" } } }, "post": { "summary": "Retrieves producers list", "description": "Retrieves producers list", "tags": [ "chain" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": [ "object", "string" ], "properties": { "limit": { "type": "string", "description": "total number of producers to retrieve" }, "lower_bound": { "type": "string", "description": "In conjunction with limit can be used to paginate through the results. For example, limit=10 and lower_bound=10 would be page 2" }, "json": { "type": "boolean", "description": "return result in JSON format" } } } } ], "responses": { "200": { "description": "Default Response" } } } }, "/v1/chain/get_table_by_scope": { "get": { "summary": "Retrieves table scope", "description": "Retrieves table scope", "tags": [ "chain" ], "parameters": [ { "type": "string", "description": "`name` of the contract to return table data for", "required": true, "in": "query", "name": "code" }, { "type": "string", "description": "Filter results by table", "required": false, "in": "query", "name": "table" }, { "type": "string", "description": "Filters results to return the first element that is not less than provided value in set", "required": false, "in": "query", "name": "lower_bound" }, { "type": "string", "description": "Filters results to return the first element that is greater than provided value in set", "required": false, "in": "query", "name": "upper_bound" }, { "type": "integer", "description": "Limit number of results returned.", "required": false, "in": "query", "name": "limit" }, { "type": "boolean", "description": "Reverse the order of returned results", "required": false, "in": "query", "name": "reverse" } ], "responses": { "200": { "description": "Default Response" } } }, "head": { "summary": "Retrieves table scope", "description": "Retrieves table scope", "tags": [ "chain" ], "parameters": [ { "type": "string", "description": "`name` of the contract to return table data for", "required": true, "in": "query", "name": "code" }, { "type": "string", "description": "Filter results by table", "required": false, "in": "query", "name": "table" }, { "type": "string", "description": "Filters results to return the first element that is not less than provided value in set", "required": false, "in": "query", "name": "lower_bound" }, { "type": "string", "description": "Filters results to return the first element that is greater than provided value in set", "required": false, "in": "query", "name": "upper_bound" }, { "type": "integer", "description": "Limit number of results returned.", "required": false, "in": "query", "name": "limit" }, { "type": "boolean", "description": "Reverse the order of returned results", "required": false, "in": "query", "name": "reverse" } ], "responses": { "200": { "description": "Default Response" } } }, "post": { "summary": "Retrieves table scope", "description": "Retrieves table scope", "tags": [ "chain" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": [ "object", "string" ], "properties": { "code": { "type": "string", "description": "`name` of the contract to return table data for" }, "table": { "type": "string", "description": "Filter results by table" }, "lower_bound": { "type": "string", "description": "Filters results to return the first element that is not less than provided value in set" }, "upper_bound": { "type": "string", "description": "Filters results to return the first element that is greater than provided value in set" }, "limit": { "type": "integer", "description": "Limit number of results returned." }, "reverse": { "type": "boolean", "description": "Reverse the order of returned results" } }, "required": [ "code" ] } } ], "responses": { "200": { "description": "Default Response" } } } }, "/v1/chain/get_raw_code_and_abi": { "get": { "summary": "Retrieves raw code and ABI for a contract based on account name", "description": "Retrieves raw code and ABI for a contract based on account name", "tags": [ "chain" ], "parameters": [ { "$ref": "#/definitions/def-3", "required": true, "in": "query", "name": "account_name" } ], "responses": { "200": { "description": "Default Response" } } }, "head": { "summary": "Retrieves raw code and ABI for a contract based on account name", "description": "Retrieves raw code and ABI for a contract based on account name", "tags": [ "chain" ], "parameters": [ { "$ref": "#/definitions/def-3", "required": true, "in": "query", "name": "account_name" } ], "responses": { "200": { "description": "Default Response" } } }, "post": { "summary": "Retrieves raw code and ABI for a contract based on account name", "description": "Retrieves raw code and ABI for a contract based on account name", "tags": [ "chain" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": [ "object", "string" ], "properties": { "account_name": { "$ref": "#/definitions/def-3" } }, "required": [ "account_name" ] } } ], "responses": { "200": { "description": "Default Response" } } } }, "/v1/chain/get_scheduled_transaction": { "get": { "summary": "Retrieves the scheduled transaction", "description": "Retrieves the scheduled transaction", "tags": [ "chain" ], "parameters": [ { "type": "string", "description": "Date/time string in the format YYYY-MM-DDTHH:MM:SS.sss", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}$", "title": "DateTimeSeconds", "required": false, "in": "query", "name": "lower_bound" }, { "description": "The maximum number of transactions to return", "type": "integer", "required": false, "in": "query", "name": "limit" }, { "description": "true/false whether the packed transaction is converted to json", "type": "boolean", "required": false, "in": "query", "name": "json" } ], "responses": { "200": { "description": "Default Response" } } }, "head": { "summary": "Retrieves the scheduled transaction", "description": "Retrieves the scheduled transaction", "tags": [ "chain" ], "parameters": [ { "type": "string", "description": "Date/time string in the format YYYY-MM-DDTHH:MM:SS.sss", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}$", "title": "DateTimeSeconds", "required": false, "in": "query", "name": "lower_bound" }, { "description": "The maximum number of transactions to return", "type": "integer", "required": false, "in": "query", "name": "limit" }, { "description": "true/false whether the packed transaction is converted to json", "type": "boolean", "required": false, "in": "query", "name": "json" } ], "responses": { "200": { "description": "Default Response" } } }, "post": { "summary": "Retrieves the scheduled transaction", "description": "Retrieves the scheduled transaction", "tags": [ "chain" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": [ "object", "string" ], "properties": { "lower_bound": { "type": "string", "description": "Date/time string in the format YYYY-MM-DDTHH:MM:SS.sss", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}$", "title": "DateTimeSeconds" }, "limit": { "description": "The maximum number of transactions to return", "type": "integer" }, "json": { "description": "true/false whether the packed transaction is converted to json", "type": "boolean" } } } } ], "responses": { "200": { "description": "Default Response" } } } }, "/v1/chain/push_transaction": { "post": { "summary": "This method expects a transaction in JSON format and will attempt to apply it to the blockchain.", "description": "This method expects a transaction in JSON format and will attempt to apply it to the blockchain.", "tags": [ "chain" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": [ "object", "string" ], "properties": { "signatures": { "type": "array", "description": "array of signatures required to authorize transaction", "items": { "$ref": "#/definitions/def-2" } }, "compression": { "type": "boolean", "description": "Compression used, usually false" }, "packed_context_free_data": { "type": "string", "description": "json to hex" }, "packed_trx": { "type": "string", "description": "Transaction object json to hex" } } } } ], "responses": { "200": { "description": "Default Response" } } } }, "/v1/chain/get_table_rows": { "get": { "summary": "Returns an object containing rows from the specified table.", "description": "Returns an object containing rows from the specified table.", "tags": [ "chain" ], "parameters": [ { "type": "string", "description": "The name of the smart contract that controls the provided table", "required": true, "in": "query", "name": "code" }, { "type": "string", "description": "The name of the table to query", "required": true, "in": "query", "name": "table" }, { "type": "string", "description": "The account to which this data belongs", "required": true, "in": "query", "name": "scope" }, { "type": "string", "description": "Position of the index used, accepted parameters `primary`, `secondary`, `tertiary`, `fourth`, `fifth`, `sixth`, `seventh`, `eighth`, `ninth` , `tenth`", "required": false, "in": "query", "name": "index_position" }, { "type": "string", "description": "Type of key specified by index_position (for example - `uint64_t` or `name`)", "required": false, "in": "query", "name": "key_type" }, { "type": "string", "required": false, "in": "query", "name": "encode_type" }, { "type": "string", "required": false, "in": "query", "name": "upper_bound" }, { "type": "string", "required": false, "in": "query", "name": "lower_bound" } ], "responses": { "200": { "description": "Default Response" } } }, "head": { "summary": "Returns an object containing rows from the specified table.", "description": "Returns an object containing rows from the specified table.", "tags": [ "chain" ], "parameters": [ { "type": "string", "description": "The name of the smart contract that controls the provided table", "required": true, "in": "query", "name": "code" }, { "type": "string", "description": "The name of the table to query", "required": true, "in": "query", "name": "table" }, { "type": "string", "description": "The account to which this data belongs", "required": true, "in": "query", "name": "scope" }, { "type": "string", "description": "Position of the index used, accepted parameters `primary`, `secondary`, `tertiary`, `fourth`, `fifth`, `sixth`, `seventh`, `eighth`, `ninth` , `tenth`", "required": false, "in": "query", "name": "index_position" }, { "type": "string", "description": "Type of key specified by index_position (for example - `uint64_t` or `name`)", "required": false, "in": "query", "name": "key_type" }, { "type": "string", "required": false, "in": "query", "name": "encode_type" }, { "type": "string", "required": false, "in": "query", "name": "upper_bound" }, { "type": "string", "required": false, "in": "query", "name": "lower_bound" } ], "responses": { "200": { "description": "Default Response" } } }, "post": { "summary": "Returns an object containing rows from the specified table.", "description": "Returns an object containing rows from the specified table.", "tags": [ "chain" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": [ "object", "string" ], "properties": { "code": { "type": "string", "description": "The name of the smart contract that controls the provided table" }, "table": { "type": "string", "description": "The name of the table to query" }, "scope": { "type": "string", "description": "The account to which this data belongs" }, "index_position": { "type": "string", "description": "Position of the index used, accepted parameters `primary`, `secondary`, `tertiary`, `fourth`, `fifth`, `sixth`, `seventh`, `eighth`, `ninth` , `tenth`" }, "key_type": { "type": "string", "description": "Type of key specified by index_position (for example - `uint64_t` or `name`)" }, "encode_type": { "type": "string" }, "upper_bound": { "type": "string" }, "lower_bound": { "type": "string" } }, "required": [ "code", "table", "scope" ] } } ], "responses": { "200": { "description": "Default Response" } } } }, "/v1/chain/push_transactions": { "post": { "summary": "This method expects a transaction in JSON format and will attempt to apply it to the blockchain.", "description": "This method expects a transaction in JSON format and will attempt to apply it to the blockchain.", "tags": [ "chain" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": [ "array", "object", "string" ], "items": { "type": [ "object", "string" ], "additionalProperties": false, "minProperties": 8, "required": [ "expiration", "ref_block_num", "ref_block_prefix", "max_net_usage_words", "max_cpu_usage_ms", "delay_sec", "context_free_actions", "actions" ], "properties": { "expiration": { "$ref": "#/definitions/def-4" }, "ref_block_num": { "type": "integer" }, "ref_block_prefix": { "type": "integer" }, "max_net_usage_words": { "$ref": "#/definitions/def-0" }, "max_cpu_usage_ms": { "$ref": "#/definitions/def-0" }, "delay_sec": { "type": "integer" }, "context_free_actions": { "type": "array", "items": { "$ref": "#/definitions/def-6" } }, "actions": { "type": "array", "items": { "$ref": "#/definitions/def-6" } }, "transaction_extensions": { "type": "array", "items": { "$ref": "#/definitions/def-5" } } } } } } ], "responses": { "200": { "description": "Default Response" } } } }, "/v1/chain/send_transaction": { "post": { "summary": "This method expects a transaction in JSON format and will attempt to apply it to the blockchain.", "description": "This method expects a transaction in JSON format and will attempt to apply it to the blockchain.", "tags": [ "chain" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": [ "object", "string" ], "properties": { "signatures": { "type": "array", "description": "array of signatures required to authorize transaction", "items": { "$ref": "#/definitions/def-2" } }, "compression": { "type": "boolean", "description": "Compression used, usually false" }, "packed_context_free_data": { "type": "string", "description": "json to hex" }, "packed_trx": { "type": "string", "description": "Transaction object json to hex" } } } } ], "responses": { "200": { "description": "Default Response" } } } }, "/v1/chain/{wildcard}": { "get": { "summary": "Wildcard chain api handler", "tags": [ "chain" ], "responses": { "200": { "description": "Default Response" } } }, "post": { "summary": "Wildcard chain api handler", "tags": [ "chain" ], "responses": { "200": { "description": "Default Response" } } } }, "/v1/node/get_supported_apis": { "get": { "summary": "Get list of supported APIs", "tags": [ "node" ], "responses": { "200": { "description": "Default Response" } } } }, "/stream-client.js": { "get": { "tags": [ "internal" ], "responses": { "200": { "description": "Default Response" } } } } }, "host": "chain-history.upland.me", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ] }