SDK ReferencePython SDK

Sitemap

API functions for the Sitemap resource.

Sitemap

Functions for interacting with the sitemap API resource. Each operation ships in four forms — sync / sync_detailed and their async counterparts.

Create Sitemap

Discover URLs on a domain

Crawls a domain to build a sitemap. Returns cached results if available within cache_ttl. Results delivered via webhook and downloadable from results_url.

Parameters

  • body (SitemapRequest)

Call styles

sync_detailed(client, body) -> Response[SitemapResponse]
sync(client, body) -> SitemapResponse | None
await asyncio_detailed(client, body) -> Response[SitemapResponse]
await asyncio(client, body) -> SitemapResponse | None

Get Sitemap

Get sitemap job status

Parameters

  • id (str)

Call styles

sync_detailed(id, client) -> Response[Error | SitemapResponse]
sync(id, client) -> Error | SitemapResponse | None
await asyncio_detailed(id, client) -> Response[Error | SitemapResponse]
await asyncio(id, client) -> Error | SitemapResponse | None