get_currency_stats

Overview

The get_currency_stats method is utilized to retrieve the statistics for a specific currency on the EOS blockchain. By employing this method, users and developers can obtain crucial information about a currency, such as its supply, maximum supply, and issuer, thereby enabling in-depth analysis and insights into the currency's status and distribution.

// yarn add @tatumio/tatum

import { TatumSDK, Eos, Network } from '@tatumio/tatum'

const tatum = await TatumSDK.init<Eos>({ network: Network.EOS })

const response = await tatum.rpc.getCurrencyStats({
  code: 'eosio.token',
  symbol: 'EOS',
})

await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs

Example use cases:

1. Token Analysis:
   Individuals and analysts can utilize the get_currency_stats method to gather comprehensive details about a token's supply and issuer, facilitating profound analysis and research on the token’s characteristics and distribution.

2. Smart Contract Interaction:
   Developers can use this method to obtain necessary information about a token, which can aid in interacting efficiently with smart contracts that deal with tokens, for operations like transferring tokens or querying balances.

3. Market Analysis:
   get_currency_stats is instrumental for acquiring essential details about a token, which are critical for performing market analysis. This enables users and potential investors to make informed and insightful decisions based on the available token data.

Request Parameters

The getCurrencyStats method requires the following parameters in the request body:

• code (string, required): The contract that operates the token.
• symbol (string, required): The symbol of the token for which the statistics are being requested.

Return Object

The get_currency_stats method typically returns an object containing the statistics of the requested currency. This object includes:

• supply (string): The total supply of the token in circulation.
• max_supply (string): The maximum supply of the token that can ever be created.
• issuer (string): The account name of the issuer of the token.

JSON-RPC Request Example

{
  "code": "eosio.token",
  "symbol": "EOS"
}

JSON-RPC Response Example

{
  "EOS": {
    "supply": "1168690795.8555 EOS",
    "max_supply": "10000000000.0000 EOS",
    "issuer": "eosio"
  }
}