--- title: "Geocode an address" method: GET path: "/geocoding/geocode" tags: ["geocoding"] --- # Geocode an address `GET /geocoding/geocode` The Gisgraphy geocoding service allows you to transform postal addresses or other descriptions (a street, a city, a postal code, a country, or a combination) of a location into a (latitude, longitude) coordinate. ## Query parameters - `address` string, required - `country` string - `postal` string - `format` 'XML' | 'JSON' | 'PHP' | 'RUBY' | 'PYTHON' | 'YAML' - `from` integer - `to` integer - `callback` string - `indent` boolean ## Response `200` Sucessfully processed - AddressResultsDto - `message` string — a message - `numFound` integer — how many result found - `QTime` integer — how long the query took - `parsedAddress` Address - `nameAlternatesLocalized` object - `adm1NameAlternatesLocalized` object - `adm2NameAlternatesLocalized` object - `countryNameAlternatesLocalized` object - `geocodinglevel` 'NONE' | 'HOUSE_NUMBER' | 'STREET' | 'CITY' | 'STATE' | 'COUNTRY' - `id` integer — An internal ID to identify the address - `lng` number, double — The longitude of the address - `lat` number, double — The latitude of the address - `confidence` string — An indicator that mesure how the parser is confident for the result - `distance` number, double — The distance of the address for the given parameter location in the query - `name` string — Name of the place, it is null in case of address but filled if common place. Name is different than recipient name - `recipientName` string — Name of the organisation or person at the given address - `houseNumber` string — Official number assigned to an address by the municipality, several languages supported - `houseNumberInfo` string — All information that give extra information on the house number - `streetName` string — The official name of the street or the ordinal number - `streetType` string — The type of the street - `city` string — The city or locality, a small town or village name sometimes is included in an address when the Delivery Point is outside the boundary of the main Post Town that serves it. - `citySubdivision` string — A sub division of a city - `dependentLocality` string — 'Sub' city atached to a big city - `postTown` string — a city is a required part of all postal addresses in the United Kingdom - `prefecture` string — prefecture of China - `state` string — The state or county when applicable, can be fullname or abbreviation - `district` string — The district, mainly use for Russia - `quarter` string — A section of an urban settlement - `zipCode` string — The zip or post code - `extraInfo` string — Informations on floor, unit, and sometimes POBOX,... - `suiteType` string — Informations on the unit, mainly used and filled by standardizer - `suiteNumber` string — Informations on the unit, mainly used and filled by standardizer - `POBox` string — Post office box, Boite postale, Casilla de Correo,... - `POBoxInfo` string — extra info on post office box, Boite postale, Casilla de Correo,.. - `POBoxAgency` string — Agency where the office box, Boite postale, Casilla de Correo is - `preDirection` string — The cardinal direction before the name of the street - `postDirection` string — The cardinal direction after the name of the street - `streetNameIntersection` string — The official name of the intersection street - `streetTypeIntersection` string — The type of the intersection street - `preDirectionIntersection` string — The cardinal direction before the name of the intersection street - `postDirectionIntersection` string — The cardinal direction after the name of the intersection street - `civicNumberSuffix` string — The number that follows the house number (Canada only) - `floor` string — The floor in an address, not a floor number in a unit (Brasilia only) - `sector` string — The sector in an address (Brasilia only) - `quadrant` string — The quadrant in an address (Brasilia only) - `block` string — The block in an address (Brasilia only) the block in austria, singapore,... address - `lote` string — Lote in Brazilian address - `country` string — The country name - `countrycode` string — The countrycode given in the request - `ward` string — Ward in japanese address - `result` Address[] - `nameAlternatesLocalized` object - `adm1NameAlternatesLocalized` object - `adm2NameAlternatesLocalized` object - `countryNameAlternatesLocalized` object - `geocodinglevel` 'NONE' | 'HOUSE_NUMBER' | 'STREET' | 'CITY' | 'STATE' | 'COUNTRY' - `id` integer — An internal ID to identify the address - `lng` number, double — The longitude of the address - `lat` number, double — The latitude of the address - `confidence` string — An indicator that mesure how the parser is confident for the result - `distance` number, double — The distance of the address for the given parameter location in the query - `name` string — Name of the place, it is null in case of address but filled if common place. Name is different than recipient name - `recipientName` string — Name of the organisation or person at the given address - `houseNumber` string — Official number assigned to an address by the municipality, several languages supported - `houseNumberInfo` string — All information that give extra information on the house number - `streetName` string — The official name of the street or the ordinal number - `streetType` string — The type of the street - `city` string — The city or locality, a small town or village name sometimes is included in an address when the Delivery Point is outside the boundary of the main Post Town that serves it. - `citySubdivision` string — A sub division of a city - `dependentLocality` string — 'Sub' city atached to a big city - `postTown` string — a city is a required part of all postal addresses in the United Kingdom - `prefecture` string — prefecture of China - `state` string — The state or county when applicable, can be fullname or abbreviation - `district` string — The district, mainly use for Russia - `quarter` string — A section of an urban settlement - `zipCode` string — The zip or post code - `extraInfo` string — Informations on floor, unit, and sometimes POBOX,... - `suiteType` string — Informations on the unit, mainly used and filled by standardizer - `suiteNumber` string — Informations on the unit, mainly used and filled by standardizer - `POBox` string — Post office box, Boite postale, Casilla de Correo,... - `POBoxInfo` string — extra info on post office box, Boite postale, Casilla de Correo,.. - `POBoxAgency` string — Agency where the office box, Boite postale, Casilla de Correo is - `preDirection` string — The cardinal direction before the name of the street - `postDirection` string — The cardinal direction after the name of the street - `streetNameIntersection` string — The official name of the intersection street - `streetTypeIntersection` string — The type of the intersection street - `preDirectionIntersection` string — The cardinal direction before the name of the intersection street - `postDirectionIntersection` string — The cardinal direction after the name of the intersection street - `civicNumberSuffix` string — The number that follows the house number (Canada only) - `floor` string — The floor in an address, not a floor number in a unit (Brasilia only) - `sector` string — The sector in an address (Brasilia only) - `quadrant` string — The quadrant in an address (Brasilia only) - `block` string — The block in an address (Brasilia only) the block in austria, singapore,... address - `lote` string — Lote in Brazilian address - `country` string — The country name - `countrycode` string — The countrycode given in the request - `ward` string — Ward in japanese address ## Other responses - `401` — Need auth. The API key parameter is missing or wrong, or doesn't correspond to any subscriptions - `403` — Unhauthorize (auth will change nothing).Your IP is not allowed. - `412` — Missing parameter. Some parameters required for the webservices ar missing, please consult documentation - `429` — Too many requests. You exceed the authorized rate - `500` — Internal error --- [API](https://skmtc.net/gisgraphy/apis/gisgraphy-webservices.md) · [All operations](https://skmtc.net/gisgraphy/apis/gisgraphy-webservices/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gisgraphy/gisgraphy-webservices/versions/3f91690c0e06/schema)