Skip to main content
API docs by Redocly

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.

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.

Responses

Places

Get Places using Query params as filters

Authorizations:
API_KEY
query Parameters
required
object (GetPlacesDto)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Places with their Building shapes using Query params as filters

Authorizations:
API_KEY
query Parameters
required
object (GetPlacesWithBuildingsDto)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all Brands from Places using Query params as filters

Authorizations:
API_KEY
query Parameters
required
object (GetBrandsDto)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all Countries from Places using Query params as filters

Authorizations:
API_KEY

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all Categories from Places using Query params as filters

Authorizations:
API_KEY
query Parameters
required
object (GetCategoriesDto)

Responses

Response samples

Content type
application/json
[
  • {
    }
]