Places API

URL

Request Method 

https://sg-restapi.opnavi.com/v3/place/text?parameters

GET

Parameter Name

Description 

Specification

Mandatory

Default

key

Service Authorization Token

Applying for a Web Service API Key and Submitting a Work Order for Overseas Permissions on Amap Map Official Website

Mandatory

None

keywords

Search Keywords

Input Search Keywords

At least one of keywords and types must be selected.

None

types

Search POI Type

Enhance your POI (Point of Interest) search by inputting relevant keywords. You have the flexibility to use either classification codes or Chinese characters (refer to the attached document for Chinese character options). Multiple keywords should be separated by a vertical bar (|).

The classification code consists of six digits, divided into three parts: the first two digits represent the major category; the middle two digits represent the medium category; the last two digits represent the minor category.

If a major category is specified, all medium and minor categories under it will be included.

For example, 010000 represents automobile services (major category)

         010100 represents gas stations (medium category)

         010101 represents Sinopec (minor category)

          010900 represents car rental (medium category)

          010901 represents car return locations for rental (minor category)

When specifying 010000, medium categories like 010100 and minor categories like 010101 will be included. When specifying 010900, minor categories like 010901 will be included.

Note: The returned results may include medium and minor category POIs, but not all. For more precise information, it is recommended to input minor categories or narrow down the search scope. POI classification codes

At least one of keywords and types must be selected.

None

city

Search City and Administrative Division

For overseas searches, the "city" field is mandatory and can be populated using either the city code or administrative division code (adcode).

To obtain the adcode:

Obtain adcode table by country

Note:

If there is no corresponding administrative division adcode, use the country's adcode instead. For example, the USA: 840000000

If there is no corresponding adcode for the country, enter "000000000"

Obtain via reverse geocoding interface

Optional for domestic, required for overseas

None(Search within the entire territory of China)

page

Current page number

Optional

1

offset

Records Per Page

Customize the number of records per page from 0 to 50. The default setting is 20 records.

Optional

20

langCode

Return result language

Default is zh（Chinese），

optional: 

• zh（Chinese）
• en（English）
• es（Spanish）
• pt（Portuguese）
• fr（French）
• de（German）
• th（Thai）
• ja（Japanese）
• ko（Korean）
• ar（Arabic）
• tr（Turkish）
• he（Hebrew）
• it（Italian）
• ru（Russian）
• ms（Malay）
• id（Indonesian）
• vi（Vietnamese）
• pl（Polish）
• cs（Czech）
• uk（Ukrainian）
• az（Azerbaijani）

Optional

None

extensions

Result Control

By default, only basic address information is returned. For a comprehensive output including nearby POIs, roads, and road intersections, set this parameter to "all".

Optional

base

sig

Digital Signature

Methods for Obtaining and Using Digital Signatures

Optional

None

callback

Callback Function

The callback value is a function name defined by the user.

Optional

None

Name

Description

Specification

status

Result Status Value, Value is 0 or 1

0‌: Request failed; ‌1‌: Request succeeded

info

Return Status Description

When status is 0, specific error reasons will be returned in info. Otherwise, "OK" will be returned. For details, refer to theinfo status table.

infocode

Return Status Code

Refer to the info status table for details.

count

Number of Returned Results

The number of returned results

pois

Search POI Information List

pois

POI Information

id

Unique ID

Overseas POI IDs start with 'P'. 'PO' represents ordinary POIs, while 'PS'/'PV' represent public transit POIs. Example: P0JAK55X50

name

Name

type

POI Type

Categorized into 1~5 levels, for example: food; Latin American Restaurant; South American Restaurant; Brazilian Restaurant; Acai House

typecode

POI Type Code

biz_type

 Industry Type

address

Address

location

Latitude and Longitude

Longitude, Latitude

tel

Phone Number of the POI

pcode

Province Code of the POI

 Returned when extensions=all

pname

Province Name of the POI

Note: Due to differences in administrative divisions between overseas and domestic areas, it is currently not possible to strictly follow province, city, and district divisions.

citycode

City Code of the POI

 Returned when extensions=all

cityname

City Name of the POI

Note: Due to differences in administrative divisions between overseas and domestic areas, it is currently not possible to strictly follow province, city, and district divisions.

adcode

District Code

 Returned when extensions=all

adname

District Name

 Note: Due to differences in administrative divisions between overseas and domestic areas, it is currently not possible to strictly follow province, city, and district divisions.

gridcode

Geographic Grid ID

Returned when extensions=all

distance

Distance from Center Point

Unit: meters; this value is only returned during nearby search.

URL

Request Method 

https://sg-restapi.opnavi.com/v3/place/around?parameters

GET

Parameter Name 

Description

Specification

Mandatory

Default

key

Service Authorization Token

Applying for a Web Service API Key and Submitting a Work Order for Overseas Permissions on Amap Map Official Website

Mandatory

None

location

Center Point Coordinates

Rule: Longitude and latitude are separated by ",", with longitude first and latitude second. The decimal places for both should not exceed 6 digits.

Note: Enter the longitude and latitude for overseas locations.

Mandatory

None

keywords

Search Keywords

Input Search Keywords

At least one of keywords and types must be selected.

None

types

Search POI Type

Enhance your POI (Point of Interest) search by inputting relevant keywords. You have the flexibility to use either classification codes or Chinese characters (refer to the attached document for Chinese character options). Multiple keywords should be separated by a vertical bar (|).

The classification code consists of six digits, divided into three parts: the first two digits represent the major category; the middle two digits represent the medium category; the last two digits represent the minor category.

If a major category is specified, all medium and minor categories under it will be included.

For example, 010000 represents automobile services (major category)

         010100 represents gas stations (medium category)

         010101 represents Sinopec (minor category)

          010900 represents car rental (medium category)

          010901 represents car return locations for rental (minor category)

When specifying 010000, medium categories like 010100 and minor categories like 010101 will be included. When specifying 010900, minor categories like 010901 will be included.

Note: The returned results may include medium and minor category POIs, but not all. For more precise information, it is recommended to input minor categories or narrow down the search scope. POI classification codes

At least one of keywords and types must be selected.

None

radius

Search Radius

Value Range: 0-50000, unit: meters

Optional

3000

page

Current page number

Optional

1

offset

Records Per Page

Customize the number of records per page from 0 to 50. The default setting is 20 records.

Optional

20

langCode

Return result language

Default is zh（Chinese），

optional: 

• zh（Chinese）
• en（English）
• es（Spanish）
• pt（Portuguese）
• fr（French）
• de（German）
• th（Thai）
• ja（Japanese）
• ko（Korean）
• ar（Arabic）
• tr（Turkish）
• he（Hebrew）
• it（Italian）
• ru（Russian）
• ms（Malay）
• id（Indonesian）
• vi（Vietnamese）
• pl（Polish）
• cs（Czech）
• uk（Ukrainian）
• az（Azerbaijani）

Optional

None

extensions

Result Control

By default, only basic address information is returned. For a comprehensive output including nearby POIs, roads, and road intersections, set this parameter to "all".

Optional

base

sig

Digital Signature

Methods for Obtaining and Using Digital Signatures

Optional

None

callback

Callback Function

The callback value is a function name defined by the user.

Optional

None

URL

Request Method 

https://sg-restapi.opnavi.com/v3/place/polygon?parameters

GET

Parameter Name

Description

Specification

Mandatory

Default 

key

Service Authorization Token

Applying for a Web Service API Key and Submitting a Work Order for Overseas Permissions on Amap Map Official Website

Mandatory

None

polygon

Latitude and Longitude Coordinate Pairs

Rule: Longitude and latitude are separated by ",", with longitude first and latitude second. Coordinate pairs are separated by "|". The decimal places for both should not exceed 6 digits.

Note:

1、For rectangular polygons, you can input the coordinates of the top-left and bottom-right vertices. In other cases, the first and last coordinate pairs must be the same.

2、If any one of the latitude and longitude coordinate pairs is within China, domestic POI data will be returned.

Mandatory

None

keywords

Search Keywords

Input Search Keywords

At least one of keywords and types must be selected.

None

types

Search POI Type

Enhance your POI (Point of Interest) search by inputting relevant keywords. You have the flexibility to use either classification codes or Chinese characters (refer to the attached document for Chinese character options). Multiple keywords should be separated by a vertical bar (|).

The classification code consists of six digits, divided into three parts: the first two digits represent the major category; the middle two digits represent the medium category; the last two digits represent the minor category.

If a major category is specified, all medium and minor categories under it will be included.

For example, 010000 represents automobile services (major category)

         010100 represents gas stations (medium category)

         010101 represents Sinopec (minor category)

          010900 represents car rental (medium category)

          010901 represents car return locations for rental (minor category)

When specifying 010000, medium categories like 010100 and minor categories like 010101 will be included. When specifying 010900, minor categories like 010901 will be included.

Note: The returned results may include medium and minor category POIs, but not all. For more precise information, it is recommended to input minor categories or narrow down the search scope. POI classification codes

At least one of keywords and types must be selected.

None

page

Current page number

Optional

1

offset

Records Per Page

Customize the number of records per page from 0 to 50. The default setting is 20 records.

Optional

20

langCode

Return result language

Default is zh（Chinese），

optional: 

• zh（Chinese）
• en（English）
• es（Spanish）
• pt（Portuguese）
• fr（French）
• de（German）
• th（Thai）
• ja（Japanese）
• ko（Korean）
• ar（Arabic）
• tr（Turkish）
• he（Hebrew）
• it（Italian）
• ru（Russian）
• ms（Malay）
• id（Indonesian）
• vi（Vietnamese）
• pl（Polish）
• cs（Czech）
• uk（Ukrainian）
• az（Azerbaijani）

Optional

None

extensions

Result Control

By default, only basic address information is returned. For a comprehensive output including nearby POIs, roads, and road intersections, set this parameter to "all".

Optional

base

sig

Digital Signature

Methods for Obtaining and Using Digital Signatures

Optional

None

callback

Callback Function

The callback value is a function name defined by the user.

Optional

None

URL

Request Method 

https://sg-restapi.opnavi.com/v3/place/detail?parameters 

GET

Parameter Name

Description

Specification

Mandatory

Default

key

Service Authorization Token

Applying for a Web Service API Key and Submitting a Work Order for Overseas Permissions on Amap Map Official Website

Mandatory

None

id

POI ID

Unique Identifier ID for the POI

Note: Overseas POI IDs start with 'P'. 'PO' represents ordinary POIs, while 'PS'/'PV' represent public transit POIs. Example: P0JAK55X50

Mandatory

None

langCode

Return result language

Default is zh（Chinese），

optional: 

• zh（Chinese）
• en（English）
• es（Spanish）
• pt（Portuguese）
• fr（French）
• de（German）
• th（Thai）
• ja（Japanese）
• ko（Korean）
• ar（Arabic）
• tr（Turkish）
• he（Hebrew）
• it（Italian）
• ru（Russian）
• ms（Malay）
• id（Indonesian）
• vi（Vietnamese）
• pl（Polish）
• cs（Czech）
• uk（Ukrainian）
• az（Azerbaijani）

Optional

None

sig

Digital Signature

Methods for Obtaining and Using Digital Signatures

Optional

None

callback

Callback Function

The callback value is a function name defined by the user.

Optional

None