GEgeoapify
Batch Geocoding

Submit batch geocode search job

Submit up to 1000 free-text addresses for asynchronous geocoding. One result is requested per input address.

post/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

lang'ab' | 'aa' | 'af' | 'ak' | 'sq' | 'am' | 'ar' | 'an' | 'hy' | 'as' | 'av' | 'ae' | 'ay' | 'az' | 'bm' | 'ba' | 'eu' | 'be' | 'bn' | 'bh' | 'bi' | 'bs' | 'br' | 'bg' | 'my' | 'ca' | 'ch' | 'ce' | 'ny' | 'zh' | 'cv' | 'kw' | 'co' | 'cr' | 'hr' | 'cs' | 'da' | 'dv' | 'nl' | 'en' | 'eo' | 'et' | 'ee' | 'fo' | 'fj' | 'fi' | 'fr' | 'ff' | 'gl' | 'ka' | 'de' | 'el' | 'gn' | 'gu' | 'ht' | 'ha' | 'he' | 'hz' | 'hi' | 'ho' | 'hu' | 'ia' | 'id' | 'ie' | 'ga' | 'ig' | 'ik' | 'io' | 'is' | 'it' | 'iu' | 'ja' | 'jv' | 'kl' | 'kn' | 'kr' | 'ks' | 'kk' | 'km' | 'ki' | 'rw' | 'ky' | 'kv' | 'kg' | 'ko' | 'ku' | 'kj' | 'la' | 'lb' | 'lg' | 'li' | 'ln' | 'lo' | 'lt' | 'lu' | 'lv' | 'gv' | 'mk' | 'mg' | 'ms' | 'ml' | 'mt' | 'mi' | 'mr' | 'mh' | 'mn' | 'na' | 'nv' | 'nb' | 'nd' | 'ne' | 'ng' | 'nn' | 'no' | 'ii' | 'nr' | 'oc' | 'oj' | 'cu' | 'om' | 'or' | 'os' | 'pa' | 'pi' | 'fa' | 'pl' | 'ps' | 'pt' | 'qu' | 'rm' | 'rn' | 'ro' | 'ru' | 'sa' | 'sc' | 'sd' | 'se' | 'sm' | 'sg' | 'sr' | 'gd' | 'sn' | 'si' | 'sk' | 'sl' | 'so' | 'st' | 'es' | 'su' | 'sw' | 'ss' | 'sv' | 'ta' | 'te' | 'tg' | 'th' | 'ti' | 'bo' | 'tk' | 'tl' | 'tn' | 'to' | 'tr' | 'ts' | 'tt' | 'tw' | 'ty' | 'ug' | 'uk' | 'ur' | 'uz' | 've' | 'vi' | 'vo' | 'wa' | 'cy' | 'wo' | 'fy' | 'xh' | 'yi' | 'yo' | 'za'

Result language as a supported two-letter language code.

latnumber

Latitude for an optional geocoding bias. Must be used together with lon.

lonnumber

Longitude for an optional geocoding bias. Must be used together with lat.

filterstring

Optional geocoding filter expression.

biasstring

Optional geocoding bias expression.

textstring

Default text query applied with request-level parameters.

countrycodesstring

Comma-separated ISO 3166-1 alpha-2 country code filters.

type'country' | 'state' | 'city' | 'postcode' | 'street' | 'amenity' | 'locality'

Optional result type filter.

prioritynumber

Optional batch processing priority factor.

Request body

string[] required

Response

Normalized geocoding results when the batch completes immediately.

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.