POI Search
Keyword Search
Service Introduction
Query relevant location queries based on input keywords or types
Interface address
https://lbs.navinfo.com/open-api/search/v1/text
Request method
GET
Request parameters
See the table below for keyword search instructions:
Parameter | Type | Meaning | Required | Default | Remarks |
---|---|---|---|---|---|
ak | string | Developer Key | Yes | ||
guid | string | device id | No | ||
kw | string | Keywords | Yes | If the searched words have no results in the current city and there is no outstanding result in the urban distribution, return the province list information; | |
city | string | Query City | Yes | Search Administration Regional adcode/name, example "BEIJING" | |
lonlat | string | Current location latitude and longitude | No | Get the current city center point if the field value is empty | |
exinfo | int | Return poi information control | No | 1 | Default 1, range of values: |
sort | string | Sort | No | Value range: (POI type) | |
psize | int | Number of records per page | No | 15 | Default 15, less than 1 by 1 processing, greater than 15 by 15 processing |
pnum | int | current page | No | 1 | Back to page 1 by default, less than 1 by 1 Processing, greater than 20 by 20 processing |
inGb | string | Entered coordinate system | No | g02 | Default: g02, |
outGb | string | Output coordinate system | No | g02 | Default: g02, |
language | string | Language Type | No | Default: ch |
Response data
Name | Type | Meaning | Remarks | |||||
---|---|---|---|---|---|---|---|---|
status | int | Return status | Refer to the status code table for details | |||||
msg | string | Return status description | Refer to the status code table | |||||
data | object | Back Results | ||||||
total | int | Total number of results retrieved | ||||||
ftype | string | Get the identifier of the filtering sorting configuration information | Default: 0 | |||||
provs | array | Return the list of province distribution results | ||||||
pnm | string | Province Name | ||||||
lonlat | string | Center point latitude and longitude | Provincial administrative area Center point (refers to the administrative center point of the entire province), longitude and latitude are separated by "," | |||||
adcode | string | Regional code for the province | ||||||
num | int | The number of provinces distributed | ||||||
count | int | Number of cities under the province | ||||||
cities | array | List of city distribution results under provinces | ||||||
cnm | string | city name | ||||||
lonlat | string | Center point latitude and longitude | City center point (refers to the center point of the city) Longitude and latitude are separated by "," | |||||
adcode | string | Adcode in the city | 6 national codes | |||||
num | int | total | The city contains the number of this keyword | |||||
pois | array | List of returned POI information | ||||||
pid | string | poi unique ID | can be used for location details retrieval | |||||
nm | string | poi name | ||||||
snm | string | Poi name abbreviation | Subpoi information will return value | |||||
lonlat | string | poi Latitude and longitude | ||||||
nlonlat | string | Navigation latitude and longitude | Used for navigation, longitude and latitude separated by "," | |||||
addr | string | poi address information | ||||||
prov | string | The provinces | ||||||
city | string | City | ||||||
dist | string | Home County | ||||||
phone | string | The POI's phone | ||||||
tp | string | Type name | ||||||
tcode | string | Affiliation Type Code | ||||||
dis | string | Center point distance | ||||||
brand | string | Brand | ||||||
tag | string | label | tags, separated by "," for multiple tags, example: 5A level scenic spots, cultural relics | |||||
photo | string | Image URL list, separated by ";" between multiple images | ||||||
rinfo | string | Introduction | ||||||
extend | object | Extension information for poi | This field is displayed only when exinfo = 2 or 3, different poi classes , the content displayed is different | |||||
price | string | poi merchant price | value range: | |||||
taste | string | Taste | ||||||
service | string | Service | Value range: Gas station related poi:1 means convenience store, 2 means car wash, 3 means car repair, 4 means bathroom, 5 means catering, 6 means accommodation 7 means oil change, 8 means self-service refueling, 11 means oil change (Hong Kong and Macao ), 12 means car wash (Hong Kong and Macao ), 13 indicates convenience store (Hong Kong and Macau), 14 tables Show bathroom (Hong Kong and Macau), separated by "|" for multiple services. | |||||
envi | string | Environment | ||||||
score | float | score | ||||||
time | string | opening Time | ||||||
faci | string | Facility | Multiple commas are separated, up to a maximum of 3. Example: "1,2,3,5" | |||||
rank | string | Star Rating | The Elong Hotel class has a special description. When the return value is 0, the eLong Hotel will display the value of reco available, but please make an icon distinction. | |||||
reco | string | cp recommended information | Value range: | |||||
cpid | string | Partner Id | Partner data, data fusion by tcode | |||||
cpnm | string | Partner Name | Partner Data , according to tcode for data fusion (after completing the enterprise certification, the permissions can be opened) | |||||
cpurl | string | Partner's official website | ||||||
status | int | Parking lot or gas station status | Use with tcode: | |||||
total | int | the total number of parking spaces | and tcode Used together: | |||||
sfree | int | Number of empty spaces | (Only parking related poi returns, returns A value of -1 means no data is returned. | |||||
model | int | Charging station category | 1 means standard charging, 2 means medium Speed charging, 3 means fast charging, multiple charger categories separated by "|"(This field is discarded. It is recommended to use the "sinfo" field.) | |||||
payment | string | Payment method | tcode=valid for parking lot, gas station, charging pile type | |||||
zcode | string | Postcode | tcode=valid for car type | |||||
ebnum | int | Number of change boxes | tcode=Valid for charging station type | |||||
ptype | string | plug specification | plug specification ( Hong Kong and Macao), 11 means 3 hole household, 12 means 7 hole European single phase electricity, 21 means 7 hole European three phase electricity, 22 means 5 hole American type, 23 means 3 hole household, 31 means Japanese CHAdeMO standard plug, multiple plug specifications Separated by "|" | |||||
parknum | string | Electric car parking berth number | tcode=Valid for station type | |||||
fee | string | Charging Standards | tcode=Parking Type Valid | |||||
ftext | string | Charging Information | tcode=Valid for parking type | |||||
tollway | string | Charging Method | tcode=parking type valid | |||||
ports | array | Parking entrance and exit list | tcode=Parking type Valid | |||||
dir | string | Directing and Exiting Directions | ||||||
lonlat | string | latitude and longitude coordinates | The longitude and latitude are separated by "," | |||||
type | int | Import and exit type | 0 means entry, 1 means exit, 2 shows the entrance | |||||
sinfo | array | Charging pile equipment list | tcode=Charging station type is valid | |||||
etype | int | Device Type | 1: DC Device | |||||
ctotal | int | Total number of charging posts | ||||||
cftotal | int | Charging pile Free number | ||||||
childrens | array | Sub-POI Information List | If poi has no sub-points, this field is empty | |||||
tag | object | Subpoi tag information | ||||||
tnm | string | label name | ||||||
pois | array | subpoi information list | ||||||
Dist | object | administrative area switching information | (search The result is that the city jump returns this information) | |||||
parents | string | List of parent administrative names | Between multiple names Separated by "|" | |||||
nm | string | Name | ||||||
adcode | string | regional code | ||||||
lv | int | Administrative area level | 0: Country, | |||||
lonlat | string | Administrative Regional Center Point | (the central point of the municipal district is the central point of the city), the longitude and latitude are separated by "," | |||||
lonlats | administrative area boundaries | providing provinces | Currently only returns the latitude and longitude of the four east, south, west and north points. Format: most east longitude, east latitude; south longitude, southernmost latitude; western longitude, western latitude; northern longitude , the northernmost latitude |
Service example
Circular Search
Service Introduction
Retrieve surrounding related location information based on a coordinate point (usually used for surrounding search scenes)
Interface address
https://lbs.navinfo.com/open-api/search/v1/around
Request method
GET
Request parameters
For a circular search input, please refer to the following table:
Parameter | type | Meaning | Required | Default | Remarks |
---|---|---|---|---|---|
ak | string | Developer Key | Yes | ||
guid | string | device id | No | ||
kw | string | Keywords | Yes | ||
city | string | Query City | Yes | Search for the adcode/name of the administrative area, example "BEIJING" | |
exinfo | int | Return poi information control | No | 1 | Recognition 1, value range: |
lonlat | string | current position coordinates | Yes | Format: Longitude, Latitude | |
radius | int | Search radius | No | 3000 | Unit: meter, value range :0-50000. Rule: greater than 50000 by default, default: 3000 |
sort | string | Sort | No | Value range: (POI type) | |
inGb | string | Entered coordinate system | No | g02 | Default: g02, |
outGb | string | The output coordinate system | No | g02 | Default: g02, |
psize | int | Number of records per page | No | 15 | Default 15, less than 1 by 1 processing, greater than 15 by 15 processing |
pnum | int | current page | No | 1 | Return to page 1 by default, less than 1 by 1 and greater than 20 by 20 |
language | string | Language Type | No | Default: ch |
Response data
Refer to the result field description for keyword search.
Service example
Rectangular Search
Service Introduction
Retrieve the location information in the corresponding polygon of the coordinates (usually used for searching in the field of view of mobile phone or PC-side map)
Interface address
https://lbs.navinfo.com/open-api/search/v1/polygon
Request method
GET
Request parameters
Rectangle search input tips please refer to the following table:
Parameter | Type | Meaning | Required | Default | Remarks |
---|---|---|---|---|---|
ak | string | Developer Key | Yes | ||
guid | string | device id | No | ||
kw | string | Keywords | Yes | ||
city | string | Query City | Yes | Search for the adcode/name of the administrative area, example "BEIJING" | |
exinfo | int | Return poi information control | No | 1 | Default 1, Range of values: |
lonlats | string | Rectangular coordinate string | Yes | Rules: Longitude and latitude are separated by "," and coordinate pairs are separated by ";". Pass in the top left and bottom right vertex coordinates pair | |
sort | string | Sort | No | Value range: (POI type) | |
inGb | string | Entered coordinate system | No | g02 | Default: g02, |
outGb | string | The coordinate system of the output | No | g02 | Default: g02, |
psize | int | Each page Number of records | No | 15 | Default 15, less than 1 is processed by 1 and greater than 15 by 15 |
pnum | int | Current page | No | 1 | Back to page 1 by default, less than 1 by 1 and greater than 20 by 20 |
language | string | Language Type | No | Default: ch |
Response data
Refer to the result field description for keyword search.
Service example
Search Along the Way
Service Introduction
Retrieve the location information around the path (usually used with the path planning interface)
Interface address
https://lbs.navinfo.com/open-api/search/v1/line
Request method
GET
Request parameters
For a search along the way, please refer to the following table:
Parameter | Type | Meaning | Required | Default | Remarks |
---|---|---|---|---|---|
ak | string | Developer Key | Yes | ||
guid | string | device id | No | ||
kw | string | Keywords | Yes | ||
lonlats | string | polygon coordinate string | Yes | Rules: Longitude and latitude are separated by "," and coordinate pairs are separated by ";". At least 2 pairs of latitude and longitude | |
city | string | Query City | Yes | Search for the adcode/name of the administrative area, example "BEIJING" | |
sort | String | sort | No | Value range: (POI type) | |
exinfo | int | Return poi information control | No | 1 | Default 1, Range of values: |
limit | int | Route length | No | 20000 | The unit is meters, the default is 20000 Meter, when the line length specified by the lonlats parameter is greater than the parameter, the line length specified by the parameter is taken from the starting point to search along the line, less than 1 is processed by 20000, and greater than 20000 is processed by 20000 |
radius | int | Search radius | No | Unit: meter, value range: 1-1000. Default 3000 meters | |
inGb | string | Entered coordinate system | No | g02 | Default: g02 |
outGb | string | Output coordinate system | No | g02 | Default: g02, |
psize | int | Number of records per page | No | 15 | Default 15, less than 1 by 1 processing, greater than 15 by 15 processing |
pnum | int | current page | No | 1 | Return to page 1 by default, less than 1 by 1 and greater than 20 by 20 |
language | string | Language Type | No | Default: ch |
Response data
Refer to the result field description for keyword search.
Service example
Details Query
Service Introduction
Query POI details based on poi unique identifier
Interface address
https://lbs.navinfo.com/open-api/search/v1/detail
Request method
GET
Request parameters
Location Details Enquiry Input Tips Please see the table below:
Parameter | Type | Meaning | Required | Default | Remarks |
---|---|---|---|---|---|
ak | string | Developer Key | Yes | ||
guid | string | device id | No | ||
id | string | POI unique id | Yes | ||
exinfo | int | Return poi information control | No | 1 | Default 1, Range of values: |
outGb | string | output Coordinate system | No | g02 | Default: g02, G02: National Bureau of Surveying (gcj02) Coordinates |
language | string | Language Type | No | Default: ch |
Response data
Refer to the result field description for keyword search.
Service example
Partner Information Query
Service Introduction
According to cpid, cpnm for in-depth information on third-party hotels, attractions, food, parking lots, etc.
Interface address
https://lbs.navinfo.com/open-api/search/v1/cpdetail
Request method
GET
Request parameters
Partner Details Search Input Tips Please see the table below:
Parameter | Type | Meaning | Required | Default | Remarks |
---|---|---|---|---|---|
ak | string | Developer Key | Yes | ||
guid | string | device id | No | ||
cpid | string | cp unique identifier | Yes | ||
cpnm | string | cpname | Yes | ||
adate | string | Check-in date | No | is greater than or equal to yesterday. If the check-in time is early morning, then the date of the previous day is passed. Format: yyyy-MM-dd Example: 2018-11-18 (Hotel Information Query Dedicated Field) Default | |
ddate | string | Date Date | No | At least one day after the arrival of the store, no more than 30 days, format: yyyy-MM-dd Example: 2017-11-19 ( Hotel Information Query Dedicated Fields) Default | |
exinfo | int | Return information control | No | 1 | Default 1, value range: |
outGb | string | Output coordinate system | No | g02 | Default: g02 |
Response data
Name | Type | Meaning | Remarks | ||
---|---|---|---|---|---|
status | int | Return status | See status code table for details. | ||
msg | string | Back Status Description | See status code table for details. | ||
data | object | returned results | |||
cpid | string | cp unique ID | |||
cpnm | strin g | cp name | |||
lonlat | string | latitude and longitude | |||
addr | string | Address Information | |||
City | string | City | |||
phone | string | Phone | |||
otime | string | Business hours | |||
type | string | cp | Return value description: hotel: hotel, cater: food, scenery: attractions, parking: parking | ||
rinfo | string | introduction to cp | |||
rimgurl | int | cp cover map | |||
faci | string | facilities | Only hotels and foods have data to return | ||
rec | array | cp recommended information | type=scenery, return to ticket purchase notice (only attractions have data returned) | ||
rimgurls | array | cp image set | up to 5 | ||
extend | object | extension information for cp | This field is displayed only when exinfo = 2 or 3, different cp types, the display content is different | ||
detail | cp extension information | cp extension information For specific fields, see the following document Hotel: hotelinfo |
Food: type= cater (detailed field format) in cpinfo
Name | Type | Meaning | Remarks | |
---|---|---|---|---|
deals | array | Group purchase information list | ||
Id | string | group buy id | ||
name | string | Group Buying Name | ||
oprice | float | original price | ||
Price | float | group purchase price | ||
stime | string | start time | ||
etime | string | End time | ||
snums | int | sales d> | ||
score | string | Rating | ||
link | string | pc front-end page | cp next page | |
comment | array | Commentary Information | Up to 5 | |
tating | int | score | Value range 0-50, divided by 10 to score | |
content | string | Content | ||
time | long | timestamp | ||
imgurls | string | Comment Picture | Up to 5, with ";" interval between multiple images |
Hotel: format=detail field for type= hotel in cpinfo
Name | Type | Meaning | Remarks | ||
---|---|---|---|---|---|
rooms | array | list of rooms | |||
rid | string | Show room number | |||
rnm | string | Room Name | |||
picurl | string | Room cover image | Room cover image url address | ||
area | string | area | |||
btype | string | bed type | |||
floor | string | floor | |||
bnet | string | Internet access | 0-Non-1 - Free Broadband 2 - Charging Broadband 3 - Free WIFI 4 - Charging WIFI | ||
capcity | string | Capacity | The bed is purchased for a bed, regardless of the number of people staying here. | ||
imgurls | array | Room image collection | Up to 5 | ||
pros | array | Product Information List | |||
pid | int | Product Number | |||
pnm | string | Product Name | |||
price | double | Average Daily Price | |||
isbf | string | Do you have breakfast | true: with early flase: no early | ||
ptype | string | Payment Type | SelfPay-Guaranteed, Prepay-Prepaid | ||
pdesc | string | Description Type Description | |||
link | string | Order Address | Booking Jump | ||
review | object | Evaluation | |||
good | int | Praise number | |||
poor | int | Budget | |||
count | int | Total Comments | |||
score | string | favorable rate |
Attractions: type=description in seninfo (details) format field
Name | Type | Meaning | Remarks | |
---|---|---|---|---|
policys | array | Price list | ||
id | int | Price Strategy id | ||
nm | string | price strategy name | ||
putil | Int | Product Unit | ||
putilnm | string | product unit name | ||
price | double | Market Price | Unit: Yuan | |
tcprice | double | Price in the same city | Unit: Yuan | |
ptype | int | Payment Type | Payment Method | |
time | string | Scheduled time in advance | Format: HH:mm | |
gmode | string | How to enter | ||
cltems | string | The scenic area contains items | ||
remark | string | Booking Instructions | SelfPay-Guarantee, Prepay-Prepaid | |
indesc | string | Invoice Description | ||
rerule | string | Refund Instructions | ||
link | string | Order Address | Booking Jump |
Parking (Hibo/ETCP): detail field format when type= parking in seninfo
Name | Type | Meaning | Remarks | |
---|---|---|---|---|
status | string | Parking is currently busy | empty/busy/full/off | |
total | int | Total number of passengers | ||
sfree | int | Free car number | When the return value is -1, no data is returned | |
fee | string | Standard Fees | ||
feew | string | Standards on weekends | ||
feeh | string | Holiday Standards Charge | ||
pay | string | Charging method | POS/CUP card/Abandon QR code/WeChat II Dimensional Code / Flash Payment QR Code / Mobile Application / Payment Machine | |
plink | string | Payment Link | can be restored to QR code | |
feep | float | Next hour forecasting fee | ||
feelv | int | Standard fees | 1: Low price | |
feex | Int | High and low discount | 1: Low price | |
diff | int | Parking Difficulty | 1: Easy | |
recom | int | Parking Comprehensive Recommendation | 1: Recommendation | |
ports | array | Parking entrance and exit list | ||
nm | string | Director Name | Example: Beiqing Road | |
lonlats | string | entry and exit coordinate string | format is "longitude" 1, latitude 1; longitude 2, latitude 2...." | |
type | string | Types of entrances and exits | 0 means entrances, 1 means exits, 2 means entrances and exits |
Charging station (pile home): detail field format when type= charge (charge station) in seninfo
Name | Type | Meaning | Remarks | ||
---|---|---|---|---|---|
stype | string | Charging site type | 1: Public 50: Personal 100: Bus (dedicated) | ||
status | int | Charging station status | 0: Unknown | ||
pnums | int | The total number of parking spaces that can be parked | |||
cons | int | Buildings | 1: Residential area | ||
mcars | string | Describe the size and type of car accepted by the site | Bars, logistics vehicles, private passenger cars, taxis, etc. | ||
efee | string | electricity fee | |||
cfree | int | Is it free? | 0: Free | ||
sfee | string | Charging Service Fee | |||
pfee | string | Parking Fees | |||
pfree | int | Whether free parking | 0: Free | ||
pay | string | payment method | |||
recom | int | Recommended Station | Default: 2 | ||
sorder | int | Support for appointments | Default: 0 | ||
einfos | array | Device Information List | |||
eid | string | Device unique encoding | |||
egun | int | whether with a charging gun | default :2 | ||
etype | int | Device Type | 1: DC device | ||
lonlat | string | equipment latitude and longitude | |||
power | Int | power | |||
ename | string | Charging device interface name | |||
cinfos | array | Charging device information list | |||
cid | string | Charging device interface encoding | |||
cname | string | Charging device interface name | |||
ctype | int | socket type | 1: Household outlet (mode 2) | ||
vulimits | int | Max voltage, unit: V | |||
vllimits | int | Minimum voltage, unit: V | |||
current | int | Charging current | |||
power | int | power | |||
status | int | Pile Status | 0: Off-net | ||
parkno | string | Parking Location Number |
Service example
Type Filter Item
Service Introduction
Returns the filter information supported by this type based on the poi type. (for poi secondary search)
Interface address
https://lbs.navinfo.com/open-api/search/v1/config
Request method
GET
Request parameters
Type filter entry descriptions are shown in the table below:
Parameter | Type | Meaning | Required | Default | Remarks |
---|---|---|---|---|---|
ak | string | Developer Key | Yes | ||
guid | string | device id | No | ||
ftype | string | Data Type | Yes | The following types are only supported: |
Return parameters
Name | Type | Meaning | Remarks | |||
---|---|---|---|---|---|---|
status | int | Return status | See status code table for details. | |||
msg | string | Back Status Description | Refer to the status code table | |||
data | object | Returned results | ||||
total | int | Number of configuration items | ||||
configs | array | Configuration Item List | ||||
nm | string | Configuration Item Name | Scope Filtering, Type/Brand Filtering, Sorting Selection | |||
pnm | string | Configuration item search method Name | Value range: | |||
content | array | Configuration Item Content | ||||
detail | string | Configuration Item Details |
pnm= kws in configs (details field format (type catering/car)
Name | Type | Meaning | Remarks |
---|---|---|---|
code | string | Type Encoding | |
nm | string | Type Name | |
categories | array | Subclass List | The data structure is consistent with the parent class |
pnm equals other types in configs for detail field format
Name | Type | Meaning | Remarks |
---|---|---|---|
nm | string | type name | |
value | string | Type value | |
isdef | int | is the default value | 1: Default, |
Service example