API

Verified agents get an API key. Three calls to a live listing. Any runtime that speaks REST.

curl -X POST https://api.housepeek.ca/v1/listings \
  -H "Authorization: Bearer $HOUSEPEEK_KEY" \
  -d '{"address":"123 Main St","city":"Toronto",
       "province":"ON","price":899000}'

→ {
    "listingId": "lst_abc",
    "publicUrl": "housepeek.ca/listings/123-main-st-toronto"
  }
ChatGPT ActionsClaudeGeminiCursorCustom scriptsBrokerage software

1. Authenticate

Create an API key from the dashboard. The AI agent stores only the key.

2. Publish

Create, upload photos, publish. Three endpoints, draft to live.

3. Manage

Update, mark sold, archive, read inquiries. Same key that published.

Publish endpoints

POST
/v1/listings

Create a draft listing under a verified agent account.

POST
/v1/listings/{id}/photos

Attach listing photos after the draft exists.

POST
/v1/listings/{id}/publish

Publish the listing. Returns the public URL.

Management endpoints

PATCH
/v1/listings/{id}

Update listing details.

POST
/v1/listings/{id}/sold

Mark as sold.

POST
/v1/listings/{id}/archive

Archive the listing.

GET
/v1/listings/{id}/inquiries

Read buyer inquiries.

GET
/v1/listings

List your inventory.

GET
/v1/agent/profile

Load your verified profile.

Response shape

{
  "listingId": "lst_abc",
  "status": "active",
  "publicUrl": "https://housepeek.ca/listings/123-main-st-toronto",
  "directUrl": "https://123-main-st-toronto.housepeek.ca"
}

Every response returns the URLs your agent needs for the next action.

Search policy

  • Public listing pages and sitemap handle discoverability.
  • Website search is open on housepeek.ca for buyers.
  • API search is gated by plan for authenticated workflows.

API permissions by plan

Every API key has the same endpoints. What changes by plan is which creative theming fields the API accepts. Fields outside your plan are silently stripped, and the response tells you exactly what was ignored and how to upgrade.

Free Trial

  • Create, publish, and manage up to 3 active listings via API
  • Upload up to 5 photos per listing
  • Full creative customization (colors, fonts, layouts, CSS)
  • Read buyer inquiries
  • Mark sold, archive, and update listings

Restricted:

  • Video hero URLs not available
  • 14-day trial period

Solo Agent

  • Up to 10 active listings
  • Up to 15 photos per listing
  • Full creative customization (colors, fonts, layouts, CSS)
  • Dashboard + API access
  • Inquiry inbox with buyer context

Restricted:

  • Video hero URLs not available

Growth

  • Up to 30 active listings
  • Up to 100 photos per listing
  • Video hero support
  • Full creative customization (colors, fonts, layouts, CSS)
  • Higher API throughput and priority support

Team

  • Up to 50 active listings
  • Up to 100 photos per listing
  • Video hero support
  • Full creative customization (colors, fonts, layouts, CSS)
  • Multi-agent management and approval controls
  • Shared branding and subdomain policies

Branding by plan

Platform StandardAll plans

Consistent look across the marketplace so every listing benefits from the same trust and search quality.

Agent SignatureAll plans

Your colours, fonts, layouts, and custom CSS on your listing pages — full creative control on every plan.

Brokerage White-labelTeam and Custom plans

Full brokerage branding across your team's listings. Managed at the plan level, not per-publish.

Pricing

  • Free Trial: $0/month for 3 active listings.
  • Solo Agent: $49/month for 10 active listings.
  • Growth: $129/month for 30 active listings.
  • Team: $199/month for 50 active listings.