---
title: "Документація API"
description: "Довідник API webatla: автентифікація через Bearer, ендпоінти датасетів і завантажень, формат JSONL і zstd, ліміти частоти та робочі приклади."
url: https://webatla.com/uk/api-docs
---

# API webatla

Підключіть базу доменів напряму до власного стека. Автентифікуйтеся ключем Bearer, завантажте цілий датасет або окремий зріз у стисненому JSONL і фільтруйте його локально. Без тарифікації за кожен рядок.

[Отримати ключ API](https://webatla.com/account/api)
[Специфікація OpenAPI](https://webatla.com/api/v1/openapi.json)

REST, через HTTPS, відповіді у JSON

Bearer, автентифікація токеном, список дозволених IP

JSONL, файли, стиснені zstd

OpenAPI, машиночитна специфікація 3.1

## Як працює API

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

#### 1. Створіть ключ

Згенеруйте ключ API типу Bearer у своєму акаунті, за бажанням обмеживши його списком дозволених IP. Надсилайте його у заголовку Authorization.

#### 2. Завантажте файли

Заберіть повний експорт або один зріз за TLD, суфіксом TLD, країною чи технологією. Перервані завантаження можна продовжити запитом Range.

#### 3. Фільтруйте локально

Розпакуйте через zstd і робіть запити за допомогою jq, сховища даних або власного коду. Один вимір на зріз, решту перетинайте самостійно.

## Автентифікація

Більшість ендпоїнтів вимагають Bearer API-ключа. Каталог датасетів відкритий для всіх. Завантаження прев'ю та зразків потребує безкоштовного акаунта або ключа.

- Створюйте ключі та керуйте ними у [вашому акаунті](https://webatla.com/account/api). Повний ключ показується лише один раз під час створення, тому збережіть його в надійному місці.

- Надсилайте його як `Authorization: Bearer wbtl_…` у кожному автентифікованому запиті.

- За бажанням обмежте ключ списком дозволених IP. Запити з інших адрес отримують `401`.

- Ліміт частоти запитів рахується окремо для кожного ключа. Ключ можна замінити або відкликати будь-коли.

```
GET https://webatla.com/api/v1/me
  Authorization: Bearer wbtl_•••••••f3a9

# 200 OK
{
  "user": { "id": "…", "email": "you@example.com", "role": "customer" },
  "apiKeyId": "…",
  "scopes": ["me:read"]
}
```

## Ендпоінти

Повний машиночитний контракт доступний за адресою [`/api/v1/openapi.json`](https://webatla.com/api/v1/openapi.json) (OpenAPI 3.1).

| Метод | Ендпоінт | Автентифікація | Ліміт частоти | Призначення |
| --- | --- | --- | --- | --- |
| GET | `/api/v1/datasets` | Публічний | 60/min | Список опублікованих датасетів із цінами та кількістю рядків |
| GET | `/api/v1/preview?dataset={slug}` | Акаунт або API-ключ | 30/min | Безкоштовний зразок на 10 000 рядків з усього датасету |
| GET | `/api/v1/sample/{scope}/{key}?dataset={slug}` | Акаунт або API-ключ | 30/min | Безкоштовний зразок на 20 рядків для однієї сутності (TLD, суфікс, країна, технологія) |
| GET | `/api/v1/me` | Bearer | 200/min | Користувач і області доступу поточного ключа |
| GET | `/api/v1/me/orders` | Bearer | 200/min | Ваші замовлення та їхній статус |
| GET | `/api/v1/me/downloads` | Bearer | 200/min | Історія ваших завантажень (`?limit=` до 500) |
| GET | `/api/download/{slug}` | Bearer | 240/min | Повний експорт датасету у форматі `.jsonl.zst` |
| GET | `/api/download/{slug}/{scope}/{key}` | Bearer | 240/min | Один зріз датасету за обраною областю |

`scope` може бути `tld`, `tld_suffix`, `country` або `technology`. Ендпоінти завантаження вимагають оплаченого та чинного доступу до цього датасету.

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

Кожне завантаження — це один файл. Заберіть увесь датасет або спершу звузьте вибірку до одного виміру.

#### Завантажити повний експорт

```
GET https://webatla.com/api/download/all-data
  Authorization: Bearer wbtl_•••••••f3a9

# Віддає весь датасет одним файлом .jsonl.zst
```

#### Завантажити окремий зріз

```
GET https://webatla.com/api/download/all-data/tld/com
https://webatla.com/api/download/all-data/tld_suffix/com.ua
https://webatla.com/api/download/websites-ranking/country/DE
https://webatla.com/api/download/technologies/technology/wordpress
  Authorization: Bearer wbtl_•••••••f3a9

# Рівно один вимір на файл. Решту фільтрувати локально.
```

#### curl, відновлення та локальна фільтрація

```
curl -f -OJ -H "Authorization: Bearer wbtl_•••••••f3a9" \
  https://webatla.com/api/download/technologies/technology/wordpress

# Відновити перерване завантаження через -C -
curl -f -C - -o all-data.jsonl.zst -H "Authorization: Bearer wbtl_•••••••f3a9" \
  https://webatla.com/api/download/all-data

# Великі файли: aria2c з 3 паралельними з’єднаннями швидший і сам продовжує після обриву
aria2c -x 3 -s 3 -c -o all-data.jsonl.zst \
  --header="Authorization: Bearer wbtl_•••••••f3a9" \
  https://webatla.com/api/download/all-data

# Розпакувати і відфільтрувати на своїй машині
zstdcat webatla-technologies-WordPress-*.jsonl.zst \
  | jq -c 'select(.["Country by IP"] == "DE")' > wordpress-de.jsonl
```

Перегляньте минулі завантаження через `GET https://webatla.com/api/v1/me/downloads`. Прев'ю будь-якого датасету зі своїм ключем: `GET https://webatla.com/api/v1/preview?dataset=all-data`.

## Формат даних

Файли мають формат JSON Lines (один об'єкт JSON на рядок) і стиснені zstd. Схема спільна для всіх датасетів, тому сигнали збігаються за одним і тим самим ключем домену.

- Кожен рядок — це один домен. Розпакуйте його командою `zstd -d` або читайте потоком через `zstdcat`.

- Назви колонок можуть містити пробіли, тому звертайтеся до них у jq через квадратні дужки, наприклад `.["Country by IP"]`.

- Поля можуть бути відсутні або мати значення null. Задайте для них значення за замовчуванням, наприклад `.Registrar // ""`.

- Дати подані рядками у форматі ISO 8601, наприклад `"2026-11-18T04:47:13.573"` або `"2026-04-22"`.

#### Довідник колонок

| Колонка | Тип | Приклад | Датасети |
| --- | --- | --- | --- |
| Domain | string | "arriva.com.hr" | d1–d7 |
| TLD suffix | string | "com.hr" | d1–d7 |
| TLD | string | "hr" | d1–d7 |
| Domain type | string: "ICANN" \| "PRIVATE" | "ICANN" | d1–d4, d6, d7 |
| HTTP status | integer \| null | 200 | d3, d6, d7 |
| IP address | string \| null | "31.13.236.27" | d3, d6, d7 |
| Country by IP | string (ISO-2) \| null | "DE" | d2, d3, d6, d7 |
| Social networks | object \| null | {"facebook": ["https://…"]} | d3, d6, d7 |
| Technologies last data checked | string (date) \| null | "2026-04-22" | d3, d6, d7 |
| Technologies | array \| object \| null | ["WordPress"] / {"PHP": "4.4.9"} | d3, d6, d7 |
| DNS last data checked | string (date) | "2026-06-03" | d4, d6, d7 |
| DNS Status | string: "TRUE" \| "FALSE" | "TRUE" | d4, d6, d7 |
| DNS records | object \| null | {"A": ["31.13.236.27"], "MX": [{"host": "…", "priority": 0}]} | d4, d6, d7 |
| PR value | number | 4.808574e-9 / 0 | d2, d3, d6, d7 |
| Harmonic value | number | 10305265 / 0 | d2, d3, d6, d7 |
| RDAP/WHOIS last date checked | string (date) | "2026-01-04" | d5, d7, d6* |
| RDAP/WHOIS method | string: "rdap" \| "whois" | "whois" | d5, d7, d6* |
| Domain creation date | string (ISO 8601) \| null | "2024-12-12T14:04:04" | d2, d3, d5, d6, d7 |
| Domain expiration date | string (ISO 8601) \| null | "2026-12-12T14:04:04" | d2, d3, d5, d6, d7 |
| Domain last changed | string (ISO 8601) \| null | "2026-01-04T04:43:01" | d5, d7, d6* |
| Registrar | string \| null | "REGRU-RU" | d5, d6, d7 |
| RDAP/WHOIS Record | object \| null | {"raw_response": "% TCI Whois…"} | d5, d6* |
| Response Status RDAP/WHOIS | string | "Domain is active" | d5, d6* |

**Датасети:** d1 All active domains · d2 Websites + Ranking · d3 Technologies · d4 DNS · d5 RDAP & WHOIS · d6 All data · d7 Domain Investor.

* У датасеті All data (d6) поля RDAP/WHOIS присутні лише для доменів, які мають запис про реєстрацію.

#### Структура вкладених полів

- `Technologies` може бути або масивом назв, або об'єктом, що зіставляє назву з версією.

- `DNS Status` — це рядок `"TRUE"` або `"FALSE"`, а не булеве значення. Відбирайте живі домени за "TRUE", а не за непорожнім обʼєктом DNS records, бо рядок зі значенням FALSE може містити останні відомі записи домену.

- `DNS records` є обʼєктом, у якому ключі відповідають типам записів. Кожен тип містить список, крім SOA, який є одним обʼєктом. Записи SRV вказують назву сервісу. Після повторної перевірки домену в його даних також зʼявляються похідні поля DKIM, DNSSEC, CDN, ASN, WWW (записи хоста www), MX_TLSA і NULL_MX, які можуть бути рядками, булевими значеннями або обʼєктами. PARTIAL перелічує типи записів, на які під час останньої перевірки не надійшло відповіді. Їхні значення, якщо вони є, взято з ранішої перевірки. Типи записів такі: `A, AAAA, CAA, CNAME, DNSKEY, DS, HTTPS, MX, NS, SOA, SRV, SSHFP, TLSA, TXT`. `MX` має вигляд `[{"host", "priority"}]`.

- `Social networks` зіставляє платформу з посиланнями на профілі: `facebook, instagram, x-twitter, linkedin, youtube, whatsapp, telegram, tiktok, github…`. Це власні публічні посилання сайту, а не контакти конкретної людини.

- `RDAP/WHOIS Record` містить необроблений запис про реєстрацію, з якого вилучено персональні поля згідно з правилами ICANN.

## Рецепти

Перевірено на справжніх файлах експорту. Усе виконується локально після того, як ви завантажите файл.

#### Підрахунок, вибірка та експорт у CSV

```
# Порахувати рядки у зрізі
zstdcat webatla-all-data-com-*.jsonl.zst | wc -l

# Один домен на рядок
zstdcat webatla-all-data-com-*.jsonl.zst | jq -r '.Domain' > domains.txt

# Вибрані колонки у CSV
zstdcat webatla-all-data-com-*.jsonl.zst \
  | jq -r '[.Domain, .["Country by IP"] // "", .Registrar // ""] | @csv' > out.csv
```

#### Фільтрація за технологією

```
# Technologies буває масивом АБО об'єктом, обробляти обидва
zstdcat webatla-all-data-com-*.jsonl.zst \
  | jq -c 'select(.Technologies
      | if type=="array" then index("WordPress")
        elif type=="object" then has("WordPress")
        else false end)' > wordpress.jsonl
```

#### DNS і терміни дії

```
# Припарковані або мертві домени
zstdcat webatla-dns-com-*.jsonl.zst \
  | jq -r 'select(.["DNS Status"] == "FALSE") | .Domain' > parked.txt

# Унікальні A records
zstdcat webatla-dns-com-*.jsonl.zst \
  | jq -r '.["DNS records"].A[]?' | sort -u > ips.txt

# Домени, що спливають у червні 2026
zstdcat webatla-all-data-com-*.jsonl.zst \
  | jq -r 'select((.["Domain expiration date"] // "") | startswith("2026-06")) | .Domain'
```

#### Python

```
# Спочатку розпакувати
zstd -d webatla-all-data-com-*.jsonl.zst

# Потім читати рядок за рядком
import json

with open("webatla-all-data-com-2026-06-09.jsonl", encoding="utf-8") as f:
    for line in f:
        row = json.loads(line)
        t = row.get("Technologies")
        names = t if isinstance(t, list) else list(t) if isinstance(t, dict) else []
        if "WordPress" in names and row.get("Country by IP") == "DE":
            print(row["Domain"])
```

## Коди відповідей і ліміти

Помилки повертають тіло JSON у вигляді `{"error": "…"}`. Заголовки з лімітами частоти повертаються на кожен запит.

| Код | Значення |
| --- | --- |
| 200 / 206 | Успіх. 206 означає часткове (відновлене) завантаження. |
| 302 | На маршруті завантаження немає сесії браузера. Для ключів API натомість повертається 401. |
| 401 | Ключ API відсутній, недійсний або заблокований за IP. |
| 403 | Немає активного оплаченого доступу до цього датасету. |
| 404 | Невідомий датасет чи сутність, або файл ще не завантажено на сервер. |
| 416 | Некоректний або багаточастинний запит Range. |
| 429 | Перевищено ліміт частоти запитів. Зачекайте та повторіть спробу. |

Публічні ендпоінти обмежені за IP. Автентифіковані ендпоінти обмежені за ключем або за користувачем, як зазначено вище.

## Почніть розробку

Створіть ключ у своєму акаунті або перегляньте датасети й завантажте зразок через свій безкоштовний акаунт. Питання щодо індивідуального зрізу? Напишіть на support@webatla.com.

[Отримати ключ API](https://webatla.com/account/api)
[Переглянути датасети](https://webatla.com/uk/pricing)
