GET /v1/entity/search/who/bylocation

HTTP Method: GET

Path: /v1/entity/search/who/bylocation

Authentication: API Key required

Description: Perform a company name search for entities by a supplied search phrase and location name.

Parameters:

parameter type description required
who  string The company name to be searched for e.g. starbucks yes
where string The location name to be searched for e.g. dublin 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
latitude float The "context" latitude used to disambiguate locations. If supplied (with a longitude), the search will be performed for the "where" string closest to this location no
longitude float The "context" longitude used to disambiguate locations. If supplied (with a latitude), the search will be performed for the "where" string closest to this location 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 4 as of 5 years ago by Unknown

Docs Navigation