SDK для Python — whatsapp-data-sdk

Офіційний клієнт Python для WhatsApp Data API. Типізовані відповіді, одна залежність (запити), пошук у кеші та чітка ієрархія винятків.

1 залежність
Типізовано (py.typed)
Порт npm SDK
PyPIGitHub

Встановити

pip install whatsapp-data-sdk

Підтримується Python 3.8-3.13. Поставляється з маркером py.typed для повної підтримки перевірки типів (mypy, pyright).

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

from whatsapp_data_sdk import WhatsAppDataClient

client = WhatsAppDataClient(api_key="YOUR_KEY")  # sent as x-rapidapi-key

profile = client.get_profile("59898297150")
print(profile.get("exists"), profile.get("about"), profile.get("profilePic"))

Автентифікація та транспортування

Ваш ключ завжди надсилається у форматі x-rapidapi-key. Виберіть, куди надсилаються запити за допомогою транспорту.

transportВедучий прямого ефіруКеш / хост лише для бази даних
"proxy" (за замовчуванням)whatsapp-proxy.checkleaked.cc/number_cache на тому ж хості
"rapidapi"wp-data.p.rapidapi.comwp-data-db-only.p.rapidapi.com
client = WhatsAppDataClient(api_key="RAPIDAPI_KEY", transport="rapidapi")

Перевизначення URL-адрес/хостів через base_url, cache_base_url, rapidapi_host, rapidapi_cache_host.

Пошук у кеші (економія коштів)

check_cached() спочатку зчитує кінцеву точку дешевого кешу / лише для бази даних і повертається до платної перевірки в реальному часі лише у разі справжнього промаху.

r1 = client.check_cached("59898297150")                  # cacheFirst (default)
print(r1["_source"])                                     # "cache" | "live"
r2 = client.check_cached("59898297150", mode="cacheOnly")  # never a live call
r3 = client.check_cached("59898297150", mode="live")       # always fresh

Авторитетний кешований запис, який не знаходиться в WhatsApp, вважається згодою (без марнотратної повторної перевірки в реальному часі); лише справжній промах NOT_IN_DATABASE залишається активним.

Довідник API

Кожен метод зіставляє 1:1 з кінцевою точкою маркетплейсу — таке ж покриття, як і npm SDK, іменування snake_case.

# Profile & pictures
client.get_profile(number, telegram=True, include_carrier=True)  # Get Profile Information
client.get_profile_no_picture(number)                            # (No profile pic)
pic = client.get_last_picture(number)                            # JPEG bytes -> pic.content, pic.to_data_uri()
client.get_device_count(number)                                  # Device count
client.get_osint_info(number)                                    # OSINT Info

# Breaches
client.get_phone_breaches(number, limit=50)                      # built-in (no external key)
client.get_phone_breaches_external(number, api_key="...")        # your checkleaked.cc key

# Search & database
client.search(country_code="UY", is_business=True, limit=20)     # Search
client.search_google_maps(latitude=-34.9, longitude=-56.16, radius=2000)  # Search in Google Maps
client.get_leaked_numbers_info()                                 # Leaked Numbers (500M) -> Drive link (MEGA tier)
client.download_entire_database()                                # Download the Entire DB -> Drive link (MEGA tier)

# Bulk
client.bulk_check(numbers)                                       # live (max 50)
client.bulk_check_db_basic(numbers)                              # DB basic (max 1000)
client.bulk_check_db_full(numbers)                                # DB full (max 1000)

# Telegram / carrier
client.get_telegram_profile("59898297150")                      # experimental
client.get_telegram_profile(["num1", "num2"])
client.carrier_lookup(number)                                    # Carrier Lookup
client.carrier_lookup_alt(number, page=2)                        # Carrier Lookup Alternative

«Не знайдено» вирішує проблему — не викликає

Номер, якого немає в WhatsApp, є нормальним результатом, тому ці рішення (ніколи не підвищують):

get_profile / get_profile_no_picture / check_cached повертає словник зі значенням exists=False (та кодом=NUMBER_NOT_FOUND).
пошук з нульовим збігом повертає порожню сторінку (success=False, data['docs'] == []).
get_device_count для номера, відмінного від WhatsApp, повертає success=False.
p = client.get_profile("14155552671")
if not p.get("exists"):
    print("not on WhatsApp")

Що викликає: недійсний номер (400), авторизація (401/403), обмеження швидкості (429), тайм-аут, мережа, 5xx.

Варіанти для кожного запиту

Кожен метод приймає тайм-аут (секунди) та повторні спроби:

client.get_profile("59898297150", timeout=5, retries=0)

Помилки

Усі невдачі створюють підклас WhatsAppDataError.

КласКоли
ValidationErrorНеправильні аргументи (виникають перед будь-яким запитом; немає .status).
AuthError401 / 403 — відсутній/недійсний/відписаний ключ.
RateLimitError429 — переносить .retry_after_ms, коли сервер надіслав Retry-After.
HttpErrorБудь-який інший код, відмінний від 2xx (наприклад, 400, 5xx); має .status, .body.
TimeoutErrorЗапит перевищив час очікування.
NetworkErrorТранспортний збій.
WhatsAppDataErrorБазовий клас.
from whatsapp_data_sdk import AuthError, RateLimitError, WhatsAppDataError

try:
    client.get_profile("59898297150")
except AuthError:
    ...  # 401/403
except RateLimitError as e:
    print(e.retry_after_ms)
except WhatsAppDataError as e:
    print(e.status, e.body)

POST-запити (bulk_check, bulk_check_db_*) не повторюються автоматично, щоб уникнути подвійного використання квоти.

Формати номерів телефонів

Працює будь-який формат — SDK нормалізує; допоміжні функції експортуються:

from whatsapp_data_sdk import to_digits, to_e164
to_digits("+598 98 297 150")  # "59898297150"  (path & live endpoints)
to_e164("59898297150")        # "+59898297150" (bulk-DB endpoints require it)

Пов'язані

Що кажуть наші користувачі

Реальні відгуки від наших задоволених клієнтів

4.5/5 (176 відгуки)