Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/docs/changelog/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ related:
- /references/versioning/breaking-changes-policy
- /references/migration
title: Changelog
description: Notable changes to the Whitepages API, newest first.
description: Notable changes to the Whitepages Pro API, newest first.
---

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ related:
- /references/versioning/breaking-changes-policy
- /documentation/mcp
title: Integration Guide
description: The workflow to follow when integrating the Whitepages API, by hand or with an agent.
description: The workflow to follow when integrating the Whitepages Pro API, by hand or with an agent.
icon: Workflow
lifecycle: current
topic: getting-started
Expand Down
2 changes: 1 addition & 1 deletion content/docs/documentation/events/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ related:
- /references/events/search_deed_events
- /documentation/regions
title: Events
description: Retrieve and understand property deed events from the Whitepages API
description: Retrieve and understand property deed events from the Whitepages Pro API
---

Events represent property deed activities — transfers, recordings, and other deed transactions — captured from county recorder offices across the United States. Each event contains structured data about the property, the parties involved, and the transaction details.
Expand Down
4 changes: 2 additions & 2 deletions content/docs/documentation/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ related:
- /documentation/person-search
- /documentation/property-search
title: Getting Started
description: Get started with the Whitepages API
description: Get started with the Whitepages Pro API
icon: Rocket
---

The Whitepages API provides access to comprehensive person and property data. Whether you're verifying identities, enriching customer records, or researching properties, our API delivers the data you need.
The Whitepages Pro API provides access to comprehensive person and property data. Whether you're verifying identities, enriching customer records, or researching properties, our API delivers the data you need.

## Get Your API Key

Expand Down
2 changes: 1 addition & 1 deletion content/docs/documentation/getting-trial-api-key.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ related:
- /documentation/purchasing-api
- /references/authentication
title: Getting a Trial API Key
description: Step-by-step guide to signing up for a free Whitepages API trial
description: Step-by-step guide to signing up for a free Whitepages Pro API trial
icon: Key
---

Expand Down
4 changes: 2 additions & 2 deletions content/docs/documentation/guides.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Guides
description: In-depth guides for using the Whitepages API
description: In-depth guides for using the Whitepages Pro API
---

In-depth guides for integrating and using the Whitepages API.
In-depth guides for integrating and using the Whitepages Pro API.

<Callout type="info" title="Coming Soon">
Detailed guides are under development.
Expand Down
4 changes: 2 additions & 2 deletions content/docs/documentation/making-your-first-request.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ related:
- /documentation/person-search
- /documentation/agentic-guidance/capability-map
title: Making Your First Request
description: A beginner-friendly guide to making your first Whitepages API request
description: A beginner-friendly guide to making your first Whitepages Pro API request
icon: Play
---

Expand All @@ -31,7 +31,7 @@ Postman is a free tool that lets you interact with APIs without writing code. Cl

### What You'll Need

- Your Whitepages API key (received via email after [signing up for a trial](/documentation/getting-trial-api-key))
- Your Whitepages Pro API key (received via email after [signing up for a trial](/documentation/getting-trial-api-key))
- [Postman](https://www.postman.com/downloads/) (free download)

### Step-by-Step Guide
Expand Down
8 changes: 4 additions & 4 deletions content/docs/documentation/mcp/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ related:
- /documentation/agentic-guidance/integration-guide
- /references/rate-limits
title: MCP Server
description: Connect to Whitepages API via Model Context Protocol for AI assistants
description: Connect to Whitepages Pro API via Model Context Protocol for AI assistants
icon: Plug
---

import { Callout } from "fumadocs-ui/components/callout";
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
import { Step, Steps } from "fumadocs-ui/components/steps";

The Whitepages MCP (Model Context Protocol) server allows AI assistants like Claude Desktop, Cursor, and other MCP-compatible tools to directly access Whitepages API functionality.
The Whitepages MCP (Model Context Protocol) server allows AI assistants like Claude Desktop, Cursor, and other MCP-compatible tools to directly access Whitepages Pro API functionality.

## Quick Start

Expand Down Expand Up @@ -66,7 +66,7 @@ Add this to your Claude Desktop configuration file:
```

<Callout type="info">
Replace `YOUR_API_KEY_HERE` with your actual Whitepages API key.
Replace `YOUR_API_KEY_HERE` with your actual Whitepages Pro API key.
</Callout>

After saving, restart Claude Desktop for the changes to take effect.
Expand Down Expand Up @@ -103,7 +103,7 @@ claude mcp add --transport http whitepages https://api.whitepages.com/mcp \
```

<Callout type="info">
Replace `YOUR_API_KEY_HERE` with your actual Whitepages API key.
Replace `YOUR_API_KEY_HERE` with your actual Whitepages Pro API key.
</Callout>

After running `claude mcp add`, reconnect with `/mcp` in an open
Expand Down
2 changes: 1 addition & 1 deletion content/docs/documentation/regions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ related:
- /documentation/events/search-events
- /documentation/webhooks/create-webhook
title: Regions
description: Browse and search US states and counties available in the Whitepages API
description: Browse and search US states and counties available in the Whitepages Pro API
icon: Map
---

Expand Down
2 changes: 1 addition & 1 deletion content/docs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
title: Documentation
description: Whitepages API Documentation
description: Whitepages Pro API Documentation
---
2 changes: 1 addition & 1 deletion content/docs/references/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ related:
- /references/rate-limits
- /references/billing
title: Authentication
description: Learn how to authenticate your requests to the Whitepages API.
description: Learn how to authenticate your requests to the Whitepages Pro API.
icon: KeyRound
lifecycle: current
topic: account-billing
Expand Down
4 changes: 2 additions & 2 deletions content/docs/references/index.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Routes
description: Complete overview of all available Whitepages API endpoints organized by category.
description: Complete overview of all available Whitepages Pro API endpoints organized by category.
icon: Route
---

import { Cards, Card } from "fumadocs-ui/components/card";

The Whitepages API provides comprehensive access to person and property data with enterprise-grade authentication and usage tracking.
The Whitepages Pro API provides comprehensive access to person and property data with enterprise-grade authentication and usage tracking.

Before using the API, review the [Authentication](/references/authentication), [Rate Limits](/references/rate-limits), and [Billing](/references/billing) documentation.

Expand Down
2 changes: 1 addition & 1 deletion content/docs/references/migration/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ keywords:
- "property v1"
---

V1 of the Whitepages API is being deprecated in favor of V2. V2 endpoints
V1 of the Whitepages Pro API is being deprecated in favor of V2. V2 endpoints
deliver richer data, pagination, and forward-compatible response metadata
so customers can adapt to ongoing changes without code rewrites.

Expand Down
2 changes: 1 addition & 1 deletion content/docs/references/rate-limits.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ related:
- /documentation/purchasing-api
- /references/authentication
title: Rate Limits
description: Understand the rate limiting policies for the Whitepages API, including monthly query limits and trial exhaustion.
description: Understand the rate limiting policies for the Whitepages Pro API, including monthly query limits and trial exhaustion.
icon: Gauge
lifecycle: current
topic: account-billing
Expand Down
2 changes: 1 addition & 1 deletion content/docs/references/support-and-incident-response.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ keywords:

import { Callout } from "fumadocs-ui/components/callout";

We are committed to keeping the Whitepages API reliable and transparent. This page covers how to get help, what to expect during incidents, and how we handle changes to the API.
We are committed to keeping the Whitepages Pro API reliable and transparent. This page covers how to get help, what to expect during incidents, and how we handle changes to the API.

## Support Channels

Expand Down
17 changes: 17 additions & 0 deletions public/pro_api_logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 0 additions & 14 deletions public/whitepages_gray_icon.svg

This file was deleted.

14 changes: 0 additions & 14 deletions public/whitepages_white_icon.svg

This file was deleted.

16 changes: 8 additions & 8 deletions src/app/layout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ const roboto = Roboto({

export const metadata: Metadata = {
title: {
default: "Whitepages API Documentation",
template: "%s | Whitepages API",
default: "Whitepages Pro API Documentation",
template: "%s | Whitepages Pro API",
},
description:
"Official documentation for the Whitepages API. Access comprehensive person and property data for identity verification, customer enrichment, and research.",
"Official documentation for the Whitepages Pro API. Access comprehensive person and property data for identity verification, customer enrichment, and research.",
keywords: [
"Whitepages",
"API",
Expand All @@ -34,16 +34,16 @@ export const metadata: Metadata = {
openGraph: {
type: "website",
locale: "en_US",
siteName: "Whitepages API Documentation",
title: "Whitepages API Documentation",
siteName: "Whitepages Pro API Documentation",
title: "Whitepages Pro API Documentation",
description:
"Official documentation for the Whitepages API. Access comprehensive person and property data for identity verification, customer enrichment, and research.",
"Official documentation for the Whitepages Pro API. Access comprehensive person and property data for identity verification, customer enrichment, and research.",
},
twitter: {
card: "summary_large_image",
title: "Whitepages API Documentation",
title: "Whitepages Pro API Documentation",
description:
"Official documentation for the Whitepages API. Access comprehensive person and property data.",
"Official documentation for the Whitepages Pro API. Access comprehensive person and property data.",
},
icons: {
icon: "/docs/favicon.ico",
Expand Down
4 changes: 2 additions & 2 deletions src/app/llms.txt/route.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ export async function GET() {
return `- [${title}](${url})${description ? `: ${description}` : ""}`;
});

const content = `# Whitepages API Documentation
const content = `# Whitepages Pro API Documentation

> Documentation for the Whitepages API
> Documentation for the Whitepages Pro API

${lines.join("\n")}

Expand Down
2 changes: 1 addition & 1 deletion src/app/og/[...slug]/route.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export async function GET(
<DefaultImage
title={page.data.title}
description={page.data.description}
site="Whitepages API Documentation"
site="Whitepages Pro API Documentation"
/>,
{
width: 1200,
Expand Down
16 changes: 4 additions & 12 deletions src/components/layout/navigation-title.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,11 @@ export function NavigationTitle() {
return (
<div className="flex h-8">
<Image
src="/docs/whitepages_gray_icon.svg"
alt="Whitepages"
width={150}
src="/docs/pro_api_logo.svg"
alt="Whitepages Pro API"
width={172}
height={32}
className="block dark:hidden h-full w-auto"
priority
/>
<Image
src="/docs/whitepages_white_icon.svg"
alt="Whitepages"
width={150}
height={32}
className="hidden dark:block h-full w-auto"
className="block h-full w-auto"
priority
/>
</div>
Expand Down
24 changes: 6 additions & 18 deletions src/components/layout/whitepages-logo-link.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,16 @@ mock.module("@/lib/amplitude", () => ({
}));

const { default: amplitude } = await import("@/lib/amplitude");
const { trackHomepageLinkClick } = await import("./whitepages-logo-link");
const { trackHeaderSiteLinkClick } = await import("./whitepages-logo-link");

describe("trackHomepageLinkClick", () => {
test("tracks WPAPIDocsHomepageLinkClicked with source_page", () => {
describe("trackHeaderSiteLinkClick", () => {
test("fires WPClickedHeaderSiteLink with LinkType: API", () => {
const spy = spyOn(amplitude, "track");
const url = "https://api.whitepages.com/docs/documentation/getting-started";

trackHomepageLinkClick(url);
trackHeaderSiteLinkClick();

expect(spy).toHaveBeenCalledWith("WPAPIDocsHomepageLinkClicked", {
source_page: url,
});
});

test("passes the exact source_page URL provided", () => {
const spy = spyOn(amplitude, "track");
const url = "https://api.whitepages.com/docs/references";

trackHomepageLinkClick(url);

expect(spy).toHaveBeenCalledWith("WPAPIDocsHomepageLinkClicked", {
source_page: url,
expect(spy).toHaveBeenCalledWith("WPClickedHeaderSiteLink", {
LinkType: "API",
});
});
});
6 changes: 3 additions & 3 deletions src/components/layout/whitepages-logo-link.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
import amplitude from "@/lib/amplitude";
import { NavigationTitle } from "@/components/layout/navigation-title";

export function trackHomepageLinkClick(sourcePage: string): void {
amplitude.track("WPAPIDocsHomepageLinkClicked", { source_page: sourcePage });
export function trackHeaderSiteLinkClick(): void {
amplitude.track("WPClickedHeaderSiteLink", { LinkType: "API" });
}

export function WhitepagesLogoLink() {
return (
<span onClick={() => trackHomepageLinkClick(window.location.href)}>
<span onClick={() => trackHeaderSiteLinkClick()}>
<NavigationTitle />
</span>
);
Expand Down
2 changes: 1 addition & 1 deletion src/lib/layout.shared.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export function baseOptions(): BaseLayoutProps {
nav: {
transparentMode: "top",
title: <WhitepagesLogoLink />,
url: "https://www.whitepages.com",
url: "https://www.whitepages.com/pro-api",
},
githubUrl: "https://github.com/whitepages/docs",
};
Expand Down
Loading