GET /health and GET /ready

GET

health

curl --request GET \
  --url https://mcr.peaq.xyz/health

import requests

url = "https://mcr.peaq.xyz/health"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://mcr.peaq.xyz/health', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://mcr.peaq.xyz/health",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://mcr.peaq.xyz/health"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://mcr.peaq.xyz/health")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mcr.peaq.xyz/health")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

GET /health

GET /health

A lightweight liveness probe. Returns 200 whenever the process is running. Does not check connectivity or contract readiness.

Response

200 OK

Field	Type	Description
`status`	string	Always `"ok"` when the process is running

Error responses

None. This endpoint always returns 200 while the server process is alive.

Example

curl "${PEAQOS_MCR_API_URL}/health"

const response = await fetch(`${PEAQOS_MCR_API_URL}/health`);
const data = await response.json();
console.log(data.status); // "ok"

import requests

response = requests.get(f"{PEAQOS_MCR_API_URL}/health")
data = response.json()
print(data["status"])  # "ok"

Response

{
  "status": "ok"
}

GET /ready

GET /ready

A readiness probe. Verifies that the RPC is reachable and all six (IdentityRegistry, IdentityStaking, EventRegistry, MachineNFT, DID registry, AdminFlags) are callable. Returns 200 when all checks pass and 503 when any check fails.

Response

200 OK (all contracts ready)

Field	Type	Description
`status`	string	`"ready"`
`rpc_connected`	boolean	`true` when the RPC node is reachable
`contracts.identity_registry`	boolean	IdentityRegistry contract callable
`contracts.identity_staking`	boolean	IdentityStaking contract callable
`contracts.event_registry`	boolean	EventRegistry contract callable
`contracts.machine_nft`	boolean	MachineNFT contract callable
`contracts.admin_flags`	boolean	AdminFlags contract callable. Returns `true` when the contract address is not configured. AdminFlags is optional, so the readiness probe skips the call and reports ready.
`contracts.did_registry`	boolean	DID precompile callable

503 Service Unavailable (one or more checks failed) The response body has the same shape as the 200 response, but status is "not_ready" and one or more boolean fields are false.

Status	Condition
503	Any contract unreachable, RPC failure, or services not initialised

Two failure modes produce a 503:

Services not initialised (server started without IDENTITY_REGISTRY_ADDRESS): every field is false, including rpc_connected and contracts.admin_flags.
Initialised but a check failed (RPC down, contract unreachable, etc.): only the failing fields are false. When ADMIN_FLAGS_ADDRESS is unset, contracts.admin_flags is true: AdminFlags is optional, the probe skips it, and that field never blocks readiness.

Example

curl "${PEAQOS_MCR_API_URL}/ready"

const response = await fetch(`${PEAQOS_MCR_API_URL}/ready`);
const data = await response.json();
if (response.ok) {
  console.log("Service ready");
} else {
  console.log("Not ready:", data.contracts);
}

import requests

response = requests.get(f"{PEAQOS_MCR_API_URL}/ready")
data = response.json()
if response.status_code == 200:
    print("Service ready")
else:
    print("Not ready:", data["contracts"])

Response (healthy)

{
  "status": "ready",
  "rpc_connected": true,
  "contracts": {
    "identity_registry": true,
    "identity_staking": true,
    "event_registry": true,
    "machine_nft": true,
    "admin_flags": true,
    "did_registry": true
  }
}

Response (not ready)

{
  "status": "not_ready",
  "rpc_connected": false,
  "contracts": {
    "identity_registry": false,
    "identity_staking": false,
    "event_registry": false,
    "machine_nft": false,
    "admin_flags": false,
    "did_registry": false
  }
}

API reference overview lists all available endpoints and common error patterns.

Machine Markets API overviewBase path, access model, common shapes, error codes, and endpoints for the peaqOS Machine Markets API.

⌘I

GET /health and GET /ready

curl --request GET \
  --url https://mcr.peaq.xyz/health

import requests

url = "https://mcr.peaq.xyz/health"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://mcr.peaq.xyz/health', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://mcr.peaq.xyz/health",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://mcr.peaq.xyz/health"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://mcr.peaq.xyz/health")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mcr.peaq.xyz/health")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

​GET /health

​Response

​Error responses

​Example

​GET /ready

​Response

​Example

​Related endpoints

GET /health

Response

Error responses

Example

GET /ready

Response

Example

Related endpoints