# Google Maps Nearby Search (`maps.search_nearby`)

Search Google Maps around exact coordinates and zoom and get one viewport of up to 20 places with the address split into street, city, state, postal code and country.

Docs: https://primaryapi.com/docs/api-reference/maps/search_nearby

- Endpoint: `POST https://api.primaryapi.com/v1/run/maps.search_nearby`
- Category: Search & SEO · Platform: `maps` · Kind: search · Status: live
- Price: 2 credits per call; up to 75 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost.
- Billing unit: per successful call
- Reliability: routed to a healthy upstream and retried automatically when an attempt fails; live 30-day status: `GET https://api.primaryapi.com/v1/status/apis?sku=maps.search_nearby`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `query` | string | yes |  | max 500 chars | What you would type in the Google Maps search bar, for example "pizza". |
| `coordinates` | object | yes |  |  | The exact map centre to search around. Use maps.search instead if you only have a place name. |
| `coordinates.latitude` | number | yes |  | -90–90 | Latitude of the map centre (WGS84). |
| `coordinates.longitude` | number | yes |  | -180–180 | Longitude of the map centre (WGS84). |
| `zoom` | number | no | 13.1 | 3–21 | Google Maps viewport zoom (3-21, default 13.1). Lower covers a wider area, higher focuses more tightly. |
| `language` | string | no | "en" | max 10 chars | Two-letter language code for the results, for example "en". |
| `limit` | integer | no | 20 | 1–20 | Accepted for compatibility (1-20, default 20) but does not trim the page: every call returns one full Google Maps viewport of up to 20 places, so nextCursor continues exactly where this page ended. |
| `cursor` | string | no |  |  | Opaque pagination cursor: pass the previous response's nextCursor. |

Unknown fields are rejected with `400 invalid_input`. The routing controls `preferLatencyUnderMs` and `maxCredits` may be sent in the same JSON body.

## Output

When `output.found` is `true`, `output.data` has this shape:

| Field | Type | Description |
|---|---|---|
| `items` | object[] |  |
| `items[].rank` | integer \| null | Position in the upstream result list (1-based). |
| `items[].name` | string |  |
| `items[].placeId` | string \| null | Google place id (ChIJ...). |
| `items[].cid` | string \| null | Google customer id (CID), unsigned decimal string. |
| `items[].dataId` | string \| null | Google data id ("0x...:0x..."), accepted by some reviews endpoints. |
| `items[].address` | string \| null |  |
| `items[].street` | string \| null |  |
| `items[].city` | string \| null |  |
| `items[].state` | string \| null |  |
| `items[].postalCode` | string \| null |  |
| `items[].countryCode` | string \| null |  |
| `items[].neighborhood` | string \| null |  |
| `items[].latitude` | number \| null |  |
| `items[].longitude` | number \| null |  |
| `items[].rating` | number \| null |  |
| `items[].reviewCount` | integer \| null |  |
| `items[].category` | string \| null |  |
| `items[].categories` | string[] |  |
| `items[].phone` | string \| null |  |
| `items[].website` | string \| null |  |
| `items[].domain` | string \| null |  |
| `items[].description` | string \| null |  |
| `items[].hours` | object[] \| null |  |
| `items[].hours[].day` | string |  |
| `items[].hours[].hours` | string |  |
| `items[].priceLevel` | string \| null |  |
| `items[].permanentlyClosed` | boolean \| null |  |
| `items[].image` | string \| null |  |
| `items[].url` | string \| null |  |
| `nextCursor` | string \| null |  |

When the thing you asked about does not exist (or a search matches nothing) the call still succeeds: `output.found` is `false`, `output.data` is `null` and `output.reason` says why (`not_found`, `private`, `no_results`, …). Misses are free unless the notes below say misses are billed.

Pagination: pass the previous response’s `nextCursor` as `cursor` to get the next page; `nextCursor: null` means there are no more results.

## Example request

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/maps.search_nearby" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"pizza","coordinates":{"latitude":40.7455096,"longitude":-74.0083012},"zoom":14}'
```

## Example response

_Values are placeholders that follow the output schema; `credits` is what this call would cost at the usual price._

```json
{
  "output": {
    "found": true,
    "data": {
      "items": [
        {
          "rank": 0,
          "name": "string",
          "placeId": "string",
          "cid": "string",
          "dataId": "string",
          "address": "string",
          "street": "string",
          "city": "string",
          "state": "string",
          "postalCode": "string",
          "countryCode": "string",
          "neighborhood": "string",
          "latitude": 0,
          "longitude": 0,
          "rating": 0,
          "reviewCount": 0,
          "category": "string",
          "categories": [
            "string"
          ],
          "phone": "string",
          "website": "string",
          "domain": "string",
          "description": "string",
          "hours": [
            {
              "day": "string",
              "hours": "string"
            }
          ],
          "priceLevel": "string",
          "permanentlyClosed": true,
          "image": "string",
          "url": "https://example.com"
        }
      ],
      "nextCursor": null
    }
  },
  "provider": "PrimaryAPI",
  "credits": 2,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z",
  "nextCursor": null
}
```

## Pricing and reliability

- Usual price: 2 credits per call
- Price ceiling: up to 75 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost; the `maxCredits` routing control caps it per call
- Live 30-day status, success rate, uptime and latency: `GET https://api.primaryapi.com/v1/status/apis?sku=maps.search_nearby`

## Errors to handle

`invalid_input`, `unauthorized`, `insufficient_balance`, `key_limit_reached`, `trial_cap_reached`, `forbidden`, `not_found`, `idempotency_conflict`, `rate_limited`, `all_sources_failed`, `service_unavailable`, `timeout`. See https://primaryapi.com/docs/errors.

## Notes

Pages of 20 places.

## Legal

Google Maps terms forbid automated collection. Customers are responsible for lawful use.

