Google maps place API

Get a place's address, hours, rating and contact details

curl --request POST \
  --url https://api.stophy.dev/v1/google/maps/place \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "placeUrl": "<string>",
  "placeId": "<string>",
  "country": "us",
  "language": "en"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({placeUrl: '<string>', placeId: '<string>', country: 'us', language: 'en'})
};

fetch('https://api.stophy.dev/v1/google/maps/place', 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/place"

payload = {
    "placeUrl": "<string>",
    "placeId": "<string>",
    "country": "us",
    "language": "en"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "success": true,
  "data": {
    "placeUrl": "<string>",
    "categories": [
      "<string>"
    ],
    "latitude": 0,
    "longitude": 0,
    "hours": [
      {
        "days": "<string>",
        "times": [
          "<string>"
        ]
      }
    ],
    "attributes": [
      "<string>"
    ],
    "placeId": "<string>",
    "googlePlaceId": "<string>",
    "name": "<string>",
    "address": "<string>",
    "rating": 123,
    "reviews": 0,
    "photos": 0,
    "phone": "<string>",
    "website": "<string>",
    "description": "<string>",
    "hoursToday": "<string>",
    "openStatus": "<string>",
    "timezone": "<string>",
    "plusCode": "<string>",
    "thumbnailUrl": "<string>",
    "reservationUrl": "<string>"
  },
  "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

place

Get a place's address, hours, rating and contact details

curl --request POST \
  --url https://api.stophy.dev/v1/google/maps/place \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "placeUrl": "<string>",
  "placeId": "<string>",
  "country": "us",
  "language": "en"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({placeUrl: '<string>', placeId: '<string>', country: 'us', language: 'en'})
};

fetch('https://api.stophy.dev/v1/google/maps/place', 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/place"

payload = {
    "placeUrl": "<string>",
    "placeId": "<string>",
    "country": "us",
    "language": "en"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "success": true,
  "data": {
    "placeUrl": "<string>",
    "categories": [
      "<string>"
    ],
    "latitude": 0,
    "longitude": 0,
    "hours": [
      {
        "days": "<string>",
        "times": [
          "<string>"
        ]
      }
    ],
    "attributes": [
      "<string>"
    ],
    "placeId": "<string>",
    "googlePlaceId": "<string>",
    "name": "<string>",
    "address": "<string>",
    "rating": 123,
    "reviews": 0,
    "photos": 0,
    "phone": "<string>",
    "website": "<string>",
    "description": "<string>",
    "hoursToday": "<string>",
    "openStatus": "<string>",
    "timezone": "<string>",
    "plusCode": "<string>",
    "thumbnailUrl": "<string>",
    "reservationUrl": "<string>"
  },
  "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"
  }
}

Returns a place’s address, hours, rating and contact details. The place is identified by its URL or ID.

Request

Exactly one of placeUrl or placeId is required. A request that sets both, or none, fails with invalidRequest.

import { Stophy } from "stophy";

const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.google.maps.place({ placeId: "ChIJN1t_tDeuEmsRUsoyG83frY4" });
console.log(result.data);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.google.maps.place(place_id="ChIJN1t_tDeuEmsRUsoyG83frY4")
print(result["data"])

curl -X POST https://api.stophy.dev/v1/google/maps/place \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"placeId":"ChIJN1t_tDeuEmsRUsoyG83frY4"}'

stophy google maps place --placeId ChIJN1t_tDeuEmsRUsoyG83frY4

Response

If successful, the response body contains the standard envelope. data contains the place’s address, rating, hours and contact details. The following example is a real response, truncated: each list shows one item and long strings are cut.

{
  "success": true,
  "data": {
    "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,
    "photos": 268,
    "phone": "+1 555 0100",
    "website": "http://www.mojodrivethru.com/",
    "description": "Mojo Coffee - Where Love Brews",
    "hours": [
      {
        "days": "Monday",
        "times": ["5:30 AM–8 PM"]
      }
    ],
    "hoursToday": "5:30 AM–8 PM",
    "openStatus": "Open · Closes 8 PM",
    "timezone": "America/Chicago",
    "plusCode": "8624F56M+W4",
    "thumbnailUrl": "https://lh3.googleusercontent.com/gps-cs-s/ANWiy9T_f8uieZ56cfKjTf64azsc12ETycEiGzT98fcYD0nQ-7CkNIabcVnorFv2IXcDxlYvhOER…",
    "attributes": ["Wheelchair accessible entrance"]
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}

Field	Type	Description
`rating`	number	The average star rating, on a scale of 1 to 5.
`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
`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`.

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

This method is not paginated. A single request returns the complete result.

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

placeUrl

string

Link to the Google Maps place, like https://maps.app.goo.gl/Xa3bN7cQ. Send this or placeId.

placeId

string

Google Maps place id, like ChIJN1t_tDeuEmsRUsoyG83frY4. Send this or placeUrl.

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})?$

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 place 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