GET /metadata/{token_id}

GET

metadata

{token_id}

curl --request GET \
  --url https://mcr.peaq.xyz/metadata/{token_id}

import requests

url = "https://mcr.peaq.xyz/metadata/{token_id}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

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

	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/metadata/{token_id}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mcr.peaq.xyz/metadata/{token_id}")

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 /metadata/{token_id}

Returns metadata for a MachineNFT token. The server looks up the from the via the MachineNFT contract, then resolves the machine owner and builds the same response as GET /machine/. This endpoint is designed to serve as an ERC-721 tokenURI target.

Path parameters

integer

default:"1"

required

NFT token ID (not the machine ID)

Response

200 OK The response shape is identical to GET /machine/. All base fields and data visibility-dependent fields apply. See that page for the full field reference.

Field	Type	Description
`schema_version`	string	Always `"1.0"`
`name`	string	`"Machine #<token_id>"` when the token round-trips, or `"Machine (no NFT)"` if the on-chain NFT lookup returns 0
`peaqos.machine_id`	integer	On-chain machine ID resolved from the token
`peaqos.did`	string	Machine DID derived from the owner address (`did:peaq:<owner_address>`)
`peaqos.operator`	string or null	Operator DID from the DID document
`peaqos.mcr`	string	Letter rating: `AAA`, `AA`, `A`, `BBB`, `BB`, `B`, `NR`, or `Provisioned`
`peaqos.mcr_score`	integer	MCR score 0-100
`peaqos.bond_status`	string	`"bonded"` or `"unbonded"`
`peaqos.negative_flag`	boolean	`true` when the AdminFlags contract has a negative-flag timestamp set for this machine. Stays `true` for as long as the timestamp is recorded on-chain, regardless of whether the 180-day MCR scoring penalty is still in effect.
`peaqos.event_count`	integer	Total on-chain event count
`peaqos.data_visibility`	string	`"private"`, `"onchain"`, or `"public"`
`peaqos.documentation_url`	string or null	Public documentation URL from the DID document

Additional fields (data_api, event_data, partner_data, partner_data_error) depend on data_visibility. See GET /machine/ for details.

Error responses

Status	`detail`	Condition
404	`"Token not found"`	Token ID does not map to any machine in the MachineNFT contract
404	`"Machine not registered"`	The token’s machine ID is not present in the IdentityRegistry contract
422	(FastAPI validation error)	`token_id` is less than 1 or not an integer
503	`"Service not initialised"`	Server started without contract addresses
503	`"Chain unavailable"`	Any chain or DID call failed

Example

curl "${PEAQOS_MCR_API_URL}/metadata/7"

const response = await fetch(`${PEAQOS_MCR_API_URL}/metadata/7`);
const data = await response.json();
console.log(data.name, data.peaqos.mcr);

import requests

response = requests.get(f"{PEAQOS_MCR_API_URL}/metadata/7")
data = response.json()
print(data["name"], data["peaqos"]["mcr"])

Response

{
  "schema_version": "1.0",
  "name": "Machine #7",
  "peaqos": {
    "machine_id": 42,
    "did": "did:peaq:0xabc1230000000000000000000000000000000001",
    "operator": "did:peaq:0xoperator0000000000000000000000000000001",
    "mcr": "B",
    "mcr_score": 30,
    "bond_status": "bonded",
    "negative_flag": false,
    "event_count": 5,
    "data_visibility": "onchain",
    "documentation_url": null,
    "event_data": [
      {
        "event_type": 0,
        "origin_value": 1500,
        "timestamp": 1711900000,
        "trust_level": 1,
        "metadata": {},
        "origin_currency": "USD",
        "origin_subunit": 100,
        "usd_value": 1500,
        "usd_subunit": 100,
        "amount_status": "ok"
      }
    ]
  }
}

GET /machine/ returns the same response shape, resolved by DID instead of token ID.
GET /mcr/ returns a focused MCR response with revenue trend and summary.
GET /machines/ returns the peaqOS Machine Card resolved by numeric machine ID.

GET /machines/{machine_id}Return a peaqOS Machine Card for a machine identified by its numeric machine ID.

⌘I

GET /metadata/{token_id}

curl --request GET \
  --url https://mcr.peaq.xyz/metadata/{token_id}

import requests

url = "https://mcr.peaq.xyz/metadata/{token_id}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

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

	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/metadata/{token_id}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mcr.peaq.xyz/metadata/{token_id}")

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