wehub-resource-sync
6ede33ccdb
Build and Push Docker Images / create_manifest (web, surfsense-web, , cpu) (push) Has been cancelled
Build and Push Docker Images / finalize_release (push) Has been cancelled
Obsidian Plugin Lint / lint (push) Has been cancelled
Build and Push Docker Images / build (./surfsense_web, cpu, ./surfsense_web/Dockerfile, web, surfsense-web, ubuntu-24.04-arm, linux/arm64, arm64, , runner, false, cpu) (push) Has been cancelled
Build and Push Docker Images / build (./surfsense_web, cpu, ./surfsense_web/Dockerfile, web, surfsense-web, ubuntu-latest, linux/amd64, amd64, , runner, false, cpu) (push) Has been cancelled
Build and Push Docker Images / compute_version (push) Has been cancelled
Build and Push Docker Images / build (./surfsense_backend, cpu, ./surfsense_backend/Dockerfile, backend, surfsense-backend, ubuntu-24.04-arm, linux/arm64, arm64, , production, false, cpu) (push) Has been cancelled
Build and Push Docker Images / build (./surfsense_backend, cpu, ./surfsense_backend/Dockerfile, backend, surfsense-backend, ubuntu-latest, linux/amd64, amd64, , production, false, cpu) (push) Has been cancelled
Build and Push Docker Images / build (./surfsense_backend, cu126, ./surfsense_backend/Dockerfile, backend, surfsense-backend, ubuntu-24.04-arm, linux/arm64, arm64, -cuda126, production, true, cuda126) (push) Has been cancelled
Build and Push Docker Images / build (./surfsense_backend, cu126, ./surfsense_backend/Dockerfile, backend, surfsense-backend, ubuntu-latest, linux/amd64, amd64, -cuda126, production, true, cuda126) (push) Has been cancelled
Build and Push Docker Images / build (./surfsense_backend, cu128, ./surfsense_backend/Dockerfile, backend, surfsense-backend, ubuntu-24.04-arm, linux/arm64, arm64, -cuda, production, true, cuda) (push) Has been cancelled
Build and Push Docker Images / build (./surfsense_backend, cu128, ./surfsense_backend/Dockerfile, backend, surfsense-backend, ubuntu-latest, linux/amd64, amd64, -cuda, production, true, cuda) (push) Has been cancelled
Build and Push Docker Images / verify_digests (push) Has been cancelled
Build and Push Docker Images / create_manifest (backend, surfsense-backend, , cpu) (push) Has been cancelled
Build and Push Docker Images / create_manifest (backend, surfsense-backend, -cuda, cuda) (push) Has been cancelled
Build and Push Docker Images / create_manifest (backend, surfsense-backend, -cuda126, cuda126) (push) Has been cancelled
65 lines
2.5 KiB
Plaintext
65 lines
2.5 KiB
Plaintext
---
|
|
title: Google Maps
|
|
description: Scrape public Google Maps places and reviews
|
|
---
|
|
|
|
The Google Maps scraper has two verbs: **scrape** for place data and **reviews** for a place's review feed.
|
|
|
|
## Scrape places
|
|
|
|
```bash
|
|
POST /api/v1/workspaces/{workspace_id}/scrapers/google_maps/scrape
|
|
```
|
|
|
|
Give it search queries (optionally scoped by location), Google Maps URLs, or place IDs. Returns structured place items — name, address, category, phone, website, rating, review count, coordinates, and opening hours.
|
|
|
|
At least one of `search_queries`, `urls`, or `place_ids` is required.
|
|
|
|
| Field | Default | Description |
|
|
|-------|---------|-------------|
|
|
| `search_queries` | — | Search terms, e.g. `"coffee shops"` (max 20 sources per call, combined with URLs and place IDs) |
|
|
| `urls` | — | Place page (`/maps/place/...`) or search-results URLs |
|
|
| `place_ids` | — | Known Google place IDs (`ChIJ...`) |
|
|
| `location` | — | Scope for search queries, e.g. `"New York, USA"` |
|
|
| `max_places` | `10` | Max places per search query (max 1000) |
|
|
| `include_details` | `false` | Also fetch each place's detail page: opening hours, popular times, extra contact info (slower) |
|
|
| `max_reviews` | `0` | Reviews to attach per place |
|
|
| `max_images` | `0` | Images to attach per place |
|
|
| `language` | `en` | Result language code |
|
|
|
|
```bash
|
|
curl -X POST "$BASE_URL/api/v1/workspaces/1/scrapers/google_maps/scrape" \
|
|
-H "Authorization: Bearer $SURFSENSE_API_KEY" \
|
|
-H "Content-Type: application/json" \
|
|
-d '{
|
|
"search_queries": ["specialty coffee"],
|
|
"location": "Amsterdam, Netherlands",
|
|
"max_places": 20,
|
|
"include_details": true
|
|
}'
|
|
```
|
|
|
|
This verb is dual-metered: billed per returned place, plus per attached review when `max_reviews > 0`.
|
|
|
|
## Fetch reviews
|
|
|
|
```bash
|
|
POST /api/v1/workspaces/{workspace_id}/scrapers/google_maps/reviews
|
|
```
|
|
|
|
Give it place URLs or place IDs; returns review items with author, text, star rating, like count, owner response, and timestamps.
|
|
|
|
At least one of `urls` or `place_ids` is required.
|
|
|
|
| Field | Default | Description |
|
|
|-------|---------|-------------|
|
|
| `urls` / `place_ids` | — | Up to 20 places per call |
|
|
| `max_reviews` | `20` | Max reviews per place (max 100,000) |
|
|
| `sort_by` | `newest` | `newest`, `mostRelevant`, `highestRanking`, or `lowestRanking` |
|
|
| `start_date` | — | Only reviews on/after this ISO date |
|
|
| `language` | `en` | Review language code |
|
|
|
|
Billing is per returned review.
|
|
|
|
For the full input and output JSON schemas and generated code snippets in your language, open **API Playground → Google Maps** in your workspace.
|