docs: refresh property search example response#54
Merged
Conversation
Replace the property search example response with sample data that mirrors the on-site API Preview widget — same Seattle Main Street property, same `Sample` identifiers (`RSAMPLE0001`, `ASAMPLE0001`, `PSAMPLE0001` and friends), the same NANP-reserved 555-01XX phone numbers, and the same `example.com` / `example.org` email domains. The previous example pointed at a real-world address with an obviously fabricated resident name that read poorly as documentation. Mirroring the live preview fixture keeps the docs aligned with what API evaluators already see on the marketing site and makes it obvious the data is synthetic. Use `STREET_ADDRESS` / `CITY` / `STATE_CODE` placeholders in the runnable curl example (alongside the existing `YOUR_API_KEY` placeholder) and call out below the snippet that all four need to be replaced. The previous concrete address was a real property nobody owns, so a copy-paste of the example would 404 and read as a broken docs page. Placeholders force the reader to plug in their own lookup target and make it obvious the snippet isn't self-contained. Update the request-parameter table examples and the ZIP / property-ID example snippets on the same page so the illustrative values share the same Seattle / `RSAMPLE0001` shape as the response example.
lhagenWP
force-pushed
the
docs-property-search-sample-response
branch
from
2fa9100 to
b217b5a
Compare
ericbmerritt
approved these changes
Jun 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two related cleanups on the Property Search page, one commit.
Refresh the response example to mirror the on-site API Preview. Replace the property search example response with sample data that matches the API Preview widget — same Seattle Main Street property (
RSAMPLE0001), sameSampleidentifiers across persons (PSAMPLE0001,PSAMPLE0011,PSAMPLE0013) and addresses (ASAMPLE0001), same NANP-reserved 555-01XX phone numbers, sameexample.com/example.orgemails. The previous example pointed at a real-world address with an obviously fabricated resident name that read poorly as documentation. Mirroring the live preview fixture keeps the docs aligned with what API evaluators already see on the marketing site and makes it obvious the data is synthetic. Response shape is unchanged — same fields, same nesting, samestreet_type: nullfor the mailing PO Box.Use placeholders in the runnable curl example. Swap the request's
street=…&city=…&state_code=…values forSTREET_ADDRESS/CITY/STATE_CODEplaceholders (matching the existingYOUR_API_KEYconvention) and call out below the snippet that all four need to be replaced. The previous concrete address would 404 in production because nobody actually owns "123 Main Street, Seattle, WA 98101", and a copy-paste of the example would read as a broken docs page. Placeholders force the reader to plug in their own lookup target.The illustrative ZIP-code and property-ID example snippets still use the Seattle /
RSAMPLE0001shape — those are labeled as examples, not runnable, so they stay consistent with the response example.Changes
content/docs/documentation/property-search.mdx— refresh the example response to mirror the API Preview property fixture, swap the curl's location parameters forSTREET_ADDRESS/CITY/STATE_CODEplaceholders, expand the placeholder-replacement note below the curl, and update the parameter table examples and ZIP / property-ID example snippets to share the same Seattle /RSAMPLE0001shape.