{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/places:gisgraphy/addressparsing":{"get":{"operationId":"places_gisgraphy_addressparsing","summary":"split a raw address into several parts","description":"GET /addressparser/parse","tags":["places"],"parameters":[{"name":"address","in":"query","required":true,"description":"A postal address.","schema":{"type":"string","description":"A postal address."}},{"name":"country","in":"query","required":false,"description":"The ISO 3166 Alpha 2 code of the country.","schema":{"type":"string","description":"The ISO 3166 Alpha 2 code of the country."}},{"name":"format","in":"query","required":false,"description":"The output format.","schema":{"type":"string","enum":["XML","JSON","PHP","RUBY","PYTHON","YAML"],"default":"XML","description":"The output format."}},{"name":"callback","in":"query","required":false,"description":"The callback method name (optional), use to wrap the content into a (alphanumeric) Javascript method. Works only for script output formats…","schema":{"type":"string","description":"The callback method name (optional), use to wrap the content into a (alphanumeric) Javascript method. Works only for script output formats…"}},{"name":"indent","in":"query","required":false,"description":"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…","schema":{"type":"boolean","default":"false","description":"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…"}},{"name":"standardize","in":"query","required":false,"description":"Whether the address should be standardized after parsing, the value will be 'on' or 'off', so for a simple use : the value of indent can…","schema":{"type":"boolean","default":"false","description":"Whether the address should be standardized after parsing, the value will be 'on' or 'off', so for a simple use : the value of indent can…"}},{"name":"geocode","in":"query","required":false,"description":"UNUSED YET. Whether the address should be geocoded after parsing, the value will be 'on' or 'off', so for a simple use : the value of…","schema":{"type":"boolean","default":"false","description":"UNUSED YET. Whether the address should be geocoded after parsing, the value will be 'on' or 'off', so for a simple use : the value of…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/places:gisgraphy/fulltxtsearch":{"get":{"operationId":"places_gisgraphy_fulltxtsearch","summary":"search for places by text around a GPS point","description":"GET /fulltext/search","tags":["places"],"parameters":[{"name":"q","in":"query","required":true,"description":"The searched text : The text for the query can be a zip code, a string or one or more strings","schema":{"type":"string","description":"The searched text : The text for the query can be a zip code, a string or one or more strings"}},{"name":"allwordsrequired","in":"query","required":true,"description":"Whether the fulltext engine should considers all the words specified as required. Defaults to false (since v 4.0). possible values are…","schema":{"type":"boolean","default":"false","description":"Whether the fulltext engine should considers all the words specified as required. Defaults to false (since v 4.0). possible values are…"}},{"name":"spellchecking","in":"query","required":false,"description":"The spellchecking (optional) : whether some suggestions should be provided if no results are found","schema":{"type":"string","description":"The spellchecking (optional) : whether some suggestions should be provided if no results are found"}},{"name":"lat","in":"query","required":false,"description":"The latitude (north-south) for the location point to search around. The value is a floating number, between -90 and +90. It uses GPS…","schema":{"type":"number","description":"The latitude (north-south) for the location point to search around. The value is a floating number, between -90 and +90. It uses GPS…"}},{"name":"lng","in":"query","required":false,"description":"TThe longitude (east-West) for the location point to search around. The value is a floating number between -180 and +180. It uses GPS…","schema":{"type":"number","description":"TThe longitude (east-West) for the location point to search around. The value is a floating number between -180 and +180. It uses GPS…"}},{"name":"radius","in":"query","required":false,"description":"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.","schema":{"type":"number","default":10000,"description":"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."}},{"name":"suggest","in":"query","required":false,"description":"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…","schema":{"type":"boolean","default":"false","description":"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…"}},{"name":"style","in":"query","required":false,"description":"The output style verbosity (optional) : Determines the output verbosity. 4 styles are available","schema":{"type":"string","enum":["SHORT","MEDIUM","LONG","FULL"],"default":"MEDIUM","description":"The output style verbosity (optional) : Determines the output verbosity. 4 styles are available"}},{"name":"country","in":"query","required":false,"description":"limit the search to the specified ISO 3166 country code. Default : search in all countries","schema":{"type":"string","description":"limit the search to the specified ISO 3166 country code. Default : search in all countries"}},{"name":"lang","in":"query","required":false,"description":"The language code (optional) : The iso 639 Alpha2 or alpha3 Language Code. Some properties such as the AlternateName AdmNames and…","schema":{"type":"string","description":"The language code (optional) : The iso 639 Alpha2 or alpha3 Language Code. Some properties such as the AlternateName AdmNames and…"}},{"name":"format","in":"query","required":false,"description":"The output format.","schema":{"type":"string","enum":["XML","JSON","PHP","RUBY","PYTHON","YAML","ATOM","GEORSS"],"default":"XML","description":"The output format."}},{"name":"from","in":"query","required":false,"description":"The first pagination index. Numbered from 1. If the number is < 1 or not specified, it will be set to the default value : 1","schema":{"type":"integer","default":1,"description":"The first pagination index. Numbered from 1. If the number is < 1 or not specified, it will be set to the default value : 1"}},{"name":"to","in":"query","required":false,"description":"The last pagination index. if < 1 or not specified, it will be set to startindex + 10. Max = 10 (can be changed)","schema":{"type":"integer","default":10,"description":"The last pagination index. if < 1 or not specified, it will be set to startindex + 10. Max = 10 (can be changed)"}},{"name":"callback","in":"query","required":false,"description":"The callback method name (optional), use to wrap the content into a (alphanumeric) Javascript method. Works only for script output formats…","schema":{"type":"string","description":"The callback method name (optional), use to wrap the content into a (alphanumeric) Javascript method. Works only for script output formats…"}},{"name":"indent","in":"query","required":false,"description":"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…","schema":{"type":"boolean","default":"false","description":"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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/places:gisgraphy/geocode":{"get":{"operationId":"places_gisgraphy_geocode","summary":"Geocode an address","description":"GET /geocoding/geocode","tags":["places"],"parameters":[{"name":"address","in":"query","required":true,"description":"A postal address, structured or not, a street, a city, a postal code, a country, or a combination.","schema":{"type":"string","description":"A postal address, structured or not, a street, a city, a postal code, a country, or a combination."}},{"name":"country","in":"query","required":false,"description":"The country where the place/address is. It is used to determine the postal address format and to improve performance. It will probably be…","schema":{"type":"string","description":"The country where the place/address is. It is used to determine the postal address format and to improve performance. It will probably be…"}},{"name":"postal","in":"query","required":false,"description":"Whether the given address is a postal address. default to false. In other words, if the address follow the specification or if it is a…","schema":{"type":"string","description":"Whether the given address is a postal address. default to false. In other words, if the address follow the specification or if it is a…"}},{"name":"format","in":"query","required":false,"description":"The output format.","schema":{"type":"string","enum":["XML","JSON","PHP","RUBY","PYTHON","YAML"],"default":"XML","description":"The output format."}},{"name":"from","in":"query","required":false,"description":"The first pagination index. Numbered from 1. If the number is < 1 or not specified, it will be set to the default value : 1","schema":{"type":"integer","default":1,"description":"The first pagination index. Numbered from 1. If the number is < 1 or not specified, it will be set to the default value : 1"}},{"name":"to","in":"query","required":false,"description":"The last pagination index. if < 1 or not specified, it will be set to startindex + 10. Max = 10 (can be changed)","schema":{"type":"integer","default":10,"description":"The last pagination index. if < 1 or not specified, it will be set to startindex + 10. Max = 10 (can be changed)"}},{"name":"callback","in":"query","required":false,"description":"The callback method name (optional), use to wrap the content into a (alphanumeric) Javascript method. Works only for script output formats…","schema":{"type":"string","description":"The callback method name (optional), use to wrap the content into a (alphanumeric) Javascript method. Works only for script output formats…"}},{"name":"indent","in":"query","required":false,"description":"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…","schema":{"type":"boolean","default":"false","description":"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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/places:gisgraphy/geoloc":{"get":{"operationId":"places_gisgraphy_geoloc","summary":"Geocode an address","description":"GET /geoloc/search","tags":["places"],"parameters":[{"name":"lat","in":"query","required":true,"description":"The latitude (north-south) for the location point to search around. The value is a floating number, between -90 and +90. It uses GPS…","schema":{"type":"number","description":"The latitude (north-south) for the location point to search around. The value is a floating number, between -90 and +90. It uses GPS…"}},{"name":"lng","in":"query","required":true,"description":"TThe longitude (east-West) for the location point to search around. The value is a floating number between -180 and +180. It uses GPS…","schema":{"type":"number","description":"TThe longitude (east-West) for the location point to search around. The value is a floating number between -180 and +180. It uses GPS…"}},{"name":"radius","in":"query","required":false,"description":"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.","schema":{"type":"number","default":10000,"description":"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."}},{"name":"distance","in":"query","required":false,"description":"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…","schema":{"type":"boolean","default":true,"description":"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…"}},{"name":"placetype","in":"query","required":false,"description":"filter search for a given placetype","schema":{"type":"string","description":"filter search for a given placetype"}},{"name":"format","in":"query","required":false,"description":"The output format.","schema":{"type":"string","enum":["XML","JSON","PHP","RUBY","PYTHON","YAML"],"default":"XML","description":"The output format."}},{"name":"from","in":"query","required":false,"description":"The first pagination index. Numbered from 1. If the number is < 1 or not specified, it will be set to the default value : 1","schema":{"type":"integer","default":1,"description":"The first pagination index. Numbered from 1. If the number is < 1 or not specified, it will be set to the default value : 1"}},{"name":"to","in":"query","required":false,"description":"The last pagination index. if < 1 or not specified, it will be set to startindex + 10. Max = 10 (can be changed)","schema":{"type":"integer","default":10,"description":"The last pagination index. if < 1 or not specified, it will be set to startindex + 10. Max = 10 (can be changed)"}},{"name":"callback","in":"query","required":false,"description":"The callback method name (optional), use to wrap the content into a (alphanumeric) Javascript method. Works only for script output formats…","schema":{"type":"string","description":"The callback method name (optional), use to wrap the content into a (alphanumeric) Javascript method. Works only for script output formats…"}},{"name":"indent","in":"query","required":false,"description":"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…","schema":{"type":"boolean","default":"false","description":"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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/places:gisgraphy/reversegeocode":{"get":{"operationId":"places_gisgraphy_reversegeocode","summary":"Reverse geocode an address","description":"GET /reversegeocoding/reversegeocode","tags":["places"],"parameters":[{"name":"lat","in":"query","required":true,"description":"The latitude (north-south) for the location point to search around. The value is a floating number, between -90 and +90. It uses GPS…","schema":{"type":"number","description":"The latitude (north-south) for the location point to search around. The value is a floating number, between -90 and +90. It uses GPS…"}},{"name":"lng","in":"query","required":true,"description":"TThe longitude (east-West) for the location point to search around. The value is a floating number between -180 and +180. It uses GPS…","schema":{"type":"number","description":"TThe longitude (east-West) for the location point to search around. The value is a floating number between -180 and +180. It uses GPS…"}},{"name":"format","in":"query","required":false,"description":"The output format.","schema":{"type":"string","enum":["XML","JSON","PHP","RUBY","PYTHON","YAML"],"default":"XML","description":"The output format."}},{"name":"from","in":"query","required":false,"description":"The first pagination index. Numbered from 1. If the number is < 1 or not specified, it will be set to the default value : 1","schema":{"type":"integer","default":1,"description":"The first pagination index. Numbered from 1. If the number is < 1 or not specified, it will be set to the default value : 1"}},{"name":"to","in":"query","required":false,"description":"The last pagination index. if < 1 or not specified, it will be set to startindex + 10. Max = 10 (can be changed)","schema":{"type":"integer","default":10,"description":"The last pagination index. if < 1 or not specified, it will be set to startindex + 10. Max = 10 (can be changed)"}},{"name":"callback","in":"query","required":false,"description":"The callback method name (optional), use to wrap the content into a (alphanumeric) Javascript method. Works only for script output formats…","schema":{"type":"string","description":"The callback method name (optional), use to wrap the content into a (alphanumeric) Javascript method. Works only for script output formats…"}},{"name":"indent","in":"query","required":false,"description":"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…","schema":{"type":"boolean","default":"false","description":"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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/places:gisgraphy/streetsearch":{"get":{"operationId":"places_gisgraphy_streetsearch","summary":"Geocode an address","description":"GET /street/find","tags":["places"],"parameters":[{"name":"lat","in":"query","required":true,"description":"The latitude (north-south) for the location point to search around. The value is a floating number, between -90 and +90. It uses GPS…","schema":{"type":"number","description":"The latitude (north-south) for the location point to search around. The value is a floating number, between -90 and +90. It uses GPS…"}},{"name":"lng","in":"query","required":true,"description":"TThe longitude (east-West) for the location point to search around. The value is a floating number between -180 and +180. It uses GPS…","schema":{"type":"number","description":"TThe longitude (east-West) for the location point to search around. The value is a floating number between -180 and +180. It uses GPS…"}},{"name":"radius","in":"query","required":false,"description":"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.","schema":{"type":"number","default":10000,"description":"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."}},{"name":"oneway","in":"query","required":false,"description":"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…","schema":{"type":"boolean","default":"false","description":"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…"}},{"name":"distance","in":"query","required":false,"description":"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…","schema":{"type":"boolean","default":true,"description":"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…"}},{"name":"streettype","in":"query","required":false,"description":"filter search with a stret type","schema":{"type":"string","description":"filter search with a stret type"}},{"name":"format","in":"query","required":false,"description":"The output format.","schema":{"type":"string","enum":["XML","JSON","PHP","RUBY","PYTHON","YAML"],"default":"XML","description":"The output format."}},{"name":"from","in":"query","required":false,"description":"The first pagination index. Numbered from 1. If the number is < 1 or not specified, it will be set to the default value : 1","schema":{"type":"integer","default":1,"description":"The first pagination index. Numbered from 1. If the number is < 1 or not specified, it will be set to the default value : 1"}},{"name":"to","in":"query","required":false,"description":"The last pagination index. if < 1 or not specified, it will be set to startindex + 10. Max = 10 (can be changed)","schema":{"type":"integer","default":10,"description":"The last pagination index. if < 1 or not specified, it will be set to startindex + 10. Max = 10 (can be changed)"}},{"name":"callback","in":"query","required":false,"description":"The callback method name (optional), use to wrap the content into a (alphanumeric) Javascript method. Works only for script output formats…","schema":{"type":"string","description":"The callback method name (optional), use to wrap the content into a (alphanumeric) Javascript method. Works only for script output formats…"}},{"name":"indent","in":"query","required":false,"description":"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…","schema":{"type":"boolean","default":"false","description":"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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}