v1

latestSwagger 2.0LGPL license V3.2026-07-136979.5 KB
fulltext - autocomplete

search for places by text around a GPS point

The full text service allows you to search for features / places / street and do autocompletion . you can : Specify one or more words search on part of the name (auto completion / suggestion) Search for text or zip code Specify a GPS restriction (promote nearest, not sorted but has an impact on the score), Limit the results to a specific Language, Country, place type, Paginate the results, Specify the output verbosity, Tells if you want the output to be indented, Tells that all words are required or not, The search is case insensitive, use synonyms (Saint/st, ..), separator characters stripping, ...

get/fulltext/search

Query parameters

qstring required

The searched text : The text for the query can be a zip code, a string or one or more strings

allwordsrequiredboolean required

Whether the fulltext engine should considers all the words specified as required. Defaults to false (since v 4.0). possible values are true|false (or 'on' when used with the rest service)

spellcheckingstring

The spellchecking (optional) : whether some suggestions should be provided if no results are found

latnumber double

The latitude (north-south) for the location point to search around. The value is a floating number, between -90 and +90. It uses GPS coordinates

lngnumber double

TThe longitude (east-West) for the location point to search around. The value is a floating number between -180 and +180. It uses GPS coordinates.

radiusnumber double

distance from the location point in meters we'd like to search around. The value is a number > 0 if it is not specify or incorrect.

suggestboolean

If this parameter is set then it will search in part of the names of the street, place,.... It allow you to do auto completion auto suggestion. See the Gisgraphy leaflet plugin for more details. The JSON format will be forced if this parameter is true. See auto completion / suggestions engine for more details

style'SHORT' | 'MEDIUM' | 'LONG' | 'FULL'

The output style verbosity (optional) : Determines the output verbosity. 4 styles are available

countrystring

limit the search to the specified ISO 3166 country code. Default : search in all countries

langstring

The language code (optional) : The iso 639 Alpha2 or alpha3 Language Code. Some properties such as the AlternateName AdmNames and countryname belong to a certain language code. The language parameter can limit the output of those fields to a certain language (it only apply when style parameter='style') : If the language code does not exists or is not specified, properties with all the languages are retrieved If it exists, the properties with the specified language code, are retrieved

format'XML' | 'JSON' | 'PHP' | 'RUBY' | 'PYTHON' | 'YAML' | 'ATOM' | 'GEORSS'

The output format.

frominteger

The first pagination index. Numbered from 1. If the number is < 1 or not specified, it will be set to the default value : 1

tointeger

The last pagination index. if < 1 or not specified, it will be set to startindex + 10. Max = 10 (can be changed)

callbackstring

The callback method name (optional), use to wrap the content into a (alphanumeric) Javascript method. Works only for script output formats (JSON, PHP, Ruby, Python)

indentboolean

indents the results.Default to false. Possible values are true or false (or on when used with the rest service. If you use a checkbox in a web form, to indent the results, the value will be 'on' or 'off', so for a simple use : the value of indent can be 'true' or 'on'

Response

Sucessfully processed

messagestring

a message

numFoundinteger

how many results were found whatever the pagination

QTimeinteger

how long the query took

resultsSizeinteger

how many results are return

maxScorenumber float

the max score value accross all the results found