Travel and places · SearchApi
places.search
- Operation
- POST /v1/capabilities/places.search/execute
- operationId
- executePlacesSearch
- Typical credits
- 4
- Search deadline
- 15 s server-side
- Paging
- page
- Availability
- ConfiguredChecked 2026-09-23 21:02 UTC
GET /v1/catalog (available). The timestamped snapshot describes configuration, not provider uptime or your account's enabled choices. Check the catalog with your own key before a call. Credits are explained under credits and limits.Request
Body of POST /v1/capabilities/places.search/execute, JSON, validated against the PlacesSearchRequest component of the public OpenAPI document. Defaults are applied server-side, so an omitted optional field behaves exactly as its default.
| Field | Type | Required | Default | Constraints and description |
|---|---|---|---|---|
| query | string | yes | min length 1, max length 300 | |
| location | object | no | ||
| location.lat | number | yes | min -90, max 90 | |
| location.lon | number | yes | min -180, max 180 | |
| radius_m | number | no | min 62, max 50000 Strict distance from location; requires location and excludes results without coordinates. | |
| country | string | no | pattern ^[A-Za-z]{2}$ | |
| language | string | no | min length 2, max length 12 | |
| min_rating | number | no | min 0, max 5 | |
| open_now | boolean | no | Require an explicit open or closed provider state at observation time; unknown states do not qualify. | |
| num | integer | no | 10 | min 1, max 20 |
- 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.
querymust not be blank.radius_mrequireslocation.
Examples
Surf lessons nearby
curl -s -X POST https://api.powerups-ai.store/v1/capabilities/places.search/execute \
-H "Authorization: Bearer $AIPA_API_KEY" -H "Content-Type: application/json" \
-d '{"query":"surf schools Carcavelos Portugal","num":5}'ExecuteResponse component (see sessions and records); the record keys below are what the adapter emits. A first call with the example above returns search_id, the records and the charge.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 PlacesSearchRecord component (all optional, extra keys allowed) so generated clients type them. The wire schema itself still validates only the base keys. See stability tiers.
| Key | Type | Presence | Note |
|---|---|---|---|
| address | string | when the source has it | |
| phone | string | when the source has it | |
| type | string | when the source has it | |
| types | string[] | when the source has it | |
| open_state | string | when the source has it | |
| hours | string | when the source has it | |
| website | string | when the source has it | |
| rating | number | when the source has it | |
| reviews | integer | when the source has it | |
| price_level_label | string | when the source has it | |
| coordinates | object | when the source has it | |
| distance_m | number | when the source has it | Only with location. |
| open_now | boolean | when the source has it | |
| source | string | always | |
| fetched_at | string | always |
Caveats
- Paging stops at 20 provider pages; a filtered page can be empty while
has_moreis true.
Follow-ups
- Paging: Provider page number;
morefetches the next page from the source. Send{ "search_id": "…", "action": "more" }whilehas_moreis 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 (
PlacesSearchUpdateParams). - Record actions:
details: Place contacts, hours, location and source-reported amenities.
- Detail behaviour: First
detailscall fetches from the provider (billed as stated); repeats are cached and free.detailsis a fresh place 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/places.search/execute", {
body: {
"query": "surf schools Carcavelos Portugal",
"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);