GET /v1/entity/search/what/byboundingbox

HTTP Method: GET

Path: /v1/entity/search/what/byboundingbox

Authentication: API Key required

Description: Perform a search for entities by a supplied search phrase and a pair of lat/long coordinates that define a bounding box within which to search.

Parameters:

parameter type description required
what string The phrase to be searched for e.g. plumber yes
latitude_1 float Latitude of bounding box point 1 yes
Longitude_1 float Longitude of bounding box point 1 yes
latitude_2 float Latitude of bounding box point 2 yes
longitude_2 float Longitude of bounding box point 2 yes
per_page integer The number of results to return per page. Default 10. no
page integer The page number of results to return. Default 1. no
country string The ISO country code of the country's entities to search e.g. ie for Eire yes
language string The ISO language code of the supplied 'what' e.g. en for English no

Pseudo Sample Response:

{
    "success": true,
    "msg": "ok",
    "data": {
        "total_rows": 265,
        "rows": [
              {
                "id": "<entity_id>",
                "doc" : { }
              },              {
                "id": "<entity_id>",
                "doc" : { }
              },
.
.
.
      ]
   }
}

where

  • total_rows is the number of rows in the data set
  • <entity_id> is the number that uniquely identifies each entity
  • each "doc" is an entity, as described in the /v1/entity API call.

version 3 as of 6 years ago by Unknown

Docs Navigation