GET /metadata/{token_id}

GET

metadata

{token_id}

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

<?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))

}

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 machine token. A machine’s and its are the same value, so the server checks that the token exists in MachineRegistry (or, for a Solana-homed machine, on its home chain) and builds the same response as GET /machine/{did} for did:peaq:<token_id>. This endpoint is designed to serve as an ERC-721 tokenURI target.

Path parameters

integer

required

NFT token ID, which equals the decimal machine ID. Range 1 to 2^256-1.

Response

200 OK The response shape is identical to GET /machine/{did}: the same base fields, the optional data_api, and the extra fields a Solana-homed machine carries. See that page for the full field reference. peaqos.machine_id is the token ID as a decimal string, peaqos.did is did:peaq:<token_id>, and name is "Machine #<token_id>".

Error responses

Status	`detail`	Condition
404	`"Token not found"`	No chain records a machine with this token ID
409	`{"code": "MACHINE_HOMED_ELSEWHERE", "home_protocol_chain_id", "message"}`	The machine is homed on a chain this server cannot read
422	(FastAPI validation error)	`token_id` is less than 1, above `2^256-1`, or not an integer
429	`"rate_limited"`	The server’s budget for home-chain lookups is spent; slow down and retry
503	`"Machine is relocating to another chain; retry later"`	The machine is moving between chains
503	`"machine home chain is unreachable; retry later"`	Reading a Solana-homed machine’s record failed
503	`"Service not initialised"`	Server started without contract addresses
503	`"Chain unavailable"`	Any chain call failed

Example

curl "${PEAQOS_MCR_API_URL:-https://mcr.peaq.xyz}/metadata/108934426058480933785963234320575706003575332367737915173645220784539698794848"

const PEAQOS_MCR_API_URL = process.env.PEAQOS_MCR_API_URL ?? "https://mcr.peaq.xyz";
const response = await fetch(
  `${PEAQOS_MCR_API_URL}/metadata/108934426058480933785963234320575706003575332367737915173645220784539698794848`
);
const data = await response.json();
console.log(data.name, data.peaqos.mcr);

import os

import requests

PEAQOS_MCR_API_URL = os.environ.get("PEAQOS_MCR_API_URL", "https://mcr.peaq.xyz")

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

Response

{
  "schema_version": "1.0",
  "name": "Machine #108934426058480933785963234320575706003575332367737915173645220784539698794848",
  "peaqos": {
    "machine_id": "108934426058480933785963234320575706003575332367737915173645220784539698794848",
    "did": "did:peaq:108934426058480933785963234320575706003575332367737915173645220784539698794848",
    "operator": "did:peaq:0x47d0d49382bdbe6f969056aab22edc56cc59fe4f",
    "mcr": "Provisioned",
    "mcr_score": 0,
    "bond_status": "bonded",
    "negative_flag": false,
    "event_count": 0,
    "data_visibility": "private",
    "documentation_url": null
  }
}

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

⌘I

GET /metadata/{token_id}

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

<?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))

}

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