Quickstart
Jumpstart your blockchain project with the GoldRush quickstart guide. Use our TypeScript SDK & UI Kit to access multichain data and get your free API key now!
Introduction
This quickstart guide walks through using the GoldRush TypeScript SDK and GoldRush UI Kit to quickly build with multichain data leveraging the powerful GoldRush APIs.
Prerequisites
Using any of the GoldRush developer tools requires an API key.
Get Started
Sign up for a free API key to get started with GoldRush.
Supported Chains
GoldRush can be used with any of the supported chains. See the full list, including chain categorization, at Supported Chains.
Some data enrichments such as internal transactions and historical balance fetches are only available for Foundational Chains.
Using the GoldRush TypeScript SDK
The GoldRush TypeScript SDK is the fastest way to integrate the GoldRush APIs for working with blockchain data. The SDK works with all supported chains including Mainnets and Testnets.
This SDK requires NodeJS v18 or above.
Step 1. Install the SDK
or
See the package on npm for more details.
Step 2. Import the Client
The GoldRushClient
class provides typesafe, easy-to-use helper functions and classes to use the GoldRush APIs.
Step 3. Initialize the Client
Step 4. Invoke the Service
In this quickstart, we use the BalanceService
and getTokenBalancesForWalletAddress()
function to fetch all token balances held by an address. This function takes a chain name and wallet address as required arguments.
ENS resolution is supported for eth-mainnet
.
Example response:
Using the GoldRush UI Kit
The GoldRush UI Kit consists of beautifully designed React components for your dapp frontend. The Kit is open source and customizable.
This UI Kit requires React 18.
See the open source repo on GitHub.
Step 1. Install the UI Kit
or