Control Parameters

The control parameters specify inputs other than location.

Parameter Data Type Example Description Purpose
locale string fr_CA The language and country. A two-letter ISO-639 major language code and a two-letter ISO-3166-1 alpha-2 country code, separated by either a hyphen or underscore. Default is en_US (English/US).  
count integer 24 Number of results to return. Range is 1 to 100. Default is 10.  
flags string flags=XRT Option flags (characters are concatenated together):
  • B - Return business information element for each point result (match quality is 80 or greater)
  • C - Only return coordinate data and match quality elements; do not return address data elements.
  • D - Return DMA information element for each result
  • E - Do not return woeid element. This impacts the radius output.
  • G - Return global area elements instead of US-specific elements.
  • I - Only return WOEIDs for WOE entities
  • J - Return data in JSON format. Default format is XML. See Supported Formats.
  • Q - Return nearest commercial airport code element for each result.
  • R - Return telephone area code element for each result.
  • T - Return timezone information element for each result.
  • U - Return MSA information element for each result
  • 'W - Return WOE information element for each result (see WOEEntity section)
  • X - Return bounding box element for each area result.
The input parameter named flags determines which data elements are returned in the response. The value of the flags parameter is a string of characters. Each character is a capital letter that signifies the data to return. For example, the following flags parameter specifies that the bounding box (X), telephone area code (R), and timezone (T) are returned:
gflags string gflags=AC Option flags (characters are concatenated together):
  • A - Return neighborhood names for each result.
  • C - Look up cross streets for each result.
  • L - Limit results to the locale country.
  • Q - Quick mode, enable exact matches only for free-form input.
  • R - Reverse geocode coordinates for each result (Note: Locale has no bearing on this request).

The input parameter named gflags affects how geocoding is performed for the request. The value of the gflags is a string of characters. Each character is a capital letter that controls an aspect of the geocoding. For example, the following gflags parameter specifies the return of neighborhood names (A) and the lookup of cross streets (C).

Table of Contents