GEgeoapify
Batch Geocoding

Get batch geocode search result

Retrieve batch geocode search status or normalized results.

get/batch/geocode/search

Request

  • Base URL
    https://api.geoapify.com/v1
  • Auth
    • API key in query parameter apiKey
    • or API key in header x-api-key

Query parameters

idstring required

Batch job identifier returned by the submit endpoint.

format'json' | 'csv'

Batch geocode result format.

Response

Normalized geocoding results for the completed job.

namestring
continentstring
countrystring
country_codestring
regionstring
statestring
state_codestring
state_COGstring
department_COGstring
state_districtstring
provincestring
departmentstring
arrondissementstring
countystring
county_codestring
county_districtstring
citystring
city_districtstring
postcodestring
postal_codestring
openGeoDB:postal_codesstring
districtstring
suburbstring
municipalitystring
communestring
subdistrictstring
city_blockstring
neighbourhoodstring
quarterstring
sectionstring
sectorstring
subdivisionstring
croftstring
allotmentsstring
residentalstring
farmstring
farmyardstring
industrialstring
commercialstring
retailstring
boroughstring
townstring
townshipstring
villagestring
hamletstring
localitystring
isolated_dwellingstring
streetstring
roadstring
footwaystring
pedestrianstring
pathstring
housenumberstring
house_numberstring
house_namestring
old_namestring
otherstring
formattedstring
address_line1string
address_line2string
unlocodestring
iso3166_2string
iso3166_2_sublevelstring
iso3166_sublevelstring
plus_codestring
plus_code_shortstring
postcodesstring[]
other_namesobject
populationnumber
lonnumber
latnumber
parent_as_place_idboolean
NUTS_3string
result_type'unknown' | 'amenity_name' | 'amenity' | 'building' | 'street' | 'postcode' | 'suburb' | 'district' | 'city' | 'county' | 'state' | 'country'
distancenumber
categorystring
categoriesstring[]
place_idstring

Changes

No recorded changes to this operation across all 1 revision of this API.