pelias
/
documentation
mirror of https://github.com/pelias/documentation.git
1
0
Fork 0
Code Issues Releases Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
107 Commits
5 Branches
0 Tags
13 MiB
 
Tree: 6ea066b5e4
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '6ea066b5e4'
${ noResults }
documentation/001-api.md

1.2 KiB
Raw Blame History

API keys and rate limits

Obtain an API key

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

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

Rate limits

Because Mapzen Search is a free, shared service, there are limitations on the numbers of requests to prevent individual users from degrading the overall 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.

Security

Mapzen Search works over HTTPS, in addition to 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.