WhatsApp API

Our WhatsApp API gives you programmatic access to WhatsApp data that isn't available through any official API. Get data on phone numbers, profile names, business descriptions, email addresses, website URLs, profile pictures, and more. And the best part? You can try the WhatsApp API entirely for free, no credit card required.

Try WhatsApp API

Trusted by industry leaders all over the world

Integrate our WhatsApp API

Access the WhatsApp API using Python, JavaScript, CLI, cURL, OpenAPI, or MCP. Choose your preferred option and start extracting WhatsApp data in minutes.

Python

JavaScript

HTTP

MCP

1from apify_client import ApifyClient
2
3# Initialize the ApifyClient with your Apify API token
4# Replace '<YOUR_API_TOKEN>' with your token.
5client = ApifyClient("<YOUR_API_TOKEN>")
6
7# Prepare the Actor input
8run_input = {
9    "numbers": [
10        "8976859807",
11        "8655907795",
12        "8860033772",
13    ],
14    "proxy": {
15        "useApifyProxy": True,
16        "apifyProxyGroups": ["RESIDENTIAL"],
17        "apifyProxyCountry": "US",
18    },
19}
20
21# Run the Actor and wait for it to finish
22run = client.actor("curious_coder/whatsapp-scraper").call(run_input=run_input)
23
24# Fetch and print Actor results from the run's dataset (if there are any)
25print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
26for item in client.dataset(run["defaultDatasetId"]).iterate_items():
27    print(item)
28
29# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

WhatsApp API in Python

WhatsApp API in JavaScript

WhatsApp MCP server

WhatsApp API in CLI

Get data with WhatsApp API

Extract WhatsApp profile data by providing phone numbers in bulk through the input interface. The WhatsApp scraper returns structured JSON data with contact names, business profiles, email addresses, website URLs, profile pictures, descriptions, business hours, and location details.

Input

{
 "proxy": {
  "useApifyProxy": true,
  "apifyProxyGroups": [
   "RESIDENTIAL"
  ],
  "apifyProxyCountry": "US"
 },
 "numbers": [
  "8976859807",
  "8655907795",
  "8860033772"
 ],
 "sessionStoreId": "whatsapp-session-1"
}

Output

[
 {
  "_fromStrapi": true,
  "id": {
   "user": "918976859807",
   "server": "c.us",
   "_serialized": "918976859807@c.us"
  },
  "isMe": false,
  "type": "in",
  "about": "India’s Highest Rated Food Delivery App: 4.7",
  "isUser": true,
  "number": "918976859807",
  "isGroup": false,
  "isBlocked": false,
  "isBusiness": true,
  "givenNumber": "8976859807",
  "isMyContact": false,
  "isWAContact": true,
  "profilePicUrl": "<https://pps.whatsapp.net/v/t61.24694-24/328134927_579346797408337_6534925906918654566_n.jpg?ccb=11-4&oh=01_AdTENlu80Nd9A9D7bR3Llynpj2Bp0F5mr3yZJ9r_uO1lhA&oe=6511557C&_nc_sid=000000&_nc_cat=108>",
  "businessProfile": {
   "_fromStrapi": true,
   "id": {
    "user": "918976859807",
    "server": "c.us",
    "_serialized": "918976859807@c.us"
   },
   "tag": "102921066",
   "email": "hello@eatclub.in",
   "fbPage": {},
   "address": "No 548, 22nd Cross, 14th Main Road, HSR Layout Sector 3, Bangalore, Karnataka - 560102",
   "website": [
    "<https://eatclub.page.link/qrid>"
   ],
   "categories": [
    {
     "_fromStrapi": true,
     "id": "273819889375819",
     "localized_display_name": "Restaurant"
    }
   ],
   "coverPhoto": null,
   "description": "India’s Highest Rated Food Delivery App: 4.7. \\nFlat 30% OFF on every order. NO T&C. ZERO Delivery/Packaging Fees. Benefits on all Handpicked Partner Brands like BOX8, MOJO Pizza, Itminaan Biryani & more.",
   "businessHours": null,
   "igProfessional": {},
   "profileOptions": {
    "cartEnabled": true,
    "directConnection": false,
    "commerceExperience": "none"
   },
   "isProfileLinked": false,
   "directConnection": {
    "enabled": false
   }
  }
 }
]

How to use WhatsApp API

Sign up for Apify account01

Creating an account is quick and free — no credit card required. Your account gives you access to more than 5,000 scrapers and APIs.

Get started for free

Get your Apify API token02

Go to settings in the Apify console and navigate to the “API & Integrations” tab. There, create a new token and save it for later.

Integrate WhatsApp API03

Navigate to the WhatsApp API page and click on the API dropdown menu in the top right corner. In the dropdown menu, you can see API clients, API endpoints, and more.

Open WhatsApp API

Get your WhatsApp data via API04

Now, you can use the API and get the data you need from WhatsApp.

Why use Apify?

Never get blocked

Every plan (free included) comes with Apify Proxy, which is great for avoiding blocking and giving you access to geo-specific content.

Customers love us

We truly care about the satisfaction of our users and thanks to that we're one of the best-rated data extraction platforms on both G2 and Capterra.

Monitor your runs

With our latest monitoring features, you always have immediate access to valuable insights on the status of your web scraping tasks.

Export to various formats

Your datasets can be exported to any format that suits your data workflow, including Excel, CSV, JSON, XML, HTML table, JSONL, and RSS.

Integrate Apify to your workflow

You can integrate your Apify runs with platforms such as Zapier, Make, Keboola, Google Drive, or GitHub. Connect with practically any cloud service or web app.

Large developer community

Apify is built by developers, so you'll be in good hands if you have any technical questions. Our Discord server is always here to help!

Get AI-ready WhatsApp data via API

Connect to hundreds of apps right away using ready-made integrations, or set up your own with webhooks and our API.

Frequently asked questions

WhatsApp does not provide an official public API for scraping profile data. This actor uses web scraping techniques to extract publicly available information from WhatsApp profiles by connecting through QR code authentication, similar to WhatsApp Web.

Yes, you can try the WhatsApp scraper for free using Apify's free tier credits. The actor is priced at $25.00/month plus usage costs, but new users receive free credits to test the functionality before committing to a paid plan.

From WhatsApp profiles, you can extract contact names, profile pictures, about/bio status, business descriptions, email addresses, website URLs, physical addresses, business categories, business hours, and determine whether it's a business or personal account.

Scraping WhatsApp data may have legal implications depending on your jurisdiction and use case. This tool extracts only publicly available profile information and requires user authentication via QR code. Always ensure compliance with WhatsApp's Terms of Service, local data protection laws, and obtain proper consent when processing personal data for business purposes.

Getting started is simple: First, go to the input tab and enter the phone numbers you want to scrape. Then run the actor and wait for the QR code to appear in the Live view tab. Open WhatsApp on your phone, go to Linked Devices, scan the QR code, and the scraper will begin extracting profile data automatically.