XMRig

https://xmrig.com/docs
Admin
XMRig is a unified CPU/GPU miner that supports multiple cryptocurrencies with additional tools...
Tokens:25,316
Snippets:219
Trust Score:9.2
Update:9 months ago
Show doc for...
Tokens:
Raw
### Install Dependencies for macOS

Source: https://xmrig.com/docs/proxy/macos-build

Installs necessary libraries for building XMRig Proxy on macOS using Homebrew. Ensure Homebrew is installed before running this command.

```bash
brew install cmake libuv openssl
```

--------------------------------

### Install Dependencies for XMRig Proxy (Ubuntu)

Source: https://xmrig.com/docs/proxy/ubuntu-build

Installs necessary packages required for building XMRig Proxy on Ubuntu. This includes development tools, libraries for asynchronous I/O, UUID generation, and SSL support.

```bash
sudo apt install git build-essential cmake libuv1-dev uuid-dev libssl-dev
```

--------------------------------

### GET /2/config

Source: https://xmrig.com/docs/miner/api/config

Retrieves the current XMRig configuration.

```APIDOC
## GET /2/config

### Description
Retrieves the current XMRig configuration.

### Method
GET

### Endpoint
/2/config

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **config** (object) - The XMRig configuration object.

#### Response Example
{
  "config": {
    "algo": "rx/0",
    "threads": 4,
    "donate-level": 1
  }
}
```

--------------------------------

### GET /1/benchmarks

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

Fetches an array of top benchmark results, ordered by hashrate. Supports filtering by algorithm and threads.

```APIDOC
## GET /1/benchmarks

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

### Method
GET

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

### Parameters
#### Query Parameters
- **algo** (string) - Optional - Benchmark algorithm. Supported values: `rx/0`, `rx/wow`. Defaults to `rx/0`.
- **threads** (number) - Optional - Number of threads for filtering. Defaults to `0` (no filter).

### Response
#### Success Response (200)
- An array of benchmark objects, each containing details like ID, algorithm, hashrate, threads, CPU info, and version.

#### Response Example
```json
[
  {
    "id": "benchmark_id_1",
    "algo": "rx/0",
    "hashrate": 15000.50,
    "threads": 12,
    "cpu": {
      "model": "AMD Ryzen 9 5900X",
      "cores": 12,
      "threads": 24
    },
    "version": "6.18.0"
  },
  {
    "id": "benchmark_id_2",
    "algo": "rx/wow",
    "hashrate": 10000.75,
    "threads": 8,
    "cpu": {
      "model": "Intel(R) Core(TM) i9-10900K CPU @ 3.70GHz",
      "cores": 10,
      "threads": 20
    },
    "version": "6.17.0"
  }
]
```
```

--------------------------------

### Basic XMRig Build on FreeBSD

Source: https://xmrig.com/docs/miner/build/freebsd

This section outlines the steps for a basic build of XMRig on FreeBSD, suitable for local machine usage. It requires installing development tools and libraries like git, cmake, libuv, openssl, and hwloc.

```bash
1. pkg install git cmake libuv openssl hwloc
2. git clone https://github.com/xmrig/xmrig.git
3. mkdir xmrig/build && cd xmrig/build
4. cmake ..
5. make -j$(sysctl -n hw.ncpu)
```

--------------------------------

### Basic XMRig Build on Ubuntu

Source: https://xmrig.com/docs/miner/build/ubuntu

This snippet outlines the steps to perform a basic build of XMRig on an Ubuntu system. It installs necessary development packages, clones the repository, and compiles the software using CMake and make. This method is suitable for local machine builds.

```bash
1. sudo apt install git build-essential cmake libuv1-dev libssl-dev libhwloc-dev
2. git clone https://github.com/xmrig/xmrig.git
3. mkdir xmrig/build && cd xmrig/build
4. cmake ..
5. make -j$(nproc)
```

--------------------------------

### CPU Mining Configuration Profiles (JSON)

Source: https://xmrig.com/docs/miner/config/cpu

Example JSON configuration demonstrating flexible CPU mining profiles for different algorithms like RandomX variants and CryptoNight variants. It shows how to define threads, affinity, and fallback profiles.

```json
{
    "cpu": {
        "enabled": true,
        "rx/wow": [-1, -1, -1, -1],
        "cn": [
            [1, 0],
            [1, 2]
        ],
        "cn-lite": [
            [2, 0],
            [2, 2]
        ],
        "cn-pico": {
            "intensity": 2,
            "threads": 8,
            "affinity": -1
        },
        "custom-profile": [0, 2],
        "*": [-1],
        "cn/r": "custom-profile",
        "cn/0": false
    }
}
```

--------------------------------

### GET /1/benchmarks?cpu=:cpu

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

Retrieves compact benchmark objects filtered by CPU, ordered by hashrate. Optionally filters by algorithm.

```APIDOC
## GET /1/benchmarks?cpu=:cpu

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

### Method
GET

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

### Parameters
#### Query Parameters
- **cpu** (string) - Required - Identifier for the CPU to filter benchmarks.
- **algo** (string) - Optional - Benchmark algorithm. Supported values: `rx/0`, `rx/wow`.

### Response
#### Success Response (200)
- An array of compact benchmark objects, including ID, algorithm, and hashrate.

#### Response Example
```json
[
  {
    "id": "benchmark_id_4",
    "algo": "rx/0",
    "hashrate": 13000.00
  },
  {
    "id": "benchmark_id_5",
    "algo": "rx/wow",
    "hashrate": 9500.50
  }
]
```
```

--------------------------------

### GET /1/benchmark/:id

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

Retrieves a full benchmark object for a specified ID. This provides a live example of a benchmark result.

```APIDOC
## GET /1/benchmark/:id

### Description
Get a full benchmark object with specified `id`. Live example.

### Method
GET

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

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier for the benchmark.

### Response
#### Success Response (200)
- **id** (string) - The benchmark ID.
- **algo** (string) - The algorithm used for the benchmark.
- **hashrate** (number) - The hashrate achieved during the benchmark.
- **threads** (number) - The number of threads used.
- **cpu** (object) - CPU information.
- **version** (string) - XMRig version used.

#### Response Example
```json
{
  "id": "some_benchmark_id",
  "algo": "rx/0",
  "hashrate": 12345.67,
  "threads": 8,
  "cpu": {
    "model": "Intel(R) Core(TM) i7-8700K CPU @ 3.70GHz",
    "cores": 6,
    "threads": 12
  },
  "version": "6.17.0"
}
```
```

--------------------------------

### GET /1/benchmarks/recent

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

Fetches an array of recently submitted benchmarks. Supports an optional limit parameter to control the number of results.

```APIDOC
## GET /1/benchmarks/recent

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

### Method
GET

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

### Parameters
#### Query Parameters
- **limit** (number) - Optional - The maximum number of recent benchmarks to return (1-100).

### Response
#### Success Response (200)
- An array of recent benchmark objects, including details like ID, algorithm, hashrate, and submission timestamp.

#### Response Example
```json
[
  {
    "id": "benchmark_id_6",
    "algo": "rx/0",
    "hashrate": 14800.70,
    "timestamp": "2023-10-27T10:00:00Z"
  },
  {
    "id": "benchmark_id_7",
    "algo": "rx/wow",
    "hashrate": 9800.20,
    "timestamp": "2023-10-27T09:55:00Z"
  }
]
```
```

--------------------------------

### Basic XMRig Build on Alpine Linux

Source: https://xmrig.com/docs/miner/build/alpine

This snippet outlines the steps for a basic build of XMRig on Alpine Linux. It requires installing development tools and libraries like git, make, cmake, and others. The process involves cloning the repository, configuring the build with cmake, and compiling the source code.

```shell
1. apk add git make cmake libstdc++ gcc g++ libuv-dev openssl-dev hwloc-dev
2. git clone https://github.com/xmrig/xmrig
3. mkdir xmrig/build && cd xmrig/build
4. cmake ..
5. make -j$(nproc)
```

--------------------------------

### Basic XMRig Build on macOS

Source: https://xmrig.com/docs/miner/build/macos

This snippet details the basic build process for XMRig on macOS using Homebrew. It covers installing necessary dependencies, cloning the repository, configuring the build with CMake, and compiling the project. This method is suitable for local machine builds.

```shell
1. brew install cmake libuv openssl hwloc
2. git clone https://github.com/xmrig/xmrig.git
3. mkdir xmrig/build && cd xmrig/build
4. cmake .. -DOPENSSL_ROOT_DIR=$(brew --prefix openssl)
5. make -j$(sysctl -n hw.logicalcpu)
```

--------------------------------

### Miner-Defined Supported Algorithms in Login Request (JSON)

Source: https://xmrig.com/docs/extensions/algorithm-negotiation

This JSON example illustrates a miner's login request, where it declares its supported mining algorithms ('rx/0', 'cn/r', 'cn-lite/1') using the 'algo' field. This is an optional extension for algorithm switching.

```json
{
  "id": 1, "jsonrpc": "2.0", "method": "login",
  "params": {
    "login": "...", "pass": "...", "agent": "...",
    "algo": ["rx/0", "cn/r", "cn-lite/1"]
  }
}
```

--------------------------------

### GET /1/latest_release

Source: https://xmrig.com/docs/api/1/latest_release

An alias to `https://api.xmrig.com/1/latest_release/xmrig`. Retrieves information about the latest stable release for the 'xmrig' project.

```APIDOC
## GET /1/latest_release

### Description
An alias to `https://api.xmrig.com/1/latest_release/xmrig`. Retrieves information about the latest stable release for the 'xmrig' project.

### Method
GET

### Endpoint
https://api.xmrig.com/1/latest_release

### Parameters
#### Query Parameters
- **version_gt** (string) - Optional - Return results only if the current version is greater than the specified version. Useful for checking updates.
- **id** (string) - Optional - Return results only if the asset with the specified ID is found. Also filters the `assets` array to contain only the requested asset.

### Response
#### Success Response (200)
- **url** (string) - URL to a release page on GitHub.
- **version** (string) - Release version.
- **ts** (Timestamp) - Release timestamp.
- **assets** (Array) - Array of asset objects, each containing details about a downloadable item for the release.

#### Asset object
- **os** (string) - OS code combined with CPU architecture.
- **id** (string) - Asset ID retrieved from the file name.
- **name** (string) - Asset name.
- **url** (string) - Download URL for the asset.
- **size** (Number) - Asset size in bytes.
- **ts** (Timestamp) - Asset timestamp.
- **hash** (String) - SHA256 hash of the asset file.
- **cuda** (String) - CUDA version (only available for the 'cuda' project).

#### Response Example
```json
{
  "url": "https://github.com/xmrig/xmrig/releases/tag/v6.3.3",
  "version": "6.3.3",
  "ts": 1598627267000,
  "assets": [
    {
      "os": "windows-x64",
      "id": "msvc-win64",
      "name": "xmrig-6.3.3-msvc-win64.zip",
      "url": "https://github.com/xmrig/xmrig/releases/download/v6.3.3/xmrig-6.3.3-msvc-win64.zip",
      "size": 1931716,
      "ts": 1598627243000,
      "hash": "98f370f87b75e9d2718837c91746a0e6e04d292f4a348bc3fc457c5abdbc94e5"
    }
  ]
}
```
```

--------------------------------

### GET /1/benchmarks/:threads

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

Fetches benchmark results filtered by the number of threads. This endpoint is an alternative way to filter benchmarks by thread count.

```APIDOC
## GET /1/benchmarks/:threads

### Description
Get an array of top benchmark results ordered by hashrate, filtered by the specified number of threads. This endpoint is an alternative way to filter benchmarks by thread count.

### Method
GET

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

### Parameters
#### Path Parameters
- **threads** (number) - Required - The number of threads to filter benchmarks by.

#### Query Parameters
- **algo** (string) - Optional - Benchmark algorithm. Supported values: `rx/0`, `rx/wow`. Defaults to `rx/0`.

### Response
#### Success Response (200)
- An array of benchmark objects matching the specified thread count and optional algorithm.

#### Response Example
```json
[
  {
    "id": "benchmark_id_3",
    "algo": "rx/0",
    "hashrate": 14500.25,
    "threads": 10,
    "cpu": {
      "model": "AMD Ryzen 7 5800X",
      "cores": 8,
      "threads": 16
    },
    "version": "6.18.0"
  }
]
```
```

--------------------------------

### Login Reply with NiceHash Extension Enabled

Source: https://xmrig.com/docs/extensions/nicehash

This JSON example shows a typical login reply from a mining pool that includes the 'nicehash' extension. The presence of 'nicehash' in the 'extensions' array indicates that the miner can utilize the job splitting functionality.

```json
{
  "id": 1, "jsonrpc": "2.0", "error": null,
  "result": {
    "id": "...",
    "job": {
      "blob": "...", "job_id": "...", "target": "...", "id": "...", "algo": "..."
    },
    "extensions": ["keepalive", "nicehash"],
    "status": "OK"
  }
}
```

--------------------------------

### Basic XMRig Build on CentOS 7

Source: https://xmrig.com/docs/miner/build/centos7

This section describes the basic build process for XMRig on CentOS 7, suitable for local machine use. It involves installing development tools and dependencies using yum, cloning the repository, and compiling the miner using make.

```bash
1. sudo yum install -y epel-release
2. sudo yum install -y git make cmake gcc gcc-c++ libstdc++-static libuv-static hwloc-devel openssl-devel
3. git clone https://github.com/xmrig/xmrig.git
4. mkdir xmrig/build && cd xmrig/build
5. cmake ..
6. make -j$(nproc)
```

--------------------------------

### Basic XMRig Build on CentOS 8

Source: https://xmrig.com/docs/miner/build/centos8

This section outlines the steps for a basic build of XMRig on CentOS 8. It requires installing development packages and dependencies using `dnf` and `yum`, cloning the XMRig repository, and then compiling the software. This build is suitable for local machine use.

```bash
1. sudo dnf install -y epel-release
2. sudo yum config-manager --set-enabled PowerTools
3. sudo dnf install -y git make cmake gcc gcc-c++ libstdc++-static hwloc-devel openssl-devel automake libtool autoconf
4. git clone https://github.com/xmrig/xmrig.git
5. mkdir xmrig/build
6. cd xmrig/scripts && ./build.uv.sh
7. cd ../build && cmake .. -DXMRIG_DEPS=scripts/deps
8. make -j$(nproc)
```

--------------------------------

### Advanced XMRig Build with hwloc on macOS

Source: https://xmrig.com/docs/miner/build/macos

This snippet describes the advanced build process for XMRig on macOS, which includes building hwloc as a static library. It covers installing additional build tools, cloning the repository, using a script to build hwloc, configuring CMake with specific hwloc paths, and compiling. This is recommended for running the miner on other machines.

```shell
1. brew install cmake wget automake libtool autoconf
2. git clone https://github.com/xmrig/xmrig.git
3. mkdir xmrig/build && cd xmrig/scripts
4. ./build.hwloc.sh && cd ../build
5. cmake .. -DOPENSSL_ROOT_DIR=$(brew --prefix openssl) -DHWLOC_INCLUDE_DIR=../scripts/deps/include -DHWLOC_LIBRARY=../scripts/deps/lib/libhwloc.a
6. make -j$(sysctl -n hw.logicalcpu)
```

--------------------------------

### Build XMRig Proxy on macOS

Source: https://xmrig.com/docs/proxy/macos-build

Compiles the XMRig Proxy software on macOS after dependencies are installed and source code is cloned. It configures the build using CMake and then uses Make to compile, leveraging all available logical CPU cores for faster build times.

```bash
cd xmrig-proxy/build
cmake .. -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl
make -j$(sysctl -n hw.logicalcpu)
```

--------------------------------

### Workaround for Faulty First-Gen Zen CPUs in XMRig

Source: https://xmrig.com/docs/miner/randomx-stability-troubleshooting-guide

This configuration snippet provides a workaround for a hardware bug in some first-generation Ryzen/EPYC CPUs that prevents RandomX from running. It involves modifying the `wrmsr` (Write Model Specific Register) settings in the `config.json` file to bypass the issue.

```json
"wrmsr": ["0xc0011020:0x0", "0xc0011021:0x60", "0xc0011022:0x510000", "0xc001102b:0x1808cc16"]
```

--------------------------------

### XMRig CUDA Plugin Build on Ubuntu

Source: https://xmrig.com/docs/miner/build/ubuntu

This snippet shows how to build the optional CUDA plugin for XMRig, enabling support for NVIDIA GPUs. It requires prior installation of the CUDA toolkit. The build process involves cloning the CUDA plugin repository and configuring CMake with specific CUDA paths.

```bash
1. git clone https://github.com/xmrig/xmrig-cuda.git
2. mkdir xmrig-cuda/build && cd xmrig-cuda/build
3. cmake .. -DCUDA_LIB=/usr/local/cuda/lib64/stubs/libcuda.so -DCUDA_TOOLKIT_ROOT_DIR=/usr/local/cuda
4. make -j$(nproc)
```

--------------------------------

### Build XMRig CUDA Plugin with Visual Studio

Source: https://xmrig.com/docs/miner/build/windows

Compiles the optional XMRig CUDA plugin for NVIDIA GPUs using Visual Studio 2022. Requires Git and CMake, and CUDA Toolkit installed. It clones the plugin repository, creates a build directory, configures with CMake specifying the generator and CUDA toolkit path, and then builds the release configuration.

```shell
1. git clone https://github.com/xmrig/xmrig-cuda.git
2. mkdir xmrig-cuda\build && cd xmrig-cuda\build
3. cmake .. -G "Visual Studio 17 2022" -A x64 -DCUDA_TOOLKIT_ROOT_DIR="c:/Program Files/NVIDIA GPU Computing Toolkit/CUDA/v12.9"
4. cmake --build . --config Release
```

--------------------------------

### Get Latest Release for XMRig (API)

Source: https://xmrig.com/docs/api/1/latest_release

An alias endpoint to get the latest stable release information specifically for the 'xmrig' project. It accepts optional query parameters for filtering by version or asset ID.

```http
GET https://api.xmrig.com/1/latest_release

# Equivalent to:
GET https://api.xmrig.com/1/latest_release/xmrig
```

--------------------------------

### POST /1/benchmark

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

Creates a new benchmark entry and returns initial parameters required for the benchmark process. This is used internally by the XMRig miner.

```APIDOC
## POST /1/benchmark

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

### Method
POST

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

### Parameters
#### Request Body
- **size** (number) - Required - Benchmark size from `1000000` to `10000000`.
- **algo** (string) - Required - Algorithm: `rx/0` or `rx/wow`.
- **version** (string) - Required - Miner version, for example `6.6.0`.
- **cpu** (object) - Required - Object with information about CPU in same format with the miner API.

### Request Example
```json
{
  "size": 5000000,
  "algo": "rx/0",
  "version": "6.18.0",
  "cpu": {
    "model": "AMD Ryzen 9 5900X",
    "cores": 12,
    "threads": 24
  }
}
```

### Response
#### Success Response (200)
- **id** (string) - Benchmark public id.
- **seed** (string) - RandomX seed hash to initialize benchmark.
- **token** (string) - Token for update benchmark state.

#### Response Example
```json
{
  "id": "new_benchmark_id",
  "seed": "some_random_seed_hash",
  "token": "bearer_token_for_update"
}
```
```

--------------------------------

### Advanced XMRig Build on Ubuntu

Source: https://xmrig.com/docs/miner/build/ubuntu

This snippet details the advanced build process for XMRig on Ubuntu, which compiles key dependencies (libuv, openssl, hwloc) as static libraries. It requires additional build tools and uses a script to manage dependencies, making it suitable for deploying on other machines. The `ldd xmrig` command is used to verify binary dependencies.

```bash
1. sudo apt install git build-essential cmake automake libtool autoconf
2. git clone https://github.com/xmrig/xmrig.git
3. mkdir xmrig/build && cd xmrig/scripts
4. ./build_deps.sh && cd ../build
5. cmake .. -DXMRIG_DEPS=scripts/deps
6. make -j$(nproc)
```

--------------------------------

### Advanced Static XMRig Build on FreeBSD

Source: https://xmrig.com/docs/miner/build/freebsd

This section details the advanced build process for XMRig on FreeBSD, creating a fully static executable. This method uses a script to build dependencies as static libraries and requires additional build tools. Note that this build option is CPU-only and not compatible with GPU backends.

```bash
1. pkg install git cmake automake libtool autoconf wget
2. git clone https://github.com/xmrig/xmrig.git
3. mkdir xmrig/build && cd xmrig/scripts
4. ./build_deps.sh && cd ../build
5. cmake .. -DXMRIG_DEPS=scripts/deps -DBUILD_STATIC=ON
6. make -j$(sysctl -n hw.ncpu)
```

--------------------------------

### PATCH /1/benchmark/:id

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

Updates an existing benchmark, used to start or finish a benchmark process. Requires authorization with a Bearer token.

```APIDOC
## PATCH /1/benchmark/:id

### Description
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.

### Method
PATCH

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

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier for the benchmark.

#### Headers
- **Authorization** (string) - Required - Bearer token obtained from POST /1/benchmark.

#### Request Body (First Request - Start Benchmark)
- **steady_start_ts** (number) - Required - Steady timestamp of benchmark start time.

#### Request Body (Second Request - Finish Benchmark)
- **steady_done_ts** (number) - Required - 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) - Required - Checksum of benchmark execution with seed can be `used` for validation.
- **backend** (object) - Optional - Object with information about CPU mining backend in same format with the miner API.

### Request Example (Start Benchmark)
```json
{
  "steady_start_ts": 1678886400
}
```

### Request Example (Finish Benchmark)
```json
{
  "steady_done_ts": 1678886460,
  "hash": "calculated_checksum_hash",
  "backend": {
    "name": "OpenSSL",
    "version": "1.1.1k"
  }
}
```

### Response
#### Success Response (200)
- A confirmation message indicating the benchmark status update.

#### Response Example
```json
{
  "message": "Benchmark updated successfully."
}
```
```

--------------------------------

### Create Build Directory for XMRig Proxy

Source: https://xmrig.com/docs/proxy/ubuntu-build

Creates a dedicated directory for the build process of XMRig Proxy. This helps in organizing build artifacts and keeping the source directory clean.

```bash
mkdir xmrig-proxy/build
```

--------------------------------

### Build XMRig Proxy

Source: https://xmrig.com/docs/proxy/ubuntu-build

Compiles the XMRig Proxy software using CMake and Make. It navigates to the build directory, configures the build with CMake, and then compiles the source code using multiple processor cores for faster build times.

```bash
cd xmrig-proxy/build
cmake ..
make -j$(nproc)
```

--------------------------------

### GET /1/latest_release/:project

Source: https://xmrig.com/docs/api/1/latest_release

Retrieves information about the latest stable release for a specific XMRig project. Supported projects include 'xmrig', 'cuda', and 'proxy'.

```APIDOC
## GET /1/latest_release/:project

### Description
Retrieves information about the latest stable release for a specific XMRig project. Supported projects include 'xmrig', 'cuda', and 'proxy'.

### Method
GET

### Endpoint
https://api.xmrig.com/1/latest_release/:project

### Parameters
#### Path Parameters
- **project** (string) - Required - The project for which to retrieve the latest release. Possible values: xmrig, cuda, proxy.

#### Query Parameters
- **version_gt** (string) - Optional - Return results only if the current version is greater than the specified version. Useful for checking updates.
- **id** (string) - Optional - Return results only if the asset with the specified ID is found. Also filters the `assets` array to contain only the requested asset.

### Response
#### Success Response (200)
- **url** (string) - URL to a release page on GitHub.
- **version** (string) - Release version.
- **ts** (Timestamp) - Release timestamp.
- **assets** (Array) - Array of asset objects, each containing details about a downloadable item for the release.

#### Asset object
- **os** (string) - OS code combined with CPU architecture.
- **id** (string) - Asset ID retrieved from the file name.
- **name** (string) - Asset name.
- **url** (string) - Download URL for the asset.
- **size** (Number) - Asset size in bytes.
- **ts** (Timestamp) - Asset timestamp.
- **hash** (String) - SHA256 hash of the asset file.
- **cuda** (String) - CUDA version (only available for the 'cuda' project).

#### Response Example
```json
{
  "url": "https://github.com/xmrig/xmrig/releases/tag/v6.3.3",
  "version": "6.3.3",
  "ts": 1598627267000,
  "assets": [
    {
      "os": "windows-x64",
      "id": "msvc-win64",
      "name": "xmrig-6.3.3-msvc-win64.zip",
      "url": "https://github.com/xmrig/xmrig/releases/download/v6.3.3/xmrig-6.3.3-msvc-win64.zip",
      "size": 1931716,
      "ts": 1598627243000,
      "hash": "98f370f87b75e9d2718837c91746a0e6e04d292f4a348bc3fc457c5abdbc94e5"
    }
  ]
}
```
```

--------------------------------

### Get All Supported Network Objects

Source: https://xmrig.com/docs/api/1/network

Retrieves an array of network objects for all coins supported by the API. Each object provides a summary of the coin's network statistics.

```APIDOC
## GET /1/networks

### Description
Retrieves an array of network objects for all coins supported by the API. Each object provides a summary of the coin's network statistics.

### Method
GET

### Endpoint
https://api.xmrig.com/1/networks

### Parameters
None

### Response
#### Success Response (200)
An array of network objects. Each object has the following structure:
- **coin** (string) - Coin code.
- **hash** (string) - Hash of the last network block.
- **major_version** (number) - Major version of the last network block.
- **difficulty** (number) - Current network difficulty.
- **target** (number) - Block time target in seconds. Use `difficulty / target` to get network hashrate.
- **height** (number) - Current network height.
- **reward** (number) - Reward of the last network block in atomic units.
- **units** (number) - Use `reward / units` to get a human-readable reward value.
- **ts** (timestamp) - Time when the last block was actually mined (discovered by API).
- **algo** (string) - Current network PoW algorithm.

#### Response Example
```json
[
  {
    "coin": "XMR",
    "hash": "0194ca54327f2e997d8286f9355e5a892121d1028dce7a10ace095db73705b53",
    "major_version": 12,
    "difficulty": 156507748988,
    "target": 120,
    "height": 2175193,
    "reward": 1460595207335,
    "units": 1000000000000,
    "ts": 1598723700495,
    "algo": "rx/0"
  },
  {
    "coin": "ETH",
    "hash": "...",
    "major_version": 13,
    "difficulty": 123456789012,
    "target": 10,
    "height": 10000000,
    "reward": 1000000000000000000,
    "units": 1000000000000000000,
    "ts": 1678886400000,
    "algo": "ethash"
  }
]
```
```

--------------------------------

### Get Network Object for Specified Coin

Source: https://xmrig.com/docs/api/1/network

Retrieves the network object for a specific cryptocurrency coin. The network object contains a short summary of the coin's network statistics.

```APIDOC
## GET /1/network/:coin

### Description
Retrieves the network object for a specific cryptocurrency coin. The network object contains a short summary of the coin's network statistics.

### Method
GET

### Endpoint
https://api.xmrig.com/1/network/:coin

### Parameters
#### Path Parameters
- **coin** (string) - Required - The coin code for which to retrieve network information (e.g., XMR).

### Response
#### Success Response (200)
- **coin** (string) - Coin code.
- **hash** (string) - Hash of the last network block.
- **major_version** (number) - Major version of the last network block.
- **difficulty** (number) - Current network difficulty.
- **target** (number) - Block time target in seconds. Use `difficulty / target` to get network hashrate.
- **height** (number) - Current network height.
- **reward** (number) - Reward of the last network block in atomic units.
- **units** (number) - Use `reward / units` to get a human-readable reward value.
- **ts** (timestamp) - Time when the last block was actually mined (discovered by API).
- **algo** (string) - Current network PoW algorithm.

#### Response Example
```json
{
  "coin": "XMR",
  "hash": "0194ca54327f2e997d8286f9355e5a892121d1028dce7a10ace095db73705b53",
  "major_version": 12,
  "difficulty": 156507748988,
  "target": 120,
  "height": 2175193,
  "reward": 1460595207335,
  "units": 1000000000000,
  "ts": 1598723700495,
  "algo": "rx/0"
}
```
```

--------------------------------

### Get Network Object for Specific Coin (API)

Source: https://xmrig.com/docs/api/1/network

Retrieves the network object for a specified cryptocurrency coin. This endpoint is useful for obtaining real-time network statistics for a single coin.

```HTTP
GET
https://api.xmrig.com/1/network/:coin
```

--------------------------------

### Run Online RandomX Benchmark with XMRig

Source: https://xmrig.com/docs/miner/benchmark

Execute XMRig to perform an online RandomX benchmark and publish results. This requires an internet connection and optionally a personal access token for submission. The benchmark runs a specified number of hashes (e.g., 1M or 10M) and prints a benchmark URL. Different algorithm variants (Monero or Wownero) can be selected.

```bash
xmrig --bench=1M --submit
xmrig --bench=10M --submit
xmrig --bench=1M --submit -a rx/wow
xmrig --bench=10M --submit -a rx/wow
```

--------------------------------

### KeepAlive Success Reply Example

Source: https://xmrig.com/docs/extensions/keepalive

This JSON object illustrates a successful reply from the server to a KeepAlive request. It confirms the keep-alive status and includes the original request ID and JSON-RPC version.

```json
{
  "id": 2,
  "jsonrpc": "2.0",
  "error": null,
  "result": {
    "status": "KEEPALIVED"
  }
}
```

--------------------------------

### KeepAlive Request Example

Source: https://xmrig.com/docs/extensions/keepalive

This JSON object represents a KeepAlive request sent by the miner to the server. It includes a unique ID and the 'keepalived' method, along with a specific ID for the keep-alive session.

```json
{
  "id": 2,
  "method": "keepalived",
  "params": {
    "id": "1be0b7b6-b15a-47be-a17d-46b2911cf7d0"
  }
}
```

--------------------------------

### Verify XMRig Binary Dependencies on macOS

Source: https://xmrig.com/docs/miner/build/macos

This command-line utility is used to inspect the dynamic shared libraries linked by an executable file on macOS. It helps verify that the XMRig binary has the correct dependencies after compilation, ensuring it can run as expected.

```shell
otool -L xmrig
```

--------------------------------

### Get Network Objects for All Supported Coins (API)

Source: https://xmrig.com/docs/api/1/network

Fetches an array of network objects for all cryptocurrencies supported by the XMRig API. This provides a comprehensive overview of network statistics across multiple coins.

```HTTP
GET
https://api.xmrig.com/1/networks
```

--------------------------------

### Configure TLS Bind Address and Port

Source: https://xmrig.com/docs/proxy/tls

This snippet shows how to configure the host and port for TLS-enabled incoming connections. It can be set in the configuration file or via command-line arguments.

```json
"bind": [
    {
        "host": "0.0.0.0",
        "port": 443,
        "tls": true
    }
]
```

```bash
--tls-bind 0.0.0.0:443
```

--------------------------------

### Pool-Defined Algorithm in Pool Job Response (JSON)

Source: https://xmrig.com/docs/extensions/algorithm-negotiation

This JSON example demonstrates how a pool specifies the mining algorithm ('cn/r') within a job response to a miner. This is a primary extension for algorithm negotiation.

```json
{
  "id": 1, "jsonrpc": "2.0", "error": null,
  "result": {
    "id": "...",
    "job": {
      "blob": "...", "job_id": "...", "target": "...", "id": "...",
      "algo": "cn/r"
    },
    "status": "OK"
  }
}
```

--------------------------------

### Pool-Defined Algorithm in Job Notification (JSON)

Source: https://xmrig.com/docs/extensions/algorithm-negotiation

This JSON example shows a pool notifying a miner about a new job, including the specified mining algorithm ('cn/r'). This is part of the pool-defined algorithm negotiation.

```json
{
  "jsonrpc": "2.0", "method": "job",
  "params": {
    "blob": "...", "job_id": "...", "target": "b88d0600", "id": "...",
    "algo": "cn/r"
  }
}
```

--------------------------------

### Pool Defined Algorithm

Source: https://xmrig.com/docs/extensions/algorithm-negotiation

This extension allows the pool to specify the mining algorithm for each job. It simplifies miner setup by centralizing algorithm configuration on the pool side and enables dynamic algorithm switching for multi-algorithm pools.

```APIDOC
## Pool Defined Algorithm

### Description
This extension allows the pool to specify the mining algorithm for each job by adding a simple text field `"algo"` to the job details. This simplifies miner setup and enables dynamic algorithm switching.

### Method
Not applicable (Server-initiated)

### Endpoint
Not applicable (Part of existing Stratum communication)

### Parameters
#### Response Body (Job Details)
- **algo** (string) - Required - The name of the mining algorithm to be used for the current job (e.g., `"cn/r"`).

### Request Example
```json
{
  "id": 1, "jsonrpc": "2.0", "error": null,
  "result": {
    "id": "...",
    "job": {
      "blob": "...", "job_id": "...", "target": "...", "id": "...",
      "algo": "cn/r"
    },
    "status": "OK"
  }
}
```
```json
{
  "jsonrpc": "2.0", "method": "job",
  "params": {
    "blob": "...", "job_id": "...", "target": "b88d0600", "id": "...",
    "algo": "cn/r"
  }
}
```

### Response
#### Success Response (Job Update)
- **algo** (string) - The algorithm specified by the pool for the current job.

#### Response Example
(See Request Example)
```

--------------------------------

### Advanced Static XMRig Build on Alpine Linux

Source: https://xmrig.com/docs/miner/build/alpine

This snippet details the advanced build process for XMRig on Alpine Linux, focusing on creating a fully static executable. It uses a script to build dependencies like libuv, openssl, and hwloc as static libraries. This method results in a CPU-only binary and is not compatible with GPU backends. Dependencies include git, make, cmake, and build tools.

```shell
1. apk add git make cmake libstdc++ gcc g++ automake libtool autoconf linux-headers
2. git clone https://github.com/xmrig/xmrig.git
3. mkdir xmrig/build && cd xmrig/scripts
4. ./build_deps.sh && cd ../build
5. cmake .. -DXMRIG_DEPS=scripts/deps -DBUILD_STATIC=ON
6. make -j$(nproc)
```
Tokens:
Raw