npm SDK — whatsapp-data-sdk

インストール

npm install whatsapp-data-sdk
# or
pnpm add whatsapp-data-sdk
# or
yarn add whatsapp-data-sdk

ネイティブのfetchを使用します。Node 18以降、Bun、Deno、およびブラウザで動作します。axiosやポリフィルは不要です。

クイックスタート

import { WhatsAppDataClient } from 'whatsapp-data-sdk'

const client = new WhatsAppDataClient({
  apiKey: process.env.WA_API_KEY!, // sent as x-rapidapi-key
})

const profile = await client.getProfile('59898297150')
console.log(profile.exists, profile.about, profile.profilePic)

認証と輸送

APIキーは常にx-rapidapi-keyヘッダーで送信されます。トランスポートを使用してリクエストの送信先を選択してください。

// RapidAPI marketplace (live + DB-only hosts)
const client = new WhatsAppDataClient({
  apiKey: process.env.RAPIDAPI_KEY!,
  transport: 'rapidapi',
})

baseUrl、cacheBaseUrl、rapidApiHost、rapidApiCacheHost を介して、任意の URL/ホストを上書きできます。

キャッシュ優先検索（コスト削減）

checkCached() は、まず安価なキャッシュ/データベース専用エンドポイントを読み込み、番号がまだキャッシュされていない場合にのみ、有料のライブチェックにフォールバックします。

// cacheFirst (default): DB first → live only on a miss
const r1 = await client.checkCached('59898297150')
console.log(r1._source) // 'cache' | 'live'

// cacheOnly: never spend on a live check
const r2 = await client.checkCached('59898297150', { mode: 'cacheOnly' })

// live: always fresh
const r3 = await client.checkCached('59898297150', { mode: 'live' })

rapidapiトランスポートでは、キャッシュの読み取りはwp-data-db-only.p.rapidapi.comにルーティングされ、ライブフォールバックはwp-data.p.rapidapi.comにルーティングされます。これは、2つのホストを使用するコスト削減フローです。

APIリファレンス

すべてのメソッドは、マーケットプレイスのエンドポイントに1対1で対応しています。

プロフィールと写真

await client.getProfile(number, options?)            // Get Profile Information
await client.getProfileNoPicture(number, options?)   // Get Profile Information (No profile pic)
await client.getLastPicture(number)                  // Get Last Saved Picture (JPEG bytes)
await client.getDeviceCount(number)                  // Device count
await client.getOsintInfo(number)                    // OSINT Info

getProfile のオプションには、telegram、google、lookup、includeCarrier、base64、geminiFaceAnalysis、reverseImageSearch、fullAiReport、includeDeviceCount、onlyCheck、useCache、forceBypassCache などがあります。

const pic = await client.getLastPicture('59898297150')
// pic.bytes: Uint8Array, pic.contentType: string
htmlImg.src = pic.toDataUri()

電話の不正アクセス

await client.getPhoneBreaches(number, { limit, offset }) // Get Phone Breaches (no external key)
await client.getPhoneBreachesExternal(number, apiKey)     // Get Phone Breaches (your checkleaked.cc key)

検索とデータベース

await client.search({ countryCode: 'UY', isBusiness: true, limit: 20 })   // Search
await client.searchGoogleMaps({ latitude: -34.9, longitude: -56.16, radius: 2000 }) // Search in Google Maps

// Bulk downloads return a Google Drive link to the full dataset (MEGA tier only)
const leaks = await client.getLeakedNumbersInfo()   // Leaked Numbers (500M database)
console.log(leaks.driveFolder.url)

const backup = await client.downloadEntireDatabase() // Download the Entire DB
console.log(backup.driveFolder.url)

一括小切手

await client.bulkCheck(numbers, { includeBusiness, noBanStatus }) // Bulk Check (live, max 50)
await client.bulkCheckDbBasic(numbers)                            // Basic Check (DB, max 1000)
await client.bulkCheckDbFull(numbers)                            // Full Check (DB, max 1000)

テレグラム＆キャリア

// Telegram (experimental)
await client.getTelegramProfile('59898297150')            // single
await client.getTelegramProfile(['num1', 'num2'])         // batch

// Carrier
await client.carrierLookup(number)              // Carrier Lookup
await client.carrierLookupAlt(number)           // Carrier Lookup Alternative (spam-report signals)
await client.carrierLookupAlt(number, { page: 2 }) // page through the reports (response has a `pagination` block)

「見つかりません」は解決され、エラーは発生しません。

WhatsAppに登録されていない番号は正常な結果であり、エラーではないため、これらは解決されます（拒否されることはありません）。

const p = await client.getProfile('14155552671')
if (!p.exists) console.log('not on WhatsApp')

発生するエラー: 無効な番号 (400)、認証失敗 (401/403)、レート制限 (429)、タイムアウト、ネットワーク障害、および 5xx。

エラー

すべての拒否は WhatsAppDataError のサブクラスであるため、単一の catch 文ですべてを処理できます。

import { AuthError, RateLimitError, TimeoutError, WhatsAppDataError } from 'whatsapp-data-sdk'

try {
  await client.getProfile('59898297150')
} catch (err) {
  if (err instanceof AuthError) {/* 401/403 — bad/unsubscribed key */}
  else if (err instanceof RateLimitError) {/* 429 — err.retryAfterMs */}
  else if (err instanceof TimeoutError) {/* request timed out */}
  else if (err instanceof WhatsAppDataError) {
    console.error(err.status, err.body)
  }
}

構成

new WhatsAppDataClient({
  apiKey: '...',           // required
  transport: 'proxy',      // 'proxy' | 'rapidapi'
  timeoutMs: 60000,        // request timeout (bounds headers AND body read)
  retries: 2,              // retry 5xx / 429 / network / timeout (GET only) with backoff
  retryDelayMs: 500,       // exponential base; 429 honors Retry-After when longer
  baseUrl: '...',          // override live base URL
  cacheBaseUrl: '...',     // override cache/DB-only base URL
  rapidApiHost: '...',     // override live x-rapidapi-host
  rapidApiCacheHost: '...',// override cache x-rapidapi-host
  userAgent: '...',        // custom User-Agent
  fetch: globalThis.fetch, // inject a custom fetch (tests / polyfills)
})

電話番号の形式

数値を任意の形式で渡してください。SDKがそれらを正規化し、同じ正規化を再利用できるヘルパーをエクスポートします。

import { toDigits, toE164 } from 'whatsapp-data-sdk'
toDigits('+598 98 297 150') // '59898297150'  (path & live endpoints)
toE164('59898297150')       // '+59898297150' (bulk-DB endpoints; their validator requires it)
// both throw ValidationError on input with no digits

リクエストごとのオプション

すべてのメソッドは、シグナル、タイムアウトMs、およびリトライも受け入れる末尾オプションオブジェクトを受け取ります。これらは、呼び出しごとのキャンセルと調整に使用されます。

const controller = new AbortController()
const p = client.getProfile('59898297150', {
  telegram: true,
  signal: controller.signal, // cancel this specific request
  timeoutMs: 5000,           // override the client timeout for this call
})
controller.abort() // rejects with WhatsAppDataError

関連している