Function createInfoApiClient

Returns {
    acps: () => Promise<AcpsReturnType>;
    extend: <const client extends { [key: string]: unknown }>(
        fn: (
            client: {
                acps: ...;
                extend: ...;
                getBlockchainID: ...;
                getNetworkID: ...;
                getNetworkName: ...;
                getNodeID: ...;
                getNodeIP: ...;
                getNodeVersion: ...;
                getTxFee: ...;
                getVMs: ...;
                isBootstrapped: ...;
                peers: ...;
                upgrades: ...;
                uptime: ...;
            },
        ) => client,
    ) => { [K in (...)
    | (...)
    | (...)]: (...)[(...)] };
    getBlockchainID: (args: GetBlockchainIDParameters) => Promise<GetBlockchainIDReturnType>;
    getNetworkID: () => Promise<GetNetworkIDReturnType>;
    getNetworkName: () => Promise<GetNetworkNameReturnType>;
    getNodeID: () => Promise<GetNodeIDReturnType>;
    getNodeIP: () => Promise<GetNodeIPReturnType>;
    getNodeVersion: () => Promise<GetNodeVersionReturnType>;
    getTxFee: () => Promise<GetTxFeeReturnType>;
    getVMs: () => Promise<GetVMsReturnType>;
    isBootstrapped: (args: IsBootstrappedParameters) => Promise<IsBootstrappedReturnType>;
    peers: (args: PeersParameters) => Promise<PeersReturnType>;
    upgrades: () => Promise<UpgradesReturnType>;
    uptime: () => Promise<UptimeReturnType>;
}

An Info API Client. InfoApiClient

• acps: () => Promise<AcpsReturnType>

  Returns peer preferences for Avalanche Community Proposals (ACPs).

  • Docs: https://build.avax.network/docs/api-reference/info-api#infoacps

  Example

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

• extend: <const client extends { [key: string]: unknown }>(
      fn: (
          client: {
              acps: ...;
              extend: ...;
              getBlockchainID: ...;
              getNetworkID: ...;
              getNetworkName: ...;
              getNodeID: ...;
              getNodeIP: ...;
              getNodeVersion: ...;
              getTxFee: ...;
              getVMs: ...;
              isBootstrapped: ...;
              peers: ...;
              upgrades: ...;
              uptime: ...;
          },
      ) => client,
  ) => { [K in (...)
  | (...)
  | (...)]: (...)[(...)] }

• getBlockchainID: (args: GetBlockchainIDParameters) => Promise<GetBlockchainIDReturnType>

  Given a blockchain's alias, get its ID.

  • Docs: https://build.avax.network/docs/api-reference/info-api#infogetblockchainid

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const blockchainID = await client.info.getBlockchainID({
    alias: "X"
  })
  Copy

• getNetworkID: () => Promise<GetNetworkIDReturnType>

  Get the ID of the network this node is participating in. Network ID of 1 = Mainnet, Network ID of 5 = Fuji (testnet).

  • Docs: https://build.avax.network/docs/api-reference/info-api#infogetnetworkid

  Example

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

• getNetworkName: () => Promise<GetNetworkNameReturnType>

  Get the name of the network this node is participating in.

  • Docs: https://build.avax.network/docs/api-reference/info-api#infogetnetworkname

  Example

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

• getNodeID: () => Promise<GetNodeIDReturnType>

  Get the ID, the BLS key, and the proof of possession of this node. Note: This endpoint is only available on specific nodes, not on public servers.

  • Docs: https://build.avax.network/docs/api-reference/info-api#infogetnodeid

  Example

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

• getNodeIP: () => Promise<GetNodeIPReturnType>

  Get the IP address of this node.

  • Docs: https://build.avax.network/docs/api-reference/info-api#infogetnodeip

  Example

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

• getNodeVersion: () => Promise<GetNodeVersionReturnType>

  Get the version of this node.

  • Docs: https://build.avax.network/docs/api-reference/info-api#infogetnodeversion

  Example

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

• getTxFee: () => Promise<GetTxFeeReturnType>

  Get the transaction fee for this node.

  • Docs: https://build.avax.network/docs/api-reference/info-api#infogettxfee

  Example

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

• getVMs: () => Promise<GetVMsReturnType>

  Get the virtual machines (VMs) this node is running.

  • Docs: https://build.avax.network/docs/api-reference/info-api#infogetvms

  Example

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

• isBootstrapped: (args: IsBootstrappedParameters) => Promise<IsBootstrappedReturnType>

  Check whether a given chain is done bootstrapping.

  • Docs: https://build.avax.network/docs/api-reference/info-api#infoisbootstrapped

  Example

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

• peers: (args: PeersParameters) => Promise<PeersReturnType>

  Get a description of peer connections.

  • Docs: https://build.avax.network/docs/api-reference/info-api#infopeers

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const peers = await client.info.peers({
    nodeIDs: []
  })
  Copy

• upgrades: () => Promise<UpgradesReturnType>

  Returns the upgrade history and configuration of the network.

  • Docs: https://build.avax.network/docs/api-reference/info-api#infoupgrades

  Example

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

• uptime: () => Promise<UptimeReturnType>

  Returns the network's observed uptime of this node. This is the only reliable source of data for your node's uptime.

  • Docs: https://build.avax.network/docs/api-reference/info-api#infouptime

  Example

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

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

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

// Get info
const info = await client.getNetworkID()
Copy