Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.chipipay.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Usage

const balance = await sdk.getTokenBalance(
  {
    chainToken: ChainToken.USDC,
    chain: Chain.STARKNET,
    walletPublicKey: "0x...",
  },
  bearerToken,
);

​
Parameters

ParameterTypeRequiredDescription
chainTokenChainTokenYesToken identifier (e.g. "USDC")
chainChainYesBlockchain network. Use Chain.STARKNET
walletPublicKeystringNoWallet address. Use this or externalUserId
externalUserIdstringNoExternal user ID. Use this or walletPublicKey
bearerTokenstringNoJWT token. Falls back to apiSecretKey if not provided

​
Return Value

Returns a Promise<GetTokenBalanceResponse> with the balance data.

​
Example

import { ChipiServerSDK, Chain, ChainToken } from "@chipi-stack/backend";

const sdk = new ChipiServerSDK({
  apiPublicKey: process.env.CHIPI_PUBLIC_KEY!,
  apiSecretKey: process.env.CHIPI_SECRET_KEY!,
});

const balance = await sdk.getTokenBalance(
  {
    chainToken: ChainToken.USDC,
    chain: Chain.STARKNET,
    walletPublicKey: "0x04...abc",
  },
  bearerToken,
);

console.log("Balance:", balance);