Google maps search API

Search places on Google Maps by keyword and location

curl --request POST \
  --url https://api.stophy.dev/v1/google/maps/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "coffee",
  "location": "Austin, TX",
  "openNow": true
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({query: 'coffee', location: 'Austin, TX', openNow: true})
};

fetch('https://api.stophy.dev/v1/google/maps/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/google/maps/search"

payload = {
    "query": "coffee",
    "location": "Austin, TX",
    "openNow": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "placeUrl": "<string>",
        "latitude": 0,
        "longitude": 0,
        "placeId": "<string>",
        "googlePlaceId": "<string>",
        "name": "<string>",
        "categories": [
          "<string>"
        ],
        "address": "<string>",
        "rating": 123,
        "reviews": 0,
        "photos": 0,
        "phone": "<string>",
        "website": "<string>",
        "description": "<string>",
        "hours": [
          {
            "days": "<string>",
            "times": [
              "<string>"
            ]
          }
        ],
        "hoursToday": "<string>",
        "openStatus": "<string>",
        "timezone": "<string>",
        "thumbnailUrl": "<string>",
        "reservationUrl": "<string>",
        "attributes": [
          "<string>"
        ]
      }
    ],
    "page": 4503599627370496
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

POST

google

maps

Search places on Google Maps by keyword and location

curl --request POST \
  --url https://api.stophy.dev/v1/google/maps/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "coffee",
  "location": "Austin, TX",
  "openNow": true
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({query: 'coffee', location: 'Austin, TX', openNow: true})
};

fetch('https://api.stophy.dev/v1/google/maps/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/google/maps/search"

payload = {
    "query": "coffee",
    "location": "Austin, TX",
    "openNow": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "placeUrl": "<string>",
        "latitude": 0,
        "longitude": 0,
        "placeId": "<string>",
        "googlePlaceId": "<string>",
        "name": "<string>",
        "categories": [
          "<string>"
        ],
        "address": "<string>",
        "rating": 123,
        "reviews": 0,
        "photos": 0,
        "phone": "<string>",
        "website": "<string>",
        "description": "<string>",
        "hours": [
          {
            "days": "<string>",
            "times": [
              "<string>"
            ]
          }
        ],
        "hoursToday": "<string>",
        "openStatus": "<string>",
        "timezone": "<string>",
        "thumbnailUrl": "<string>",
        "reservationUrl": "<string>",
        "attributes": [
          "<string>"
        ]
      }
    ],
    "page": 4503599627370496
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

Searches places on Google Maps by keyword and location.

Request

query and location are required.

This endpoint can be called without an API key, subject to per-address limits. Pagination requires a key.

import { Stophy } from "stophy";

const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.google.maps.search({ query: "coffee", location: "Austin, TX", openNow: true });
console.log(result.data.results);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.google.maps.search(query="coffee", location="Austin, TX", open_now=True)
print(result["data"]["results"])

curl -X POST https://api.stophy.dev/v1/google/maps/search \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"query":"coffee","location":"Austin, TX","openNow":true}'

stophy google maps search --query coffee --location "Austin, TX" --openNow

Response

If successful, the response body contains the standard envelope. data.results[] contains the places, each with its rating, address, contact details and opening hours. The following example is a real response, truncated: each list shows one item and long strings are cut.

{
  "success": true,
  "data": {
    "results": [
      {
        "placeId": "0x865b33ee6a9856e5:0x5064d03fde124e36",
        "googlePlaceId": "ChIJ5VaYau4zW4YRNk4S3j_QZFA",
        "placeUrl": "https://www.google.com/maps?cid=5792983993432559158",
        "name": "Mojo Coffee Lakeline",
        "categories": ["Coffee shop"],
        "address": "12206 Ranch Rd 620 N, Austin, TX 78750",
        "latitude": 30.462303,
        "longitude": -97.817188,
        "rating": 4.7,
        "reviews": 679,
        "photos": 268,
        "phone": "+1 555 0100",
        "website": "http://www.mojodrivethru.com/",
        "hours": [
          {
            "days": "Monday",
            "times": ["5:30 AM–8 PM"]
          }
        ],
        "hoursToday": "5:30 AM–8 PM",
        "openStatus": "Open · Closes 8 PM",
        "timezone": "America/Chicago",
        "thumbnailUrl": "https://lh3.googleusercontent.com/gps-cs-s/AHRPTWlPKARR4YyKDk76jDBsFhgsqjIvxLr7sKpLPhAnAWtgf2_0l9wx3yKJUF1vlNqaEE0Ao_eQ…",
        "attributes": ["Wheelchair accessible entrance", "Wheelchair accessible parking lot"]
      }
    ],
    "page": 1
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}

Field	Type	Description
`page`	integer	The page number of this response.
`rating`	number	The average star rating, on a scale of 1 to 5.
`reviews`	integer	The number of reviews the rating is based on.
`openStatus`	string	The current opening status, as displayed by Google.

For every field, see the response schema on this page.

Optional parameters

Parameter	Type	Description
`minRating`	number	Restricts results to places rated at least this high. Acceptable values are `2`, `2.5`, `3`, `3.5`, `4` and `4.5`.
`openNow`	boolean	Restricts results to places open at the time of the search. If unset, defaults to `false`.
`country`	string	The country to query, as a two-letter ISO 3166-1 code such as `us`. If unset, defaults to `us`.
`language`	string	The language of the results, as a BCP 47 tag such as `en` or `pt-BR`. If unset, defaults to `en`.
`page`	integer	The page to return. Pages are numbered from 1. Must be between 1 and 10. If unset, defaults to `1`.

Billing

Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed.

Pagination

Results are paginated. To retrieve the next page, increment page. An empty data.results indicates the last page. The maximum value of page is 10.

Google Maps place: Accepts placeUrl. Returns a place’s address, hours, rating and contact details.
Google Maps reviews: Accepts placeUrl. Returns a place’s reviews.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

query

string

required

Required string length: 1 - 200

location

string

required

Required string length: 2 - 200

minRating

enum<number>

Available options:

2,

2.5,

3,

3.5,

4,

4.5

openNow

boolean

default:false

Google Maps' own Hours filter, Open now: only places open at the moment of the search.

country

string

default:us

ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted.

Pattern: ^[A-Za-z]{2}$

language

string

default:en

BCP 47 language tag, e.g. en or pt-BR. Any case is accepted.

Pattern: ^[A-Za-z]{2,3}(?:[-_][A-Za-z0-9]{2,4})?$

page

integer

default:1

Page number, starting at 1.

Required range: 1 <= x <= 10

Response

The data, and the credits this call used.

success

any

required

data

object

required

Show child attributes

creditsUsed

integer

required

requestId

string

required

Using the API

Catalog

Account

Search and AI answers

Video

Social

Places and travel

Jobs

Shopping

Apps

Real estate

Ads

Google maps search API

Request

Response

Optional parameters

Billing

Authorizations

Body

Response

​Request

​Response

​Optional parameters

​Billing

​Pagination

​Related methods

Authorizations

Body

Response

Request

Response

Optional parameters

Billing

Pagination

Related methods