Skip to main content

Getting Started

Arkhia offers API services, including the status API for end users to fetch current service status and receive information on scheduled maintenance, and the Events API that allows users to subscribe to real-time events for specific items.

Before getting started, make sure you have completed Arkhia API Quickstart guide

To check if you have configured your Arkhia API correctly, you can use the following

const axios = require('axios');const apiKey = '<YOUR_API_KEY>';let config = {  method: 'get',  url: 'https://api.arkhia.io/service/status/' + apiKey,};axios.request(config)    .then((response) => {        console.log(JSON.stringify(response.data));    })    .catch((error) => {        console.log(error);    });
Example Response Payload
{    "maintenance_mode": false,    "outage_mode": false}

Once all in good shape, you can start using the Arkhia API to subscribe to your first contract event, let's start with a simple one.