--- title: "Batch Geocode" method: POST path: "/geocode/batch" tags: ["Places_Geocoding"] --- # Batch Geocode `POST /geocode/batch` ## Query parameters - `key` string, 32 character alphanumeric string, required ## Request body - object[] - `q` string, required — Specify the free-text search query. Please note that whitespace, urls, email addresses, or other out-of-scope queries will yield no results. - `at` string, latitude,longitude — Specify the center of the search context expressed as coordinates. Please note that one of "at", "in=circle" or "in=bbox" should be provided for relevant results. - `in` string — Search within a geographic area. This is a hard filter. Results will be returned if they are located within the specified area. A geographic area can be * a country (or multiple countries), provided as comma-separated [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country codes The country codes are to be provided in all uppercase. Format: countryCode:{countryCode}[,{countryCode}] * a circular area, provided as latitude, longitude, and radius (an integer with meters as unit) Format: circle:{latitude},{longitude};r={radius} * a bounding box, provided as _west longitude_, _south latitude_, _east longitude_, _north latitude_ Format: bbox:{west longitude},{south latitude},{east longitude},{north latitude} Please provide one of 'at', 'in=circle' or 'in=bbox' input for a relevant result. - `limit` integer — Maximum number of results to be returned. Please note that the minimum value that can be provided is 1 and the maximum that can be provided is 100. - `lang` string — Select the language to be used for result rendering from a list of [BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) compliant language codes. ## Response `200` - object - `items` object[] — The results are presented as a JSON list of candidates in ranked order (most-likely to least-likely) based on the matched location criteria. - `title` string — The localized display name of this result item. - `id` string — The unique identifier for the result item. - `address` Address — Postal address of the result item. - `label` string — Assembled address value built out of the address components according to the regional postal rules. These are the same rules for all endpoints. It may not include all the input terms. - `countryCode` string — A three-letter country code. - `countryName` string — The localised country name. - `stateCode` string — A country specific state code or state name abbreviation. For example, in the United States it is the two letter state abbreviation: "CA" for California. - `state` string — The state division of a country. - `county` string — A division of a state; typically, a secondary-level administrative division of a country or equivalent. - `city` string — The name of the primary locality of the place. - `district` string — A division of city; typically an administrative unit within a larger city or a customary name of a city's neighborhood. - `street` string — Name of street of the returned place, if available. - `postalCode` string — An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code. - `houseNumber` string — House number of the returned place, if available. - `scoring` Scoring — Score of the result. A higher score indicates a closer match. - `queryScore` number — A score, out of 1, indicating how closely the result matches with the provided query q . - `fieldScore` object — A breakdown of how closely individual field of the result matched with the provided query q. - `position` Position — Returns the location coordinates of the result. - `lat` string — The latitude of the searched place. - `lng` string — The longitude of the searched place. - `access` Access — An array returning the location coordinates of all the access points of the search result. - `lat` number — The latitude of the access point of the search result. - `lng` number — The longitude of the access point of the search result. - `distance` integer — The distance "as the crow flies" from the search center to this result item in meters. - `mapView` MapView — The bounding box enclosing the geometric shape (area or line) that an individual result covers. place typed results have no mapView. - `west` string — Longitude of the western-side of the box. - `south` string — Longitude of the southern-side of the box. - `east` string — Longitude of the eastern-side of the box. - `north` string — Longitude of the northern-side of the box. - `categories` Categories[] — The list of categories assigned to this place. - `id` string — Identifier number for an associated category. - `name` string — Name of the place category in the result item language. - `primary` string — Whether or not it is a primary category. This field is visible only when the value is 'true'. - `contacts` Contacts[] — Contact information like phone, email or website. - `phone` ContactObject[] - `label` string — Optional label for the contact string, such as "Customer Service" or "Pharmacy Fax". - `value` string — Contact information, as specified by the contact type. - `categories` object[] — The list of place categories this contact refers to. - `id` string — Identifier number for an associated category. For example: "900-9300-0000" - `mobile` ContactObject[] - `label` string — Optional label for the contact string, such as "Customer Service" or "Pharmacy Fax". - `value` string — Contact information, as specified by the contact type. - `categories` object[] — The list of place categories this contact refers to. - `id` string — Identifier number for an associated category. For example: "900-9300-0000" - `tollFree` ContactObject[] - `label` string — Optional label for the contact string, such as "Customer Service" or "Pharmacy Fax". - `value` string — Contact information, as specified by the contact type. - `categories` object[] — The list of place categories this contact refers to. - `id` string — Identifier number for an associated category. For example: "900-9300-0000" - `fax` ContactObject[] - `label` string — Optional label for the contact string, such as "Customer Service" or "Pharmacy Fax". - `value` string — Contact information, as specified by the contact type. - `categories` object[] — The list of place categories this contact refers to. - `id` string — Identifier number for an associated category. For example: "900-9300-0000" - `www` ContactObject[] - `label` string — Optional label for the contact string, such as "Customer Service" or "Pharmacy Fax". - `value` string — Contact information, as specified by the contact type. - `categories` object[] — The list of place categories this contact refers to. - `id` string — Identifier number for an associated category. For example: "900-9300-0000" - `email` ContactObject[] - `label` string — Optional label for the contact string, such as "Customer Service" or "Pharmacy Fax". - `value` string — Contact information, as specified by the contact type. - `categories` object[] — The list of place categories this contact refers to. - `id` string — Identifier number for an associated category. For example: "900-9300-0000" --- [API](https://skmtc.net/nextbillion-ai/apis/one-spec-service.md) · [All operations](https://skmtc.net/nextbillion-ai/apis/one-spec-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nextbillion-ai/one-spec-service/versions/b647f1808dda/schema)