Goong REST API V2

https://help.goong.io/kb/rest-api-v2
Admin
Goong REST API V2 provides location-based services including autocomplete, geocoding, directions,...
Tokens:25,353
Snippets:97
Trust Score:7.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Request Children ID via GET

Source: https://help.goong.io/kb/rest-api-v2/autocomplete-rest-api-v2/child-id-v2

Example of a GET request to the children endpoint. Ensure the parent_id and api_key are correctly provided.

```http
https://rsapi.goong.io/v2/place/children?parent_id=mkSTeXlgiYFUzS5Mu1-nwXuWbga8aInzZs8jS7hgq-FopXItor-FwbqqMFx3brv-aqoyT6Nja5MyBqEQIoF54wUWQRwS6bajPeaVfS4ls9uAfqUwfv26ZiR67RDSJbPLJ&api_key={YOUR_API_KEY}&has_deprecated_administrative_unit=false
```

--------------------------------

### Directions API Parameter Examples

Source: https://help.goong.io/kb/rest-api-v2/directions-rest-api-v2/directions-v2

Examples of values for various API parameters used in the response.

```json
[]
```

```json
{ “bounds”: {}, “legs”: [ { “distance”: { “text”: “2.83 km”, “value”: 2828 },
```

```json
{ “northeast”: { “lat”: 21.1, “lng”: 105.9 }, “southwest”: { “lat”: 20.9, “lng”: 105.7 } }
```

```json
[ { … } ]
```

```json
“1155.66 km”
```

```json
1155660
```

```json
“22 giờ 10 phút”
```

```json
79799
```

```json
[]
```

```json
“mtm_C{cudSG@eAfDc@xAq@
```

--------------------------------

### Autocomplete API Request

Source: https://help.goong.io/kb/rest-api-v2/autocomplete-rest-api-v2/autocomplete-v2

Example of a GET request to the Autocomplete API with location bias and administrative unit parameters.

```http
https://rsapi.goong.io/v2/place/autocomplete?input=298 ngoc lam long bien &location=21.0278,105.8342&api_key={YOUR_API_KEY}&has_deprecated_administrative_unit=true
```

--------------------------------

### Request URL for Place Detail API V2

Source: https://help.goong.io/kb/rest-api-v2/place-detail-rest-api-v2/place-detail-place-detail-v2

Example of a GET request URL to retrieve place details, including the required place_id, api_key, and the optional has_deprecated_administrative_unit parameter.

```http
https://rsapi.goong.io/v2/place/detail?place_id=ceemb00pVO95sWtNulG-8kaxRbG6WjCYdY94iKIH79BASozdSlnGY8EaIRS-VTZzjQbCmEmdwnJN0iJEJp1qivHrWTT2XY4iOdLBGUl1gkPl1ipAGVQaAkHeiXS2QB-vQ&api_key={YOUR_API_KEY}&has_deprecated_administrative_unit=true
```

--------------------------------

### Place ID Example

Source: https://help.goong.io/kb/rest-api-v2/geocode-rest-api-v2/geocode-v2

A sample string representing a unique place_id.

```text
drtqhLmKubt1uUEJoVZFi3Wrd5ijaE10ar...
```

--------------------------------

### Request Directions API V2

Source: https://help.goong.io/kb/rest-api-v2/directions-rest-api-v2/directions-v2

Example of a GET request to the Directions API V2 endpoint with required origin, destination, vehicle, and API key parameters.

```http
https://rsapi.goong.io/v2/direction?origin=21.046623224000029,105.790168203000060&destination=21.046666732000062,105.790169569000060&vehicle=car&api_key={YOUR_API_KEY}
```

--------------------------------

### Response Parameter Examples

Source: https://help.goong.io/kb/rest-api-v2/distance-matrix-rest-api-v2/distance-matrix-v2

Snippets illustrating specific fields within the API response object.

```json
 {
  “elements”: [
 {
  “distance”: {},
  “duration”: {},
  “status”: “OK”
 }
 ]
}
```

```json
"elements": [ 
{ "status": "OK",
 "duration": 
{ "text": "36 phút",
 "value": 2150 
},
```

```json
"duration": { 
"text": "35 phút", 
"value": 2089
```

```json
"distance": { 
"text": "15.1 km", 
"value": 15110
```

--------------------------------

### Address Components Example

Source: https://help.goong.io/kb/rest-api-v2/geocode-rest-api-v2/geocode-v2

A snippet showing the structure of the address_components array within the results.

```json
{
"address_components": [
{
"long_name": "Duy Xuyên",
"short_name": "Duy Xuyên"
},
{
"long_name": "Đà Nẵng",
"short_name": "Đà Nẵng"
}
```

--------------------------------

### Geocode Street API Request

Source: https://help.goong.io/kb/rest-api-v2/geocode-rest-api-v2/geocode-street

Example of a GET request to the Geocode Street endpoint with required and optional parameters.

```http
**https://rsapi.goong.io/v2/geocode/street?api_key={YOUR_API_KEY}&latlng=21.030145,105.811122&has_deprecated_administrative_unit=true**
```

--------------------------------

### Request Distance Matrix via cURL

Source: https://help.goong.io/kb/rest-api-v2/distance-matrix-rest-api-v2/distance-matrix-v2

Example of a GET request to the Distance Matrix API v2 using cURL, requiring origins, destinations, vehicle type, and a valid API key.

```bash
curl "https://rsapi.goong.io/v2/distancematrix?origins=20.981971,105.864323&destinations=21.031011,105.783206%7C21.022328,105.790480%7C21.016665,105.788774&vehicle=car&api_key={YOUR_API_KEY}"
```

--------------------------------

### Geocode Parameter Examples

Source: https://help.goong.io/kb/rest-api-v2/geocode-rest-api-v2/geocode-v2

Various JSON snippets representing specific response parameters.

```json
{
"compound_code": "+63G73 Trung Hòa, Cầu Giấy, Hà Nội",
"global_code": "LOC1+63G73"
},
```

```json
"poiuyTREWqazx09876MNB==.bm9ybWFs"
```

```json
 {
"long_name": "Thời trang Bim",
"short_name": "Thời trang Bim"
},
{
"long_name": "91 Ngõ 43 Trung Kính",
"short_name": "91 Ngõ 43 Trung Kính"
},
{
"long_name": "Yên Hòa",
"short_name": "Yên Hòa"
},
{
"long_name": "Hà Nội",
"short_name": "Hà Nội"
}
```

```json
"CRdosr1ubzGqZwEhsJV2xKkCmeNrXbNmYY_3IMQoaBxeuLQhZq
YnZDX92dmu1_EUr.."
```

```json
"location": {
"lat": 21.01178451000004,
"lng": 105.79653747400005
},
```

--------------------------------

### GET https://rsapi.goong.io/v2/direction

Source: https://help.goong.io/kb/rest-api-v2/directions-rest-api-v2/directions-v2

Calculates a route between an origin and a destination point.

```APIDOC
## GET https://rsapi.goong.io/v2/direction

### Description
Calculates a route between two or more points, providing distance, duration, and step-by-step navigation instructions.

### Method
GET

### Endpoint
https://rsapi.goong.io/v2/direction

### Parameters
#### Query Parameters
- **origin** (string) - Required - Coordinates of the starting point (latitude,longitude).
- **destination** (string) - Required - Coordinates of the destination point (latitude,longitude).
- **vehicle** (string) - Required - Type of vehicle (e.g., car, bike).
- **alternatives** (boolean) - Optional - If true, returns multiple route options. Defaults to false.
- **api_key** (string) - Required - Authentication API key.

### Request Example
https://rsapi.goong.io/v2/direction?origin=21.046623224000029,105.790168203000060&destination=21.046666732000062,105.790169569000060&vehicle=car&api_key={YOUR_API_KEY}

### Response
#### Success Response (200)
- **geocoded_waypoints** (array) - List of geocoded waypoint statuses.
- **routes** (array) - List of calculated routes containing legs, distance, duration, and step-by-step instructions.

#### Response Example
{
  "geocoded_waypoints": [
    { "geocoder_status": "OK", "place_id": "..." }
  ],
  "routes": [
    {
      "legs": [
        {
          "distance": { "text": "2.83 km", "value": 2828 },
          "duration": { "text": "8 phút", "value": 502 },
          "end_address": "Starlake Project Secondary School, Xuân Tảo, Bắc Từ Liêm, Hà Nội",
          "steps": []
        }
      ]
    }
  ]
}
```

--------------------------------

### Geocode Response Structure Example

Source: https://help.goong.io/kb/rest-api-v2/geocode-rest-api-v2/geocode-v2

A sample JSON response structure for a Forward Geocode request.

```json
{
        }
      ],
      "formatted_address": "Cửa hàng 91, 91 Ngõ 43 Trung Kính, Yên Hòa, Hà Nội",
      "geometry": {
        "location": {
          "lat": 21.011780584000064,
          "lng": 105.79652819400008
        },
        "boundary": null
      },
      "place_id": "kb8rgRCehm5Ih0ioXX6G5HuHcZ-fbLKdYydDU6tTe8HtEYYwr2F4Inn6BRxyvboLieYZuHphhlddJkGUxqG6S9k-uSyF_lr-oer5IXH_Vnvd7hFsIqAiOnnmsUyOeCeXe",
      "reference": "kb8rgRCehm5Ih0ioXX6G5HuHcZ-fbLKdYydDU6tTe8HtEYYwr2F4Inn6BRxyvboLieYZuHphhlddJkGUxqG6S9k-uSyF_lr-oer5IXH_Vnvd7hFsIqAiOnnmsUyOeCeXe",
      "plus_code": {
        "compound_code": "+40BD Trung Hòa, Cầu Giấy, Hà Nội",
        "global_code": "LOC1+40BD"
      },
      "compound": {
        "commune": "Yên Hòa",
        "province": "Hà Nội"
      },
      "types": [
        "grocery_store"
      ],
      "name": "Cửa hàng 91",
      "address": "91 Ngõ 43 Trung Kính, Yên Hòa, Hà Nội",
      "deprecated_description": "Cửa hàng 91, 91 Ngõ 43 Trung Kính, Trung Hòa, Cầu Giấy, Hà Nội",
      "deprecated_compound": {
        "district": "Cầu Giấy",
        "commune": "Trung Hòa",
        "province": "Hà Nội"
      }
    }
  ],
  "status": "OK"
}
```

--------------------------------

### GET https://rsapi.goong.io/v2/place/autocomplete

Source: https://help.goong.io/kb/rest-api-v2/autocomplete-rest-api-v2/autocomplete-v2

Retrieves a list of location predictions based on a search query.

```APIDOC
## GET https://rsapi.goong.io/v2/place/autocomplete

### Description
Provides real-time location suggestions based on a search keyword. It supports filtering by location, radius, and administrative unit settings.

### Method
GET

### Endpoint
https://rsapi.goong.io/v2/place/autocomplete

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Your Goong API Key.
- **input** (string) - Required - The search keyword.
- **location** (string) - Optional - Preferred search coordinates (e.g., 21.0278,105.8342).
- **limit** (integer) - Optional - Number of results to return (default 5).
- **radius** (integer) - Optional - Search radius in km (default 50).
- **more_compound** (boolean) - Optional - If true, returns district, commune, and province information.
- **has_deprecated_administrative_unit** (boolean) - Optional - If true, includes information about old administrative boundaries.
- **origin** (string) - Optional - Coordinates to calculate distance from for sorting.

### Request Example
https://rsapi.goong.io/v2/place/autocomplete?input=298 ngoc lam long bien&location=21.0278,105.8342&api_key={YOUR_API_KEY}&has_deprecated_administrative_unit=true

### Response
#### Success Response (200)
- **predictions** (array) - List of location suggestions.

#### Response Example
{
  "predictions": [
    {
      "description": "298 Ngọc Lâm, Bồ Đề, Hà Nội",
      "place_id": "lqtHcLCBkwdsiW1Vllir7TVywQSWmXb-wSLNMUnRxvY2i1WY0d1qP1HOnai6IYLfTcKA_F7tiitdAskgjl0yd92-LVA24B6vvdbFHmZFhKFN0i1T4p5EHkXajXCyRBurR",
      "structured_formatting": {
        "main_text": "298 Ngọc Lâm",
        "secondary_text": "Bồ Đề, Hà Nội"
      }
    }
  ]
}
```

--------------------------------

### GET https://rsapi.goong.io/v2/place/detail

Source: https://help.goong.io/kb/rest-api-v2/place-detail-rest-api-v2/place-detail-place-detail-v2

Retrieves detailed information for a specific place using its unique identifier.

```APIDOC
## GET https://rsapi.goong.io/v2/place/detail

### Description
Retrieves detailed information about a location, including its name, address, coordinates, and administrative details, updated to current administrative boundaries.

### Method
GET

### Endpoint
https://rsapi.goong.io/v2/place/detail

### Parameters
#### Query Parameters
- **place_id** (string) - Required - The unique ID of the location.
- **api_key** (string) - Required - Your personal API access key.
- **has_deprecated_administrative_unit** (boolean) - Optional - If true, includes legacy administrative information (deprecated_description and deprecated_compound) in the response.

### Response
#### Success Response (200)
- **result** (object) - The location details.
- **status** (string) - The API response status (e.g., "OK").

#### Response Example
{
    "result": {
        "place_id": "ceemb00pVO95sWtNulG-8kaxRbG6WjCYdY94iKIH79BASozdSlnGY8EaIRS-VTZzjQbCmEmdwnJN0iJEJp1qivHrWTT2XY4iOdLBGUl1gkPl1ipAGVQaAkHeiXS2QB-vQ",
        "formatted_address": "2/31 Ngô Gia Khảm, Bồ Đề, Hà Nội",
        "geometry": {
            "location": {
                "lat": 21.048178407000023,
                "lng": 105.87687658000004
            }
        },
        "name": "2/31 Ngô Gia Khảm",
        "status": "OK"
    }
}
```

--------------------------------

### Directions API Response Structure

Source: https://help.goong.io/kb/rest-api-v2/directions-rest-api-v2/directions-v2

Example of the JSON response structure for route segments and polyline data.

```json
“html_instructions”: “Hướng sang phải”,
“maneuver”: “slight right”,
“polyline”: {
“points”: “oun_CwdudSGb@KPQHs@?qB@aG@wLAw@?”
},
“start_location”: {
“lat”: 21.05192,
“lng”: 105.79036
},
“travel_mode”: “DRIVING”
},
{
“distance”: {
“text”: “15 m”,
“value”: 15
},
“duration”: {
“text”: “1 phút”,
“value”: 67
},
“end_location”: {
“lat”: 21.05671,
“lng”: 105.79017
},
“html_instructions”: “Rẽ phải”,
“maneuver”: “right”,
“polyline”: {
“points”: “mso_CubudS?[“
},
“start_location”: {
“lat”: 21.05671,
“lng”: 105.79003
},
“travel_mode”: “DRIVING”
},
“end_location”: {
“lat”: 21.05671,
“lng”: 105.79017
},
“html_instructions”: “Bạn đã đến điểm đích”,
“maneuver”: “”,
“polyline”: {
“points”: “mso_CqcudS”
},
“start_location”: {
“lat”: 21.05671,
“lng”: 105.79017
},
“travel_mode”: “DRIVING”
}
]
}
],
“overview_polyline”: {
“points”: “mtm_C{cudSh@C^Ch@C?o@A[?oC?s@?mE?wBAuB@qCAwK?gB?iA?s@k@@aA@W?k@?cE@_C?}@?iE@kAAkF?cA?Q?C??f@?dAE~L@hK@lOGb@KPQHs@?qB@aG@wLAw@??[“
},
“summary”: “”,
“warnings”: [],
“waypoint_order”: []
}
]
```

--------------------------------

### GET https://rsapi.goong.io/v2/trip

Source: https://help.goong.io/kb/rest-api-v2/trip-rest-api-v2/trip-v2

Retrieves an optimized route between an origin, destination, and optional waypoints.

```APIDOC
## GET https://rsapi.goong.io/v2/trip

### Description
Calculates an optimized route between specified coordinates, supporting multiple waypoints and various vehicle types.

### Method
GET

### Endpoint
https://rsapi.goong.io/v2/trip

### Parameters
#### Query Parameters
- **origin** (string) - Optional - Starting coordinates (latitude,longitude).
- **destination** (string) - Optional - Ending coordinates (latitude,longitude).
- **waypoints** (string) - Optional - List of intermediate points separated by semicolons (;).
- **vehicle** (string) - Optional - Vehicle type (car, bike, taxi, truck, hd). Defaults to car.
- **roundtrip** (boolean) - Optional - Whether the route returns to the origin. Defaults to true.
- **api_key** (string) - Required - Your Goong API key.

### Request Example
curl "https://rsapi.goong.io/v2/trip?origin=21.03931,105.83997&waypoints=21.03303,105.79131;21.01765,105.80350&destination=21.01343,105.79855&api_key={YOUR_API_KEY}"

### Response
#### Success Response (200)
- **code** (string) - Status code of the request.
- **trips** (array) - List of trip results containing distance and duration.
```

--------------------------------

### Reverse Geocode Request URL

Source: https://help.goong.io/kb/rest-api-v2/geocode-rest-api-v2/geocode-v2

Example URL for performing a Reverse Geocode request.

```http
https://rsapi.goong.io/v2/geocode?latlng=15.765075, 108.204474&limit=5&api_key={YOUR_API_KEY}&has_deprecated_administrative_unit=true
```

--------------------------------

### Autocomplete API JSON Response Example

Source: https://help.goong.io/kb/rest-api-v2/autocomplete-rest-api-v2/autocomplete-v2

A sample JSON response object returned by the Autocomplete API, showing the structure of location predictions.

```json
                ]
            },
            "has_children": false,
            "plus_code": {
                "compound_code": "+GNYO Ngọc Lâm, Long Biên, Hà Nội",
                "global_code": "LOEJ+GNYO"
            },
            "compound": {
                "commune": "Bồ Đề",
                "province": "Hà Nội"
            },
            "terms": [
                {
                    "offset": 0,
                    "value": "Sảnh đón/trả khách"
                },
                {
                    "offset": 26,
                    "value": "Chung cư IDB Complex"
                },
                {
                    "offset": 49,
                    "value": "Ngõ 298 Ngọc Lâm"
                },
                {
                    "offset": 71,
                    "value": "Bồ Đề"
                },
                {
                    "offset": 83,
                    "value": "Hà Nội"
                }
            ],
            "types": [
                "building"
            ],
            "distance_meters": null,
            "deprecated_description": "Sảnh đón/trả khách, Chung cư IDB Complex, Ngõ 298 Ngọc Lâm, Phường Ngọc Lâm, Quận Long Biên, Thành phố Hà Nội",
            "deprecated_compound": {
                "district": "Long Biên",
                "commune": "Ngọc Lâm",
                "province": "Hà Nội"
            }
        }
    ],
    "execution_time": "",
    "status": "OK"
}
```

--------------------------------

### GET https://rsapi.goong.io/v2/distancematrix

Source: https://help.goong.io/kb/rest-api-v2/distance-matrix-rest-api-v2/distance-matrix-v2

Calculates the distance and duration between specified origin and destination coordinates.

```APIDOC
## GET https://rsapi.goong.io/v2/distancematrix

### Description
Calculates travel distance and duration between one or more origin points and one or more destination points.

### Method
GET

### Endpoint
https://rsapi.goong.io/v2/distancematrix

### Parameters
#### Query Parameters
- **origins** (string) - Required - Coordinates of the starting point(s) in latitude,longitude format.
- **destinations** (string) - Required - Coordinates of the destination point(s), separated by the pipe character (|).
- **vehicle** (string) - Required - Type of vehicle: car, bike, motorcycle, or truck.
- **api_key** (string) - Required - User authentication API key.

### Request Example
curl "https://rsapi.goong.io/v2/distancematrix?origins=20.981971,105.864323&destinations=21.031011,105.783206%7C21.022328,105.790480%7C21.016665,105.788774&vehicle=car&api_key={YOUR_API_KEY}"

### Response
#### Success Response (200)
- **rows** (array) - An array of objects, each representing an origin point.
- **elements** (array) - An array within each row containing distance, duration, and status for each origin-destination pair.
- **status** (string) - Status of the calculation (e.g., "OK", "NOT_FOUND", "ZERO_RESULTS").
- **duration** (object) - Travel time containing 'text' (human-readable) and 'value' (seconds).
- **distance** (object) - Travel distance containing 'text' (human-readable) and 'value' (meters).

#### Response Example
{
    "rows": [
        {
            "elements": [
                {
                    "distance": {
                        "text": "11.99 km",
                        "value": 11988
                    },
                    "duration": {
                        "text": "34 phút",
                        "value": 2016
                    },
                    "status": "OK"
                }
            ]
        }
    ]
}
```

--------------------------------

### Autocomplete API Response Structure

Source: https://help.goong.io/kb/rest-api-v2/autocomplete-rest-api-v2/autocomplete-v2

Example of the JSON response body returned by the Autocomplete API, containing place details and formatting information.

```json
"value": "Ngõ 298 Ngọc Lâm"
            },
            {
                "offset": 44,
                "value": "Bồ Đề"
            },
            {
                "offset": 56,
                "value": "Hà Nội"
            }
        ],
        "types": [
            "building"
        ],
        "distance_meters": null,
        "deprecated_description": "Chung cư IDB Complex, Ngõ 298 Ngọc Lâm, Phường Ngọc Lâm, Quận Long Biên, Thành phố Hà Nội",
        "deprecated_compound": {
            "district": "Long Biên",
            "commune": "Ngọc Lâm",
            "province": "Hà Nội"
        }
    },
    {
        "description": "Cổng đón/trả khách, Trường THCS Ái Mộ, Ngõ 298 Ngọc Lâm, Bồ Đề, Hà Nội",
        "matched_substrings": [
            {
                "length": 3,
                "offset": 43
            },
            {
                "length": 4,
                "offset": 47
            },
            {
                "length": 3,
                "offset": 52
            }
        ],
        "place_id": "gUDax5FIeHd5hFQinFBjJHuHfJ-vbo0pT4dQJ7cLs-N6ULwctm2r-3hQZiTubqzuvL1qH5x9TJ6VhbEEqlevkdtAgzCaboXqeb1LX51tnfR4h1gHLqwuNnXqvUCCdCubd",
        "reference": "gUDax5FIeHd5hFQinFBjJHuHfJ-vbo0pT4dQJ7cLs-N6ULwctm2r-3hQZiTubqzuvL1qH5x9TJ6VhbEEqlevkdtAgzCaboXqeb1LX51tnfR4h1gHLqwuNnXqvUCCdCubd",
        "structured_formatting": {
            "main_text": "Cổng đón/trả khách",
            "main_text_matched_substrings": [],
            "secondary_text": "Trường THCS Ái Mộ, Ngõ 298 Ngọc Lâm, Bồ Đề, Hà Nội",
            "secondary_text_matched_substrings": [
                {
                    "length": 3,
                    "offset": 23
                },
                {
                    "length": 4,
                    "offset": 27
                },
                {
                    "length": 3,
                    "offset": 32
                }
            ]
        },
        "has_children": false,
        "plus_code": {
            "compound_code": "+GPCG Ngọc Lâm, Long Biên, Hà Nội",
            "global_code": "LOEJ+GPCG"
        },
        "compound": {
            "commune": "Bồ Đề",
            "province": "Hà Nội"
        },
        "terms": [
            {
                "offset": 0,
                "value": "Cổng đón/trả khách"
            },
            {
                "offset": 26,
                "value": "Trường THCS Ái Mộ"
            },
            {
                "offset": 51,
                "value": "Ngõ 298 Ngọc Lâm"
            },
            {
                "offset": 73,
                "value": "Bồ Đề"
            },
            {
                "offset": 85,
                "value": "Hà Nội"
            }
        ],
        "types": [
            "site"
        ],
        "distance_meters": null,
        "deprecated_description": "Cổng đón/trả khách, Trường THCS Ái Mộ, Ngõ 298 Ngọc Lâm, Phường Ngọc Lâm, Quận Long Biên, Thành phố Hà Nội",
        "deprecated_compound": {
            "district": "Long Biên",
            "commune": "Ngọc Lâm",
            "province": "Hà Nội"
        }
    },
    {
        "description": "Sảnh đón/trả khách, Chung cư IDB Complex, Ngõ 298 Ngọc Lâm, Bồ Đề, Hà Nội",
        "matched_substrings": [
            {
                "length": 3,
                "offset": 46
            },
            {
                "length": 4,
                "offset": 50
            },
            {
                "length": 3,
                "offset": 55
            }
        ],
        "place_id": "Oyx0RyVbUFSniEMxkHCR-XijT1e7cKPUeNVcpwdznfBv1lSwumGm8HayWL-6Y47Xc7JYFaxauNlsi34ekQewk0GOKGq4Y-qVdbGZU1xhkRTB0i5G9-AeBkXYHXKORBurR",
        "reference": "Oyx0RyVbUFSniEMxkHCR-XijT1e7cKPUeNVcpwdznfBv1lSwumGm8HayWL-6Y47Xc7JYFaxauNlsi34ekQewk0GOKGq4Y-qVdbGZU1xhkRTB0i5G9-AeBkXYHXKORBurR",
        "structured_formatting": {
            "main_text": "Sảnh đón/trả khách",
            "main_text_matched_substrings": [],
            "secondary_text": "Chung cư IDB Complex, Ngõ 298 Ngọc Lâm, Bồ Đề, Hà Nội",
            "secondary_text_matched_substrings": [
                {
                    "length": 3,
                    "offset": 26
                },
                {
                    "length": 4,
                    "offset": 30
                },
                {
                    "length": 3,
                    "offset": 35
                }
            ]
```

--------------------------------

### Forward Geocode Request URL

Source: https://help.goong.io/kb/rest-api-v2/geocode-rest-api-v2/geocode-v2

Example URL structure for performing a forward geocode request to convert an address into coordinates.

```http
https://rsapi.goong.io/v2/geocode?address=91%20Trung%20K%C3%ADnh%2C%20Trung%20H%C3%B2a%2C%20C%E1%BA%A7u%20Gi%E1%BA%A5y%2C%20H%C3%A0%20N%E1%BB%99i&api_key={YOUR_API_KEY}
```

--------------------------------

### Trip API Response Structure

Source: https://help.goong.io/kb/rest-api-v2/trip-rest-api-v2/trip-v2

Example of the JSON response returned by the Trip API, containing status code and trip details.

```json
{
    "code": "Ok",
    "trips": [
        {
            "distance": 33343.4,
            "duration": 10065.2,
```

--------------------------------

### Create a Trip Request with cURL

Source: https://help.goong.io/kb/rest-api-v2/trip-rest-api-v2/trip-v2

Use this cURL command to perform a GET request to the Trip API. Ensure you replace {YOUR_API_KEY} with your valid Goong API key.

```bash
curl "https://rsapi.goong.io/v2/trip?origin=21.03931,105.83997&waypoints=21.03303694945164,105.79131815992706;21.017654632470325,105.80350611785252;21.00755912449365,105.81105921853873;20.99834437409386,105.79148982130629;21.00507520431542,105.78814242441126;21.0191769116844,105.78822825510088;21.026948305457093,105.79466555682208;21.012767209964053,105.80256198026676;21.020619056604428,105.78925822337628;21.01028337649572,105.7894298847555&destination=21.01343,105.79855&api_key={YOUR_API_KEY}"
```

--------------------------------

### GET https://rsapi.goong.io/v2/place/children

Source: https://help.goong.io/kb/rest-api-v2/autocomplete-rest-api-v2/child-id-v2

Retrieves a list of child locations associated with a specific parent place ID.

```APIDOC
## GET https://rsapi.goong.io/v2/place/children

### Description
Retrieves sub-locations (children) associated with a parent place ID. This is useful for granular navigation or location management within large sites like airports or malls.

### Method
GET

### Endpoint
https://rsapi.goong.io/v2/place/children

### Parameters
#### Query Parameters
- **parent_id** (string) - Required - The unique identifier of the parent location.
- **api_key** (string) - Required - Your Goong API key for authentication.
- **has_deprecated_administrative_unit** (boolean) - Optional - If true, includes information about administrative units before the recent mergers (deprecated_description and deprecated_compound). Defaults to false.

### Request Example
https://rsapi.goong.io/v2/place/children?parent_id=mkSTeXlgiYFUzS5Mu1-nwXuWbga8aInzZs8jS7hgq-FopXItor-FwbqqMFx3brv-aqoyT6Nja5MyBqEQIoF54wUWQRwS6bajPeaVfS4ls9uAfqUwfv26ZiR67RDSJbPLJ&api_key={YOUR_API_KEY}&has_deprecated_administrative_unit=false

### Response
#### Success Response (200)
- **predictions** (array) - A list of child location objects.
- **execution_time** (string) - Time taken to process the request.
- **status** (string) - The status of the request (e.g., "OK").

#### Response Example
{
    "predictions": [
        {
            "description": "Cổng đón/trả khách, Trường THPT Nguyễn Bỉnh Khiêm, 78 Hoàng Hoa Thám, Tam Long, Hồ Chí Minh",
            "place_id": "oXe3tlO8AXFyj1sxpFqs6HPSalW6d53fcr9xFHNbls6l0V8vQXmk33e1nlSnZI55aNKTJ79bitZ0tlugFmbtz38vZdG8AJbfcqVAVJZmQlv9zjFMAoACGlnGkWyuWAe3W",
            "has_children": false,
            "compound": {
                "commune": "Tam Long",
                "province": "Hồ Chí Minh"
            }
        }
    ],
    "execution_time": "143.612µs",
    "status": "OK"
}
```

--------------------------------

### Autocomplete API Response Structure

Source: https://help.goong.io/kb/rest-api-v2/autocomplete-rest-api-v2/autocomplete-v2

Example of the JSON response object returned by the Autocomplete API, containing location details, matched substrings, and formatting information.

```json
"value": "Bồ Đề"
            },
            {
                "offset": 28,
                "value": "Hà Nội"
            }
        ],
        "types": [
            "house_number"
        ],
        "distance_meters": null,
        "deprecated_description": "298 Ngọc Lâm, Phường Ngọc Lâm, Quận Long Biên, Thành phố Hà Nội",
        "deprecated_compound": {
            "district": "Long Biên",
            "commune": "Ngọc Lâm",
            "province": "Hà Nội"
        }
    },
    {
        "description": "Ngõ 298 Ngọc Lâm, Bồ Đề, Hà Nội",
        "matched_substrings": [
            {
                "length": 3,
                "offset": 4
            },
            {
                "length": 4,
                "offset": 8
            },
            {
                "length": 3,
                "offset": 13
            }
        ],
        "place_id": "T6yvDK69hfZcbNdOvJVIR2tG0kq9bfZibL_GMbB__1takohPs1CGVG27yzeSGpJEb4jFC1bBGoWJwpI80jRusdl2SiWikf5dbAq3kaY19jUhol40buxudQGq_zTCNGvZA",
        "reference": "T6yvDK69hfZcbNdOvJVIR2tG0kq9bfZibL_GMbB__1takohPs1CGVG27yzeSGpJEb4jFC1bBGoWJwpI80jRusdl2SiWikf5dbAq3kaY19jUhol40buxudQGq_zTCNGvZA",
        "structured_formatting": {
            "main_text": "Ngõ 298 Ngọc Lâm",
            "main_text_matched_substrings": [
                {
                    "length": 3,
                    "offset": 4
                },
                {
                    "length": 4,
                    "offset": 8
                },
                {
                    "length": 3,
                    "offset": 13
                }
            ],
            "secondary_text": "Bồ Đề, Hà Nội",
            "secondary_text_matched_substrings": []
        },
        "has_children": false,
        "plus_code": {
            "compound_code": "+5Z628 Ngọc Lâm, Long Biên, Hà Nội",
            "global_code": "LOEJ+5Z628"
        },
        "compound": {
            "commune": "Bồ Đề",
            "province": "Hà Nội"
        },
        "terms": [
            {
                "offset": 0,
                "value": "Ngõ 298 Ngọc Lâm"
            },
            {
                "offset": 21,
                "value": "Bồ Đề"
            },
            {
                "offset": 33,
                "value": "Hà Nội"
            }
        ],
        "types": [
            "alley"
        ],
        "distance_meters": null,
        "deprecated_description": "Ngõ 298 Ngọc Lâm, Phường Ngọc Lâm, Quận Long Biên, Thành phố Hà Nội",
        "deprecated_compound": {
            "district": "Long Biên",
            "commune": "Ngọc Lâm",
            "province": "Hà Nội"
        }
    },
    {
        "description": "Chung cư IDB Complex, Ngõ 298 Ngọc Lâm, Bồ Đề, Hà Nội",
        "matched_substrings": [
            {
                "length": 3,
                "offset": 26
            },
            {
                "length": 4,
                "offset": 30
            },
            {
                "length": 3,
                "offset": 35
            }
        ],
        "place_id": "S2G9JKvaC6utYFgirVfv1qxMcj2sVI30vUtEGat-s8e9ULEdmAqC1nx8VBOsSp3hbndIXpxQldmxekQDq2_u7755cgSufKfAvXhLvJVtX52HelidH9AuNna94UCCdCubd",
        "reference": "S2G9JKvaC6utYFgirVfv1qxMcj2sVI30vUtEGat-s8e9ULEdmAqC1nx8VBOsSp3hbndIXpxQldmxekQDq2_u7755cgSufKfAvXhLvJVtX52HelidH9AuNna94UCCdCubd",
        "structured_formatting": {
            "main_text": "Chung cư IDB Complex",
            "main_text_matched_substrings": [],
            "secondary_text": "Ngõ 298 Ngọc Lâm, Bồ Đề, Hà Nội",
            "secondary_text_matched_substrings": [
                {
                    "length": 3,
                    "offset": 4
                },
                {
                    "length": 4,
                    "offset": 8
                },
                {
                    "length": 3,
                    "offset": 13
                }
            ]
        },
        "has_children": true,
        "plus_code": {
            "compound_code": "+GNYN Ngọc Lâm, Long Biên, Hà Nội",
            "global_code": "LOEJ+GNYN"
        },
        "compound": {
            "commune": "Bồ Đề",
            "province": "Hà Nội"
        },
        "terms": [
            {
                "offset": 0,
                "value": "Chung cư IDB Complex"
            },
            {
                "offset": 22,

```

--------------------------------

### GET https://rsapi.goong.io/v2/geocode/street

Source: https://help.goong.io/kb/rest-api-v2/geocode-rest-api-v2/geocode-street

Retrieves street information and administrative data based on provided latitude and longitude coordinates.

```APIDOC
## GET https://rsapi.goong.io/v2/geocode/street

### Description
Converts a pair of latitude and longitude coordinates into a specific street name and retrieves related geographic data, including administrative units and boundary information.

### Method
GET

### Endpoint
https://rsapi.goong.io/v2/geocode/street

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Your API key for authentication.
- **latlng** (string) - Required - The coordinates to query, formatted as 'lat,long' (e.g., 21.120678,106.397301).
- **has_deprecated_administrative_unit** (boolean) - Optional - If true, includes historical administrative data (deprecated_description and deprecated_compound) for areas that have changed boundaries.

### Request Example
https://rsapi.goong.io/v2/geocode/street?api_key={YOUR_API_KEY}&latlng=21.030145,105.811122&has_deprecated_administrative_unit=true

### Response
#### Success Response (200)
- **results** (array) - List of geographic results.
- **status** (string) - The status of the request (e.g., 'OK').

#### Response Example
{
  "results": [
    {
      "address_components": [
        {"long_name": "Kim Mã", "short_name": "Kim Mã"},
        {"long_name": "Giảng Võ", "short_name": "Giảng Võ"},
        {"long_name": "Hà Nội", "short_name": "Hà Nội"}
      ],
      "formatted_address": "Kim Mã, Giảng Võ, Hà Nội",
      "geometry": {
        "location": {"lat": 21.030145, "lng": 105.811122},
        "boundary": "anj_CenydSx@tH"
      },
      "place_id": "gqXMe8N2ZLdLtl-brGZ7twebS0PDeopXeJ2tRqxmoi57i9lNP-naGtlKmUCqBTJXVZMBAQ7Vknf5SwSsD",
      "compound": {"commune": "Giảng Võ", "province": "Hà Nội"},
      "name": "Kim Mã",
      "address": "Giảng Võ, Hà Nội",
      "deprecated_description": "Kim Mã, Ngọc Khánh, Ba Đình, Hà Nội",
      "deprecated_compound": {"district": "Ba Đình", "commune": "Ngọc Khánh", "province": "Hà Nội"}
    }
  ],
  "status": "OK"
}
```
Tokens:
Raw