Benchmark

GET

https://api.xmrig.com/1/benchmark/:id

Get a full benchmark object with specified id. Live example.

GET

https://api.xmrig.com/1/benchmarks

GET

https://api.xmrig.com/1/benchmarks?algo=:algo

GET

https://api.xmrig.com/1/benchmarks/:threads

GET

https://api.xmrig.com/1/benchmarks/:threads?algo=:algo

Get an array of top benchmark results ordered by hashrate with optional parameters: algo and threads. Main benchmark page uses this API endpoints.

Parameters

Field	Type	Description
`algo`	String	Benchmark algorithm, right now only supported values is `rx/0` and `rx/wow`. By default `rx/0`.
`threads`	Number	Number of threads for filter, by default `0` (no filter results).

GET

https://api.xmrig.com/1/benchmarks?cpu=:cpu

GET

https://api.xmrig.com/1/benchmarks?algo=:algo&cpu=:cpu

Get an array of compact benchmarks objects ordered by hashrate with required parameter cpu and optional algo.

GET

https://api.xmrig.com/1/benchmarks/recent

GET

https://api.xmrig.com/1/benchmarks/recent?limit=:limit

Get an array of recently submitted benchmarks with optional limit parameter (1-100).

POST

https://api.xmrig.com/1/benchmark

Create a benchmark and get initial benchmark parameters, this API endpoint used internally by XMRig miner.

Request

Field	Type	Description
`size`	Number	Benchmark size from `1000000` to `10000000`.
`algo`	String	Algorithm: `rx/0` or `rx/wow`.
`version`	String	Miner version, for example `6.6.0`.
`cpu`	Object	Object with information about CPU in same format with the miner API.

Miner user agent transferred as User-Agent HTTP header and version should match with request body.

Response

Field	Type	Description
`id`	String	Benchmark public id.
`seed`	String	RandomX seed hash to initialize benchmark.
`token`	String	Token for update benchmark state.

PATCH

https://api.xmrig.com/1/benchmark/:id

Start (first request) or finish (second request) benchmark, this API endpoint used internally by XMRig miner. Authorization is required by using Authorization HTTP header with Bearer token.

First Request

Field	Type	Description
`steady_start_ts`	Number	Steady timestamp of benchmark start time.

Second Request

Field	Type	Description
`steady_done_ts`	Number	Steady timestamp of benchmark finish time. Benchmark duration is difference between `steady_done_ts` and `steady_start_ts`. Server is also recording time between API calls and reject benchmark is time difference with reported by miner is above certain limit.
`hash`	String	Checksum of benchmark execution with seed can be `used` for validation.
`backend`	Object	Object with information about CPU mining backend in same format with the miner API.