Zestaw SDK Pythona — whatsapp-data-sdk

Oficjalny klient Pythona dla API danych WhatsApp. Odpowiedzi wpisywane, jedna zależność (żądania), wyszukiwanie w pamięci podręcznej i przejrzysta hierarchia wyjątków.

1 zależność
Wpisane (py.typed)
Port npm SDK
PyPIGitHub

Zainstalować

pip install whatsapp-data-sdk

Obsługiwane są wersje Pythona 3.8–3.13. Dostarczany z markerem py.typed zapewniającym pełną obsługę funkcji sprawdzania typów (mypy, pyright).

Szybki start

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"))

Uwierzytelnianie i transport

Twój klucz jest zawsze wysyłany w formacie x-rapidapi-key. Wybierz, dokąd mają być wysyłane żądania w ramach transportu.

transportGospodarz na żywoHost tylko dla pamięci podręcznej/bazy danych
"proxy" (domyślny)whatsapp-proxy.checkleaked.cc/number_cache na tym samym hoście
"rapidapi"wp-data.p.rapidapi.comwp-data-db-only.p.rapidapi.com
client = WhatsAppDataClient(api_key="RAPIDAPI_KEY", transport="rapidapi")

Nadpisz adresy URL/hosty za pomocą base_url, cache_base_url, rapidapi_host, rapidapi_cache_host.

Wyszukiwania w pamięci podręcznej (oszczędność pieniędzy)

Funkcja check_cached() najpierw odczytuje tani punkt końcowy pamięci podręcznej/tylko bazy danych i powraca do płatnego sprawdzania na żywo tylko w przypadku prawdziwego chybienia.

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

Autorytatywny rekord z pamięci podręcznej, który nie znajduje się w WhatsApp, jest uznawany za trafienie (bez zbędnego ponownego sprawdzania na żywo); tylko prawdziwy błąd NOT_IN_DATABASE nie zostaje opublikowany.

Odniesienie do API

Każda metoda mapuje 1:1 na punkt końcowy sklepu — taki sam zasięg jak npm SDK, nazewnictwo 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

„Nie znaleziono” rozwiązuje problem — nie powoduje

Numer, którego nie ma na WhatsAppie, jest normalnym wynikiem, dlatego rozwiąż te problemy (nigdy nie podnieś):

get_profile / get_profile_no_picture / check_cached zwraca słownik z parametrem exists=False (i kodem code=NUMBER_NOT_FOUND).
wyszukiwanie z zerowymi wynikami zwraca pustą stronę (sucess=False, data['docs'] == []).
get_device_count dla numeru innego niż WhatsApp zwraca success=False.
p = client.get_profile("14155552671")
if not p.get("exists"):
    print("not on WhatsApp")

Co powoduje błąd: nieprawidłowy numer (400), autoryzacja (401/403), limit przepustowości (429), przekroczenie limitu czasu, sieć, 5xx.

Opcje na żądanie

Każda metoda akceptuje limit czasu (sekundy) i ponowne próby:

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

Błędy

Wszystkie awarie powodują utworzenie podklasy WhatsAppDataError.

KlasaGdy
ValidationErrorBłędne argumenty (podniesione przed jakimkolwiek żądaniem; brak .status).
AuthError401 / 403 — brakujący/nieprawidłowy/niesubskrybowany klucz.
RateLimitError429 — przenosi .retry_after_ms, gdy serwer wysłał Retry-After.
HttpErrorKażdy inny typ nie-2xx (np. 400, 5xx); ma .status, .body.
TimeoutErrorŻądanie przekroczyło limit czasu.
NetworkErrorAwaria transportu.
WhatsAppDataErrorKlasa bazowa.
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)

Polecenia POST (bulk_check, bulk_check_db_*) nie są automatycznie ponawiane, aby uniknąć podwójnego wydatkowania kwoty.

Formaty numerów telefonów

Działa każdy format — SDK normalizuje, a pomocnicy są eksportowani:

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)

Powiązany

Co mówią nasi użytkownicy

Prawdziwe opinie od naszych zadowolonych klientów

4.5/5 (176 recenzje)