By continent : world | Africa | Asia | europe | middle east | south america
| Parameter name | required | Default value | description |
|---|---|---|---|
| address | yes | none | The address to parse |
| country | yes | none | The ISO 3166 country code of the country of the address |
| format | no | XML | Output format of the response : XML, JSON, PHP, PYTHON, RUBY, PHP |
| callback | no | none | The callback method name, used to wrap the content into a method name, must be alphanumeric and operate only for script outputformat (json,php,ruby,python) |
| indent | no | XML | Wether the feed should be indented, the value can be 'true','false', or 'on' (this is usefull if you use a checkbox in a form) |
AddressParserClient addressParser = new AddressParserClient();
String rawAddress = "101 Avenue des Champs-Elysées 75008 Paris";
AddressQuery query =new AddressQuery("101 Avenue des Champs-Elysées 75008 Paris", "FR");
AddressResultsDto results =addressParser.geocode(query);
/* or
Address address=new Address();
address.setCity("Paris");
address.setZipCode("75008");
address.setHouseNumber("101");
address.setStreetType("Avenue")
address.setStreetName("des Champs-Elysées");
AddressResultsDto result = addressParser.execute(address,"FR");
*/
System.out.println("Query tooks "+result.getQTime()+" ms and"+
" return "+result.getNumFound()+" result(s)");
for (Address address : results.getResult()){
System.out.println("housenumber : "+address.getHouseNumber());
System.out.println("streetType : "+address.getStreetType());
System.out.println("streetname : "+address.getStreetName());
System.out.println("PObox : "+address.getPOBox());
System.out.println("city : "+address.getCity());
System.out.println("district : "+address.getDistrict());
System.out.println("state : "+address.getState());
//see all fields description above...
}
| field | description | Examples of value | Examples in address |
|---|---|---|---|
| id | id that identify a feature | 123456 | N/A |
| name | Name of the place, it is null in case of address but filled if common place. Name is different than recipient name. | Tour eiffel | Tour eiffel Paris |
| recipientName | Name of the organisation or person at the given address | Jack bauer | Jack Bauer street of philadelphia city, apt 5A, Washington |
| houseNumber | Official number assigned to an address by the municipality, several languages supported | 3;151-125;eight | 123 street of philadelphia city, apt 5A, Washington |
| houseNumberInfo | All informations that give extra informations on the house number | bis, ter, quater, | 125 bis rue de la france 75000 Paris |
| streetName | The official name of the street or the ordinal number | Main, 8TH | 100 MAIN ST POB 1022 SEATTLE WA 98104 |
| streetType | The type of the street | street,st,bd,dr,bvd,... | 100 MAIN ST POB 1022 SEATTLE WA 98104 |
| city | The city or locality, A small town or village name sometimes included in an address when the Delivery Point is outside the boundary of the main Post Town that serves it. | APPLEFORD | Leda Engineering Ltd APPLEFORD ABINGDON OX14 4PG |
| dependentLocality | "Sub" city attached to a big city | Dublin | boulevard of liberty Washington |
| PostTown | a city it is required part of all postal addresses in the United Kingdom | London | 49 Featherstone Street LONDON EC1Y 8SY |
| state | The state or county when applicable, can be fullName or abbreviation | WA | 100 MAIN ST POB 1022 SEATTLE WA 98104 |
| district | The district, mainly use for russia | ALEKSCEVSKTY (r-n) | ul. Lesnaya d. 5 pos. Lesnoe ALEKSCEVSKTY r-n VORONEJSKAYA obl 247112 RUSSIAN FEDERATION |
| quarter | A section of an urban settlement | DOĞANBEY MAH(turkey),French Quarter | Mebusevleri Mah. Önder Cad. Ankara Ap. 11/8 ALEKSCEVSKTY |
| zipCode | The zip or post code | 98104 | 100 MAIN ST POB 1022 SEATTLE WA 98104 |
| extraInfo | Informations on floor, unit, and sometimes POBOX,.. | floor 6,Hangar of the century | 100 MAIN ST POB 1022 SEATTLE WA 98104 100 MAIN ST 3rd floor SEATTLE WA 98104 |
| POBox | Post office box, Boite postale, Casilla de Correo,.. | POB 45, POBOX 52,boite postale 89,Casilla de Correo 17 | 100 MAIN ST POB 1022 SEATTLE WA 98104 100 MAIN ST 3rd floor SEATTLE WA 98104 |
| POBoxInfo | extra info on Post office box, Boite postale, Casilla de Correo,.. | CEDEX 01 | 5, rue Foobar, 75725 Paris CEDEX 01 |
| POBoxAgency | Agency where the office box, Boite postale, Casilla de Correo is | KHOURIBGA PRINCIPALE | P.O 1737 KHOURIBGA PRINCIPALE 25005 KHOURIBGACEDEX |
| preDirection | The cardinal direction before the name of the street | N,NE;North | N broadway bd |
| postDirection | The cardinal direction after the name of the street | N,NE;North | boulevard of liberty north Washington |
| streetNameIntersection | The official name of the intersection street | Main | N street of philadelhia & W boulevard of liberty Washington |
| streetTypeIntersection | The type of the intersection street | street,st,bd,dr,bvd,... | N street of philadelhia & W boulevard of liberty Washington |
| preDirectionIntersection | The cardinal direction before the name of the intersection street | N,NE;North | N street of philadelhia & W boulevard of liberty Washington |
| postDirectionIntersection | The cardinal direction after the name of the intersection street | N,NE;North | N street of philadelhia & boulevard of liberty SOUTH Washington |
| civicNumberSuffix | The number that follow the house number (Canada only) | 1/2 | 10-123 1/2 main street NW MONTREAL QC H3Z 2Y7 |
| floor | The floor in an address, not a floor number in a unit (Brasilia only) | 8o andar | SBN - Quadra 13 - Bloca B - 8o andar BRASILIA-DF 70002-900 |
| sector | The sector in an address (Brasilia only) | SBN | SBN - Quadra 13 - Bloca B - 8o andar BRASILIA-DF 70002-900 |
| quadrant | The quadrant in an address (Brasilia only) | Quadra 13 | SBN - Quadra 13 - Bloca B - 8o andar BRASILIA-DF 70002-900 |
| block | The block in an address (Brasilia only) the block in austria, singapore,... address | Bloca B 2 | SBN - Quadra 13 - Bloca B - 8o andar BRASILIA-DF 70002-900 Rennbahnweg 25/2/15 1220 WIEN |
| country | The country name | USA United States France | Paris - France |
| countrycode | The countrycode given in the request | FR US DE | N/A |
| field | description | Examples of value |
|---|---|---|
| message | When informations need to be given | Contrycode XX is not implemented |
| qtime | Number of milisecond the request has taken | 100 |
| numFound | Number of results found | 10 |