1.8 KiB

Raw Blame History

API keys and rate limits

Get an API key

To use the Mapzen Search service, you must first get a developer API key. Sign in at https://mapzen.com/developers to create and manage your API keys.

Go to https://mapzen.com/developers.
Sign in with your GitHub account. If you have not done this before, you need to agree to the terms first.
Create a new key for Mapzen Search, and optionally, give it a name so you can remember the purpose of the project.
Copy the key into your code.

Rate limits

Because Mapzen Search is a shared service, there are limitations on the numbers of requests to prevent individual users from degrading system performance.

Mapzen Search allows you a maximum of:

6 requests per second
30,000 requests per day

If you need more capacity, contact search@mapzen.com. You can also set up your own instance of Pelias, which has access to the same data used in Mapzen Search.

Failing to provide an `api_key`

If you fail to supply the api_key parameter, the service will respond with the status code 403 Forbidden:

{
  "meta": {
    "version": 1,
    "status_code": 403
  },
  "results": {
    "error": {
      "type": "KeyError",
      "message": "No api_key specified."
    }
  }
}

Exceeding your limits

If you exceed your limits, the service will respond with the status code 429 Too Many Requests:

{
  "meta": {
    "version": 1,
    "status_code": 429
  },
  "results": {
    "error": {
      "type": "QpsExceededError",
      "message": "Queries per second exceeded: Queries exceeded (6 allowed)."
    }
  }
}

Security

Mapzen Search works over HTTPS and HTTP. You are strongly encouraged to use HTTPS for all requests, especially for queries involving potentially sensitive information, such as a user's location or search query.

1.8 KiB Raw Blame History