GET /v1/entity/search/who/bynearest

HTTP Method: GET

Path: /v1/entity/search/who/bynearest

Authentication: API Key required

Description: Perform a search for entities by a supplied company name nearest a supplied latitude and longitude

Parameters:

parameter	type	description	required
who	string	The name to be searched for e.g. plumber	yes
latitude	float	Latitude of centre point of search	yes
Longitude	float	Longitude of centre point of search	yes
country	string	Two-letter ISO country code. Default is "gb"	no
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

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 5 years ago by Unknown

Previous: GET /v1/entity/search/who/byboundingbox
Up: Central Index API
Next: GET /v1/location

GET /v1/entity/search/who/bynearest

Docs Navigation