Health Check

GET /health

Returns OK if healthy.

Packages

Node.js

Install

npm install algosdk --save

Usage

import { Algodv2 } from "algosdk";

const client = new Algodv2( "", "https://testnet-api.algonode.cloud", 443 );
const result = await client.healthCheck().do();

Algosdk Documentation Learn more at the official documentation for algosdk

import { AlgodClient } from '@awesome-algorand/algod-fetch';

const client = new AlgodClient();
const result = await client.public.healthcheck();

Algo-fetch Documentation Learn more at the experimental documentation for algo-fetch

React

@awesome-alogrand/react-query
@tanstack/react-query

Install

npm install @awesome-algorand/react-query @txnlab/use-wallet-react @tanstack/react-query algosdk --save

Usage

import { useHealthCheck } from '@awesome-algorand/react-query';

export function HealthCheckViewer() {
    const query = useHealthCheck();
}

Tutorial Learn how to use the useHealthCheck hook in a React application.

Install

npm install @awesome-algorand/query-core @txnlab/use-wallet-react @tanstack/react-query algosdk --save

Usage

import { useQuery } from 'react-query';
import { healthCheck } from '@awesome-algorand/query-core';
import { useWallet } from "@txnlab/use-wallet-react";

export function BlockInformationViewer() {
    const walletManager = useWallet();
    const query = useQuery(healthCheck());
}

Svelte [WIP]

@awesome-algorand/svelte-query

Coming Soon!

Solid [WIP]

@awesome-algorand/solid-query

Coming Soon!

Vue [WIP]

@awesome-algorand/vue-query

Coming Soon!

Angular [WIP]

@awesome-algorand/angular-query

Coming Soon!