On-chain Data APIs

{
    "items": [
        {
            "actions": [],
            "base_fee_per_gas": "15",
            "block": 4319804,
            "confirmation_duration": [0, 5010],
            "confirmations": 431946,
            "created_contract": null,
            "decoded_input": null,
            "exchange_rate": null,
            "fee": {
                "type": "actual",
                "value": "52500000315000"
            },
            "from": {
                "ens_domain_name": null,
                "hash": "0x8B066912dCDA9c9001A84b28F1aBD06e9E19114B",
                "implementations": [],
                "is_contract": false,
                "is_verified": false,
                "metadata": null,
                "name": null,
                "private_tags": [],
                "proxy_type": null,
                "public_tags": [],
                "watchlist_names": []
            },
            "gas_limit": "1048576",
            "gas_price": "2500000015",
            "gas_used": "21000",
            "has_error_in_internal_txs": false,
            "hash": "0xb27af2f3b0d1171c58045c5671e1771a2084193f831f1b8bf81fb3c4f0e4e9bb",
            "max_fee_per_gas": "2500000015",
            "max_priority_fee_per_gas": "2500000015",
            "method": null,
            "nonce": 42633,
            "position": 0,
            "priority_fee": "52500000000000",
            "raw_input": "0x",
            "result": "success",
            "revert_reason": null,
            "status": "ok",
            "timestamp": "2024-08-22T09:48:36.000000Z",
            "to": {
                "ens_domain_name": null,
                "hash": "0x5C253e4cc17225C799724824D35D361Be201B548",
                "implementations": [],
                "is_contract": false,
                "is_verified": false,
                "metadata": null,
                "name": null,
                "private_tags": [],
                "proxy_type": null,
                "public_tags": [],
                "watchlist_names": []
            },
            "token_transfers": null,
            "token_transfers_overflow": null,
            "tx_burnt_fee": "315000",
            "tx_tag": null,
            "tx_types": ["coin_transfer"],
            "type": 2,
            "value": "10000000000000000000"
        }
    ],
    "next_page_params": {
        "api_key": "",
        "apikey": "",
        "block_number": 3515628,
        "fee": "46207912380000",
        "hash": "0x4074791a7beec5dcecb9dffbab10b0001e2d9025480cdb53e77b1606ae174e2e",
        "index": 0,
        "inserted_at": "2024-07-06T17:24:25.541294Z",
        "items_count": 50,
        "value": "500000000000000000"
    }
}

These APIs can be helpful for developers as they offer the possibility of fetching data from the blockchain and use that data for their own goals, such as dapp development, data streams and other possibilities.

Overview

Shib’s on-chain data APIs provide developers with comprehensive access to blockchain data from both Shibarium mainnet and Puppynet testnet. These APIs enable you to build applications that can fetch transaction history, account balances, and other blockchain data for various use cases including dApp development, analytics, and data streaming.

Access to the RPC data requires authentication. Head to the Developer Portal to get your API Key.

Available APIs

Transactions API

Fetch transaction data from specific addresses with detailed information about gas fees, confirmations, and token transfers.

Balance API

Retrieve account balances for native tokens and ERC-20 tokens across multiple networks.

Base URLs

The APIs are available for both Shibarium mainnet and Puppynet testnet:

Network	Base URL	Description
Shibarium	`https://chain.shib.io/api/v1/shibarium`	Mainnet production environment
Puppynet	`https://chain.shib.io/api/v1/puppynet`	Testnet for development

Transactions API

Use this endpoint to fetch transaction data from a given address.

Endpoint

GET /transactions

Request Examples

curl -s "https://chain.shib.io/api/v1/puppynet/transactions?address={{address}}&api_key={{api_key}}" \
-H "Content-Type: application/json" -X GET

import axios from 'axios';

const apiKey = '<api_key>';
const walletAddress = '<wallet_address>';
const baseURL = 'https://chain.shib.io/api/v1/puppynet';

async function makeRequest(url: string): Promise<string> {
  try {
    const response = await axios.get(url, {
      headers: { 'Content-Type': 'application/json' }
    });
    return JSON.stringify(response.data);
  } catch (error) {
    throw new Error(`Request failed: ${error}`);
  }
}

async function main() {
  try {
    // Get transactions
    const transactionsURL = `${baseURL}/transactions?address=${walletAddress}&api_key=${apiKey}`;
    const transactionsResp = await makeRequest(transactionsURL);
    console.log('Transactions response:', transactionsResp);

    // Get balances
    const balancesURL = `${baseURL}/balances?address=${walletAddress}&api_key=${apiKey}`;
    const balancesResp = await makeRequest(balancesURL);
    console.log('Balances response:', balancesResp);
  } catch (error) {
    console.error('Error:', error.message);
  }
}

main();

package main

import (
	"fmt"
	"io/ioutil"
	"net/http"
)

func main() {
	apiKey := "<api_key>"
	walletAddress := "<wallet_address>"
	baseURL := "https://chain.shib.io/api/v1/puppynet"

	// Get transactions
	transactionsURL := fmt.Sprintf("%s/transactions?address=%s&api_key=%s", baseURL, walletAddress, apiKey)
	transactionsResp, err := makeRequest(transactionsURL)
	if err != nil {
		fmt.Printf("Error getting transactions: %v\n", err)
	} else {
		fmt.Printf("Transactions response: %s\n", transactionsResp)
	}

	// Get balances
	balancesURL := fmt.Sprintf("%s/balances?address=%s&api_key=%s", baseURL, walletAddress, apiKey)
	balancesResp, err := makeRequest(balancesURL)
	if err != nil {
		fmt.Printf("Error getting balances: %v\n", err)
	} else {
		fmt.Printf("Balances response: %s\n", balancesResp)
	}
}

func makeRequest(url string) (string, error) {
	client := &http.Client{}
	req, err := http.NewRequest("GET", url, nil)
	if err != nil {
		return "", err
	}

	req.Header.Add("Content-Type", "application/json")

	resp, err := client.Do(req)
	if err != nil {
		return "", err
	}
	defer resp.Body.Close()

	body, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		return "", err
	}

	return string(body), nil
}

Query Parameters

string

required

Your API key provided by the Developer Portal.

string

required

The wallet address from which you would like to fetch data.

Response Schema

{
    "items": [
        {
            "actions": [],
            "base_fee_per_gas": "15",
            "block": 4319804,
            "confirmation_duration": [0, 5010],
            "confirmations": 431946,
            "created_contract": null,
            "decoded_input": null,
            "exchange_rate": null,
            "fee": {
                "type": "actual",
                "value": "52500000315000"
            },
            "from": {
                "ens_domain_name": null,
                "hash": "0x8B066912dCDA9c9001A84b28F1aBD06e9E19114B",
                "implementations": [],
                "is_contract": false,
                "is_verified": false,
                "metadata": null,
                "name": null,
                "private_tags": [],
                "proxy_type": null,
                "public_tags": [],
                "watchlist_names": []
            },
            "gas_limit": "1048576",
            "gas_price": "2500000015",
            "gas_used": "21000",
            "has_error_in_internal_txs": false,
            "hash": "0xb27af2f3b0d1171c58045c5671e1771a2084193f831f1b8bf81fb3c4f0e4e9bb",
            "max_fee_per_gas": "2500000015",
            "max_priority_fee_per_gas": "2500000015",
            "method": null,
            "nonce": 42633,
            "position": 0,
            "priority_fee": "52500000000000",
            "raw_input": "0x",
            "result": "success",
            "revert_reason": null,
            "status": "ok",
            "timestamp": "2024-08-22T09:48:36.000000Z",
            "to": {
                "ens_domain_name": null,
                "hash": "0x5C253e4cc17225C799724824D35D361Be201B548",
                "implementations": [],
                "is_contract": false,
                "is_verified": false,
                "metadata": null,
                "name": null,
                "private_tags": [],
                "proxy_type": null,
                "public_tags": [],
                "watchlist_names": []
            },
            "token_transfers": null,
            "token_transfers_overflow": null,
            "tx_burnt_fee": "315000",
            "tx_tag": null,
            "tx_types": ["coin_transfer"],
            "type": 2,
            "value": "10000000000000000000"
        }
    ],
    "next_page_params": {
        "api_key": "",
        "apikey": "",
        "block_number": 3515628,
        "fee": "46207912380000",
        "hash": "0x4074791a7beec5dcecb9dffbab10b0001e2d9025480cdb53e77b1606ae174e2e",
        "index": 0,
        "inserted_at": "2024-07-06T17:24:25.541294Z",
        "items_count": 50,
        "value": "500000000000000000"
    }
}

Response Fields

array

required

List of transactions for the specified address.

array

A list of actions associated with the transaction.

string

The base fee per gas unit for this transaction, indicating the minimum amount of gas required to process the transaction.

number

The number of the block where the transaction was registered.

array

An array representing the range of time (in milliseconds) it took for the transaction to be confirmed.

number

The number of confirmations this transaction has received. Confirmations indicate how many blocks have been added to the blockchain since this transaction.

object|null

Details about a contract that was created as a result of a transaction. Contains information such as the contract’s address, name, and whether it has been verified.

object|null

The decoded information from the raw transaction input. Typically includes the method call and the parameters passed to the function during the transaction.

object|null

The exchange rate at the time of the transaction (if applicable).

object

required

Contains information about the transaction fee.

Show Fee Properties

string

Specifies whether the fee is the actually charged one, an estimation or the maximum possible fee.

string

The actual fee paid for the transaction.

object

required

Contains information about the sender of the transaction.

Show Address Properties

string|null

The ENS (Ethereum Name Service) domain name, if applicable.

string

The address hash of the sender.

array

Holds a list of smart contract standards or protocols that the given address adheres to.

boolean

Indicates if the sender is a smart contract.

boolean

Indicates whether the sender address is verified.

object|null

Stores extra information about the address, such as descriptive data that might come from external sources or on-chain events.

string|null

Refers to a human-readable identifier for the address, often assigned through services like ENS.

array

User-defined labels or categories that can be assigned to addresses for organizational purposes.

string|null

Refers to the type of proxy contract the address might represent.

array

Public tags are similar to private tags but are visible to everyone.

array

Stores the names of watchlists the address has been added to.

string

The maximum amount of gas allowed for the transaction.

string

The price of gas per unit.

string

The actual amount of gas used by the transaction.

boolean

Whether there were any errors in any internal transactions.

string

The transaction hash.

string

The maximum fee per gas unit that the sender is willing to pay.

string

The maximum priority fee per gas unit that the sender is willing to pay to speed up the transaction process.

string|null

Specific method or smart contract function.

number

The nonce for this transaction, which is the number of transactions sent by the sender up to this point.

number

The position of the transaction within the block.

string

The priority fee paid to validators.

string

The raw input data provided in the transaction.

string

Indicates the outcome of the transaction.

string|null

Shows the reason why the transaction was reverted, if applicable.

string

The transaction status, that is, if it was successfully processed or not.

string

The timestamp when the transaction occurred.

object

required

Contains information about the recipient of the transaction (same structure as from field).

array|null

What token transfers occurred during this transaction.

boolean|null

Whether overflow or errors in token transfers happened.

string

The amount of gas fees burned by the transaction.

string|null

Specific tags associated with the transaction.

array

A list indicating the type of transaction.

number

The transaction type.

string

The amount of cryptocurrency transferred in the transaction.

object

These are parameters needed to retrieve the next page of transactions when paginating through API results.

Show Pagination Properties

string

Key used for authentication.

string

Key used for authentication.

number

The specific block number on the blockchain where the transaction was included.

string

The transaction fee that was paid for executing the transaction on the blockchain.

string

This is a unique identifier for the transaction.

number

This key refers to the position of the transaction within the block.

string

The timestamp when the transaction or the data related to it was inserted into the blockchain itself.

number

The number of items returned in the response or contained within a specific transaction detail.

string

The value of the transaction in the native currency of the blockchain.

Balance API

The Balance API allows you to retrieve account balances for native tokens and ERC-20 tokens.

Endpoint

GET /balances

Query Parameters

string

required

Your API key provided by the Developer Portal.

string

required

The wallet address for which you want to fetch balance data.

Response Schema

{
    "items": [
        {
            "coin_balance": "1000000000000000000",
            "exchange_rate": "1.0",
            "fiat_value": "1.0",
            "token": {
                "address": "0x0000000000000000000000000000000000000000",
                "circulating_market_cap": null,
                "decimals": 18,
                "exchange_rate": "1.0",
                "holders": 1000,
                "icon_url": null,
                "name": "Ether",
                "symbol": "ETH",
                "total_supply": "1000000000000000000000",
                "type": "coin"
            }
        }
    ],
    "next_page_params": {
        "api_key": "",
        "apikey": "",
        "items_count": 1
    }
}

Response Fields

array

required

List of token balances for the specified address.

string

The balance of the token in its smallest unit (wei for ETH).

string

The current exchange rate of the token.

string

The fiat value of the token balance.

object

required

Information about the token.

Show Token Properties

string

The contract address of the token (null for native tokens).

string|null

The circulating market cap of the token.

number

The number of decimal places for the token.

string

The current exchange rate of the token.

number

The number of token holders.

string|null

URL to the token’s icon image.

string

The name of the token.

string

The symbol of the token.

string

The total supply of the token.

string

The type of token (coin, erc-20, etc.).

object

Parameters for pagination to retrieve the next page of results.

Rate Limits

The APIs have rate limits to ensure fair usage. Monitor your API usage and implement appropriate caching strategies for production applications.

Error Handling

Authentication Errors

Error: 401 UnauthorizedCause: Invalid or missing API keySolution: Verify your API key is correct and included in the request

Rate Limit Exceeded

Error: 429 Too Many RequestsCause: Exceeded rate limitsSolution: Implement exponential backoff and reduce request frequency

Invalid Address

Error: 400 Bad RequestCause: Invalid wallet address formatSolution: Ensure the address is a valid Ethereum address format

Server Errors

Error: 500 Internal Server ErrorCause: Server-side issuesSolution: Retry the request with exponential backoff

Best Practices

Implement proper error handling and retry logic
Cache responses when appropriate to reduce API calls
Use pagination for large datasets
Monitor your API usage and stay within rate limits
Implement exponential backoff for failed requests
Validate addresses before making API calls

Never expose your API key in client-side code. Always make API calls from your backend server to keep your key secure.

Use Cases

Wallet Applications

Display transaction history and balances for user wallets with real-time updates.

Analytics Dashboards

Build comprehensive analytics platforms showing transaction patterns and token flows.

DeFi Applications

Track user positions, liquidity pools, and yield farming activities.

Blockchain Explorers

Create custom blockchain explorers with detailed transaction and balance information.

Next Steps

Get API Key

Obtain your API key from the Developer Portal to start using the on-chain data APIs.

Explore More APIs

Discover additional APIs and tools available in the Shib ecosystem.

APIs & Data

Development Tools

Overview

Available APIs

Transactions API

Balance API

Base URLs

Transactions API

Endpoint

Request Examples

Query Parameters

Response Schema

Response Fields

Balance API

Endpoint

Query Parameters

Response Schema

Response Fields

Rate Limits

Error Handling

Best Practices

Use Cases

Wallet Applications

Analytics Dashboards

DeFi Applications

Blockchain Explorers

Next Steps

Get API Key

Explore More APIs

​Overview

​Available APIs

Transactions API

Balance API

​Base URLs

​Transactions API

​Endpoint

​Request Examples

​Query Parameters

​Response Schema

​Response Fields

​Balance API

​Endpoint

​Query Parameters

​Response Schema

​Response Fields

​Rate Limits

​Error Handling

​Best Practices

​Use Cases

Wallet Applications

Analytics Dashboards

DeFi Applications

Blockchain Explorers

​Next Steps

Get API Key

Explore More APIs

​Related Resources

Overview

Available APIs

Base URLs

Transactions API

Endpoint

Request Examples

Query Parameters

Response Schema

Response Fields

Balance API

Endpoint

Query Parameters

Response Schema

Response Fields

Rate Limits

Error Handling

Best Practices

Use Cases

Next Steps

Related Resources