Overture Maps API Documentation (1.0)

Download OpenAPI specification:Download

Aden Forshaw: aden@thatapicompany.com URL: https://thatapicompany.com/overture-maps-api

OpenAPI docs for the Overture Maps API

places

Operations related to Places

root

Welcome to the Overture Maps API

Responses

Buildings

BuildingsController_getBuildings

Authorizations:

API_KEY

query Parameters

lat required	number Example: lat=40.7128 Latitude coordinate. Required if country code is not provided.
lng required	number Example: lng=-74.006 Longitude coordinate. Required if country code is not provided.
radius	number >= 1 Default: 1000 Example: radius=1000 Search radius in meters, defaulting to 1000 meters if not provided.
limit	number >= 1 Default: 1000 Example: limit=10 Limit on the number of results returned, defaulting to 1000 if not provided.
page	number >= 0 Default: 0 Example: page=0 Page number for pagination (0-indexed), used together with `limit` as the page size. Responses include Pagination-Count (total matching results), Pagination-Page and Pagination-Limit headers. Defaults to 0.
format	string Default: "json" Enum: "json" "csv" "geojson" Example: format=json Response format, defaulting to JSON. Options are "json", "csv", or "geojson".
includes	Array of strings Example: includes=id&includes=geometry&includes=properties Array of fields to include in the properties field of the response, provided as a comma-separated string. Any fields not in the list will be excluded from the properties object. This is used to make the response lighter so your application is faster.
country	string Example: country=US ISO 3166 country code consisting of 2 characters. Required if lat/lng are not provided.

Responses

Places

Get Places using Query params as filters

Authorizations:

API_KEY

query Parameters

lat required	any Example: lat=40.7128 Latitude coordinate. Required if country code is not provided.
lng required	any Example: lng=-74.006 Longitude coordinate. Required if country code is not provided.
radius	number >= 1 Default: 1000 Example: radius=1000 Search radius in meters, defaulting to 1000 meters if not provided.
limit	number >= 1 Default: 1000 Example: limit=10 Limit on the number of results returned, defaulting to 1000 if not provided.
page	number >= 0 Default: 0 Example: page=0 Page number for pagination (0-indexed), used together with `limit` as the page size. Responses include Pagination-Count (total matching results), Pagination-Page and Pagination-Limit headers. Defaults to 0.
format	any Default: "json" Example: format=json Response format, defaulting to JSON. Options are "json", "csv", or "geojson".
includes	any Example: includes=id&includes=geometry&includes=properties Array of fields to include in the properties field of the response, provided as a comma-separated string. Any fields not in the list will be excluded from the properties object. This is used to make the response lighter so your application is faster.
country	any Example: country=US ISO 3166 country code consisting of 2 characters. Required if lat/lng are not provided.
source	any Example: source=meta Filter places to only those with a source dataset matching this value.
brand_wikidata	any Example: brand_wikidata=Q12345 Wikidata brand ID associated with the place.
brand_name	any Example: brand_name=Starbucks Brand name associated with the place.
min_confidence	any Default: 0.5 Example: min_confidence=0.5 Minimum confidence score for the places to be returned, defaulting to 0.5 if not provided.
categories	any Example: categories=food,retail Array of category names, provided as a comma-separated string. Matches the legacy Overture categories vocabulary and the newer taxonomy/basic_category vocabulary.
taxonomy	any Example: taxonomy=food_and_drink Array of Overture taxonomy categories, provided as a comma-separated string. Matches the primary category or any ancestor in the taxonomy hierarchy, so e.g. "food_and_drink" matches every descendant category.
operating_status	any Example: operating_status=open Filter by operating status, e.g. "open" or "permanently_closed". Places without signals have a null operating status and are excluded when this filter is used.
enrichment_fields	any Example: enrichment_fields=brand Comma-separated list of enrichment fields to include. Use "brand" for Wikidata-sourced brand details (logo, website, industry, parent) on branded places.
has_contact	any Example: has_contact=website,social Return only places that already have at least one of the listed contact fields. Comma-separated, matched with OR: e.g. "website" returns places with a website; "website,social" returns places with a website OR a social link. Useful for filtering to businesses you can verify. Allowed values: website, phone, email, social.

Responses

Response samples

Content type

application/json

[{"id": "12345",
"type": "Point of Interest",
"geometry": {"type": "Point",
"coordinates": [40.7128,
-74.006
]
},
"properties": {"categories": {"primary": "Retail"
},
"basic_category": "financial_service",
"taxonomy": {"primary": "accountant",
"hierarchy": ["services_and_business",
"financial_service",
"accountant"
],
"alternates": ["string"
]
},
"operating_status": "open",
"confidence": 0.8,
"websites": ["string"
],
"emails": ["string"
],
"socials": ["string"
],
"phones": ["string"
],
"brand": {"names": {"primary": "Central Park",
"common": {"en": "Central Park",
"es": "Parque Central"
},
"rules": [{"variant": "Abbreviation",
"value": "CP"
}
]
},
"wikidata": "Q37158",
"ext_logo_url": "http://commons.wikimedia.org/wiki/Special:FilePath/Starbucks%20coffee%20wordmark.png",
"ext_website": "https://www.starbucks.com/",
"ext_industry": "coffee industry",
"ext_parent": "Starbucks Corporation",
"ext_wikidata_label": "Starbucks"
},
"addresses": [{"id": "12345",
"type": "Address",
"geometry": {"type": "Point",
"coordinates": [40.7128,
-74.006
]
},
"properties": {"country": "string",
"postcode": "string",
"street": "string",
"number": "string",
"unit": "string",
"address_levels": ["string"
],
"postal_city": "string"
}
}
],
"theme": "Restaurant",
"type": "Commercial",
"version": "1",
"sources": [{"property": "OpenStreetMap",
"dataset": "OSM",
"record_id": "osm12345",
"license": "CDLA-Permissive-2.0"
}
],
"names": {"primary": "Central Park",
"common": {"en": "Central Park",
"es": "Parque Central"
},
"rules": [{"variant": "Abbreviation",
"value": "CP"
}
]
},
"ext_name": {"primary": "Central Park",
"common": {"en": "Central Park",
"es": "Parque Central"
},
"rules": [{"variant": "Abbreviation",
"value": "CP"
}
]
},
"ext_brand": { }
},
"enrichment": {"source": "hosted",
"fields": { }
}
}
]

Get Places with their Building shapes using Query params as filters

Authorizations:

API_KEY

query Parameters

lat required	any Example: lat=40.7128 Latitude coordinate. Required if country code is not provided.
lng required	any Example: lng=-74.006 Longitude coordinate. Required if country code is not provided.
radius	number >= 1 Default: 1000 Example: radius=1000 Search radius in meters, defaulting to 1000 meters if not provided.
limit	number >= 1 Default: 1000 Example: limit=10 Limit on the number of results returned, defaulting to 1000 if not provided.
page	number >= 0 Default: 0 Example: page=0 Page number for pagination (0-indexed), used together with `limit` as the page size. Responses include Pagination-Count (total matching results), Pagination-Page and Pagination-Limit headers. Defaults to 0.
format	any Default: "json" Example: format=json Response format, defaulting to JSON. Options are "json", "csv", or "geojson".
includes	any Example: includes=id&includes=geometry&includes=properties Array of fields to include in the properties field of the response, provided as a comma-separated string. Any fields not in the list will be excluded from the properties object. This is used to make the response lighter so your application is faster.
country	any Example: country=US ISO 3166 country code consisting of 2 characters. Required if lat/lng are not provided.
source	any Example: source=meta Filter places to only those with a source dataset matching this value.
brand_wikidata	any Example: brand_wikidata=Q12345 Wikidata brand ID associated with the place.
brand_name	any Example: brand_name=Starbucks Brand name associated with the place.
min_confidence	any Default: 0.5 Example: min_confidence=0.5 Minimum confidence score for the places to be returned, defaulting to 0.5 if not provided.
categories	any Example: categories=food,retail Array of category names, provided as a comma-separated string. Matches the legacy Overture categories vocabulary and the newer taxonomy/basic_category vocabulary.
taxonomy	any Example: taxonomy=food_and_drink Array of Overture taxonomy categories, provided as a comma-separated string. Matches the primary category or any ancestor in the taxonomy hierarchy, so e.g. "food_and_drink" matches every descendant category.
operating_status	any Example: operating_status=open Filter by operating status, e.g. "open" or "permanently_closed". Places without signals have a null operating status and are excluded when this filter is used.
enrichment_fields	any Example: enrichment_fields=brand Comma-separated list of enrichment fields to include. Use "brand" for Wikidata-sourced brand details (logo, website, industry, parent) on branded places.
has_contact	any Example: has_contact=website,social Return only places that already have at least one of the listed contact fields. Comma-separated, matched with OR: e.g. "website" returns places with a website; "website,social" returns places with a website OR a social link. Useful for filtering to businesses you can verify. Allowed values: website, phone, email, social.

Responses

Response samples

Content type

application/json

[{"id": "12345",
"type": "Point of Interest",
"geometry": {"type": "Point",
"coordinates": [40.7128,
-74.006
]
},
"properties": {"categories": {"primary": "Retail"
},
"basic_category": "financial_service",
"taxonomy": {"primary": "accountant",
"hierarchy": ["services_and_business",
"financial_service",
"accountant"
],
"alternates": ["string"
]
},
"operating_status": "open",
"confidence": 0.8,
"websites": ["string"
],
"emails": ["string"
],
"socials": ["string"
],
"phones": ["string"
],
"brand": {"names": {"primary": "Central Park",
"common": {"en": "Central Park",
"es": "Parque Central"
},
"rules": [{"variant": "Abbreviation",
"value": "CP"
}
]
},
"wikidata": "Q37158",
"ext_logo_url": "http://commons.wikimedia.org/wiki/Special:FilePath/Starbucks%20coffee%20wordmark.png",
"ext_website": "https://www.starbucks.com/",
"ext_industry": "coffee industry",
"ext_parent": "Starbucks Corporation",
"ext_wikidata_label": "Starbucks"
},
"addresses": [{"id": "12345",
"type": "Address",
"geometry": {"type": "Point",
"coordinates": [40.7128,
-74.006
]
},
"properties": {"country": "string",
"postcode": "string",
"street": "string",
"number": "string",
"unit": "string",
"address_levels": ["string"
],
"postal_city": "string"
}
}
],
"theme": "Restaurant",
"type": "Commercial",
"version": "1",
"sources": [{"property": "OpenStreetMap",
"dataset": "OSM",
"record_id": "osm12345",
"license": "CDLA-Permissive-2.0"
}
],
"names": {"primary": "Central Park",
"common": {"en": "Central Park",
"es": "Parque Central"
},
"rules": [{"variant": "Abbreviation",
"value": "CP"
}
]
},
"ext_name": {"primary": "Central Park",
"common": {"en": "Central Park",
"es": "Parque Central"
},
"rules": [{"variant": "Abbreviation",
"value": "CP"
}
]
},
"ext_brand": { }
},
"enrichment": {"source": "hosted",
"fields": { }
}
}
]

Get all Brands from Places using Query params as filters

Authorizations:

API_KEY

query Parameters

lat required	any Example: lat=40.7128 Latitude coordinate. Required if country code is not provided.
lng required	any Example: lng=-74.006 Longitude coordinate. Required if country code is not provided.
radius	number >= 1 Default: 1000 Example: radius=1000 Search radius in meters, defaulting to 1000 meters if not provided.
limit	number >= 1 Default: 1000 Example: limit=10 Limit on the number of results returned, defaulting to 1000 if not provided.
page	number >= 0 Default: 0 Example: page=0 Page number for pagination (0-indexed), used together with `limit` as the page size. Responses include Pagination-Count (total matching results), Pagination-Page and Pagination-Limit headers. Defaults to 0.
format	any Default: "json" Example: format=json Response format, defaulting to JSON. Options are "json", "csv", or "geojson".
includes	any Example: includes=id&includes=geometry&includes=properties Array of fields to include in the properties field of the response, provided as a comma-separated string. Any fields not in the list will be excluded from the properties object. This is used to make the response lighter so your application is faster.
country	any Example: country=US ISO 3166 country code consisting of 2 characters. Required if lat/lng are not provided.
categories	any Example: categories=food&categories=retail Array of category names, provided as a comma-separated string.

Responses

Response samples

Content type

application/json

[{"names": {"primary": "Central Park",
"common": {"en": "Central Park",
"es": "Parque Central"
},
"rules": [{"variant": "Abbreviation",
"value": "CP"
}
]
},
"wikidata": "Q37158",
"ext_logo_url": "http://commons.wikimedia.org/wiki/Special:FilePath/Starbucks%20coffee%20wordmark.png",
"ext_website": "https://www.starbucks.com/",
"ext_industry": "coffee industry",
"ext_parent": "Starbucks Corporation",
"ext_wikidata_label": "Starbucks"
}
]

Get all Countries from Places using Query params as filters

Authorizations:

API_KEY

Responses

Response samples

Content type

application/json

[{"country": "US",
"ext_counts": {"places": 100,
"brands": 10
}
}
]

Get all Categories from Places using Query params as filters

Authorizations:

API_KEY

query Parameters

lat required	any Example: lat=40.7128 Latitude coordinate. Required if country code is not provided.
lng required	any Example: lng=-74.006 Longitude coordinate. Required if country code is not provided.
radius	number >= 1 Default: 1000 Example: radius=1000 Search radius in meters, defaulting to 1000 meters if not provided.
limit	number >= 1 Default: 1000 Example: limit=10 Limit on the number of results returned, defaulting to 1000 if not provided.
page	number >= 0 Default: 0 Example: page=0 Page number for pagination (0-indexed), used together with `limit` as the page size. Responses include Pagination-Count (total matching results), Pagination-Page and Pagination-Limit headers. Defaults to 0.
format	any Default: "json" Example: format=json Response format, defaulting to JSON. Options are "json", "csv", or "geojson".
includes	any Example: includes=id&includes=geometry&includes=properties Array of fields to include in the properties field of the response, provided as a comma-separated string. Any fields not in the list will be excluded from the properties object. This is used to make the response lighter so your application is faster.
country	string = 2 characters Example: country=US ISO 3166 country code consisting of 2 characters.

Responses

Response samples

Content type

application/json

[{"primary": "Retail",
"ext_counts": {"places": 100,
"brands": 10
}
}
]

Addresses

Get Addresses using Query params as filters

Authorizations:

API_KEY

query Parameters

lat required	number Example: lat=40.7128 Latitude coordinate. Required if country code is not provided.
lng required	number Example: lng=-74.006 Longitude coordinate. Required if country code is not provided.
radius	number >= 1 Default: 1000 Example: radius=1000 Search radius in meters, defaulting to 1000 meters if not provided.
limit	number >= 1 Default: 1000 Example: limit=10 Limit on the number of results returned, defaulting to 1000 if not provided.
page	number >= 0 Default: 0 Example: page=0 Page number for pagination (0-indexed), used together with `limit` as the page size. Responses include Pagination-Count (total matching results), Pagination-Page and Pagination-Limit headers. Defaults to 0.
format	string Default: "json" Enum: "json" "csv" "geojson" Example: format=json Response format, defaulting to JSON. Options are "json", "csv", or "geojson".
includes	Array of strings Example: includes=id&includes=geometry&includes=properties Array of fields to include in the properties field of the response, provided as a comma-separated string. Any fields not in the list will be excluded from the properties object. This is used to make the response lighter so your application is faster.
country	string Example: country=US ISO 3166 country code consisting of 2 characters. Required if lat/lng are not provided.

Responses

Response samples

Content type

application/json

[{"id": "12345",
"type": "Address",
"geometry": {"type": "Point",
"coordinates": [40.7128,
-74.006
]
},
"properties": {"country": "string",
"postcode": "string",
"street": "string",
"number": "string",
"unit": "string",
"address_levels": ["string"
],
"postal_city": "string"
}
}
]

Base

Get Base features using Query params as filters

Authorizations:

API_KEY

query Parameters

lat required	number Example: lat=40.7128 Latitude coordinate. Required if country code is not provided.
lng required	number Example: lng=-74.006 Longitude coordinate. Required if country code is not provided.
radius	number >= 1 Default: 1000 Example: radius=1000 Search radius in meters, defaulting to 1000 meters if not provided.
limit	number >= 1 Default: 1000 Example: limit=10 Limit on the number of results returned, defaulting to 1000 if not provided.
page	number >= 0 Default: 0 Example: page=0 Page number for pagination (0-indexed), used together with `limit` as the page size. Responses include Pagination-Count (total matching results), Pagination-Page and Pagination-Limit headers. Defaults to 0.
format	string Default: "json" Enum: "json" "csv" "geojson" Example: format=json Response format, defaulting to JSON. Options are "json", "csv", or "geojson".
includes	Array of strings Example: includes=id&includes=geometry&includes=properties Array of fields to include in the properties field of the response, provided as a comma-separated string. Any fields not in the list will be excluded from the properties object. This is used to make the response lighter so your application is faster.
country	string Example: country=US ISO 3166 country code consisting of 2 characters. Required if lat/lng are not provided.

Responses

Response samples

Content type

application/json

[{"id": "12345",
"type": "landUse",
"geometry": {"type": "Point",
"coordinates": [40.7128,
-74.006
]
},
"properties": {"subtype": "string",
"class": "string"
}
}
]

Transportation

Get Transportation segments using Query params as filters

Authorizations:

API_KEY

query Parameters

lat required	number Example: lat=40.7128 Latitude coordinate. Required if country code is not provided.
lng required	number Example: lng=-74.006 Longitude coordinate. Required if country code is not provided.
radius	number >= 1 Default: 1000 Example: radius=1000 Search radius in meters, defaulting to 1000 meters if not provided.
limit	number >= 1 Default: 1000 Example: limit=10 Limit on the number of results returned, defaulting to 1000 if not provided.
page	number >= 0 Default: 0 Example: page=0 Page number for pagination (0-indexed), used together with `limit` as the page size. Responses include Pagination-Count (total matching results), Pagination-Page and Pagination-Limit headers. Defaults to 0.
format	string Default: "json" Enum: "json" "csv" "geojson" Example: format=json Response format, defaulting to JSON. Options are "json", "csv", or "geojson".
includes	Array of strings Example: includes=id&includes=geometry&includes=properties Array of fields to include in the properties field of the response, provided as a comma-separated string. Any fields not in the list will be excluded from the properties object. This is used to make the response lighter so your application is faster.
country	string Example: country=US ISO 3166 country code consisting of 2 characters. Required if lat/lng are not provided.

Responses

Response samples

Content type

application/json

[{"id": "12345",
"type": "Feature",
"geometry": {"type": "Point",
"coordinates": [40.7128,
-74.006
]
},
"properties": {"subtype": "string",
"class": "string",
"subclass": "string",
"names": { },
"connectors": ["string"
],
"routes": ["string"
],
"subclass_rules": ["string"
],
"access_restrictions": ["string"
],
"level_rules": ["string"
],
"destinations": ["string"
],
"prohibited_transitions": ["string"
],
"road_surface": ["string"
],
"road_flags": ["string"
],
"speed_limits": ["string"
],
"width_rules": ["string"
],
"rail_flags": ["string"
]
}
}
]

Divisions

Get Division areas using Query params as filters

Authorizations:

API_KEY

query Parameters

lat	number Example: lat=40.7128 Latitude coordinate. Required if no country, name or bbox filter is provided.
lng	number Example: lng=-74.006 Longitude coordinate. Required if no country, name or bbox filter is provided.
radius	number >= 1 Default: 1000 Example: radius=1000 Search radius in meters, defaulting to 1000 meters if not provided.
limit	number >= 1 Default: 1000 Example: limit=10 Limit on the number of results returned, defaulting to 1000 if not provided.
page	number >= 0 Default: 0 Example: page=0 Page number for pagination (0-indexed), used together with `limit` as the page size. Responses include Pagination-Count (total matching results), Pagination-Page and Pagination-Limit headers. Defaults to 0.
format	string Default: "json" Enum: "json" "csv" "geojson" Example: format=json Response format, defaulting to JSON. Options are "json", "csv", or "geojson".
includes	Array of strings Example: includes=id&includes=geometry&includes=properties Array of fields to include in the properties field of the response, provided as a comma-separated string. Any fields not in the list will be excluded from the properties object. This is used to make the response lighter so your application is faster.
country	string Example: country=US ISO 3166 country code consisting of 2 characters. Required if lat/lng are not provided.
name	string Example: name=westminster Case-insensitive substring match against the division primary name and English common name. Also matches an exact division ID.
subtype	Array of strings Example: subtype=county,locality Filter by division subtype, provided as a comma-separated list (e.g. "county,locality").
admin_level	string Example: admin_level=2 Filter by admin_level — the division's position in its country's hierarchy (0 = country). Provided as a comma-separated list (e.g. "1,2").
bbox	string Example: bbox=-74.3,40.5,-73.7,40.9 Bounding box filter as "xmin,ymin,xmax,ymax" (lng/lat order). Returns divisions whose bounding box intersects it.
include_geometry	boolean Example: include_geometry=false Whether to include the full polygon geometry in each result. Defaults to false for name searches (fetch geometry via GET /divisions/{id}) and true otherwise. Division polygons can be megabytes each, so leave this off for search boxes.

Responses

Response samples

Content type

application/json

[{"id": "12345",
"type": "division_area",
"bbox": {"xmin": -74.3,
"xmax": -73.7,
"ymin": 40.5,
"ymax": 40.9
},
"geometry": {"type": "Point",
"coordinates": [40.7128,
-74.006
]
},
"properties": {"subtype": "string",
"class": "string",
"primary_name": "City of Westminster",
"names": { },
"country": "GB",
"region": "GB-WSM",
"admin_level": 2,
"is_land": true,
"is_territorial": false,
"division_id": "string",
"ext_geometry_source": "maritime"
}
}
]

Get a single Division area by ID, including its full polygon geometry

Authorizations:

API_KEY

path Parameters

required

string

Example: 0850b45bffffffff01c3320da9d5f43d

Overture division area ID

Responses

Response samples

Content type

application/json

{"id": "12345",
"type": "division_area",
"bbox": {"xmin": -74.3,
"xmax": -73.7,
"ymin": 40.5,
"ymax": 40.9
},
"geometry": {"type": "Point",
"coordinates": [40.7128,
-74.006
]
},
"properties": {"subtype": "string",
"class": "string",
"primary_name": "City of Westminster",
"names": { },
"country": "GB",
"region": "GB-WSM",
"admin_level": 2,
"is_land": true,
"is_territorial": false,
"division_id": "string",
"ext_geometry_source": "maritime"
}
}