Function createHealthApiClient

Returns {
    extend: <const client extends { [key: string]: unknown }>(
        fn: (client: { extend: ...; health: ...; liveness: ...; readiness: ... }) => client,
    ) => { [K in (...) | (...) | (...)]: (...)[(...)] };
    health: (args: HealthParameters) => Promise<HealthReturnType>;
    liveness: () => Promise<LivenessReturnType>;
    readiness: (args: ReadinessParameters) => Promise<ReadinessReturnType>;
}

A Health API Client. HealthApiClient

• extend: <const client extends { [key: string]: unknown }>(
      fn: (client: { extend: ...; health: ...; liveness: ...; readiness: ... }) => client,
  ) => { [K in (...) | (...) | (...)]: (...)[(...)] }

• health: (args: HealthParameters) => Promise<HealthReturnType>

  Returns the last set of health check results for the node. This includes checks for all chains, network, database, and other components.

  • Docs: https://build.avax.network/docs/api-reference/health-api#healthhealth

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const healthStatus = await client.health.health({
    tags: ["11111111111111111111111111111111LpoYY", "29uVeLPJB1eQJkzRemU8g8wZDw5uJRqpab5U2mX9euieVwiEbL"]
  })
  
  Copy

• liveness: () => Promise<LivenessReturnType>

  Returns a simple health check indicating if the node is alive and can handle requests. This is a lightweight check that always returns healthy if the endpoint is available.

  • Docs: https://build.avax.network/docs/api-reference/health-api#healthliveness

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  Copy

• readiness: (args: ReadinessParameters) => Promise<ReadinessReturnType>

  Returns the last evaluation of the startup health check results. This indicates if the node has finished initializing and is ready to handle requests.

  • Docs: https://build.avax.network/docs/api-reference/health-api#healthreadiness

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const readinessStatus = await client.health.readiness({
    tags: ["11111111111111111111111111111111LpoYY"]
  })
  
  Copy

import { createHealthApiClient} from '@avalanche-sdk/client'
import { avalanche } from '@avalanche-sdk/client/chains'

const client = createHealthApiClient({
  chain: avalanche,
  transport: {
    type: "http",
  },
})

// Get health status
const health = await client.liveness()
Copy