Collections

Quote a collection

See what collecting an area would cost before you start it: how much of it we have searched recently, how many places we have saved there (those cost nothing), how many searches are left to run, and the most it can cost in credits. Needs an API key. Costs no credits and starts nothing.

post/collections/quote

Request

  • Base URL: https://api.gmaps.dev/v1
  • URL: https://api.gmaps.dev/v1/collections/quote
  • Auth: HTTP bearer

Request body

keywordsstring[] required

What to search for, such as ["bakery", "coffee shop"]. One search per term.

langstring

The language to search in. New places come back in it. Two letters, such as pt or en.

minRatingnumber nullable

Keep only places rated at least this, from 1 to 5. Null keeps every place.

maxPlacesinteger

Stop after this many places. Defaults to the most your plan collects at once.

enrichstring[]

Add ["emails"] to also look for email addresses. Costs one more credit for each place that has one, and needs a paid plan.

Response

Quote a collection

Changes

No recorded changes to this operation across all 1 revision of this API.