diff --git a/content/docs/changelog/index.mdx b/content/docs/changelog/index.mdx index 48d926d..030e9ed 100644 --- a/content/docs/changelog/index.mdx +++ b/content/docs/changelog/index.mdx @@ -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. --- --- diff --git a/content/docs/documentation/agentic-guidance/integration-guide.mdx b/content/docs/documentation/agentic-guidance/integration-guide.mdx index b6cc0c6..1487cc9 100644 --- a/content/docs/documentation/agentic-guidance/integration-guide.mdx +++ b/content/docs/documentation/agentic-guidance/integration-guide.mdx @@ -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 diff --git a/content/docs/documentation/events/index.mdx b/content/docs/documentation/events/index.mdx index e1dc85e..44b13f7 100644 --- a/content/docs/documentation/events/index.mdx +++ b/content/docs/documentation/events/index.mdx @@ -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. diff --git a/content/docs/documentation/getting-started.mdx b/content/docs/documentation/getting-started.mdx index 41d03b0..b0f017b 100644 --- a/content/docs/documentation/getting-started.mdx +++ b/content/docs/documentation/getting-started.mdx @@ -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 diff --git a/content/docs/documentation/getting-trial-api-key.mdx b/content/docs/documentation/getting-trial-api-key.mdx index e597d83..dbff32d 100644 --- a/content/docs/documentation/getting-trial-api-key.mdx +++ b/content/docs/documentation/getting-trial-api-key.mdx @@ -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 --- diff --git a/content/docs/documentation/guides.mdx b/content/docs/documentation/guides.mdx index 49db481..3d4bbec 100644 --- a/content/docs/documentation/guides.mdx +++ b/content/docs/documentation/guides.mdx @@ -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. Detailed guides are under development. diff --git a/content/docs/documentation/making-your-first-request.mdx b/content/docs/documentation/making-your-first-request.mdx index 3e4d2ce..ca1d542 100644 --- a/content/docs/documentation/making-your-first-request.mdx +++ b/content/docs/documentation/making-your-first-request.mdx @@ -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 --- @@ -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 diff --git a/content/docs/documentation/mcp/index.mdx b/content/docs/documentation/mcp/index.mdx index 057fe01..c024517 100644 --- a/content/docs/documentation/mcp/index.mdx +++ b/content/docs/documentation/mcp/index.mdx @@ -5,7 +5,7 @@ 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 --- @@ -13,7 +13,7 @@ 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 @@ -66,7 +66,7 @@ Add this to your Claude Desktop configuration file: ``` - Replace `YOUR_API_KEY_HERE` with your actual Whitepages API key. + Replace `YOUR_API_KEY_HERE` with your actual Whitepages Pro API key. After saving, restart Claude Desktop for the changes to take effect. @@ -103,7 +103,7 @@ claude mcp add --transport http whitepages https://api.whitepages.com/mcp \ ``` - Replace `YOUR_API_KEY_HERE` with your actual Whitepages API key. + Replace `YOUR_API_KEY_HERE` with your actual Whitepages Pro API key. After running `claude mcp add`, reconnect with `/mcp` in an open diff --git a/content/docs/documentation/regions.mdx b/content/docs/documentation/regions.mdx index 2e79316..e1db218 100644 --- a/content/docs/documentation/regions.mdx +++ b/content/docs/documentation/regions.mdx @@ -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 --- diff --git a/content/docs/index.mdx b/content/docs/index.mdx index a5ea9fb..b0bdd3f 100644 --- a/content/docs/index.mdx +++ b/content/docs/index.mdx @@ -1,4 +1,4 @@ --- title: Documentation -description: Whitepages API Documentation +description: Whitepages Pro API Documentation --- diff --git a/content/docs/references/authentication.mdx b/content/docs/references/authentication.mdx index ed49749..800e699 100644 --- a/content/docs/references/authentication.mdx +++ b/content/docs/references/authentication.mdx @@ -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 diff --git a/content/docs/references/index.mdx b/content/docs/references/index.mdx index e6fa47e..0c06877 100644 --- a/content/docs/references/index.mdx +++ b/content/docs/references/index.mdx @@ -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. diff --git a/content/docs/references/migration/index.mdx b/content/docs/references/migration/index.mdx index d9ea840..6a64ceb 100644 --- a/content/docs/references/migration/index.mdx +++ b/content/docs/references/migration/index.mdx @@ -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. diff --git a/content/docs/references/rate-limits.mdx b/content/docs/references/rate-limits.mdx index fcae339..3dea5b3 100644 --- a/content/docs/references/rate-limits.mdx +++ b/content/docs/references/rate-limits.mdx @@ -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 diff --git a/content/docs/references/support-and-incident-response.mdx b/content/docs/references/support-and-incident-response.mdx index 6e64f48..04bcf8c 100644 --- a/content/docs/references/support-and-incident-response.mdx +++ b/content/docs/references/support-and-incident-response.mdx @@ -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 diff --git a/public/pro_api_logo.svg b/public/pro_api_logo.svg new file mode 100644 index 0000000..ec3a398 --- /dev/null +++ b/public/pro_api_logo.svg @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + diff --git a/public/whitepages_gray_icon.svg b/public/whitepages_gray_icon.svg deleted file mode 100644 index 0c2bfea..0000000 --- a/public/whitepages_gray_icon.svg +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - - - - - - - diff --git a/public/whitepages_white_icon.svg b/public/whitepages_white_icon.svg deleted file mode 100644 index 805e71e..0000000 --- a/public/whitepages_white_icon.svg +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - - - - - - - diff --git a/src/app/layout.tsx b/src/app/layout.tsx index 1b89a62..b443c62 100644 --- a/src/app/layout.tsx +++ b/src/app/layout.tsx @@ -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", @@ -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", diff --git a/src/app/llms.txt/route.ts b/src/app/llms.txt/route.ts index 15a340d..36dfeed 100644 --- a/src/app/llms.txt/route.ts +++ b/src/app/llms.txt/route.ts @@ -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")} diff --git a/src/app/og/[...slug]/route.tsx b/src/app/og/[...slug]/route.tsx index 8d4d5d9..136a41f 100644 --- a/src/app/og/[...slug]/route.tsx +++ b/src/app/og/[...slug]/route.tsx @@ -17,7 +17,7 @@ export async function GET( , { width: 1200, diff --git a/src/components/layout/navigation-title.tsx b/src/components/layout/navigation-title.tsx index 4a65a11..14d818e 100644 --- a/src/components/layout/navigation-title.tsx +++ b/src/components/layout/navigation-title.tsx @@ -4,19 +4,11 @@ export function NavigationTitle() { return (
Whitepages - Whitepages
diff --git a/src/components/layout/whitepages-logo-link.test.ts b/src/components/layout/whitepages-logo-link.test.ts index d701807..a6a1301 100644 --- a/src/components/layout/whitepages-logo-link.test.ts +++ b/src/components/layout/whitepages-logo-link.test.ts @@ -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", }); }); }); diff --git a/src/components/layout/whitepages-logo-link.tsx b/src/components/layout/whitepages-logo-link.tsx index b3fe166..538a05d 100644 --- a/src/components/layout/whitepages-logo-link.tsx +++ b/src/components/layout/whitepages-logo-link.tsx @@ -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 ( - trackHomepageLinkClick(window.location.href)}> + trackHeaderSiteLinkClick()}> ); diff --git a/src/lib/layout.shared.tsx b/src/lib/layout.shared.tsx index 9694d3e..50e8ff6 100644 --- a/src/lib/layout.shared.tsx +++ b/src/lib/layout.shared.tsx @@ -6,7 +6,7 @@ export function baseOptions(): BaseLayoutProps { nav: { transparentMode: "top", title: , - url: "https://www.whitepages.com", + url: "https://www.whitepages.com/pro-api", }, githubUrl: "https://github.com/whitepages/docs", };