Make your first request
Fetch a fixture, validate the envelope, and inspect the worker record.
Open the quickstart →02 / UNDERSTANDExplore the contract
Three resources, explicit sample flags, and documented response fields.
Read the API reference →03 / BUILDUse a sample client
Download readable JavaScript and Python clients with validation and timeouts.
Get the client examples →Documentation with a clear starting point
The MinerAPI public examples are static JSON fixtures. They are included with this website, served from the same origin, and intended for learning and interface testing. Reading a file does not create an account, operate a miner, connect a pool, or run a language model.
Start by fetching the ASIC sample. Its envelope includes demo, schema_version, kind, source, and observed_at. The worker object contains fictional numeric observations, while the display fields support the example dashboard. These are different layers: a user-facing label should not replace a typed machine field in your own contract.
Choose the right level of detail
The quickstart is the fastest route through a complete request. The API reference explains every shared response field and links to the three downloadable resources. Sample clients add basic response validation and finite request timeouts. Code examples show compact usage patterns without requiring a package registry or an account.
For hardware-specific implementation, read the ASIC or GPU topic guide. For prompt record design, start with evaluation and versioning rather than treating a sample pass count as evidence of production quality. Keep private collection and execution services outside publicly delivered HTML and JavaScript.
When something fails
A missing file, invalid JSON response, or incompatible schema should produce a visible error. Do not silently substitute demo values for a failed production observation. Use the browser-based status page to check whether this deployment is serving its sample files, sitemap, and feed. That check reports reachability from your browser, not historical uptime or hardware health.