🏦 Balance Schemas

These schemas provide structured information and statistics about wallets, integrations, tokens, and time series, and could be used to analyze and monitor user wallets and protocols, helping users to make informed decisions.

Timeseries

JavaScript

export class Timeseries {
  wallet: BaseWallet;
  tier: TierKeys;
  timeseries: Record<number, number | undefined>;
  events: Record<number, Array<TimeseriesEvent>>;
}

Python

@dataclass
class Timeseries:
    wallet: BaseWallet
    tier: TierKeys
    timeseries: dict[str, float | None]
    events: dict[str, list[TimeseriesEvent]]

A schema that holds a timeseries of events for a specific wallet and time range, along with a dictionary of TimeseriesEvent objects.

WalletIntegration

JavaScript

export class WalletIntegration {
  wallet: BaseWallet;
  integration: BaseIntegration;
  balances: Array<IntegrationTokenStats>;
  nft_balances: Array<IntegrationNFTStats>;
  wallet_stats: WalletIntegrationStats | undefined;
}

Python

@dataclass
class WalletIntegration:
    wallet: BaseWallet
    integration: BaseIntegration
    balances: list[IntegrationTokenStats]
    nft_balances: list[IntegrationNFTStats]
    wallet_stats: WalletIntegrationStats | None

A schema that holds information about a wallet's integration with a specific protocol, including the wallet, the integration, the balances, and wallet stats.

WalletIntegrations

JavaScript

export class WalletIntegrations {
  stats: Array<WalletIntegration>;
  errors: Array<RecipeError>;
}

Python

@dataclass
class WalletIntegrations:
    stats: list[WalletIntegration]
    errors: list[RecipeError]

A schema that holds a list of WalletIntegration objects along with a list of errors that occurred during integration.

BaseIntegration

JavaScript

export class BaseIntegration {
  recipe_id: string;
  integration_id: string;
  chain: ChainKeys;
  position_id: string | undefined;
  stats: IntegrationStats;
  name: string;
  platform: string;
  type: string;
  address: string | undefined;
}

Python

@dataclass
class BaseIntegration:
    recipe_id: str
    integration_id: str
    chain: ChainKeys
    stats: IntegrationStats
    position_id: str | None
    name: str = ""
    platform: str = ""
    type: str = ""
    address: str | None

A schema that holds basic information about an integration, such as the recipe ID, integration ID, chain, and integration stats.

IntegrationTokenStats

JavaScript

export class IntegrationTokenStats {
  token: BaseToken;
  wallet: BaseWallet;
  usd_value: string | undefined;
  balance: string;
  balance_type: string;
  unlock_timestamp: number | undefined;
}

Python

@dataclass
class IntegrationTokenStats:
    token: BaseToken
    wallet: BaseWallet
    usd_value: str | None
    balance: str
    balance_type: str
    unlock_timestamp: int | None

A schema that holds information about a token's balance within a wallet's integration, including the token, the wallet, the USD value of the token, the balance, and the balance type.

WalletTokenStats

JavaScript

export class WalletTokenStats {
  token: BaseToken;
  wallet: BaseWallet;
  usd_value: string | undefined;
  balance: string;
}

Python

@dataclass
class WalletTokenStats:
    token: BaseToken
    wallet: BaseWallet
    usd_value: str | None
    balance: str

A schema that holds information about a token's balance within a wallet, including the token, the wallet, the USD value of the token, and the balance.

WalletTokens

JavaScript

export class WalletTokens {
  stats: Array<WalletTokenStats>;
  errors: Array<TokenError>;
}

Python

@dataclass
class WalletTokens:
    stats: list[WalletTokenStats]
    errors: list[TokenError]

A schema that holds a list of WalletTokenStats objects along with a list of errors that occurred when retrieving token statistics.