# Quick start

You want to go a little bit further ? First if you haven't read it yet, please read a short webservices descriptions on the The home page or consult the webservice functionalities matrix. It will give you a good overview. Then you will find here several sections that will help you to start.

## Does Gisgraphy fit my needs ?

It is the first question to answer :) you're 'lost ? you don't know what webservice to use ? Don't panic :) Here is some studycase that will help you ! All those study cases are not for a specific language or framework, you can do them with you favorite framework or language, in Java, php, ruby, python, in a browser with json, or anything else, because XML is readable by almost any language.

### Study cases :

- You have a list of hotels (or anything else,e.g shops,...) and you want to offer the possibility to get the nearest(s) hotel(s) from a given GPS position :
  - Add your own hotels via the web admin interface (a list of hotels is already included in Geonames but you can add / edit yours), then simply call the find nearby service with the GPS position (and an optional radius) and specify the placetype to 'hotel'. Note that you can add your own placetype, but plactetypes already availables are, most often, enough. (see example)
- You still have a list of places and want to get the nearest(s) from a given address :
  - Call the geocoder to get the GPS position of the address and then call the find nearby. (see example)
- A user to enter a zipcode and you want to display a drop down menu if there is more than one city corresponding to that zip code :
  - Use the full text engine and restrict the placetype to city and / or citySubdivision. (see example)
- You are a trip advisor and want to propose some travels for a given destination :
  - Use the fulltext engine to search for city, state, country, lake, mountains, and so on. Many facilities are offered : spellchecker, all words required or not, pagination, place type, GPS position, spoken language, or country restriction. A lot of informations availables. (see example)
- You want to display in real time the name of the street where a given user is (and a list of streets around) :
  - Use the street service to get the nearest streets for a given GPS position.(see example)
- You got a real estate agency and want to offer a web form with streets auto-completion
  - Use the street service to get a list of streets that contains the given sentence.(see example)
- You want to parse an address (as string) to extract the useful informations and then use them in a specific way
  - Use the address parser service to get individual component parts : house number, street type (bd, street, ..), street name, unit (apt, batiment, ...), zipcode, state, country, city.<(see example)

### Webservice functionalities matrix

You're lost between all the webservices ? they seem to all do the same things ? Not at all, they all have their own role. Choose the right web service for the right use, will give you the best performances and user experience. Here is a matrix that will help you to choose the right webservice for the right needs.

Webservice | entry | What's for / What's not
--- | --- | ---
Geocoding | An address, city or street | Get GPS location, city and street for the given address If you want to search for other place than city, street or address, please use fulltext webservice
Street search | GPS position and Partial street name (optional) | Find Streets and the distance around a given GPS , restrict search to streets that contains the given partial name (useful for auto-completion) Equivalent to find nearby webservice with placetype= street, but more specific (you can restrict search to oneway/two way, streettype,...) If you want to search for streets in fulltext mode, please use the fulltext webservice
Address parser | A well formed address | Divides a single address string into its individual component parts : house number, street type (bd, street, ..), street name, unit (apt, batiment, ...), zipcode, state, country, city, ... If the address is not a normalized address, please use Geocoding service
Find nearby | GPS, a placetype (optional) and a radius (optional) | Find places of the given placetype and the distance to the given GPS point for the given radius
Fulltext | A user given string, a GPS point (optional), one or more placetypes (optional) | Find plenty of informations for place of the given placetypes (optional), in several languages, in fulltext mode, restrict search around the given point (optional) You can set 'allwordsrequired' option to false if you want a more permissive search, or find a place in a sentence

## Try

Want to try it before install. find some examples of URL on the free access.
want to have some examples on how to use, go to the Demo site

## Premium

Don't want to install it by your self or want hosted web service? we got solutions !go to the premium page

## Download

Download ? yes! but what ? If you want to download Gisgraphy, Go to the download page
If you want to download Openstreetmap data in CSV, Go to the download data page if you are intereted to download dumps (Solr/lucene dump for fulltext engine and postgres sql dump) go to the dump page if you want to download the sources, go to the source repository page.

## Install

Consult the installation guide. It can be found online or in the 'doc' repository of the Gisgraphy distribution.

## Learn

Go to the documentation page

## Develop

All you need is in the developer zone. consult the developer guide