SDK Python — whatsapp-data-sdk

Instalar

pip install whatsapp-data-sdk

Compatível com Python 3.8-3.13. Inclui um marcador py.typed para suporte completo a verificadores de tipo (mypy, pyright).

Início rápido

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

Autenticação e transporte

Sua chave é sempre enviada em x-rapidapi-key. Escolha para onde as solicitações serão enviadas com o transporte.

client = WhatsAppDataClient(api_key="RAPIDAPI_KEY", transport="rapidapi")

Substitua URLs/hosts através de base_url, cache_base_url, rapidapi_host, rapidapi_cache_host.

Consultas com prioridade no cache (economiza dinheiro)

A função check_cached() lê primeiro o endpoint de cache/banco de dados mais barato e só recorre a uma verificação paga em tempo real em caso de falha real.

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

Um registro em cache autorizado de "não presente no WhatsApp" conta como um acerto (sem necessidade de nova verificação em tempo real); somente uma falha verdadeira de "NÃO ESTÁ NO BANCO DE DADOS" é registrada em tempo real.

Referência da API

Cada método corresponde 1:1 a um endpoint do marketplace - mesma cobertura do SDK do npm, com nomenclatura em 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

"Não encontrado" resolve o problema — não gera nova mensagem.

Um número que não está no WhatsApp é um resultado normal, portanto, esses problemas são resolvidos (nunca surgem):

p = client.get_profile("14155552671")
if not p.get("exists"):
    print("not on WhatsApp")

O que gera: número inválido (400), autenticação (401/403), limite de taxa (429), tempo limite, rede, 5xx.

Opções por pedido

Cada método aceita um tempo limite (em segundos) e novas tentativas:

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

Erros

Todas as falhas geram uma subclasse de 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)

As solicitações POST (bulk_check, bulk_check_db_*) não são repetidas automaticamente para evitar o consumo duplo da cota.

Formatos de números de telefone

Qualquer formato funciona — o SDK normaliza; os auxiliares são exportados:

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)

Relacionado