04 / Mining APIs

Clean data. Clear contracts.

Explore a static mining-data reference with working JSON fixtures, documented fields, runnable client examples, and a read-only integration model.

const response = await fetch(
  '/assets/data/fleet.json'
);
if (!response.ok) throw new Error('Request failed');
const fleet = await response.json();
console.log(fleet.hashrate_th_s); // 600 (sample)

Start with a contract you can inspect

The site's public data layer consists of bundled JSON files. They can be read with ordinary HTTP GET requests when the site is hosted. They are fictional fixtures: no account, token, pool integration, or live worker connection sits behind them.

Use the examples to learn client-side loading, response validation, clear units, and failure handling. The API reference describes the exact files and their supported fields.

Three views of the same sample

The fleet file summarizes four sample workers. The worker file contains their individual measurements. The telemetry file contains three illustrative history windows with twelve readings each. All are labeled as demo data and share the same fixed observation timestamp.

Fleet hashrate is 600 TH/s and device power is 12,000 W, giving 20 J/TH. Three workers report measurements; a fourth is offline. The warning state is an authored scenario, not a manufacturer-approved threshold.

Read-only means read-only

The public files accept no operating instructions. There is no server-side filtering, authenticated session, command queue, or real-time subscription. Parameters added to a URL do not create those capabilities.

A production design would need a separately implemented collection service, appropriate authorization, storage, and operational review. The secure API guide explains how to separate that future system from a public web client.

Build small, testable clients

Check HTTP status before parsing a response. Verify expected types. Keep missing values distinct from zeros, and show errors visibly instead of leaving an old metric looking current. Test your parser with failure fixtures before connecting a new upstream.

The quickstart includes JavaScript, cURL, and Python examples. JavaScript reads the current site's local fixture path; the command-line examples target the documented local preview server.

Make the next integration explicit

Name the real hardware or upstream service you intend to support, then document versions, available fields, access requirements, and failure behavior. Do not claim broad compatibility from a JSON shape alone.

Visit the integration map for the roles of Bitcoin Core, Stratum, Prometheus, and GPU telemetry. These are learning references rather than connected services or commercial partnerships.

Your next idea starts with a little silicon.

Explore the guides. Inspect the data. Build with a clearer picture.