README_API_GUIDE.md

Guide to Geocoding APIs

This is a list of geocoding APIs supported by the Geocoder gem. Before using any API in a production environment, please read its official Terms of Service (links below).

Table of Contents

• Street Address Lookups
• IP Address Lookups
• Local IP Address Lookups

Street Address Lookups

Google (:google)

• API key: required
• Key signup: https://developers.google.com/maps/documentation/geocoding/usage-and-billing
• Quota: pay-as-you-go pricing; 50 requests/second
• Region: world
• SSL support: yes (required if key is used)
• Languages: see https://developers.google.com/maps/faq#languagesupport
• Extra params:
  • :bounds - pass SW and NE coordinates as an array of two arrays to bias results towards a viewport
  • :google_place_id - pass true if search query is a Google Place ID
• Documentation: https://developers.google.com/maps/documentation/geocoding/intro
• Terms of Service: http://code.google.com/apis/maps/terms.html#section_10_12
• Limitations: "You must not use or display the Content without a corresponding Google map, unless you are explicitly permitted to do so in the Maps APIs Documentation, or through written permission from Google." "You must not pre-fetch, cache, or store any Content, except that you may store: (i) limited amounts of Content for the purpose of improving the performance of your Maps API Implementation..."

Google Maps API for Work (:google_premier)

Similar to :google, with the following differences:

• API key: required, plus client and channel (set Geocoder.configure(lookup: :google_premier, api_key: [key, client, channel]))
• Key signup: https://developers.google.com/maps/premium/
• Quota: 100,000 requests/24 hrs, 10 requests/second