Create Watcher Link

Creates a new watcher link for one or more mining accounts, granting specific permissions with a configurable expiration.

Rate limit: 1000 requests/10 sec.

POST /api/v4/mining/watcher-links/create

Create Watcher Link

cURL

curl --request POST \
  --url https://whitebit.com/api/v4/mining/watcher-links/create \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --data '
{
  "accounts": [
    "my_miner_01",
    "my_miner_02"
  ],
  "name": "monitoring_link",
  "permissions": [
    "dashboard",
    "workers"
  ],
  "liveUntil": "7d"
}
'

import requests

url = "https://whitebit.com/api/v4/mining/watcher-links/create"

payload = {
    "accounts": ["my_miner_01", "my_miner_02"],
    "name": "monitoring_link",
    "permissions": ["dashboard", "workers"],
    "liveUntil": "7d"
}
headers = {
    "X-TXC-APIKEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-TXC-APIKEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accounts: ['my_miner_01', 'my_miner_02'],
    name: 'monitoring_link',
    permissions: ['dashboard', 'workers'],
    liveUntil: '7d'
  })
};

fetch('https://whitebit.com/api/v4/mining/watcher-links/create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://whitebit.com/api/v4/mining/watcher-links/create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'accounts' => [
        'my_miner_01',
        'my_miner_02'
    ],
    'name' => 'monitoring_link',
    'permissions' => [
        'dashboard',
        'workers'
    ],
    'liveUntil' => '7d'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-TXC-APIKEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://whitebit.com/api/v4/mining/watcher-links/create"

	payload := strings.NewReader("{\n  \"accounts\": [\n    \"my_miner_01\",\n    \"my_miner_02\"\n  ],\n  \"name\": \"monitoring_link\",\n  \"permissions\": [\n    \"dashboard\",\n    \"workers\"\n  ],\n  \"liveUntil\": \"7d\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-TXC-APIKEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://whitebit.com/api/v4/mining/watcher-links/create")
  .header("X-TXC-APIKEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accounts\": [\n    \"my_miner_01\",\n    \"my_miner_02\"\n  ],\n  \"name\": \"monitoring_link\",\n  \"permissions\": [\n    \"dashboard\",\n    \"workers\"\n  ],\n  \"liveUntil\": \"7d\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://whitebit.com/api/v4/mining/watcher-links/create")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-TXC-APIKEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accounts\": [\n    \"my_miner_01\",\n    \"my_miner_02\"\n  ],\n  \"name\": \"monitoring_link\",\n  \"permissions\": [\n    \"dashboard\",\n    \"workers\"\n  ],\n  \"liveUntil\": \"7d\"\n}"

response = http.request(request)
puts response.read_body

201

{
  "data": {
    "id": "abc123-external-id",
    "link": "https://whitebit.com/mining-pool/watcher-link/abc123-external-id",
    "liveUntil": 1709944800,
    "createdAt": 1709340000
  }
}

{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "user": [
      "Limit exceeded"
    ]
  }
}

Authorizations

X-TXC-APIKEY · string · header · required

API key authentication using signed requests

Body

application/json

accounts · string[] · required

Array of mining account names

Minimum array length: 1

Maximum string length: 255

Example:

["my_miner_01", "my_miner_02"]

name · string · required

Link name (alphanumeric and underscores only)

Maximum string length: 255

Pattern: ^[a-zA-Z0-9_]+$

Example:

"monitoring_link"

permissions · enum<string>[] · required

Array of permissions

Required array length: 1 - 3 elements

Available options: dashboard, rewards, workers

Example:

["dashboard", "workers"]

liveUntil · enum<string> · required

Expiration period

Available options: 1h, 24h, 7d, always

Example:

"7d"

Response

201

application/json

Watcher link created successfully

data · object

Show child attributes