Skip to content

Commit 2ab2a90

Browse files
committed
Merge branch 'master' of github.com:teambtcmap/btcmap-api
2 parents 370da06 + 8316e96 commit 2ab2a90

1 file changed

Lines changed: 57 additions & 1 deletion

File tree

docs/rest/v4/places.md

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,11 @@ curl 'https://api.btcmap.org/v4/places/5005?fields=id,name,phone,website'
261261

262262
### Fetch Place Comments
263263

264-
This is equivalent of filtering the `/place-comments` endpoint by `place_id`.
264+
Retrieves comments for a specific place by its ID. It supports both BTC Map numerical IDs and OSM IDs (`element_type:id`).
265+
266+
```
267+
curl https://api.btcmap.org/v4/places/{id}/comments
268+
```
265269

266270
#### Examples
267271

@@ -290,3 +294,55 @@ curl GET https://api.btcmap.org/v4/places/22923/comments
290294
}
291295
]
292296
```
297+
298+
### Fetch Place Areas
299+
300+
Retrieves Areas for a specific place by its ID. It supports both BTC Map numerical IDs and OSM IDs (`element_type:id`).
301+
302+
```
303+
curl https://api.btcmap.org/v4/places/{id}/areas
304+
```
305+
306+
#### Path Parameters
307+
308+
| Parameter | Type | Example | Default | Description |
309+
|-----------|------|---------|---------|-------------|
310+
| `id` | String | `5` or `node:28` | - | **Required**. |
311+
| `type` | String | `community` or `country` | All | Use either `country` or `community`. Absence of parameter will return all areas of all types. |
312+
313+
#### Examples
314+
315+
##### Get Community Areas for a Place ID 120
316+
317+
```bash
318+
curl GET https://api.btcmap.org/v4/places/120/areas?type=community
319+
```
320+
321+
```json
322+
[
323+
{
324+
"id": 120,
325+
"alias": "bitcoin-manchester",
326+
"tags":
327+
{
328+
"type": "community",
329+
"name": "Bitcoin Manchester",
330+
"icon:square": "https://static.btcmap.org/images/areas/120.png",
331+
"continent": "europe",
332+
"contact:twitter": "https://twitter.com/bitcoin_mcr",
333+
"contact:email": "hello@bitcoinmanchester.org.uk",
334+
"contact:telegram": "https://t.me/bitcoinmcr",
335+
"contact:meetup": "https://www.meetup.com/bitcoin-manchester/",
336+
"verified:date": "2026-01-06",
337+
"population": 2812568,
338+
"population:date": "2021-01-01",
339+
"url_alias": "bitcoin-manchester",
340+
"area_km2": 1644.48,
341+
"contact:nostr": "npub1w2d0xngltuu86yn0jfak23sty9xwnu6kwudswpdrhtxydwnhjslq60jesu",
342+
"contact:website": "http://www.bitcoinmanchester.org.uk/"
343+
},
344+
"created_at": "2023-01-10T13:35:53Z",
345+
"updated_at": "2026-02-10T12:25:23.64Z"
346+
}
347+
]
348+
```

0 commit comments

Comments
 (0)