@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Gisgraphy webservices
@base http://free.gisgraphy.com/
@version 4.0.0
@auth ApiKey api_key in query
@common_fields {format: any, callback: any, indent: any}
@endpoints 6
@toc geocoding(1), reversegeocoding(1), street(1), geoloc(1), fulltext(1), addressparser(1)

@group geocoding
@endpoint GET /geocoding/geocode
@required {address: any}
@optional {country: any, postal: any, from: any, to: any}
@returns(200)
@errors {401, 403, 412, 429, 500}

@endgroup

@group reversegeocoding
@endpoint GET /reversegeocoding/reversegeocode
@required {lat: any, lng: any}
@optional {from: any, to: any}
@returns(200)
@errors {401, 403, 412, 429, 500}

@endgroup

@group street
@endpoint GET /street/find
@required {lat: any, lng: any}
@optional {radius: any, oneway: any, distance: any, streettype: any, from: any, to: any}
@returns(200)
@errors {401, 403, 412, 429, 500}

@endgroup

@group geoloc
@endpoint GET /geoloc/search
@required {lat: any, lng: any}
@optional {radius: any, distance: any, placetype: any, from: any, to: any}
@returns(200)
@errors {401, 403, 412, 429, 500}

@endgroup

@group fulltext
@endpoint GET /fulltext/search
@required {q: any, allwordsrequired: any}
@optional {spellchecking: any, lat: any, lng: any, radius: any, suggest: any, style: any, country: any, lang: any, from: any, to: any}
@returns(200)
@errors {401, 403, 412, 429, 500}

@endgroup

@group addressparser
@endpoint GET /addressparser/parse
@required {address: any}
@optional {country: any, standardize: any, geocode: any}
@returns(200)
@errors {401, 403, 412, 429, 500}

@endgroup

@end