Whitepages Pro API Documentation

Official documentation for the Whitepages Pro API.
View Documentation

---

About the Whitepages Pro API

The Whitepages Pro API is a U.S. people and property data API. It returns phone numbers, email addresses, current and historical addresses, property ownership, and residents. The data comes from public and legal records.

Coverage is United States only, and coverage varies by record. The API is not an FCRA-regulated product and is not intended for credit, underwriting, employment, housing, or insurance decisions. See the Terms of Service for full details, or contact api@whitepages.com with questions.

Development

Prerequisites

• Bun (recommended) or Node.js 18+

Getting Started

# Install dependencies
bun install

# Start development server
bun run dev

Open http://localhost:3000 to view the documentation.

Generate API Reference

The API reference documentation is auto-generated from the OpenAPI spec:

bun run generate:openapi

This fetches the latest spec from https://api.whitepages.com/openapi.json and generates the MDX files.

Project Structure

├── content/docs/
│   ├── documentation/     # Getting Started & Guides
│   └── references/        # API Reference & SDK docs
├── scripts/generators/    # OpenAPI doc generation
├── src/
│   ├── app/              # Next.js app router
│   ├── components/       # React components
│   └── lib/              # Utilities and configs
└── public/               # Static assets

Contributing

See CONTRIBUTING.md for guidelines on code style, commit conventions, and how to submit changes.

Tech Stack

• Next.js - React framework
• Fumadocs - Documentation framework
• fumadocs-openapi - OpenAPI documentation generator