BETA This is a new service.

Methods

Resource Representation

{
   "etag" : "string",
   "items" : [
      {
         "address" : {
            "address_line_1" : "string",
            "address_line_2" : "string",
            "care_of" : "string",
            "country" : "string",
            "locality" : "string",
            "po_box" : "string",
            "postal_code" : "string",
            "region" : "string"
         },
         "address_snippet" : "string",
         "description" : "string",
         "description_identifier" : [
            "integer"
         ],
         "kind" : "string",
         "links" : {
            "self" : "string"
         },
         "matches" : {
            "address_snippet" : [
               "integer"
            ],
            "snippet" : [
               "integer"
            ],
            "title" : [
               "integer"
            ]
         },
         "snippet" : "string",
         "title" : "string"
      }
   ],
   "items_per_page" : "integer",
   "kind" : "string",
   "start_index" : "integer",
   "total_results" : "integer"
}
Parameter NameTypeDescriptionAdditional
etag string The ETag of the resource. Optional.
items[] list The results of the completed search. See items.kind for details of each specific result resource returned. Optional.
items[].address object The address of the company's registered office.
items[].address.address_line_1 string The first line of the address.
items[].address.address_line_2 string The second line of the address. Optional.
items[].address.care_of string The care of name. Optional.
items[].address.country string The country. Possible values are:
  • Wales
  • England
  • Scotland
  • Great Britain
  • Not specified
  • United Kingdom
  • Northern Ireland
Optional.
items[].address.locality string The locality e.g London. Optional.
items[].address.po_box string The post-office box number. Optional.
items[].address.postal_code string The postal code e.g CF14 3UZ. Optional.
items[].address.region string The region e.g Surrey. Optional.
items[].address_snippet string A single line address. This will be the address that matched within the indexed document, or the primary address otherwise (as returned by the address member).
items[].description string The result description. Optional.
items[].description_identifier Array An array of enumeration types that make up the search description. See search_descriptions_raw.yaml in api-enumerations Optional.
items[].kind string The type of search result. Refer to the full resource descriptions CompanySearch resource, OfficerSearch resource and DisqualifiedOfficerSearch resource for the full list of members returned. Possible values are:
  • searchresult#company
  • searchresults#officer
  • searchresults#disqualified-officer
items[].links object The URL of the search result.
items[].links.self string The URL of the resource being returned by the search item.
items[].matches object A list of members and arrays of character offset, defining substrings that matched the search terms. Optional.
items[].matches.address_snippet Array An array of character offset into the address_snippet string. These always occur in pairs, and define the start and end of substrings in the member address_snippet that matched the search terms. Optional.
items[].matches.snippet Array An array of character offset into the snippet string. These always occur in pairs, and define the start and end of substrings in the member snippet that matched the search terms. The first character of the string is index 1. Optional.
items[].matches.title Array An array of character offset into the title string. These always occur in pairs, and define the start and end of substrings in the member title that matched the search terms. The first character of the string is index 1. Optional.
items[].snippet string Summary information for the result, showing additional details that have matched. In the case of companies, this would be previous company names. Optional.
items[].title string The title of the search result.
items_per_page integer The number of search items returned per page. Optional.
kind string The type of search response returned. Possible values are:
  • search#all
Optional.
start_index integer The index into the entire result set that this result page starts. Optional.
total_results integer The number of further search results available for the current search. Optional.