3f91690c0e06

latestSwagger 2.0LGPL license V3.2026-07-136979.5 KB
streetservice

Geocode an address

The street service allows you to search for street by GPS position. You can : Specify GPS position, Give the beginning or a part of the name of the street (useful for autocompletion), Limit search to a specific type (e.g : Pedestrian, highway, residential, ... 25 types available), Limit search to a specified radius, Limit search to one way streets,

get/street/find

Query parameters

latnumber double required

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 required

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.

onewayboolean

whether the street should be a oneWay street (optional) : limit the search to the street that are one way street. If you use a checkbox in a form to indent the results, the value will be 'on' or 'off', so to simplify the use : the value for the web service can be 'true' or 'on'

distanceboolean

Whether (or not) we want the distance field to be output. This option is useful to improve the performance if we don't care about the distance (e.g : we search for name). Of course, the results won't be sorted by distance. If you use a checkbox in a form to indent the results, the value will be 'on' or 'off', so to simplify the use : the value for the web service can be 'true' or 'on'

streettypestring

filter search with a stret type

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

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. 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

numFoundinteger

The number of results display with this query (it takes the pagination into account)

QTimeinteger

The execution time of the query in ms

errorstring

A String only present if an error occured (e.g : empty Latitude or longitude)