Rest API Methods Available
This outlines the methods available in the Rest API. For further details, please refer to admin.avuxi.com/api
The Rest API is not activated by default. If you would like access, please send an email to support@avuxi.com
GetLocationScoresByRadius
This request will return the Location Scores for a point specified in the parameters. The scores will be separated by radius and distance (200 m, 500 m and 1500m), with values for 0 - 99.
| Parameters | ||
| Name | Format | Description |
| Latitude | double | The Latitude of the desired location |
| Longitude | double | The Longitude of the desired location |
Example response:
{ "values": [ { "sights200": 99, "sights500": 99, "sights1500": 99, "eating200": 99, "eating500": 99, "eating1500": 99, "eatingvegetarian200": 81, "eatingvegetarian500": 99, "eatingvegetarian1500": 99, "shopping200": 99, "shopping500": 99, "shopping1500": 99, "shoppingluxury200": 70, "shoppingluxury500": 83, "shoppingluxury1500": 99, "nightlife200": 95, "nightlife500": 98, "nightlife1500": 99, "historical200": 99, "historical500": 99, "historical1500": 99, "beachpark200": 82, "beachpark500": 85, "beachpark1500": 90, "id": "0" } ], "state": 0, "note": "" }
HeatMap
This request returns polygon data that can be used to generate vector Heat Maps.
TopPlace™ Rest API can generate Heat Maps in Tiles (raster images) or Vectors. Currently, in this API we only offer the Vector version.
There are two methods of issuing this request:
GetHeatMapAvailableCategories
Return the list of categories available in one Tile at zoom 10 (see more about tiles).
| Parameters | ||
| Name | Format | Description |
| tile10 | string | The tile ID at zoom 10. E.g. 518_352 (T10 for Paris) |
Example response:
{ "polygons": null, "categories": [ "phbeach", "phbeachpark", "phhistorical", "phpark", "phsights", "vnightlife", "vnightlifecasino", "vrestaurant", "vrestaurantfastfood", "vrestaurantvegetarian", "vshopping", "vshoppinglux" ], "state": 0, "note": "" }
GetHeatMapVectorial
Return the polygons for one category and Tile at zoom 10.
| Parameters | ||
| Name | Format | Description |
| tile10 | string | The tile ID at zoom 10. E.g. 518_352 (T10 for Paris) |
| category | string | The category you wish to search. E.g. nightlife |
Example response:
{ "polygons": { "levels": [ { "polygons": [ { "coords": [ [ 48.832294, 2.3176 ], [ ……… 48.862682, 2.343521 ] ], "title": "" } ], "level": "E" } ] }, "categories": null, "state": 0, "note": "" }
See Vector Map Integration for more details.
NearbyInfo
These methods offer location information about the surrounding area of a coordinate. It provides a more succinct summary of a location, such as:
- The Location score for each category
- Nearby POIs
- Nearby Transport
All the methods return the same object.
GetLocationScore
Return the Location Score (0 to 99) for each category for the selected location.
| Parameters | ||
| Name | Format | Description |
| Language | string | The ISO language code for your desired language |
| Latitude | double | The latitude of a location |
| Longitude | double | The longitude of a location |
GetLocationScoreWithTop3Venues
Return the Score (0 to 99) for each category with top 3 venues near for the selected location.
| Parameters | ||
| Name | Format | Description |
| Language | string | The ISO language code for your desired language |
| Latitude | double | The latitude of a location |
| Longitude | double | The longitude of a location |
GetLocationScoreWithTop6Venues
Return the Score (0 to 99) for each category with top 6 venues near for the selected location.
| Parameters | ||
| Name | Format | Description |
| Language | string | The ISO language code for your desired language |
| Latitude | double | The latitude of a location |
| Longitude | double | The longitude of a location |
GetLocationScoreWithTop12Venues
Return the Score (0 to 99) for each category with top 12 venues near for the selected location.
| Parameters | ||
| Name | Format | Description |
| Language | string | The ISO language code for your desired language |
| Latitude | double | The latitude of a location |
| Longitude | double | The longitude of a location |
GetLocationScoreWithTop1ByCategory
Return the Score (0 to 99) for each category with top 1 venue by category for the selected location.
| Parameters | ||
| Name | Format | Description |
| Language | string | The ISO language code for your desired language |
| Latitude | double | The latitude of a location |
| Longitude | double | The longitude of a location |
GetNearbyTransport
Return the near metro stations for the selected location.
| Parameters | ||
| Name | Format | Description |
| Language | string | The ISO language code for your desired language |
| Latitude | double | The latitude of a location |
| Longitude | double | The longitude of a location |
PointsOfInterest
Methods to get POIs of interest to use in a map.
GetPointsOfInterestByBox
This request will return the points of interest within a specified bounding box.
| Parameters | ||
| Name | Format | Description |
| North | double | Latitude north of bounding box |
| West | double | Latitude west of bounding box |
| South | double | Latitude south of bounding box |
| East | double | Latitude east of bounding box |
| Limit | integer | Limit of POI’s to show. (defaults to 80) |
| Language | string | ISO Language code of language desired in the response |
Example response:
{ "pois": [ { "latlon": [ 0 ], "name": "string", "cat": "string", "score": 0, "tags": [ "string" ] } ], "state": 0, "note": "string" }
Secure
GetSecureToken
Returns the key necessary to execute all the methods. Use this first. The key will be valid for 6 hours.
| Parameters | ||
| Name | Format | Description |
| appid | string | gets or sets the appid |
| appsecure | string | gets or sets the appsecure |
Example response:
{ "key": "string", "methods": [ "string" ], "state": 0, "note": "string" }
Transport
GetMetroLinesByCityCenter
Returns the metro lines and stops for the city related with the specified coordinate. Currently only works for selected cities.
| Parameters | ||
| Name | Format | Description |
| Latitude | double | The latitude of a location |
| Longitude | double | The longitude of a location |