GET /machine/{key}/monetization

GET

machine

{key}

monetization

curl --request GET \
  --url https://mcr.peaq.xyz/machine/{key}/monetization

import requests

url = "https://mcr.peaq.xyz/machine/{key}/monetization"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://mcr.peaq.xyz/machine/{key}/monetization', 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/machine/{key}/monetization",
  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/machine/{key}/monetization"

	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/machine/{key}/monetization")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mcr.peaq.xyz/machine/{key}/monetization")

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

Endpoint

GET /machine/{key}/monetization

Reads a machine’s current monetization state. Public: no signature required.

Path parameters

string

required

Machine DID (did:peaq:0x...) or a decimal machine ID (e.g. 42).

Response

200 OK

Field	Type	Description
`machine_id`	integer	The resolved numeric machine ID
`status`	string	`"PENDING"`, `"OPTED_IN"`, or `"OPTED_OUT"`
`signer`	string or null	Address that authorized the current state; `null` when `status` is `"PENDING"`
`updated_at`	integer or null	Unix seconds of the last applied change; `null` when `status` is `"PENDING"`

PENDING is the state of a machine that has never opted in or out (no record stored), distinct from OPTED_OUT (it opted in before and then opted out). signer and updated_at are null only in the PENDING case.

Error responses

Errors use a coded envelope: {"detail": {"code", "message"}}. Branch on code, never on message.

Status	`code`	Condition
400	`INVALID_REQUEST`	Unparseable `key`, or machine ID out of the int64 range
404	`MACHINE_NOT_FOUND`	The `key` does not resolve to an existing machine
503	`CHAIN_UNAVAILABLE`	An on-chain read failed while resolving the machine

Example

curl "${PEAQOS_MCR_API_URL}/machine/42/monetization"

const response = await fetch(
  `${PEAQOS_MCR_API_URL}/machine/42/monetization`
);
const data = await response.json();
console.log(data.status);

import requests

response = requests.get(f"{PEAQOS_MCR_API_URL}/machine/42/monetization")
print(response.json()["status"])

Response

{
  "machine_id": 42,
  "status": "OPTED_IN",
  "signer": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8",
  "updated_at": 1712000004
}

PUT /machine//monetization sets the state with a signed request.
GET /machine/ returns the full machine profile.

GET /health and GET /readyLiveness and readiness probes for monitoring the peaqOS MCR API server.

⌘I

GET /machine/{key}/monetization

curl --request GET \
  --url https://mcr.peaq.xyz/machine/{key}/monetization

import requests

url = "https://mcr.peaq.xyz/machine/{key}/monetization"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://mcr.peaq.xyz/machine/{key}/monetization', 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/machine/{key}/monetization",
  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/machine/{key}/monetization"

	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/machine/{key}/monetization")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mcr.peaq.xyz/machine/{key}/monetization")

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

​Endpoint

​Path parameters

​Response

​Error responses

​Example

​Related endpoints

Endpoint

Path parameters

Response

Error responses

Example

Related endpoints