Skip to main content
POST
web.sitemap.parse

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
url
string
required

Address of the sitemap.

Response

The result

url
string
required

Url link.

sampleUrls
object[]

Sample urls.

totalUrls
number

Total urls: how many.

topPathSegments
object[]

Top path segments.

hasChangefreq
boolean

True when changefreq.

hasLastmod
boolean

True when lastmod.

hasPriority
boolean

True when priority.

newestLastmod
string

Newest lastmod, ISO 8601.

oldestLastmod
string

Oldest lastmod, ISO 8601.

type
string

Type.