Servers Playground How we check Submit a server

gmaps.dev

Working · 1.6 s

dev.gmaps/gmapsv1.0.0 Domain verified

Find businesses by what they are and where they are, collect a whole city, and export the list.

Maps & Travel

Website Registry entry

Try it

Call this server's tools from your browser. Nothing to install.

https://api.gmaps.dev/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

cancel_collection

Stop a collection you no longer want. One that has not started yet stops at once and costs nothing. One already running keeps the places that have arrived and the credits they cost; the search in flight finishes, and nothing new starts. A collection that has already ended cannot be cancelled. Needs an API key. Costs no credits.

idstring, required

The collection's id, as create_collection returned it.

The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.

I understand, run it anyway

gmaps.dev MCP server | mcptry

Tools (18)

cancel_collection

destructive

Argument	Type	Description
id*	string	The collection's id, as create_collection returned it.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "The collection's id, as create_collection returned it."
    }
  },
  "additionalProperties": false
}

create_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.

Argument	Type	Description
geo*	any	Where to search. Give exactly one of: a Brazilian city as location, a lat/lng point with radiusM, a bbox, or a cityIbge with radiusKm.
lang	string	The language to search in. New places come back in it. Two letters, such as pt or en.
enrich	array	Add ["emails"] to also look for email addresses. Costs one more credit for each place that has one, and needs a paid plan.
keywords*	array	What to search for, such as ["bakery", "coffee shop"]. One search per term.
maxPlaces	integer	Stop after this many places. Defaults to the most your plan collects at once.
minRating	any	Keep only places rated at least this, from 1 to 5. Null keeps every place.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "keywords",
    "geo"
  ],
  "properties": {
    "geo": {
      "anyOf": [
        {
          "type": "object",
          "required": [
            "location"
          ],
          "properties": {
            "location": {
              "type": "string",
              "minLength": 1
            }
          },
          "additionalProperties": false
        },
        {
          "type": "object",
          "required": [
            "lat",
            "lng",
            "radiusM"
          ],
          "properties": {
            "lat": {
              "type": "number",
              "maximum": 90,
              "minimum": -90
            },
            "lng": {
              "type": "number",
              "maximum": 180,
              "minimum": -180
            },
            "radiusM": {
              "type": "number",
              "exclusiveMinimum": 0
            }
          },
          "additionalProperties": false
        },
        {
          "type": "object",
          "required": [
            "bbox"
          ],
          "properties": {
            "bbox": {
              "type": "array",
              "items": [
                {
                  "type": "number",
                  "maximum": 180,
                  "minimum": -180
                },
                {
                  "type": "number",
                  "maximum": 90,
                  "minimum": -90
                },
                {
                  "type": "number",
                  "maximum": 180,
                  "minimum": -180
                },
                {
                  "type": "number",
                  "maximum": 90,
                  "minimum": -90
                }
              ],
              "maxItems": 4,
              "minItems": 4,
              "additionalItems": false
            }
          },
          "additionalProperties": false
        },
        {
          "type": "object",
          "required": [
            "cityIbge",
            "radiusKm"
          ],
          "properties": {
            "cityIbge": {
              "type": "integer",
              "maximum": 9999999,
              "minimum": 1000000
            },
            "radiusKm": {
              "type": "number",
              "exclusiveMinimum": 0
            }
          },
          "additionalProperties": false
        }
      ],
      "description": "Where to search. Give exactly one of: a Brazilian city as location, a lat/lng point with radiusM, a bbox, or a cityIbge with radiusKm."
    },
    "lang": {
      "type": "string",
      "default": "pt",
      "pattern": "^[a-z]{2}$",
      "description": "The language to search in. New places come back in it. Two letters, such as pt or en."
    },
    "enrich": {
      "type": "array",
      "items": {
        "enum": [
          "emails"
        ],
        "type": "string"
      },
      "default": [],
      "description": "Add [\"emails\"] to also look for email addresses. Costs one more credit for each place that has one, and needs a paid plan."
    },
    "keywords": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "description": "What to search for, such as [\"bakery\", \"coffee shop\"]. One search per term."
    },
    "maxPlaces": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Stop after this many places. Defaults to the most your plan collects at once.",
      "exclusiveMinimum": 0
    },
    "minRating": {
      "anyOf": [
        {
          "type": "number",
          "maximum": 5,
          "minimum": 1
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Keep only places rated at least this, from 1 to 5. Null keeps every place."
    }
  },
  "additionalProperties": false
}

create_export

Get a link to a collection's places as one file: csv, json or xlsx. The file has the places the collection holds now, even if it is still running. The link opens without an API key for 24 hours, so share it only with people who should see the file. Needs an API key. Costs no credits.

Argument	Type	Description
format	string	The file type: csv, json or xlsx. An xlsx file holds up to 50,000 places.
locale	string	The language of the column names in csv and xlsx files: en or pt-BR. Defaults to your account's language.
collectionId*	string	The collection to export, as create_collection or search_places returned it.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "collectionId"
  ],
  "properties": {
    "format": {
      "enum": [
        "csv",
        "json",
        "xlsx"
      ],
      "type": "string",
      "default": "csv",
      "description": "The file type: csv, json or xlsx. An xlsx file holds up to 50,000 places."
    },
    "locale": {
      "enum": [
        "en",
        "pt-BR"
      ],
      "type": "string",
      "description": "The language of the column names in csv and xlsx files: en or pt-BR. Defaults to your account's language."
    },
    "collectionId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "The collection to export, as create_collection or search_places returned it."
    }
  },
  "additionalProperties": false
}

create_webhook

Tell us where to POST when a collection ends, instead of asking us every few seconds whether it is done. The answer shows the signing secret once and never again. Store it, then check every request against it. The body carries counts and a link to the places, never the places themselves. Needs an API key and a paid plan. Costs no credits.

Argument	Type	Description
url*	string	Where to POST the event. Must start with https:// and resolve to a public address. We will not send your results unencrypted or into a private network.
events	array	Which events to send here. "collection.completed" fires when a collection ends, even one that found no places; "collection.failed" fires when an error stops it. A collection you cancel sends neither.
description	string	Your own note about this endpoint, such as which of your services it is.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "maxLength": 2000,
      "description": "Where to POST the event. Must start with https:// and resolve to a public address. We will not send your results unencrypted or into a private network."
    },
    "events": {
      "type": "array",
      "items": {
        "enum": [
          "collection.completed",
          "collection.failed"
        ],
        "type": "string"
      },
      "default": [
        "collection.completed",
        "collection.failed"
      ],
      "minItems": 1,
      "description": "Which events to send here. \"collection.completed\" fires when a collection ends, even one that found no places; \"collection.failed\" fires when an error stops it. A collection you cancel sends neither."
    },
    "description": {
      "type": "string",
      "maxLength": 200,
      "description": "Your own note about this endpoint, such as which of your services it is."
    }
  },
  "additionalProperties": false
}

delete_webhook

Stop sending to an endpoint and forget it, along with the record of what we sent there. To pause one instead, set enabled to false. That keeps the secret, so you do not have to change your code to turn it back on. Needs an API key and a paid plan. Costs no credits.

destructive

Argument	Type	Description
id*	string	The endpoint's id, as create_webhook returned it.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "The endpoint's id, as create_webhook returned it."
    }
  },
  "additionalProperties": false
}

get_attributions

List the projects credited by gmaps.dev, with their licenses and notices. No API key needed. Costs no credits.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {},
  "additionalProperties": false
}

get_collection

See where a collection has got to: how much of the area is searched, how many places have arrived, and what it has cost so far. Read it again whenever you want an update. Needs an API key. Costs no credits.

read-only

Argument	Type	Description
id*	string	The collection's id, as create_collection returned it.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "The collection's id, as create_collection returned it."
    }
  },
  "additionalProperties": false
}

get_coverage

See how much of an area we have already searched for a term, when we last searched it, and how many places we have saved there. Use it to decide whether to collect again or just read the saved places. Needs an API key. Costs no credits and starts nothing.

read-only

Argument	Type	Description
geo*	any	The area. Give exactly one of: a Brazilian city as location, a lat/lng point with radiusM, a bbox, or a cityIbge with radiusKm.
lang	string	The language the search would run in. Two letters, such as pt or en.
keywords*	array	What you would search for, such as ["bakery"]. Coverage is per term: we may have searched an area for one and never for another.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "keywords",
    "geo"
  ],
  "properties": {
    "geo": {
      "anyOf": [
        {
          "type": "object",
          "required": [
            "location"
          ],
          "properties": {
            "location": {
              "type": "string",
              "minLength": 1
            }
          },
          "additionalProperties": false
        },
        {
          "type": "object",
          "required": [
            "lat",
            "lng",
            "radiusM"
          ],
          "properties": {
            "lat": {
              "type": "number",
              "maximum": 90,
              "minimum": -90
            },
            "lng": {
              "type": "number",
              "maximum": 180,
              "minimum": -180
            },
            "radiusM": {
              "type": "number",
              "exclusiveMinimum": 0
            }
          },
          "additionalProperties": false
        },
        {
          "type": "object",
          "required": [
            "bbox"
          ],
          "properties": {
            "bbox": {
              "type": "array",
              "items": [
                {
                  "type": "number",
                  "maximum": 180,
                  "minimum": -180
                },
                {
                  "type": "number",
                  "maximum": 90,
                  "minimum": -90
                },
                {
                  "type": "number",
                  "maximum": 180,
                  "minimum": -180
                },
                {
                  "type": "number",
                  "maximum": 90,
                  "minimum": -90
                }
              ],
              "maxItems": 4,
              "minItems": 4,
              "additionalItems": false
            }
          },
          "additionalProperties": false
        },
        {
          "type": "object",
          "required": [
            "cityIbge",
            "radiusKm"
          ],
          "properties": {
            "cityIbge": {
              "type": "integer",
              "maximum": 9999999,
              "minimum": 1000000
            },
            "radiusKm": {
              "type": "number",
              "exclusiveMinimum": 0
            }
          },
          "additionalProperties": false
        }
      ],
      "description": "The area. Give exactly one of: a Brazilian city as location, a lat/lng point with radiusM, a bbox, or a cityIbge with radiusKm."
    },
    "lang": {
      "type": "string",
      "default": "pt",
      "pattern": "^[a-z]{2}$",
      "description": "The language the search would run in. Two letters, such as pt or en."
    },
    "keywords": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "description": "What you would search for, such as [\"bakery\"]. Coverage is per term: we may have searched an area for one and never for another."
    }
  },
  "additionalProperties": false
}

get_export

Read an export you made, with its download link, while the link still works. After 24 hours, or once the collection's places are deleted, it answers 404: make a new export from the collection. Needs an API key. Costs no credits.

read-only

Argument	Type	Description
id*	string	The export's id, as create_export returned it.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "The export's id, as create_export returned it."
    }
  },
  "additionalProperties": false
}

get_place

Read one saved place, by our id, Google's cid, Google's place ID, or a Google Maps link to it. It never searches: a place we have not saved answers 404, and searching its area with search_places brings it in. Needs an API key. Costs no credits.

read-only

Argument	Type	Description
place*	string	Our id for the place, Google's cid, Google's place ID, or a Google Maps link to it.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "place"
  ],
  "properties": {
    "place": {
      "type": "string",
      "maxLength": 2048,
      "minLength": 1,
      "description": "Our id for the place, Google's cid, Google's place ID, or a Google Maps link to it."
    }
  },
  "additionalProperties": false
}

get_usage

See this month's credits: what your plan includes, what you have used, what is left today and this month, and the same totals for each API key. Needs an API key. Costs no credits.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {},
  "additionalProperties": false
}

list_collections

Your collections, newest first, with the total so you know how many more there are. Filter by status to find the ones still running. Needs an API key. Costs no credits.

read-only

Argument	Type	Description
limit	integer	How many collections to return, from 1 to 100.
offset	integer	How many collections to skip, for reading the next page.
status	string	Show only collections with this status, such as running.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1,
      "description": "How many collections to return, from 1 to 100."
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "How many collections to skip, for reading the next page."
    },
    "status": {
      "enum": [
        "queued",
        "running",
        "succeeded",
        "partial",
        "failed",
        "cancelled"
      ],
      "type": "string",
      "description": "Show only collections with this status, such as running."
    }
  },
  "additionalProperties": false
}

list_webhook_deliveries

What we sent to one endpoint, newest first: which event, whether it arrived, how many tries it took, and what your server answered. This is where to look when an event never showed up. Kept for 7 days. Needs an API key and a paid plan. Costs no credits.

read-only

Argument	Type	Description
id*	string	The endpoint's id, as create_webhook returned it.
limit	integer	How many deliveries to return, newest first, from 1 to 100.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "The endpoint's id, as create_webhook returned it."
    },
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1,
      "description": "How many deliveries to return, newest first, from 1 to 100."
    }
  },
  "additionalProperties": false
}

list_webhooks

Every endpoint you have added, newest first, with whether it is still receiving events and why we stopped if it is not. Secrets are not shown again after the endpoint is created. Needs an API key and a paid plan. Costs no credits.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {},
  "additionalProperties": false
}

quote_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.

read-only

Argument	Type	Description
geo*	any	Where to search. Give exactly one of: a Brazilian city as location, a lat/lng point with radiusM, a bbox, or a cityIbge with radiusKm.
lang	string	The language to search in. New places come back in it. Two letters, such as pt or en.
enrich	array	Add ["emails"] to also look for email addresses. Costs one more credit for each place that has one, and needs a paid plan.
keywords*	array	What to search for, such as ["bakery", "coffee shop"]. One search per term.
maxPlaces	integer	Stop after this many places. Defaults to the most your plan collects at once.
minRating	any	Keep only places rated at least this, from 1 to 5. Null keeps every place.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "keywords",
    "geo"
  ],
  "properties": {
    "geo": {
      "anyOf": [
        {
          "type": "object",
          "required": [
            "location"
          ],
          "properties": {
            "location": {
              "type": "string",
              "minLength": 1
            }
          },
          "additionalProperties": false
        },
        {
          "type": "object",
          "required": [
            "lat",
            "lng",
            "radiusM"
          ],
          "properties": {
            "lat": {
              "type": "number",
              "maximum": 90,
              "minimum": -90
            },
            "lng": {
              "type": "number",
              "maximum": 180,
              "minimum": -180
            },
            "radiusM": {
              "type": "number",
              "exclusiveMinimum": 0
            }
          },
          "additionalProperties": false
        },
        {
          "type": "object",
          "required": [
            "bbox"
          ],
          "properties": {
            "bbox": {
              "type": "array",
              "items": [
                {
                  "type": "number",
                  "maximum": 180,
                  "minimum": -180
                },
                {
                  "type": "number",
                  "maximum": 90,
                  "minimum": -90
                },
                {
                  "type": "number",
                  "maximum": 180,
                  "minimum": -180
                },
                {
                  "type": "number",
                  "maximum": 90,
                  "minimum": -90
                }
              ],
              "maxItems": 4,
              "minItems": 4,
              "additionalItems": false
            }
          },
          "additionalProperties": false
        },
        {
          "type": "object",
          "required": [
            "cityIbge",
            "radiusKm"
          ],
          "properties": {
            "cityIbge": {
              "type": "integer",
              "maximum": 9999999,
              "minimum": 1000000
            },
            "radiusKm": {
              "type": "number",
              "exclusiveMinimum": 0
            }
          },
          "additionalProperties": false
        }
      ],
      "description": "Where to search. Give exactly one of: a Brazilian city as location, a lat/lng point with radiusM, a bbox, or a cityIbge with radiusKm."
    },
    "lang": {
      "type": "string",
      "default": "pt",
      "pattern": "^[a-z]{2}$",
      "description": "The language to search in. New places come back in it. Two letters, such as pt or en."
    },
    "enrich": {
      "type": "array",
      "items": {
        "enum": [
          "emails"
        ],
        "type": "string"
      },
      "default": [],
      "description": "Add [\"emails\"] to also look for email addresses. Costs one more credit for each place that has one, and needs a paid plan."
    },
    "keywords": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "description": "What to search for, such as [\"bakery\", \"coffee shop\"]. One search per term."
    },
    "maxPlaces": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Stop after this many places. Defaults to the most your plan collects at once.",
      "exclusiveMinimum": 0
    },
    "minRating": {
      "anyOf": [
        {
          "type": "number",
          "maximum": 5,
          "minimum": 1
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Keep only places rated at least this, from 1 to 5. Null keeps every place."
    }
  },
  "additionalProperties": false
}

search_places

Find places by what they are and where they are, such as bakeries in Curitiba. Places we saved from earlier searches come back at once, for free. If they do not fill `limit`, a collection starts to find the rest and the answer includes it: each new place costs one credit as it arrives, and it stops at `limit`, so a search never costs more than `limit` credits. Search again later, or read the collection, to get the new ones; with `wait`, the answer waits up to 60 seconds for them. Needs an API key.

Argument	Type	Description
geo*	any	Where to search. Give exactly one of: a Brazilian city as location, a lat/lng point with radiusM, a bbox, or a cityIbge with radiusKm.
lang	string	The language to search in. New places come back in it. Two letters, such as pt or en.
wait	integer	Seconds to wait for new places when we have to collect them, up to 60. 0 answers at once with what we already have.
limit	integer	How many places you want, from 1 to 120. Also the most a search can cost.
keywords*	array	What to search for, such as ["bakery"]. One search per term.
minRating	any	Keep only places rated at least this, from 1 to 5. Null keeps every place.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "keywords",
    "geo"
  ],
  "properties": {
    "geo": {
      "anyOf": [
        {
          "type": "object",
          "required": [
            "location"
          ],
          "properties": {
            "location": {
              "type": "string",
              "minLength": 1
            }
          },
          "additionalProperties": false
        },
        {
          "type": "object",
          "required": [
            "lat",
            "lng",
            "radiusM"
          ],
          "properties": {
            "lat": {
              "type": "number",
              "maximum": 90,
              "minimum": -90
            },
            "lng": {
              "type": "number",
              "maximum": 180,
              "minimum": -180
            },
            "radiusM": {
              "type": "number",
              "exclusiveMinimum": 0
            }
          },
          "additionalProperties": false
        },
        {
          "type": "object",
          "required": [
            "bbox"
          ],
          "properties": {
            "bbox": {
              "type": "array",
              "items": [
                {
                  "type": "number",
                  "maximum": 180,
                  "minimum": -180
                },
                {
                  "type": "number",
                  "maximum": 90,
                  "minimum": -90
                },
                {
                  "type": "number",
                  "maximum": 180,
                  "minimum": -180
                },
                {
                  "type": "number",
                  "maximum": 90,
                  "minimum": -90
                }
              ],
              "maxItems": 4,
              "minItems": 4,
              "additionalItems": false
            }
          },
          "additionalProperties": false
        },
        {
          "type": "object",
          "required": [
            "cityIbge",
            "radiusKm"
          ],
          "properties": {
            "cityIbge": {
              "type": "integer",
              "maximum": 9999999,
              "minimum": 1000000
            },
            "radiusKm": {
              "type": "number",
              "exclusiveMinimum": 0
            }
          },
          "additionalProperties": false
        }
      ],
      "description": "Where to search. Give exactly one of: a Brazilian city as location, a lat/lng point with radiusM, a bbox, or a cityIbge with radiusKm."
    },
    "lang": {
      "type": "string",
      "default": "pt",
      "pattern": "^[a-z]{2}$",
      "description": "The language to search in. New places come back in it. Two letters, such as pt or en."
    },
    "wait": {
      "type": "integer",
      "default": 0,
      "maximum": 60,
      "minimum": 0,
      "description": "Seconds to wait for new places when we have to collect them, up to 60. 0 answers at once with what we already have."
    },
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 120,
      "minimum": 1,
      "description": "How many places you want, from 1 to 120. Also the most a search can cost."
    },
    "keywords": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "description": "What to search for, such as [\"bakery\"]. One search per term."
    },
    "minRating": {
      "anyOf": [
        {
          "type": "number",
          "maximum": 5,
          "minimum": 1
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Keep only places rated at least this, from 1 to 5. Null keeps every place."
    }
  },
  "additionalProperties": false
}

test_webhook

Send a "ping" to one of your endpoints now, so you can check your code reads it and the signature checks out before a real collection depends on it. Answers straight away with the delivery; read the deliveries list a moment later to see what your server said. Needs an API key and a paid plan. Costs no credits.

destructive

Argument	Type	Description
id*	string	The endpoint's id, as create_webhook returned it.
message	string	What the test event should say, so you can spot it in your logs.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "The endpoint's id, as create_webhook returned it."
    },
    "message": {
      "type": "string",
      "default": "This is a test from your gmaps.dev account.",
      "maxLength": 200,
      "minLength": 1,
      "description": "What the test event should say, so you can spot it in your logs."
    }
  },
  "additionalProperties": false
}

update_webhook

Change which events an endpoint receives, rename it, or switch it off and on. This is how an endpoint comes back after we stopped sending to it: fix your server, then set enabled to true. The failure count starts again from zero. Whatever you leave out stays as it was. Needs an API key and a paid plan. Costs no credits.

destructive

Argument	Type	Description
id*	string	The endpoint's id, as create_webhook returned it.
events	array	Which events to send here. "collection.completed" fires when a collection ends, even one that found no places; "collection.failed" fires when an error stops it. A collection you cancel sends neither.
enabled	boolean	False to stop sending here without deleting it. True to start again after we switched it off.
description	any

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "The endpoint's id, as create_webhook returned it."
    },
    "events": {
      "type": "array",
      "items": {
        "enum": [
          "collection.completed",
          "collection.failed"
        ],
        "type": "string"
      },
      "minItems": 1,
      "description": "Which events to send here. \"collection.completed\" fires when a collection ends, even one that found no places; \"collection.failed\" fires when an error stops it. A collection you cancel sends neither."
    },
    "enabled": {
      "type": "boolean",
      "description": "False to stop sending here without deleting it. True to start again after we switched it off."
    },
    "description": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 200,
          "description": "Your own note about this endpoint, such as which of your services it is."
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "additionalProperties": false
}