Docs

Spokes#

Learn how to discover available spokes in Aave v4.

Spoke Data Structure#

Spoke data provide information about individual borrowing modules, including:

  • Identification: id, name, address, chain

  • Configuration: active status and module settings

  • Liquidation parameters: target health factor, max-bonus threshold, and bonus factor (liquidationConfig)

  • Summary metrics: supplied, borrowed, cap usage, connected hubs, and connected assets

The following TypeScript interfaces illustrate the core Spoke type:

interface Spoke {  __typename: "Spoke";  id: SpokeId;  name: string;  address: EvmAddress;  chain: Chain;  liquidationConfig: SpokeLiquidationConfig | null;  summary: SpokeSummary;  connectedHubs: SpokeConnectedHub[];}

Listing Available Spokes#

Discover all available Aave Spokes across supported networks.

Use the useSpokes hook to fetch a list of available spokes.

import { type SpokesRequest, useSpokes } from "@aave/react";
function SpokesList({ request }: { request: SpokesRequest }) {  const { data, loading, error } = useSpokes(request);
  if (loading) return <div>Loading…</div>;
  if (error) return <div>Error: {error.message}</div>;
  return (    <div>      {data.map((spoke) => (        <div key={spoke.id}>          <h3>{spoke.name}</h3>          <p>Chain: {spoke.chain.name}</p>        </div>      ))}    </div>  );}

See below for examples of SpokesRequest objects.

import { chainId } from "@aave/react";
const request: SpokesRequest = {  query: {    chainIds: [chainId(1)],  },};

Fetching a Single Spoke#

Fetch a specific spoke by its address and chain ID.

Use the useSpoke hook to fetch a specific spoke.

import { type SpokeRequest, useSpoke } from "@aave/react";
function SpokeDetails({ request }: { request: SpokeRequest }) {  const { data, loading, error } = useSpoke(request);
  if (loading) return <div>Loading…</div>;
  if (error) return <div>Error: {error.message}</div>;
  if (!data) return <div>Spoke not found</div>;
  return (    <div>      <h3>{data.name}</h3>      <p>Chain: {data.chain.name}</p>    </div>  );}

See below for examples of SpokeRequest objects.

import { spokeId } from "@aave/react";
const request: SpokeRequest = {  query: {    spokeId: spokeId(params.id), // SpokeId - typically from URL params  },};

Spoke Summary History#

Fetch historical deposits and borrows for a specific spoke over a chosen time window.

Use the useSpokeSummaryHistory hook to fetch spoke-level history.

import { Currency, TimeWindow, useSpokeSummaryHistory } from "@aave/react";
const { data, loading, error } = useSpokeSummaryHistory({  query: { spokeId },  currency: Currency.Usd,  window: TimeWindow.LastWeek,});
Previous
Hubs
Next
Reserves