Collections

Start a collection

Search a whole area, square by square, and collect up to maxPlaces of the places in it. Answers straight away with the collection, then works through the area in the background. Read the collection again to see how far it has got. Starting one costs nothing: each new place costs one credit as it arrives, and saved places cost nothing. Needs an API key.

post/collections

Request

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

Headers

Idempotency-Keystring

Any text of 1 to 200 characters, such as your own job id. Send it again with the same body, and you get back what the first call started, as it stands now: nothing starts or costs credits twice. The same key with a different body answers 409. Without a key, a call that got no answer cannot be sent again safely.

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

Start a collection

Changes

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