POST /search/v2/map
List a site's page addresses
Lists the addresses of a site's pages from its sitemaps and the links of the start page, without reading their content. `search` keeps the addresses that contain a text first. Limit above 1000 is capped and said in `warning`. One call is counted.
API key (Bearer), on the public API endpoint.
Request body
application/json · schema CrawlMapRequest
| Field | Type | Description |
|---|---|---|
url | string · required | |
search | string | Addresses that contain this text come first. |
limit | integer | Values above 1000 are capped (warning map_limit_capped). |
includeSubdomains | boolean | |
ignoreSitemap | boolean | |
sitemapOnly | boolean | |
sitemap | "include" | "skip" | "only" | |
timeout | integer | |
ignoreQueryParameters | boolean |
Responses
| Status | Description | Body |
|---|---|---|
200 | The addresses found | CrawlMapResponse |
400 | body_invalid, field_unknown, field_invalid, url_invalid, url_blocked, option_unsupported, robots_disallowed, robots_unreachable | CrawlError |
401 | api_key_missing, api_key_invalid | CrawlError |
403 | scope_missing (search:query) | CrawlError |
404 | not_found | CrawlError |
429 | rate_limited, daily_limit_reached, quota_exceeded, tenant_quota_exceeded | CrawlError |
503 | search_unavailable, executor_unavailable | CrawlError |
Examples
curl
curl -X POST "$GALON_API_BASE/search/v2/map" \
-H "Authorization: Bearer $GALON_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url": "string"}'Node.js (SDK)
import { Galon } from "galon";
const galon = new Galon(process.env.GALON_API_KEY);
const result = await galon.search.map({"url": "string"});Python (SDK)
from galon import Galon
galon = Galon() # reads GALON_API_KEY
result = galon.search.map({"url": "string"})