Geo Typeahead

  • Article

Overview

Geo Typeahead API provides the best matching geo URNs based on the search query.

Note

All use of the Microsoft Bing Maps location data is subject to Microsoft Bing Maps and MapPoint Web Service End User Terms of Use and Embedded Maps Service Terms of Use and the Microsoft Privacy Statement. By accessing any Microsoft Bing Maps location data, you are agreeing to be bound by these Microsoft terms.

Note

All API requests are represented in protocol 2.0.0 and require the header X-Restli-Protocol-Version: 2.0.0.

Geo Typeahead: q=search

Schema q=search

Field Description Format
displayText The display name of the geo URN. String
entity The Geo urn matching the search query. URN

Request Parameters

Field Name Sub-Field Name Description Required
query Typeahead query parameter. Yes
locale   The locale the country/region data is requested in. "en_US" locale will be used if locale is not provided or not supported. Optional
  language A lowercase two-letter language code as defined by ISO-639. Optional
  country An uppercase two-letter country code as defined by ISO-3166. Optional

Sample Requests

GET https://api.linkedin.com/v2/geoTypeahead?q=search&query=united

GET https://api.linkedin.com/v2/geoTypeahead?q=search&query=united&locale=(language:en,country:US)

Sample Response

{
   
    },
    "elements": [
        {
            "displayText": "United States",
            "entity": "urn:li:geo:103644278"
        },
        {
            "displayText": "United Kingdom",
            "entity": "urn:li:geo:101165590"
        },
        {
            "displayText": "United Arab Emirates",
            "entity": "urn:li:geo:104305776"
        },
        {
            "displayText": "England, United Kingdom",
            "entity": "urn:li:geo:102299470"
        },
        {
            "displayText": "California, United States",
            "entity": "urn:li:geo:102095887"
        },
        {
            "displayText": "Texas, United States",
            "entity": "urn:li:geo:102748797"
        },
        {
            "displayText": "New York, United States",
            "entity": "urn:li:geo:105080838"
        },
        {
            "displayText": "Florida, United States",
            "entity": "urn:li:geo:101318387"
        },
        {
            "displayText": "London Area, United Kingdom",
            "entity": "urn:li:geo:90009496"
        },
        {
            "displayText": "London, England, United Kingdom",
            "entity": "urn:li:geo:102257491"
        }
    ]
}

DEPRECATED - Geo Typeahead: q=federated

Warning

The Geo Typeahead API below (/geoTypeahead?q=federated) will be deprecated on August 31, 2021 and replaced with the new Geo Typeahead API above (/geoTypeahead?q=search).

Schema q=federated

Field Sub-Field Description Format
hits The record containing the typeahead hit information. Array
displayName Hit title. The display name of the geo URN. String
entity The urn matching the search query. URN

Parameters

Field Name Sub-Field Name Description Required
query Typeahead query parameter. Yes
locale   The locale the country/region data is requested in. "en_US" locale will be used if locale is not provided or not supported. Optional
  language A lowercase two-letter language code as defined by ISO-639. Optional
  country An uppercase two-letter country code as defined by ISO-3166. Optional

Request

GET https://api.linkedin.com/v2/geoTypeahead?q=federated&query=San

GET https://api.linkedin.com/v2/geoTypeahead?q=federated&query=San&locale=(language:en,country:US)

Response

{
  "elements": [
    {
      "hits": [
        {
          "displayName": "San Francisco Bay Area",
          "entity": "urn:li:geo:12345"
        },
        {
          "displayName": "San Francisco, California, United States",
          "entity": "urn:li:geo:23456"
        },
        {...},
        {...}
      ]
    }
  ],
 
}