Developer Portal

Public API Documentation

Use the VTA Benchmark read-only JSON API to access published benchmark results and recorded snapshot data. The API is designed for dashboards, research tools and independent data consumers.

API status: Read-only public API · Version 1.0 · JSON responses · Missing or unverified measurements are not estimated.

Base URL

https://vtabenchmark.org/api.php

All endpoints use HTTP GET. Responses are JSON. The API is intended for public benchmark data only.

Quick start

Request the status endpoint first:

GET /api.php?endpoint=status

Then use latest, snapshots or results according to your application.

Endpoints

GET?endpoint=status

Returns API version, availability and the list of public endpoints.

{
  "api": "VTA Benchmark Public API",
  "version": "1.0",
  "read_only": true,
  "ok": true
}

GET?endpoint=latest

Returns the latest recorded value for each asset/metric combination found in the snapshot table.

{
  "ok": true,
  "count": 2,
  "data": [
    {
      "metric": "Block Height",
      "asset": "VTA",
      "value": "...",
      "recorded_at": "...",
      "source": "..."
    }
  ]
}

GET?endpoint=snapshots&limit=50

Returns timestamped snapshot records. The limit parameter accepts 1–500.

{
  "ok": true,
  "count": 1,
  "data": [
    {
      "metric": "Difficulty",
      "asset": "VTA",
      "value": "...",
      "recorded_at": "...",
      "source": "..."
    }
  ]
}

GET?endpoint=results&limit=50

Returns research benchmark records including VTA result, Bitcoin result, evidence status, source and methodology when those fields exist.

{
  "ok": true,
  "count": 1,
  "data": [
    {
      "category": "Difficulty Adjustment",
      "test_name": "...",
      "vta_result": "...",
      "btc_result": "...",
      "status": "Verified",
      "recorded_at": "...",
      "source": "...",
      "methodology": "..."
    }
  ]
}

Response fields

Field	Meaning
metric / test_name	Name of the benchmark metric or research test.
asset	Asset/network associated with a snapshot, when available.
value	Recorded snapshot value. It is not replaced by an estimate when unavailable.
recorded_at	Timestamp associated with the recorded observation.
source	Source or measurement origin stored with the record.
status	Evidence status for a research result, when available.
methodology	Test method/sample description, when stored.

JavaScript example

fetch('https://vtabenchmark.org/api.php?endpoint=latest')
  .then(r => r.json())
  .then(data => {
    console.log(data);
  });

Python example

import requests

url = "https://vtabenchmark.org/api.php"
data = requests.get(
    url,
    params={"endpoint": "latest"},
    timeout=15
).json()

print(data)

Data integrity: API consumers should preserve the supplied timestamp, source and evidence context. A local VTA node measurement describes the configured local node at that time; it should not automatically be interpreted as a network-wide measurement.