Place Details API

The Place Details API allows getting information about the place, place geometry, and surroundings. The API lets you get information by place ID returned by Geoapify Places API or Geoapify Geocoding API as well as request information by coordinates.

In addition, the API works in conjunction with the Isolines API, so for example, you can get all of the amenities reachable from a given place and then use this information to make analytic suggestions about the location.

• Authentication and Geocoding API key
• API reference: inputes
• APi reference: outputs
• Code samples
• Pricing

Authentication and API key

To use the API, you'll need an API key. But don't worry! You can register and get a Place Details API key for free without a credit card. Our free plan includes up to 3000 requests/day. For more information on our plans, visit the Pricing page.

How to get Place Details API key

1. Register on Geoapify MyProjects page
2. Create a new project.
3. Go to the API Keys section. One API key is generated automatically. You can generate multiple API keys per project if required.
4. Optionally, you can protect the API key by listing allowed IP addresses, HTTP referrers, origins, and CORS.
5. Choose "Place Details API" and an API key to get an URL and programming code.
6. Press the "Try" button to execute the API call and get the result object.

API Reference: Inputs

The API is used to query additional information about the place or location. Together with information the result may contain place geometry (for example, building geometry) and records about place surroundings. The API is implemented via HTTP Get request.

API URL

https://api.geoapify.com/v2/place-details?PARAMS

Request parameters

Supported Features

You can request one or multiple features per Place Details API request. Note! When "features" parameter is not specified for a request with a place id, the "details" feature is returned by default.

API Reference: Outputs

The response returned contains a GeoJSON FeatureCollection object. Features may have different Geometry types - Point, LineString, Polygon, MultiPoint, MultiLineString, MultiPolygon.

Response Object

Depending on feature type features may have different properties objects. Each feature has the following properties that allow identifying the feature:

Feature property structure varies by feature type. Here are the three features structures supported by this API: Details feature, Place feature, and Geometry feature. Please see the table above for the feature type returned for each feature.

Details feature specification

The "details" feature contains all the data available about the place, like contact information, wiki references, and others. Furthermore, the geometry object of the feature contains the place geometry if it has one. It's building geometry for buildings, boundaries for parks, and so on.

General properties

Contact information properties

Facilities properties

Restriction properties

Special for a category

Accommodation properties

Catering properties

Parking properties

Airport properties

Building properties

Place of worship properties

Commercial properties

Historic places properties

Artwork objects properties

Heritage objects properties

Wiki and media properties

Address properties

If the place has an address the feature properties contains address components as well:

Timezone properties

Information about timezone the place belongs to.

Note! The data returned by the API only if it's present in the OpenStreetMap database. We provide the data as it is after some cleanup and formating. All the data of the OSM database is added by OSM contributors and some parts of it might be incorrect or outdated.

Place Feature specification

Geometry feature specification

The following properties are common for Geometry Features

Code samples

Extract required features

The Place Details API returns a GeoJSON FeatureCollection object as the result. The FeatureCollection contains all the requested features.

Every feature has a "feature_type" property that lets you identify which Place Details API feature the object relates to. Note, that depending on the feature it could be one or more objects of the same feature type:

// only one feature of "details" type, which is a GeoJSON Feature object
const detailsFeature = result.features.find(feature => feature.properties.feature_type === 'details');

// array of the features of "radius_500.supermarket" type
const radius500Supermarkets = result.features
  .filter(feature => feature.properties.feature_type === 'radius_500.supermarket');

// create a GeoJSON FeatureCollection object from an array of GeoJSON Feature to visualize it
const radius500SupermarketsGeoJSON = `{
  "type": "FeatureCollection",
  "features": ${radius500Supermarkets}
}`

Visualize features

GeoJSON objects are supported by most client map libraries.

Here are a few examples how to display GeoJSON Layers with MapLibre GL / Mapbox GL:

// remove previourly added layers and source:
if (this.map.getSource(this.placeLayerId)) {
    if (this.map.getLayer(this.placeLayerId + '-point')) {
        this.map.removeLayer(this.placeLayerId + '-point');
    }

    if (this.map.getLayer(this.placeLayerId + '-line')) {
      this.map.removeLayer(this.placeLayerId + '-line');
    }

    if (this.map.getLayer(this.placeLayerId + '-poly')) {
      this.map.removeLayer(this.placeLayerId + '-poly');
    }

    this.map.removeSource(this.placeLayerId);
}

// add new GeoJSON source
this.map.addSource(this.placeLayerId, {
    type: 'geojson', data: geojson
});

// add layers for the GeoJSON source

// 1. Layer to visualize Points
this.map.addLayer({
    'id': this.placeLayerId + '-point',
    'type': 'circle',
    'source': this.placeLayerId,
    'paint': {
        "circle-radius": 10,
        'circle-color': "#bf4080",
        'circle-opacity': 0.7,
        "circle-blur": 0
    },
    'filter': ['==', '$type', 'Point']
});

// 2. Layer to visualize LineStrings and MultiLineStrings
this.map.addLayer({
    'id': this.placeLayerId + '-line',
    'type': 'line',
    'source': this.placeLayerId,
    'paint': {
        'line-color': "#bf4080"
    },
    'filter': ['==', '$type', 'LineString']
});

// 3. Layer to visualize Polygons and Multipolygons
this.map.addLayer({
    'id': this.placeLayerId + '-poly',
    'type': 'fill',
    'source': this.placeLayerId,
    'paint': {
        'fill-color': "#333399",
        'fill-opacity': 0.2
    },
    'filter': ['==', '$type', 'Polygon']
});

Pricing

We have a simple pricing structure, and you can get a rough idea of how much it'll cost from the number of credits per API call.

We have a range of Pricing Plans to suit your API usage needs. Start with our Free Plan (with 3000 credits per day included) and upgrade any time.

A Place Details API request cost depends on the features requested:

• The request with empty "features" parameter returns the "details" feature.
• The requested features costs are accumulated to the total request cost.
• All places per isoline features ("walk_5.supermarket", "drive_5.charging_station") add corresponding isoline features to the responce.

Place Details API cost example

Let's calculate the cost of the following API call:

https://api.geoapify.com/v2/place-details?
  id=5132009123fa5a244059c72f70125fb04840f00102f9014496730800000000
  &features=details,building,
    radius_500,radius_500.supermarket,radius_500.atm,radius_500.restaurant,
    walk_10,walk_10.supermarket,walk_10.atm,walk_10.restaurant,walk_10.playground,
    drive_5,drive_5.supermarket,drive_5.shopping_mall,drive_5.fuel,drive_5.charging_station,drive_5.parking&apiKey=YOUR_API_KEY

API call cost by features:

In total, the Place Details API request costs 20 credits.