realestate.search

Request

Body of POST /v1/capabilities/realestate.search/execute, JSON, validated against the RealestateSearchRequest component of the public OpenAPI document. Defaults are applied server-side, so an omitted optional field behaves exactly as its default.

• Unknown keys are rejected with 400 invalid_request.

Rules the schema cannot express

Checked after schema validation; violations return 400 invalid_request with a plain message.

• min_price must not exceed max_price.

Examples

curl -s -X POST https://api.powerups-ai.store/v1/capabilities/realestate.search/execute \
  -H "Authorization: Bearer $AIPA_API_KEY" -H "Content-Type: application/json" \
  -d '{"query":"Austin, TX","num":5}'

Result record

Every item in results[] carries record_id and title (contract, always present) and usually url and snippet. The keys below are the documented tier: produced deterministically by this capability, omitted when the source has no value, checked against recorded source fixtures in our test suite, and published as the RealestateSearchRecord component (all optional, extra keys allowed) so generated clients type them. The wire schema itself still validates only the base keys. See stability tiers.

Caveats

• Pages are capped at 24 listings; a filtered page can be empty while has_more is true.

Follow-ups

• Paging: Provider page number; more fetches the next page from the source. Send { "search_id": "…", "action": "more" } while has_more is true; tolerate an empty page and stop after a bounded number of pages.
• Update: Re-run with changed parameters (merged into the stored query); page state resets, search_id stays. Params accept any subset of the request fields (RealestateSearchUpdateParams).
• Record actions:
  • details: Property facts and reported sale history, with the listing link.
• Detail behaviour: First details call fetches from the provider (billed as stated); repeats are cached and free. details is a fresh property request: $0.004; repeated calls are cached.

curl -s -X POST https://api.powerups-ai.store/v1/follow-up \
  -H "Authorization: Bearer $AIPA_API_KEY" -H "Content-Type: application/json" \
  -d '{"record_id":"rec_…","action":"details"}'

Record detail objects of this capability are provider-shaped: documented by observation, not by schema. Full follow-up semantics: follow-up.

Typed client

With types generated from the public document (see types, client and samples) the call is path-keyed and the body is checked at compile time:

const { data, error } = await client.POST("/v1/capabilities/realestate.search/execute", {
  body: {
    "query": "Austin, TX",
    "num": 5
  },
});
if (error) throw new Error(`${error.error.code}: ${error.error.message}`);
for (const record of data.results) console.log(record.record_id, record.title);