Документація Backlinks API

Швидкий старт

Базова адреса: https://backlinks.uk.app/api/v1. Зареєструйтесь, створіть API-ключ у кабінеті й надішліть перший запит:

curl -H "X-API-Key: ВАШ_КЛЮЧ" "https://backlinks.uk.app/api/v1/overview?q=github.com"

Дані — індекс на 181 млн доменів і 2,7 млрд зв'язків, оновлюється приблизно щомісяця. Домени нормалізуються автоматично: регістр і префікс www. не мають значення.

Авторизація

Кожен запит, крім /v1/health, має містити API-ключ у заголовку:

X-API-Key: bl_live_…

Також приймається Authorization: Bearer …. Передавати ключ у параметрах URL не можна: так він потрапив би в логи та історію браузера.

Кредити й ліміти

Кожен виклик коштує 1–3 кредити залежно від ендпоінта, незалежно від кількості рядків у відповіді (до 1 000). Спершу витрачаються кредити тарифу на поточний місяць, потім — докуплений баланс. Якщо запит не вдався з нашого боку, кредити повертаються. Тарифи й пакети

Залишок кредитів також є в полі _credits кожної відповіді та в /v1/account (безкоштовно).

Формат відповіді та помилки

Кожна відповідь має поле ok. Списки містять rows, total, page, per. Помилка: ok = false, error — пояснення, code — машинний код.

{ "ok": true, "domain": "github.com", "summary": { "dr": 83, "backlinks": 826422352, "ref_domains": 1233241, … },
  "_credits": { "cost": 1, "plan_remaining": 1999, "balance": 0, "available": 1999, "cached": false } }

{ "ok": false, "code": "insufficient_credits", "error": "Not enough credits: this call costs 2, you have 1. …" }

Ендпоінти

Усі ендпоінти — GET /api/v1/{назва}. Пагінація: page (з 1) і per (10–1000). Сортування: sort + order=asc|desc.

* — обов'язковий параметр

Приклади коду

# curl — top referring domains by links
curl -H "X-API-Key: $KEY" "https://backlinks.uk.app/api/v1/refdomains?q=github.com&sort=links&per=20"

# curl — DR for a list of domains (POST, up to 2000)
curl -H "X-API-Key: $KEY" --data-binary $'github.com\nmoz.com\nnytimes.com' "https://backlinks.uk.app/api/v1/bulk_dr"

# Python
import os, requests
r = requests.get("https://backlinks.uk.app/api/v1/backlinks",
                 params={"q": "github.com", "per": 100, "follow": 1},
                 headers={"X-API-Key": os.environ["KEY"]}, timeout=30)
r.raise_for_status()
data = r.json()
for row in data["rows"]:
    print(row)
print("credits left:", data["_credits"]["available"])

// Node.js 18+ (на сервері — не у браузері)
const res = await fetch("https://backlinks.uk.app/api/v1/overview?q=github.com", { headers: { "X-API-Key": process.env.KEY } });
const d = await res.json();
if (!d.ok) throw new Error(d.error);
console.log(d.summary.dr, d.summary.ref_domains);

// PHP
$ch = curl_init('https://backlinks.uk.app/api/v1/anchors?q=github.com&per=50');
curl_setopt_array($ch, [CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => ['X-API-Key: ' . getenv('KEY')]]);
$d = json_decode(curl_exec($ch), true);
foreach ($d['rows'] as $a) echo $a['anchor'], PHP_EOL;

Спробувати

Ключ можна створити в кабінеті. Запит іде прямо з вашого браузера. Ключ ніде не зберігається й зникає після перезавантаження сторінки. Запити з консолі витрачають кредити так само, як звичайні.