# Geocoding API — Vietmap API Playground

> Convert address to coordinates with Vietmap Geocode API.

The Geocoding API turns a written address into coordinates. Version 4 understands both post-merger and former administrative addresses, takes province, district, ward, radius and category filters, and returns a normalised address with each result. It is the first step for putting a customer list on a map or feeding it to the routing and optimisation APIs.

What it is for:
- Plotting orders or customers on a map.
- Getting coordinates for Route, Matrix, TSP and VRP.
- Validating an address before an order is created.
- Grouping customers by province or ward.

- Interactive page: https://tools.vietmap.vn/playground/en/geocode
- Endpoint: `GET /api/search/v4` on `https://maps.vietmap.vn`
- Official documentation: https://maps.vietmap.vn/docs/map-api/geocode-version/geocode-v4/
- API key: every request needs the `apikey` parameter. Samples use `YOUR_API_KEY` as the placeholder — when integrating, read the key from an environment variable (e.g. `VIETMAP_API_KEY`). Get a key at https://maps.vietmap.vn/console-v2/consumers
- Error codes: `401` wrong API key · `403` key restricted to another domain/IP · `423` API not enabled for the key's consumer, or out of credit (body contains "exceeded credit") · `429` rate limit exceeded.

## Code samples

### cURL

```bash
curl 'https://maps.vietmap.vn/api/search/v4?apikey=YOUR_API_KEY&text=197+Tr%E1%BA%A7n+Ph%C3%BA&admin_new=true&display_type=6'
```

### JavaScript

```javascript
// In production, read the key from an environment variable instead.
const API_KEY = "YOUR_API_KEY";

const params = new URLSearchParams([
  ["apikey", API_KEY],
  ["text", "197 Trần Phú"],
  ["admin_new", "true"],
  ["display_type", "6"],
]);

const response = await fetch(`https://maps.vietmap.vn/api/search/v4?${params}`);
if (!response.ok) {
  throw new Error(`Vietmap ${response.status}: ${await response.text()}`);
}
const data = await response.json();
console.log(data);
```

### Python

```python
import requests

# In production, read the key from an environment variable instead.
API_KEY = "YOUR_API_KEY"

params = [
    ("apikey", API_KEY),
    ("text", "197 Trần Phú"),
    ("admin_new", "true"),
    ("display_type", "6"),
]

response = requests.get("https://maps.vietmap.vn/api/search/v4", params=params, timeout=30)
response.raise_for_status()
print(response.json())
```

### URL

```text
https://maps.vietmap.vn/api/search/v4?apikey=YOUR_API_KEY&text=197+Tr%E1%BA%A7n+Ph%C3%BA&admin_new=true&display_type=6
```

## AI prompt

A ready-made prompt for a coding assistant (ChatGPT, Claude, Copilot…) to write the integration:

````text
I need to integrate Vietmap's Geocoding (Search) API v4 into my application.

Official documentation: https://maps.vietmap.vn/docs/map-api/geocode-version/geocode-v4/

Here is a sample request that works in the Vietmap API Playground:

GET https://maps.vietmap.vn/api/search/v4?apikey=YOUR_API_KEY&text=197+Tr%E1%BA%A7n+Ph%C3%BA&admin_new=true&display_type=6

Parameters in use:
- text = 197 Trần Phú
- admin_new = true
- display_type = 6

Write code in [my language / framework] that calls this API, with these requirements:
1. Read the API key from the VIETMAP_API_KEY environment variable; never hard-code it.
2. Send the parameters in the query string exactly as in the sample; repeated parameters (such as `point`) must keep their order.
3. Handle Vietmap's HTTP errors:
   - 401: the API key is wrong or revoked.
   - 403: the key is restricted to a domain / IP that does not match.
   - 423: the API is not enabled for the key's consumer, OR the account is out of credit — tell them apart by the response body ("exceeded credit" means out of credit).
   - 429: rate limit exceeded — retry with increasing backoff.
4. Set a request timeout, and define types (type / interface / dataclass) for the response.

If unsure about a field name, look it up in the documentation linked above instead of guessing.
````

## Reopen this exact request in the Playground

https://tools.vietmap.vn/playground/en/geocode?text=197+Tr%E1%BA%A7n+Ph%C3%BA&display_type=6