openapi: 3.1.0
info:
title: EOSIO / Antelope Nodeos Chain Get Abi Get Currency Balance API
description: HTTP/JSON RPC interface exposed by the chain_api_plugin in nodeos, the reference EOSIO (now Antelope) blockchain node implementation. The chain API allows clients to read blockchain state, fetch blocks and accounts, inspect ABI and contract data, and submit signed transactions to the network.
version: '1.0'
contact:
name: EOS Network Foundation
url: https://eosnetwork.com/
license:
name: MIT
url: https://github.com/AntelopeIO/leap/blob/main/LICENSE
servers:
- url: '{node}/v1/chain'
description: Nodeos HTTP RPC endpoint with chain_api_plugin enabled.
variables:
node:
default: https://eos.greymass.com
description: Base URL of an EOS/Antelope node.
tags:
- name: Get Currency Balance
paths:
/get_currency_balance:
post:
summary: Get currency balance for an account
description: Returns the balance of a token symbol held by an account on a given token contract.
operationId: getCurrencyBalance
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: Token contract account.
example: eosio.token
account:
type: string
description: Account whose balance to query.
symbol:
type: string
description: Token symbol (e.g. EOS).
required:
- code
- account
responses:
'200':
description: List of asset strings representing balances.
content:
application/json:
schema:
type: array
items:
type: string
tags:
- Get Currency Balance