data-services/geocoder/README.md

CARTO Internal Geocoder

API Response Format

Parameters

Field	Explanation	Type
q	Input query text	text
success	Was it successfully geocoded?	boolean
geom	Resolved geometry, NULL if none	wkb
c	Input country text if provided and variable	text

• q will be searched on in lowercase but returned in input form
• c will always be returned in the form it was given, including empty string and NULL
• c will be resolved to an ISO code using a lookup dictionary
• c when NULL or empty will make the search for that entry fall back to countryless

Existing Services

Level 0 administrative regions (Countries)

Data type

Polygons

Parameters

name	type	optional?
name	text[]	false

Current coverage

Global

Example requests

SELECT (geocode_admin0_polygons(Array['Spain', 'USA', ''])).*

Links

See it on the api

See plpgsql

Level 1 administrative regions (States/Provinces)

Data type

Polygons

Parameters

name	type	optional?
name	text[]	false
country	text[]	true
countries	text[]	true

Current coverage

Global

Example requests

SELECT (geocode_admin1_polygons(Array['TX','Cuidad Real', 'sevilla'])).*

SELECT (geocode_admin1_polygons(Array['NH', 'Vermont'], 'United States')).*

SELECT (geocode_admin1_polygons(Array['az', 'az'], Array['Ecuador', 'USA'])).*

Links

See it on the api

See plpgsql

Named Places

Data type

Points

Parameters

name	type	optional?
named_place	text[]	false
country_code	string	true
country_codes	text[]	true

Current coverage

Global

Example requests

SELECT (geocode_namedplace(Array['Madrid', 'New York City', 'sunapee'])).*

SELECT (geocode_namedplace(Array['sunapee', 'sunapeeee', 'New York City'], 'USA')).*

SELECT (geocode_namedplace(Array['sunapee', 'sunapeeee', 'New York City', 'Madrid'], Array['', 'US', 'United States', NULL])).*

SELECT (geocode_namedplace(
    Array['Portland', 'Portland', 'New York City'],
    Array['Maine',    'Oregon',    NULL],
    'USA')).*

SELECT (geocode_namedplace(
    Array['Portland', 'Portland', 'New York City'],
    Array['Maine','Oregon', null],
    NULL)).*

Links

See it on the api

See plpgsql

IP Addresses

Data type

Points

Parameters

name	type	optional?
IP query array	text[]	false

Current coverage

Global

Example request

SELECT (geocode_ip(Array['1.0.16.0', '::ffff:1.0.16.0', 'not an IP'])).*

Links

See it on the api

See plpgsql

Postal Code Polygons

Parameters

name	type	optional?
postal_code	text[]	false
country_code	string	true
country_codes	text[]	true

Current coverage

United States, Canada, Australia, France

Example requests

SELECT (geocode_postalcode_polygons(Array['10013','11201','03782'])).*

SELECT (geocode_postalcode_polygons(Array['10013','11201','03782'], 'USA')).*

SELECT (geocode_postalcode_polygons(Array['10013','G9H','03782'], Array['USA', 'Canada', 'US'])).*

Links

See it on the api

See plpgsql

Postal Code Points

Parameters

name	type	optional?
postal_code	text[]	false
country_code	string	true
country_codes	text[]	true

Current coverage

Global see list

Example requests

SELECT (geocode_postalcode_points(Array['10013','11201','03782'])).*

SELECT (geocode_postalcode_points(Array['10013','11201','03782'], 'USA')).*

SELECT (geocode_postalcode_points(Array['10013','G9H','03782'], Array['USA', 'Canada', 'US'])).*

Links

See it on the api

See plpgsql