Galon Cloud
Galon API v1

/search/v2/map

Base URL https://api.galon.ai/v1 · export GALON_API_BASE="https://api.galon.ai/v1"

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

FieldTypeDescription
urlstring · required
searchstringAddresses that contain this text come first.
limitintegerValues above 1000 are capped (warning map_limit_capped).
includeSubdomainsboolean
ignoreSitemapboolean
sitemapOnlyboolean
sitemap"include" | "skip" | "only"
timeoutinteger
ignoreQueryParametersboolean

Responses

StatusDescriptionBody
200The addresses foundCrawlMapResponse
400body_invalid, field_unknown, field_invalid, url_invalid, url_blocked, option_unsupported, robots_disallowed, robots_unreachableCrawlError
401api_key_missing, api_key_invalidCrawlError
403scope_missing (search:query)CrawlError
404not_foundCrawlError
429rate_limited, daily_limit_reached, quota_exceeded, tenant_quota_exceededCrawlError
503search_unavailable, executor_unavailableCrawlError

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"})