# Gisgraphy webservices API

> Gisgraphy webservices API on Apizie: 6 endpoints (split a raw address into several parts, search for places by text around a GPS point, Geocode an address, Geocode an address, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/places:gisgraphy/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `places:gisgraphy`
- Category: Places
- Status: byok
- Source: https://gisgraphy.com
- Page: https://www.apizie.tech/api/places/gisgraphy
- OpenAPI: https://www.apizie.tech/api/places/gisgraphy/openapi.json

Since 2006, [Gisgraphy](http://www.gisgraphy.com) is a free, open source framework that offers the possibility to do geolocalisation and geocoding via Java APIs or REST webservices. Because geocoding is nothing without…

## Endpoints

### split a raw address into several parts
`GET https://www.apizie.tech/v1/places:gisgraphy/addressparsing` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| address | string | yes | A postal address. |
| country | string | no | The ISO 3166 Alpha 2 code of the country. |
| format | string | no | The output format. |
| callback | string | no | The callback method name (optional), use to wrap the content into a (alphanumeric) Javascript method. Works only for script output formats… |
| indent | boolean | no | 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… |
| standardize | boolean | no | 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… |
| geocode | boolean | no | 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… |

### search for places by text around a GPS point
`GET https://www.apizie.tech/v1/places:gisgraphy/fulltxtsearch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| q | string | yes | The searched text : The text for the query can be a zip code, a string or one or more strings |
| allwordsrequired | boolean | yes | Whether the fulltext engine should considers all the words specified as required. Defaults to false (since v 4.0). possible values are… |
| spellchecking | string | no | The spellchecking (optional) : whether some suggestions should be provided if no results are found |
| lat | number | no | The latitude (north-south) for the location point to search around. The value is a floating number, between -90 and +90. It uses GPS… |
| lng | number | no | TThe longitude (east-West) for the location point to search around. The value is a floating number between -180 and +180. It uses GPS… |
| radius | number | no | 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. |
| suggest | boolean | no | 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… |
| style | string | no | The output style verbosity (optional) : Determines the output verbosity. 4 styles are available |
| country | string | no | limit the search to the specified ISO 3166 country code. Default : search in all countries |
| lang | string | no | The language code (optional) : The iso 639 Alpha2 or alpha3 Language Code. Some properties such as the AlternateName AdmNames and… |
| format | string | no | The output format. |
| from | integer | no | The first pagination index. Numbered from 1. If the number is < 1 or not specified, it will be set to the default value : 1 |
| to | integer | no | The last pagination index. if < 1 or not specified, it will be set to startindex + 10. Max = 10 (can be changed) |
| callback | string | no | The callback method name (optional), use to wrap the content into a (alphanumeric) Javascript method. Works only for script output formats… |
| indent | boolean | no | 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… |

### Geocode an address
`GET https://www.apizie.tech/v1/places:gisgraphy/geocode` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| address | string | yes | A postal address, structured or not, a street, a city, a postal code, a country, or a combination. |
| country | string | no | The country where the place/address is. It is used to determine the postal address format and to improve performance. It will probably be… |
| postal | string | no | 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… |
| format | string | no | The output format. |
| from | integer | no | The first pagination index. Numbered from 1. If the number is < 1 or not specified, it will be set to the default value : 1 |
| to | integer | no | The last pagination index. if < 1 or not specified, it will be set to startindex + 10. Max = 10 (can be changed) |
| callback | string | no | The callback method name (optional), use to wrap the content into a (alphanumeric) Javascript method. Works only for script output formats… |
| indent | boolean | no | 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… |

### Geocode an address
`GET https://www.apizie.tech/v1/places:gisgraphy/geoloc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lat | number | yes | The latitude (north-south) for the location point to search around. The value is a floating number, between -90 and +90. It uses GPS… |
| lng | number | yes | TThe longitude (east-West) for the location point to search around. The value is a floating number between -180 and +180. It uses GPS… |
| radius | number | no | 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. |
| distance | boolean | no | 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… |
| placetype | string | no | filter search for a given placetype |
| format | string | no | The output format. |
| from | integer | no | The first pagination index. Numbered from 1. If the number is < 1 or not specified, it will be set to the default value : 1 |
| to | integer | no | The last pagination index. if < 1 or not specified, it will be set to startindex + 10. Max = 10 (can be changed) |
| callback | string | no | The callback method name (optional), use to wrap the content into a (alphanumeric) Javascript method. Works only for script output formats… |
| indent | boolean | no | 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… |

### Reverse geocode an address
`GET https://www.apizie.tech/v1/places:gisgraphy/reversegeocode` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lat | number | yes | The latitude (north-south) for the location point to search around. The value is a floating number, between -90 and +90. It uses GPS… |
| lng | number | yes | TThe longitude (east-West) for the location point to search around. The value is a floating number between -180 and +180. It uses GPS… |
| format | string | no | The output format. |
| from | integer | no | The first pagination index. Numbered from 1. If the number is < 1 or not specified, it will be set to the default value : 1 |
| to | integer | no | The last pagination index. if < 1 or not specified, it will be set to startindex + 10. Max = 10 (can be changed) |
| callback | string | no | The callback method name (optional), use to wrap the content into a (alphanumeric) Javascript method. Works only for script output formats… |
| indent | boolean | no | 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… |

### Geocode an address
`GET https://www.apizie.tech/v1/places:gisgraphy/streetsearch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lat | number | yes | The latitude (north-south) for the location point to search around. The value is a floating number, between -90 and +90. It uses GPS… |
| lng | number | yes | TThe longitude (east-West) for the location point to search around. The value is a floating number between -180 and +180. It uses GPS… |
| radius | number | no | 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. |
| oneway | boolean | no | 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… |
| distance | boolean | no | 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… |
| streettype | string | no | filter search with a stret type |
| format | string | no | The output format. |
| from | integer | no | The first pagination index. Numbered from 1. If the number is < 1 or not specified, it will be set to the default value : 1 |
| to | integer | no | The last pagination index. if < 1 or not specified, it will be set to startindex + 10. Max = 10 (can be changed) |
| callback | string | no | The callback method name (optional), use to wrap the content into a (alphanumeric) Javascript method. Works only for script output formats… |
| indent | boolean | no | 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… |

## Example
```
curl "https://www.apizie.tech/v1/places:gisgraphy/addressparsing" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Gisgraphy webservices API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/places:gisgraphy/addressparsing with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Gisgraphy webservices API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Gisgraphy webservices itself also needs your own key from gisgraphy.com.

### Can AI agents use the Gisgraphy webservices API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key places:gisgraphy.

### What is the status of the Gisgraphy webservices API?
Needs your own provider key (bring your own key)