Map a website
Synchronously lists the URLs of one website by following its links from a
starting page, optionally only the paths that match select_paths. Use it to
find the right pages inside a site, then read them with POST /v1/web/read
instead of guessing URLs with search. Billed per URL returned, so a call that
finds none costs nothing. Prices are in the
billing section.
Unknown request fields and path expressions that do not compile are rejected
with 400. The same operation is the data:web.map capability of
POST /v1/capabilities/run and the web_map tool of the BeatAPI MCP endpoint.
Authentication
Send your API key as Authorization: Bearer <BEATAPI_API_KEY>.
Headers
Request
The page to start from. It must be a public http or https URL without a
user name or password, and not localhost or a private-network IP address.
Regular expressions over the URL path, such as /docs/.*. Only matching
URLs are listed. An expression that does not compile is rejected with 400.
Response
URLs found from the starting page, without duplicates and at most limit.
Present only when urls is empty, saying what to try next (an empty map is not charged).
What this call was charged, in US dollars. The same object a social-data call answers with.