Quick Start

info

Arkhia API is reserved for paid tiers only.
You can easily upgrade your free account under the dashboard in your profile account.

For this example we are assuming you already have a paid account with Arkhia.

Arkhia API is a tooling API that enables a paid tier user to access:

• Account related operations
• API augmented functionality (protocol agnostic)
• Analytics

For security purposes certain critical operations through the Arkhia need a 2 Layer authenticated Project. Let's see how we can get started using the Arkhia API below.

Quick start

1. Create a Project under Create Project on the Dashboard Projects tab.
2. Copy the Api Key
3. Make a request using the following values
   • URL: https://api.arkhia.io/service/status/:api-key
4. Verify you get a payload with the status of our nodes.

Quick link

curl --location 'https://api.arkhia.io/service/status/<YOUR_API_KEY>'

See in the other sections what else you can do with the Arkhia API.

---

API Key

caution

All requests to Arkhia APIs require an API key to be attached in the path or the header of the request for authentication

Using the Arkhia dashboard, you can access your API key on the project details page, under the security section.

How to add the API key to a request?

REST API

# The API Key needs to be passed in the header for Rest API requestscurl --location 'https://<YOUR_BASE_URL>/hedera/mainnet/api/v1/blocks' \--header 'x-api-key: <YOUR_API_KEY>'

JSON RPC

# The API Key needs to be passed in path for JSON RPC requestscurl --location 'https://<YOUR_BASE_URL>/hedera/mainnet/json-rpc/v1/<YOUR_API_KEY>' \--header 'Content-Type: application/json' \--data '{    "jsonrpc": "2.0",    "method": "web3_clientVersion",    "params": [],    "id": 0}'

STATUS API

# The API Key needs to be passed in path for Arkhia Status API requestscurl --location 'https://<YOUR_BASE_URL>/arkhia/service/status/<YOUR_API_KEY>'

---

API Secret

API Secret is an additional security measure that you can choose to enforce on all your API requests. After activating the setting on the dashboard you will have to add an additional key in the body of each request.

caution

Once the API secret is enforced for a project. All API requests made using that projects API Key will require API Secret to be sent in the body of the request

tip

We recommend enabling API secret for additional security for production applications. Especially if you are using a service that requires you to send the API Key in path of the request, as the chances of your API Key getting compromised are high

REST API

# If activated, the API secret needs to be passed in the header of the requestcurl --location 'https://<YOUR_BASE_URL>/api/v1/blocks' \--header 'x-api-key: <YOUR_API_KEY>' \--header 'x-api-secret: <YOUR_API_SECRET>'

JSON RPC

# If activated, the API secret needs to be passed in the header of the requestcurl --location 'https://<YOUR_BASE_URL>/json-rpc/v1/<YOUR_API_KEY>' \--header 'Content-Type: application/json' \--header 'x-api-secret: <YOUR_API_SECRET>' \--data '{    "jsonrpc": "2.0",    "method": "web3_clientVersion",    "params": [],    "id": 0}'

STATUS API

# If activated, the API secret needs to be passed in the header of the requestcurl --location 'https://<YOUR_BASE_URL>/arkhia/service/status/<YOUR_API_KEY>'--header 'x-api-secret: <YOUR_API_SECRET>'