NEnextbillion-ai
Places_Geocoding

Retrieve coordinates by postal code

Changed on
post/postalcode

Request

Query parameters

keystring 32 character alphanumeric string required
Example:key=API_KEY

A key is a unique identifier that is required to authenticate a request to the API.

Request body

postalcodestring

Provide the postal code for which the information is needed. At least one of (postalcode + country) or at needs to be provided. Please note that only 1 postal code can be requested. See this example.

countrystring

Country containing the postal code or the location. It is mandatory if postalcode is provided in the request. See this example.

Please check the API Query Limits section below for a list of the countries covered by the Geocode Postcode API. Users can provide either the name or the alpha-2/3 code as per the ISO 3166-1 standard of a country covered by the API as input for this parameter.

format'geojson'

Specify the format in which the boundary details of the post code will be returned. When specified, the boundary details will be returned in the geojson format. When not specified, the boundary details are returned in general format.

Example request

{
  "format": "\"format\":\"geojson\""
}

Response

warningstring[]

Returns a message, in case the input provided triggers any warnings.

Changes

  • 7ee76f0ff679Revision changes
    • breaking

      removed the enum value geojson of the request property

    • info

      added the new geojson enum value to the request property

  • a800b73f11c1Revision changes
    • breaking

      removed the enum value geojson of the request property

    • info

      added the new geojson enum value to the request property