---
title: "Find places by name for weather lookups. Returns a normalized GeoLocation page."
method: POST
path: "/v2/ops/weather.location.search"
tags: ["weather"]
---

# Find places by name for weather lookups. Returns a normalized GeoLocation page.

`POST /v2/ops/weather.location.search`

## Request

- Base URL: `https://api.agentkey.app`
- URL: `https://api.agentkey.app/v2/ops/weather.location.search`
- Auth: HTTP bearer

Resolves a city / district name to the provider's location id and coordinates, which weather.forecast accepts (location_id, or lat / lon). Optional country narrows the match.

Fixed price: 0.1 credits per successful call, whichever provider serves it.

## Request body

- object
  - `country` string: ISO 3166-1 alpha-2 country code to narrow the match, e.g. CN, GB.
  - `fields` string[]: Projection: keep only these dotted paths of data, e.g. ["items.id", "items.text"].
  - `include_raw` boolean: Attach the raw upstream payload as `raw` (not a stable contract; truncated above 256 KB).
  - `lang` string: Language of the returned names (BCP 47), e.g. en, zh.
  - `limit` integer: Maximum number of places to return.
  - `provider` string: Shorthand for routing.only = [provider].
  - `query` string, required: Place name, e.g. 北京, London, Shanghai Pudong.
  - `routing` Routing: Provider routing override. order: try these providers first; only: restrict to these (equivalent to pinning); allow_fallbacks: false tries only the first eligible provider.
    - `allow_fallbacks` boolean: false = try only the first eligible provider.
    - `only` string[]: Restrict to these providers.
    - `order` string[]: Providers to try first, in order.
    - `strategy` 'auto': How eligible providers are ordered. auto = the method's curated order. fastest / stable / popular are specified but not implemented yet (400 until then). The price is fixed whatever the strategy; mutually exclusive with order.

## Response `200`

Success envelope

- GeoLocationPageEnvelope: Success envelope whose data is a GeoLocationPage.
  - `attempts` Attempt[], required
    - `error_type` string: validation | not_found | rate_limit | timeout | upstream_unauthorized | upstream_unavailable | provider_error
    - `provider` string, required: Provider slug.
    - `refunded` boolean: true when the reservation for this attempt was refunded.
    - `status` integer, required: HTTP status AgentKey mapped this attempt to (200 on success).
    - `took_ms` integer, required
    - `tool` string, required: Registry tool name (Provider/operation) that was called.
    - `upstream_status` integer: The provider's real HTTP status; absent when nothing was received.
  - `credits_charged` number, required: Credits charged for this call (the method's fixed price).
  - `data` object, required: One page of places.
    - `items` GeoLocation[], required
      - `city` string, nullable, required: Second-level division (city / county).
      - `country` string, nullable, required: Country name.
      - `id` string, required: Provider location id (QWeather LocationID), accepted by weather.forecast as location_id.
      - `lat` number, nullable, required: Latitude.
      - `lon` number, nullable, required: Longitude.
      - `name` string, required: Place name in the requested language.
      - `region` string, nullable, required: First-level administrative division (province / state).
      - `timezone` string, nullable, required: IANA time zone.
      - `type` string, nullable, required: Place kind as the provider reports it (city, scenic …).
    - `next_cursor` string, nullable, required: Always null — lookups return one list.
  - `op` string, required: Method name.
  - `op_version` integer, required: Method version that served the call.
  - `provider` string, required: Provider that actually served the call.
  - `raw` unknown
  - `raw_truncated` boolean
  - `request_id` string, required: Correlation id; quote it in support requests.
  - `took_ms` integer, required
  - `unsupported_fields` string[], required: Output paths this provider structurally does not supply; such fields are null for a different reason than 'missing on this record'.

## Other responses

- `400`: Validation error (unknown field, bad cursor, bad routing)
- `402`: Insufficient credits
- `404`: Not found (method, or upstream object)
- `429`: Rate limited upstream
- `502`: All providers failed
- `504`: Timed out

---

[API](https://skmtc.dev/agentkey/apis/agentkey-scenario-methods.md) - [All operations](https://skmtc.dev/agentkey/apis/agentkey-scenario-methods/llms.txt) - [OpenAPI document](https://skmtc.dev/agentkey/apis/agentkey-scenario-methods/revisions/a7cf5b682fdd?raw)