CINXE.COM

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" > <meta name="referrer" content="unsafe-url"> <title>GeoNames Search Webservice</title> <link href="/geonames.ico" rel="shortcut icon"> <link rel="StyleSheet" href="/geonames.css" type="text/css"> </head> <body> <table id="topmenutable"><tbody><tr> <td class="topmenu"> <a href="/" title="GeoName Home"> GeoNames Home</a> | <a href="/postal-codes/" title="Postal Codes">Postal Codes</a> | <a href="/export/" title="Database Dump and Webservice API">Download / Webservice</a> | <a href="/about.html" title="About GeoNames">About</a> </td> <td class="topsearch"> <form class="topsearch" name="searchForm" method="post" action="/servlet/geonames" onsubmit="javascript:fulltextsearch();return false;"> search <input class="topmenu" name="q" size="20" value="" type="text"> <input name="srv" value="1" type="hidden"> </form> </td></tr> </tbody></table> <div style="margin: auto; width: 600px; text-align: left;"> <h3>GeoNames Search Webservice</h3> <h4>Webservice Description</h4> <table> <tbody><tr><td valign="top">Url</td><td valign="top">»</td><td>api.geonames.org/search?</td></tr> <tr><td valign="top">Result</td><td valign="top">»</td><td>returns the names found for the searchterm as xml or json document, the search is using an AND operator </td></tr> </tbody></table> <table class="restable"> <tbody><tr><th>Parameter</th><th width="19%">Value</th><th>Description</th></tr> <tr><td>q</td><td>string (q,name or name_equals required)</td><td>search over all attributes of a place : place name, country name, continent, admin codes,... (Important:<a href="http://forum.geonames.org/gforum/posts/list/8.page">urlencoded utf8</a>)</td></tr> <tr><td>name</td><td>string (q,name or name_equals required)</td><td>place name only(Important:<a href="http://forum.geonames.org/gforum/posts/list/8.page">urlencoded utf8</a>)</td></tr> <tr><td>name_equals</td><td>string (q,name or name_equals required)</td><td>exact place name</td></tr> <tr><td>name_startsWith</td><td>string (optional)</td><td>place name starts with given characters</td></tr> <tr><td>maxRows</td><td>integer (optional)</td><td>the maximal number of rows in the document returned by the service. Default is 100, the maximal allowed value is 1000.</td></tr> <tr><td>startRow</td><td>integer (optional)</td><td>Used for paging results. If you want to get results 30 to 40, use startRow=30 and maxRows=10. Default is 0, the maximal allowed value is 5000 for the free services and 25000 for the premium services</td></tr> <tr><td>country</td><td>string : country code, ISO-3166 (optional)</td><td>Default is all countries. The country parameter may occur more than once, example: country=FR&country=GP</td></tr> <tr><td>countryBias</td><td>string (option), two letter country code ISO-3166</td><td>records from the countryBias are listed first</td></tr> <tr><td>continentCode</td><td>string : continent code : AF,AS,EU,NA,OC,SA,AN (optional)</td><td>restricts the search for toponym of the given continent.</td></tr> <tr><td>adminCode1, adminCode2, adminCode3, adminCode4, adminCode5</td><td>string : admin code (optional)</td><td>code of administrative subdivision</td></tr> <tr><td>featureClass</td><td>character A,H,L,P,R,S,T,U,V (optional)</td><td> <a href="/export/codes.html">featureclass(es)</a> (default= all feature classes); this parameter may occur more than once, example: featureClass=P&featureClass=A</td></tr> <tr><td>featureCode</td><td>string (optional)</td><td><a href="/export/codes.html">featurecode(s)</a> (default= all feature codes); this parameter may occur more than once, example: featureCode=PPLC&featureCode=PPLX</td></tr> <tr><td>cities</td><td>string (optional)</td><td>optional filter parameter with three possible values 'cities1000', 'cities5000','cities15000' used to categorize the populated places into three groups according to size/relevance. See the download <a href="http://download.geonames.org/export/dump/readme.txt">readme</a> for further infos </td></tr> <tr><td>lang</td><td>string ISO-639 2-letter language code; en,de,fr,it,es,zh,zh-Hant... (optional)</td><td>place name and country name will be returned in the specified language. Default is English. With the pseudo language code 'local' the local language will be returned. Feature classes and codes are only available in English and Bulgarian. Any <a href="http://forum.geonames.org/gforum/posts/list/25.page">help in translating</a> is welcome.</td></tr> <tr><td>type</td><td>string xml,json,rdf</td><td>the format type of the returned document, default = xml</td></tr> <tr><td>style</td><td>string SHORT,MEDIUM,LONG,FULL (optional)</td><td>verbosity of returned xml document, default = MEDIUM</td></tr> <tr><td>isNameRequired</td><td>boolean (optional)</td><td>At least one of the search term needs to be part of the place name. Example : A normal search for Berlin will return all places within the state of Berlin. If we only want to find places with 'Berlin' in the name we set the parameter isNameRequired to 'true'. The difference to the name_equals parameter is that this will allow searches for 'Berlin, Germany' as only one search term needs to be part of the name. </td></tr> <tr><td>tag</td><td>string (optional)</td><td>search for toponyms tagged with the specified tag</td></tr> <tr><td>operator</td><td>string (optional)</td><td>default is 'AND', with the operator 'OR' not all search terms need to be matched by the response</td></tr> <tr><td>charset</td><td>string (optional)</td><td>default is 'UTF8', defines the encoding used for the document returned by the web service.</td></tr> <tr><td>fuzzy</td><td>float (optional)</td><td>default is '1', defines the fuzziness of the search terms. float between 0 and 1. The search term is only applied to the name attribute.</td></tr> <tr><td>east,west,north,south</td><td>float (optional)</td><td>bounding box, only features within the box are returned</td></tr> <tr><td>searchlang</td><td>string (optional)</td><td>in combination with the name parameter, the search will only consider names in the specified language. Used for instance to query for <a href="http://www.iata.org/publications/Pages/code-search.aspx">IATA</a> airport codes.</td></tr> <tr><td>orderby</td><td>string (optional)[population,elevation,relevance]</td><td>in combination with the name_startsWith, if set to 'relevance' than the result is sorted by relevance.</td></tr> <tr><td>inclBbox</td><td>string (option) [true]</td><td>include Bbox info, regardelss of style setting. (normally only included with style=FULL</td></tr> </tbody></table>   <h5>Examples</h5> XML Example 1 : <a href="http://api.geonames.org/search?q=london&maxRows=10&username=demo" target="_blank">http://api.geonames.org/search?q=london&maxRows=10&username=demo</a> Example 2 : <a href="http://api.geonames.org/search?q=london&maxRows=10&style=LONG&lang=es&username=demo" target="_blank">http://api.geonames.org/search?q=london&maxRows=10&style=LONG&lang=es&username=demo</a> Example 3 bounding box : <a href="http://api.geonames.org/search?q=london&south=0&north=70&west=-120&east=-10&maxRows=10&username=demo" target="_blank">http://api.geonames.org/search?q=london&south=0&north=70&west=-120&east=-10&maxRows=10&username=demo</a> JSON <a href="view-source:http://api.geonames.org/searchJSON?q=london&maxRows=10&username=demo" target="_blank">http://api.geonames.org/searchJSON?q=london&maxRows=10&username=demo</a> JSON is easier to use in Javascript than XML, as a browser security feature will no allow you to call an xml service from an other domain. A simple example using the json service on googlemaps is <a href="http://www.geonames.org/maps/json-googlemaps-example.html">here</a> 'name' and 'toponymName' The response returns two name attributes. The 'name' attribute is a localized name, the preferred name in the language passed in the optional 'lang' parameter or the name that triggered the response in a 'startWith' search. The attribute 'toponymName' is the main name of the toponym as displayed on the google maps interface page or in the geoname file in the download. The 'name' attribute is derived from the alternate names. Fuzzy Search With the parameter 'fuzzy' the search will find results even if the search terms are incorrectly spelled. Example: <a href="http://api.geonames.org/search?q=londoz&maxRows=10&fuzzy=0.8&username=demo">http://api.geonames.org/search?q=londoz&fuzzy=0.8&username=demo</a> Reverse Geocoding <a href="http://www.geonames.org/export/reverse-geocoding.html">Reverse geocoding</a> is the process of finding a place name for a given latitude and longitude. GeoNames has a wide range of <a href="http://www.geonames.org/export/reverse-geocoding.html">reverse geocoding webservices</a>. RDF - Semantic Web <a href="http://api.geonames.org/search?q=london&maxRows=10&type=rdf&username=demo" target="_blank">http://api.geonames.org/search?q=london&maxRows=10&type=rdf&username=demo</a> With the parameter type=rdf the search service returns the result in RDF format defined by the <a href="/ontology/">GeoNames Semantic Web</a> Ontology. Tags GeoNames is using a simple tagging system. Every user can tag places. In contrast to the feature codes and feature classes which are one-dimensional (a place name can only have one feature code) several tags can be used for each place name. It is an additional categorization mechanism where the simple classification with feature codes is not sufficient. I have tagged a place with the tag 'skiresort'. You can search for tags with the search : <a href="http://www.geonames.org/search.html?q=skiresort">http://www.geonames.org/search.html?q=skiresort</a> If you only want to search for a tag and not for other occurrences of the term (in case you tag something with 'spain' for example), then you add the attribute 'tags:' to the search term : <a href="http://www.geonames.org/search.html?q=tags%3Askiresort">http://www.geonames.org/search.html?q=tags:skiresort</a> And if you want to search for tags of a particular user (or your own) then you append '@username' to the tag. Like this : <a href="http://www.geonames.org/search.html?q=tags%3Askiresort%40marc">http://www.geonames.org/search.html?q=tags:skiresort@marc</a> With the API the the call looks like this: <a href ="http://api.geonames.org/search?tag=skiresort@marc&username=demo">http://api.geonames.org/search?tag=skiresort@marc&username=demo</a>     </div>   <div id="license"> <a rel="license" href="http://creativecommons.org/licenses/by/4.0/"> <img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /> </a> This work is licensed under a <a rel="license" href="https://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 License</a>. </div>      <div id="pageFooter"> info@geonames.org <img src="/img/smallant.gif" alt="ant" align="middle" hspace="40" border="0"> <a href="/">GeoNames Home</a> • <a href="/postal-codes/">Postal Codes</a> • <a href="/export/">Download / Webservice</a> • <a href="http://forum.geonames.org">Forum</a> • <a href="http://geonames.wordpress.com">Blog</a> • <a href="/sitemap.html">Sitemap</a> </div> </body> </html>