Returns a site’s URLs, most useful first, without fetching the pages.1 credit. Failed requests are never charged.
Guide: Map a site
Ordering, search, sources, scope and examples.
Authorizations
X-API-Key
string
header
required
Your Prefetch API key. Obtain one from the dashboard.
Query Parameters
url
string
required
The website URL to process. https:// is prepended automatically if no protocol is provided.
Example:
"https://stripe.com"
limit
integer
default:1000
Maximum number of links to return.
Required range: 1 <= x <= 5000
search
string
Rank and filter results by relevance to this query. Links that match nothing are dropped.
Example:
"pricing"
sitemap
enum<string>
default:include
Which sources to use. include merges sitemap entries with on-page links, skip uses on-page links only, only uses sitemaps only.
Available options:
include,
skip,
only
include_subdomains
boolean
default:true
Include links on subdomains of the target.
ignore_query_params
boolean
default:true
Treat URLs that differ only by query string as one page.
Response
Links discovered.
success
enum<boolean>
required
Available options:
true
data
object
required
Show child attributes
meta
object
required
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Prefetch API","colors":{"primary":"#8A5A00","light":"#F7B00A","dark":"#F7B00A"},"logo":{"light":"https://mintcdn.com/prefetch/0cLjeQZN2Dy6gN5Q/logo/light.svg?fit=max\u0026auto=format\u0026n=0cLjeQZN2Dy6gN5Q\u0026q=85\u0026s=7b9ea0ec7c23b929ff607e56c0de9713","dark":"https://mintcdn.com/prefetch/0cLjeQZN2Dy6gN5Q/logo/dark.svg?fit=max\u0026auto=format\u0026n=0cLjeQZN2Dy6gN5Q\u0026q=85\u0026s=e97e8b6432d524163f934bd09b638763"},"favicon":"https://mintcdn.com/prefetch/qKlLmXxc4XUEOZI9/images/favicon.svg?fit=max\u0026auto=format\u0026n=qKlLmXxc4XUEOZI9\u0026q=85\u0026s=68c45014cec0f875b327e5b42e450b3c","appearance":{"default":"dark","strict":false},"background":{"color":{"light":"#FCFBF6","dark":"#1A0618"}},"navbar":{"links":[{"href":"https://prefetch.io/#pricing-section","label":"Pricing"},{"href":"https://prefetch.betteruptime.com/","label":"Status"},{"href":"mailto:[email protected]","label":"Support"},{"href":"https://prefetch.io/dashboard","label":"Dashboard"}],"primary":{"type":"button","label":"Get API key","href":"https://prefetch.io/account"}},"footer":{"links":[{"header":"Product","items":[{"label":"Website","href":"https://prefetch.io"},{"label":"Brand catalog","href":"https://prefetch.io/brands"},{"label":"Pricing","href":"https://prefetch.io/"},{"label":"Status","href":"https://prefetch.betteruptime.com/"},{"label":"Dashboard","href":"https://prefetch.io/dashboard"}]},{"header":"Docs","items":[{"label":"Quickstart","href":"/quickstart"},{"label":"Recipes","href":"/recipes/overview"},{"label":"Compare","href":"/compare/overview"},{"label":"API reference","href":"/api-reference/introduction"},{"label":"MCP server","href":"/mcp/overview"},{"label":"Changelog","href":"/changelog"}]},{"header":"Company","items":[{"label":"Book a demo","href":"https://cal.com/nestoras.design"},{"label":"Contact","href":"mailto:[email protected]"},{"label":"Security","href":"/concepts/security"},{"label":"Privacy","href":"https://prefetch.io/privacy"},{"label":"Terms","href":"https://prefetch.io/terms"}]}]},"fonts":{"heading":{"family":"Space Grotesk"},"body":{"family":"Inter"}},"styling":{"codeblocks":{"theme":"css-variables"},"latex":true},"integrations":{"ga4":{"measurementId":"G-GVKTFNYJ7B"}},"contextual":{"options":["copy","view","claude","chatgpt","perplexity","cursor","vscode"],"display":"header"},"thumbnails":{"appearance":"dark","background":"https://mintcdn.com/prefetch/0cLjeQZN2Dy6gN5Q/images/og-background.png?fit=max\u0026auto=format\u0026n=0cLjeQZN2Dy6gN5Q\u0026q=85\u0026s=cff58baad899de3384c86485eb291dad","fonts":{"family":"Space Grotesk"}},"navigation":{"global":{},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"prefetch","hasAudioNarration":false,"actualSubdomain":"prefetch","customDomains":["docs.prefetch.io"],"gitSource":{"type":"github","owner":"trelobarbouni18","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6aebd7f575e8c030b49a1953","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"API reference","count":38},{"language":"default","tag":"Docs","count":37},{"language":"default","tag":"Monitors","count":17},{"language":"default","tag":"Recipes","count":14},{"language":"default","tag":"Company data","count":13},{"language":"default","tag":"Integrations","count":12},{"language":"default","tag":"Web data","count":10},{"language":"default","tag":"Batches","count":8},{"language":"default","tag":"Jobs and monitoring","count":8},{"language":"default","tag":"Platform","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"custom.css","href":"/_mintlify/custom/prefetch/d2542fa30758caf7/custom.css"}],"page":{"pagePath":"api-reference/endpoint/map","slug":"/api-reference/endpoint/map","pageMetadata":{"title":"GET /map","sidebarTitle":"Map","description":"List every URL a site exposes, from its sitemaps and on-page links. 1 credit.","openapi":"GET /map","href":"/api-reference/endpoint/map"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"List every URL a site exposes, from its sitemaps and on-page links. 1 credit.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Card}=_components;if(!Card)_missingMdxReference(`Card`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Returns a site’s URLs, most useful first, without fetching the pages.`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`1 credit.`}),` Failed requests are never charged.`]}),`\n`,_jsx(Card,{title:`Guide: Map a site`,icon:`https://mintcdn.com/prefetch/Ob8l2tkuj_5KxjuQ/icons/book-open.svg?fit=max\u0026auto=format\u0026n=Ob8l2tkuj_5KxjuQ\u0026q=85\u0026s=83997c50bbffa6f63d021644f36e0d2f`,href:`/web-data/map`,\"data-og-width\":`24`,width:`24`,\"data-og-height\":`24`,height:`24`,\"data-path\":`icons/book-open.svg`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/prefetch/Ob8l2tkuj_5KxjuQ/icons/book-open.svg?w=280\u0026fit=max\u0026auto=format\u0026n=Ob8l2tkuj_5KxjuQ\u0026q=85\u0026s=571e9341106e7a820dfbdc82f1fa7848 280w, https://mintcdn.com/prefetch/Ob8l2tkuj_5KxjuQ/icons/book-open.svg?w=560\u0026fit=max\u0026auto=format\u0026n=Ob8l2tkuj_5KxjuQ\u0026q=85\u0026s=89b208a6ebed2801c21d3b334602f655 560w, https://mintcdn.com/prefetch/Ob8l2tkuj_5KxjuQ/icons/book-open.svg?w=840\u0026fit=max\u0026auto=format\u0026n=Ob8l2tkuj_5KxjuQ\u0026q=85\u0026s=cad73ea82dc28ca477d6c58a9dba2701 840w, https://mintcdn.com/prefetch/Ob8l2tkuj_5KxjuQ/icons/book-open.svg?w=1100\u0026fit=max\u0026auto=format\u0026n=Ob8l2tkuj_5KxjuQ\u0026q=85\u0026s=a756acb5854c82807bee8e5b6fdf40a4 1100w, https://mintcdn.com/prefetch/Ob8l2tkuj_5KxjuQ/icons/book-open.svg?w=1650\u0026fit=max\u0026auto=format\u0026n=Ob8l2tkuj_5KxjuQ\u0026q=85\u0026s=5c188516dd5cf7d2e4e7d1b0f4fd00a6 1650w, https://mintcdn.com/prefetch/Ob8l2tkuj_5KxjuQ/icons/book-open.svg?w=2500\u0026fit=max\u0026auto=format\u0026n=Ob8l2tkuj_5KxjuQ\u0026q=85\u0026s=58b15848f6396e16701ae55f8da4103c 2500w`,children:_jsx(_components.p,{children:`Ordering, search, sources, scope and examples.`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{"theme":"css-variables"},"config":{},"pageMetadata":{"title":"GET /map","sidebarTitle":"Map","description":"List every URL a site exposes, from its sitemaps and on-page links. 1 credit.","openapi":"GET /map","href":"/api-reference/endpoint/map"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"mapSite","summary":"Map a site's URLs","description":"List every URL a site exposes, from its sitemaps and on-page links. 1 credit.","tags":["Endpoints"],"parameters":["dba57e8e-505a-475a-85cb-3b1e18c9db7e","09cfa3fa-67c4-4b1f-b741-48245bf0f618","b0140879-f5ec-40cc-89c9-952aa05e62e0","49e4bc13-17a4-4276-a744-7dddc0b2461a","70a84d6b-d60b-4a63-b80d-66dd1411b359","46882946-8dee-41b7-9fff-df0fa2842bb8"],"responses":{"200":"ca730fc0-8968-423b-b8b3-30c9201d3489","400":"55476830-a99b-46a3-94af-6c1564a4c1f1","401":"684691e6-86e3-4468-a60e-66bffb1ca246","403":"84efcf84-86e4-451e-9bd0-e85f27430fa5","422":"886a5343-6525-47bd-9d63-f05e29760acc","429":"d388d51e-da2f-4aee-b97d-165aebad64e6","503":"8b6618ca-127a-44af-82da-5250d67b4b51","504":"59db1aa9-5dee-407a-b469-4d4d87fadff1"},"method":"get","type":"path","servers":["a72447d6-010c-4889-ae7b-b9e4d80db41a"],"security":["a1fe7f7c-62a7-42f3-b340-a37bf2940fc6"],"path":"/map","baseUrlOptions":["https://api.prefetch.io"],"title":"Map a site's URLs","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"dba57e8e-505a-475a-85cb-3b1e18c9db7e":{"name":"url","in":"query","required":true,"description":"The website URL to process. `https://` is prepended automatically if no protocol is provided.","schema":{"type":"string","example":"https://stripe.com","isRequired":true,"description":"The website URL to process. `https://` is prepended automatically if no protocol is provided.","uniqueKey":"","typeLabel":"string"}},"09cfa3fa-67c4-4b1f-b741-48245bf0f618":{"name":"limit","in":"query","required":false,"description":"Maximum number of links to return.","schema":{"type":"integer","minimum":1,"maximum":5000,"default":1000,"isRequired":false,"description":"Maximum number of links to return.","uniqueKey":"","typeLabel":"integer"}},"b0140879-f5ec-40cc-89c9-952aa05e62e0":{"name":"search","in":"query","required":false,"description":"Rank and filter results by relevance to this query. Links that match nothing are dropped.","schema":{"type":"string","example":"pricing","isRequired":false,"description":"Rank and filter results by relevance to this query. Links that match nothing are dropped.","uniqueKey":"","typeLabel":"string"}},"49e4bc13-17a4-4276-a744-7dddc0b2461a":{"name":"sitemap","in":"query","required":false,"description":"Which sources to use. `include` merges sitemap entries with on-page links, `skip` uses on-page links only, `only` uses sitemaps only.","schema":{"type":"string","enum":["include","skip","only"],"default":"include","isRequired":false,"description":"Which sources to use. `include` merges sitemap entries with on-page links, `skip` uses on-page links only, `only` uses sitemaps only.","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"70a84d6b-d60b-4a63-b80d-66dd1411b359":{"name":"include_subdomains","in":"query","required":false,"description":"Include links on subdomains of the target.","schema":{"type":"boolean","default":true,"isRequired":false,"description":"Include links on subdomains of the target.","uniqueKey":"","typeLabel":"boolean"}},"46882946-8dee-41b7-9fff-df0fa2842bb8":{"name":"ignore_query_params","in":"query","required":false,"description":"Treat URLs that differ only by query string as one page.","schema":{"type":"boolean","default":true,"isRequired":false,"description":"Treat URLs that differ only by query string as one page.","uniqueKey":"","typeLabel":"boolean"}}},"responses":{"ca730fc0-8968-423b-b8b3-30c9201d3489":{"description":"Links discovered.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"data":{"type":"object","properties":{"url":{"type":"string","uniqueKey":"data.url","typeLabel":"string"},"domain":{"oneOf":[{"type":"string","uniqueKey":"data.domain.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.domain.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.domain","typeLabel":"string | null"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","uniqueKey":"data.links.items.[INDEX].url","typeLabel":"string"},"title":{"oneOf":[{"type":"string","uniqueKey":"data.links.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.links.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.links.items.[INDEX].title","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","uniqueKey":"data.links.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.links.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.links.items.[INDEX].description","typeLabel":"string | null"},"lastmod":{"oneOf":[{"type":"string","description":"From the sitemap, when the site publishes one.","uniqueKey":"data.links.items.[INDEX].lastmod.oneOf.0","typeLabel":"string"},{"type":"null","description":"From the sitemap, when the site publishes one.","uniqueKey":"data.links.items.[INDEX].lastmod.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.links.items.[INDEX].lastmod","typeLabel":"string | null"},"source":{"type":"string","enum":["sitemap","links"],"description":"Where the URL was discovered.","uniqueKey":"data.links.items.[INDEX].source","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.links.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.links","typeLabel":"object[]"},"count":{"type":"integer","uniqueKey":"data.count","typeLabel":"integer"},"total_discovered":{"type":"integer","description":"Links found before `limit` was applied.","uniqueKey":"data.total_discovered","typeLabel":"integer"},"sources":{"type":"object","properties":{"sitemap":{"type":"integer","uniqueKey":"data.sources.sitemap","typeLabel":"integer"},"links":{"type":"integer","uniqueKey":"data.sources.links","typeLabel":"integer"}},"uniqueKey":"data.sources","typeLabel":"object"},"sitemaps_used":{"type":"array","items":{"type":"string","uniqueKey":"data.sitemaps_used.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.sitemaps_used","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"},"meta":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","description":"Unique identifier for this request.","example":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string\u003cuuid>"},"durationMs":{"oneOf":[{"type":"integer","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.durationMs","typeLabel":"integer | null"}},"required":["requestId","durationMs"],"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"required":["success","data","meta"],"uniqueKey":"","typeLabel":"object"},"example":{"success":true,"data":{"url":"https://stripe.com","domain":"stripe.com","links":[{"url":"https://stripe.com/pricing","title":"Pricing","description":null,"lastmod":"2026-07-02","source":"sitemap"},{"url":"https://stripe.com/enterprise/pricing","title":null,"description":null,"lastmod":null,"source":"sitemap"}],"count":2,"total_discovered":2,"sources":{"sitemap":2,"links":0},"sitemaps_used":["https://stripe.com/sitemap/sitemap.xml"]},"meta":{"requestId":"b4e3d2c1-8a7b-4c3d-9e2f-1a3b5c7d9e1f","durationMs":1830}},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"url":"https://stripe.com","domain":"stripe.com","links":[{"url":"https://stripe.com/pricing","title":"Pricing","description":null,"lastmod":"2026-07-02","source":"sitemap"},{"url":"https://stripe.com/enterprise/pricing","title":null,"description":null,"lastmod":null,"source":"sitemap"}],"count":2,"total_discovered":2,"sources":{"sitemap":2,"links":0},"sitemaps_used":["https://stripe.com/sitemap/sitemap.xml"]},"meta":{"requestId":"b4e3d2c1-8a7b-4c3d-9e2f-1a3b5c7d9e1f","durationMs":1830}}}},"exampleType":"examples"}},"exampleType":"examples"},"55476830-a99b-46a3-94af-6c1564a4c1f1":{"description":"Invalid or missing parameters.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message. The wording can change: branch on `error_code`.","example":"Credit limit exceeded","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_code":{"type":"string","enum":["INVALID_REQUEST","PAYLOAD_TOO_LARGE","NOT_FOUND","CONFLICT","UNAUTHORIZED","FORBIDDEN","CREDITS_EXHAUSTED","RATE_LIMITED","CONCURRENCY_LIMITED","URL_BLOCKED","URL_NOT_PERMITTED","DNS_RESOLUTION_FAILED","TARGET_BLOCKED","TARGET_CONNECTION_FAILED","TARGET_TIMEOUT","TARGET_SSL_ERROR","TARGET_SERVER_ERROR","TARGET_CLIENT_ERROR","TARGET_NOT_A_PAGE","NO_LINKS_FOUND","TARGET_UNLOADABLE","RESEARCH_INCONCLUSIVE","TIMEOUT","SERVICE_BUSY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"What went wrong, for machines. Stable: a code keeps its meaning once published. See [Error handling](/concepts/errors).","example":"CREDITS_EXHAUSTED","isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"Whether the same request can succeed if sent again after a short wait (honour `Retry-After` when present). False for problems with the request or the target.","example":false,"isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"success":{"type":"boolean","enum":[false],"description":"Always false. Absent, like `meta`, on authentication and rate-limit errors, which are answered before a request is processed.","uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"retryAfterSeconds":{"type":"integer","description":"On `RATE_LIMITED`: seconds until a request will be accepted.","uniqueKey":"retryAfterSeconds","typeLabel":"integer"},"limit":{"type":"integer","description":"On `CONCURRENCY_LIMITED`: how many requests this key may have in flight.","uniqueKey":"limit","typeLabel":"integer"},"meta":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","description":"Unique identifier for this request.","example":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string\u003cuuid>"},"durationMs":{"oneOf":[{"type":"integer","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.durationMs","typeLabel":"integer | null"}},"required":["requestId","durationMs"],"uniqueKey":"meta","typeLabel":"object"}},"required":["error","error_code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Credit limit exceeded","error_code":"CREDITS_EXHAUSTED","retryable":false,"success":false,"retryAfterSeconds":123,"limit":123,"meta":{"requestId":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","durationMs":1842}}}},"exampleType":"generated"}},"exampleType":"generated"},"684691e6-86e3-4468-a60e-66bffb1ca246":{"description":"Missing API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message. The wording can change: branch on `error_code`.","example":"Credit limit exceeded","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_code":{"type":"string","enum":["INVALID_REQUEST","PAYLOAD_TOO_LARGE","NOT_FOUND","CONFLICT","UNAUTHORIZED","FORBIDDEN","CREDITS_EXHAUSTED","RATE_LIMITED","CONCURRENCY_LIMITED","URL_BLOCKED","URL_NOT_PERMITTED","DNS_RESOLUTION_FAILED","TARGET_BLOCKED","TARGET_CONNECTION_FAILED","TARGET_TIMEOUT","TARGET_SSL_ERROR","TARGET_SERVER_ERROR","TARGET_CLIENT_ERROR","TARGET_NOT_A_PAGE","NO_LINKS_FOUND","TARGET_UNLOADABLE","RESEARCH_INCONCLUSIVE","TIMEOUT","SERVICE_BUSY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"What went wrong, for machines. Stable: a code keeps its meaning once published. See [Error handling](/concepts/errors).","example":"CREDITS_EXHAUSTED","isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"Whether the same request can succeed if sent again after a short wait (honour `Retry-After` when present). False for problems with the request or the target.","example":false,"isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"success":{"type":"boolean","enum":[false],"description":"Always false. Absent, like `meta`, on authentication and rate-limit errors, which are answered before a request is processed.","uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"retryAfterSeconds":{"type":"integer","description":"On `RATE_LIMITED`: seconds until a request will be accepted.","uniqueKey":"retryAfterSeconds","typeLabel":"integer"},"limit":{"type":"integer","description":"On `CONCURRENCY_LIMITED`: how many requests this key may have in flight.","uniqueKey":"limit","typeLabel":"integer"},"meta":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","description":"Unique identifier for this request.","example":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string\u003cuuid>"},"durationMs":{"oneOf":[{"type":"integer","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.durationMs","typeLabel":"integer | null"}},"required":["requestId","durationMs"],"uniqueKey":"meta","typeLabel":"object"}},"required":["error","error_code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Credit limit exceeded","error_code":"CREDITS_EXHAUSTED","retryable":false,"success":false,"retryAfterSeconds":123,"limit":123,"meta":{"requestId":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","durationMs":1842}}}},"exampleType":"generated"}},"exampleType":"generated"},"84efcf84-86e4-451e-9bd0-e85f27430fa5":{"description":"Revoked key, expired key, credit limit, or blocklisted URL.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message. The wording can change: branch on `error_code`.","example":"Credit limit exceeded","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_code":{"type":"string","enum":["INVALID_REQUEST","PAYLOAD_TOO_LARGE","NOT_FOUND","CONFLICT","UNAUTHORIZED","FORBIDDEN","CREDITS_EXHAUSTED","RATE_LIMITED","CONCURRENCY_LIMITED","URL_BLOCKED","URL_NOT_PERMITTED","DNS_RESOLUTION_FAILED","TARGET_BLOCKED","TARGET_CONNECTION_FAILED","TARGET_TIMEOUT","TARGET_SSL_ERROR","TARGET_SERVER_ERROR","TARGET_CLIENT_ERROR","TARGET_NOT_A_PAGE","NO_LINKS_FOUND","TARGET_UNLOADABLE","RESEARCH_INCONCLUSIVE","TIMEOUT","SERVICE_BUSY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"What went wrong, for machines. Stable: a code keeps its meaning once published. See [Error handling](/concepts/errors).","example":"CREDITS_EXHAUSTED","isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"Whether the same request can succeed if sent again after a short wait (honour `Retry-After` when present). False for problems with the request or the target.","example":false,"isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"success":{"type":"boolean","enum":[false],"description":"Always false. Absent, like `meta`, on authentication and rate-limit errors, which are answered before a request is processed.","uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"retryAfterSeconds":{"type":"integer","description":"On `RATE_LIMITED`: seconds until a request will be accepted.","uniqueKey":"retryAfterSeconds","typeLabel":"integer"},"limit":{"type":"integer","description":"On `CONCURRENCY_LIMITED`: how many requests this key may have in flight.","uniqueKey":"limit","typeLabel":"integer"},"meta":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","description":"Unique identifier for this request.","example":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string\u003cuuid>"},"durationMs":{"oneOf":[{"type":"integer","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.durationMs","typeLabel":"integer | null"}},"required":["requestId","durationMs"],"uniqueKey":"meta","typeLabel":"object"}},"required":["error","error_code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Credit limit exceeded","error_code":"CREDITS_EXHAUSTED","retryable":false,"success":false,"retryAfterSeconds":123,"limit":123,"meta":{"requestId":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","durationMs":1842}}}},"exampleType":"generated"}},"exampleType":"generated"},"886a5343-6525-47bd-9d63-f05e29760acc":{"description":"The URL hostname could not be resolved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message. The wording can change: branch on `error_code`.","example":"Credit limit exceeded","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_code":{"type":"string","enum":["INVALID_REQUEST","PAYLOAD_TOO_LARGE","NOT_FOUND","CONFLICT","UNAUTHORIZED","FORBIDDEN","CREDITS_EXHAUSTED","RATE_LIMITED","CONCURRENCY_LIMITED","URL_BLOCKED","URL_NOT_PERMITTED","DNS_RESOLUTION_FAILED","TARGET_BLOCKED","TARGET_CONNECTION_FAILED","TARGET_TIMEOUT","TARGET_SSL_ERROR","TARGET_SERVER_ERROR","TARGET_CLIENT_ERROR","TARGET_NOT_A_PAGE","NO_LINKS_FOUND","TARGET_UNLOADABLE","RESEARCH_INCONCLUSIVE","TIMEOUT","SERVICE_BUSY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"What went wrong, for machines. Stable: a code keeps its meaning once published. See [Error handling](/concepts/errors).","example":"CREDITS_EXHAUSTED","isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"Whether the same request can succeed if sent again after a short wait (honour `Retry-After` when present). False for problems with the request or the target.","example":false,"isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"success":{"type":"boolean","enum":[false],"description":"Always false. Absent, like `meta`, on authentication and rate-limit errors, which are answered before a request is processed.","uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"retryAfterSeconds":{"type":"integer","description":"On `RATE_LIMITED`: seconds until a request will be accepted.","uniqueKey":"retryAfterSeconds","typeLabel":"integer"},"limit":{"type":"integer","description":"On `CONCURRENCY_LIMITED`: how many requests this key may have in flight.","uniqueKey":"limit","typeLabel":"integer"},"meta":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","description":"Unique identifier for this request.","example":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string\u003cuuid>"},"durationMs":{"oneOf":[{"type":"integer","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.durationMs","typeLabel":"integer | null"}},"required":["requestId","durationMs"],"uniqueKey":"meta","typeLabel":"object"}},"required":["error","error_code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Credit limit exceeded","error_code":"CREDITS_EXHAUSTED","retryable":false,"success":false,"retryAfterSeconds":123,"limit":123,"meta":{"requestId":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","durationMs":1842}}}},"exampleType":"generated"}},"exampleType":"generated"},"d388d51e-da2f-4aee-b97d-165aebad64e6":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message. The wording can change: branch on `error_code`.","example":"Credit limit exceeded","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_code":{"type":"string","enum":["INVALID_REQUEST","PAYLOAD_TOO_LARGE","NOT_FOUND","CONFLICT","UNAUTHORIZED","FORBIDDEN","CREDITS_EXHAUSTED","RATE_LIMITED","CONCURRENCY_LIMITED","URL_BLOCKED","URL_NOT_PERMITTED","DNS_RESOLUTION_FAILED","TARGET_BLOCKED","TARGET_CONNECTION_FAILED","TARGET_TIMEOUT","TARGET_SSL_ERROR","TARGET_SERVER_ERROR","TARGET_CLIENT_ERROR","TARGET_NOT_A_PAGE","NO_LINKS_FOUND","TARGET_UNLOADABLE","RESEARCH_INCONCLUSIVE","TIMEOUT","SERVICE_BUSY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"What went wrong, for machines. Stable: a code keeps its meaning once published. See [Error handling](/concepts/errors).","example":"CREDITS_EXHAUSTED","isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"Whether the same request can succeed if sent again after a short wait (honour `Retry-After` when present). False for problems with the request or the target.","example":false,"isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"success":{"type":"boolean","enum":[false],"description":"Always false. Absent, like `meta`, on authentication and rate-limit errors, which are answered before a request is processed.","uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"retryAfterSeconds":{"type":"integer","description":"On `RATE_LIMITED`: seconds until a request will be accepted.","uniqueKey":"retryAfterSeconds","typeLabel":"integer"},"limit":{"type":"integer","description":"On `CONCURRENCY_LIMITED`: how many requests this key may have in flight.","uniqueKey":"limit","typeLabel":"integer"},"meta":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","description":"Unique identifier for this request.","example":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string\u003cuuid>"},"durationMs":{"oneOf":[{"type":"integer","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.durationMs","typeLabel":"integer | null"}},"required":["requestId","durationMs"],"uniqueKey":"meta","typeLabel":"object"}},"required":["error","error_code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Credit limit exceeded","error_code":"CREDITS_EXHAUSTED","retryable":false,"success":false,"retryAfterSeconds":123,"limit":123,"meta":{"requestId":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","durationMs":1842}}}},"exampleType":"generated"}},"exampleType":"generated"},"8b6618ca-127a-44af-82da-5250d67b4b51":{"description":"Service temporarily busy. Retry shortly.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message. The wording can change: branch on `error_code`.","example":"Credit limit exceeded","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_code":{"type":"string","enum":["INVALID_REQUEST","PAYLOAD_TOO_LARGE","NOT_FOUND","CONFLICT","UNAUTHORIZED","FORBIDDEN","CREDITS_EXHAUSTED","RATE_LIMITED","CONCURRENCY_LIMITED","URL_BLOCKED","URL_NOT_PERMITTED","DNS_RESOLUTION_FAILED","TARGET_BLOCKED","TARGET_CONNECTION_FAILED","TARGET_TIMEOUT","TARGET_SSL_ERROR","TARGET_SERVER_ERROR","TARGET_CLIENT_ERROR","TARGET_NOT_A_PAGE","NO_LINKS_FOUND","TARGET_UNLOADABLE","RESEARCH_INCONCLUSIVE","TIMEOUT","SERVICE_BUSY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"What went wrong, for machines. Stable: a code keeps its meaning once published. See [Error handling](/concepts/errors).","example":"CREDITS_EXHAUSTED","isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"Whether the same request can succeed if sent again after a short wait (honour `Retry-After` when present). False for problems with the request or the target.","example":false,"isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"success":{"type":"boolean","enum":[false],"description":"Always false. Absent, like `meta`, on authentication and rate-limit errors, which are answered before a request is processed.","uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"retryAfterSeconds":{"type":"integer","description":"On `RATE_LIMITED`: seconds until a request will be accepted.","uniqueKey":"retryAfterSeconds","typeLabel":"integer"},"limit":{"type":"integer","description":"On `CONCURRENCY_LIMITED`: how many requests this key may have in flight.","uniqueKey":"limit","typeLabel":"integer"},"meta":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","description":"Unique identifier for this request.","example":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string\u003cuuid>"},"durationMs":{"oneOf":[{"type":"integer","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.durationMs","typeLabel":"integer | null"}},"required":["requestId","durationMs"],"uniqueKey":"meta","typeLabel":"object"}},"required":["error","error_code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Credit limit exceeded","error_code":"CREDITS_EXHAUSTED","retryable":false,"success":false,"retryAfterSeconds":123,"limit":123,"meta":{"requestId":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","durationMs":1842}}}},"exampleType":"generated"}},"exampleType":"generated"},"59db1aa9-5dee-407a-b469-4d4d87fadff1":{"description":"Request timed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message. The wording can change: branch on `error_code`.","example":"Credit limit exceeded","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_code":{"type":"string","enum":["INVALID_REQUEST","PAYLOAD_TOO_LARGE","NOT_FOUND","CONFLICT","UNAUTHORIZED","FORBIDDEN","CREDITS_EXHAUSTED","RATE_LIMITED","CONCURRENCY_LIMITED","URL_BLOCKED","URL_NOT_PERMITTED","DNS_RESOLUTION_FAILED","TARGET_BLOCKED","TARGET_CONNECTION_FAILED","TARGET_TIMEOUT","TARGET_SSL_ERROR","TARGET_SERVER_ERROR","TARGET_CLIENT_ERROR","TARGET_NOT_A_PAGE","NO_LINKS_FOUND","TARGET_UNLOADABLE","RESEARCH_INCONCLUSIVE","TIMEOUT","SERVICE_BUSY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"What went wrong, for machines. Stable: a code keeps its meaning once published. See [Error handling](/concepts/errors).","example":"CREDITS_EXHAUSTED","isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"Whether the same request can succeed if sent again after a short wait (honour `Retry-After` when present). False for problems with the request or the target.","example":false,"isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"success":{"type":"boolean","enum":[false],"description":"Always false. Absent, like `meta`, on authentication and rate-limit errors, which are answered before a request is processed.","uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"retryAfterSeconds":{"type":"integer","description":"On `RATE_LIMITED`: seconds until a request will be accepted.","uniqueKey":"retryAfterSeconds","typeLabel":"integer"},"limit":{"type":"integer","description":"On `CONCURRENCY_LIMITED`: how many requests this key may have in flight.","uniqueKey":"limit","typeLabel":"integer"},"meta":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","description":"Unique identifier for this request.","example":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string\u003cuuid>"},"durationMs":{"oneOf":[{"type":"integer","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.durationMs","typeLabel":"integer | null"}},"required":["requestId","durationMs"],"uniqueKey":"meta","typeLabel":"object"}},"required":["error","error_code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Credit limit exceeded","error_code":"CREDITS_EXHAUSTED","retryable":false,"success":false,"retryAfterSeconds":123,"limit":123,"meta":{"requestId":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","durationMs":1842}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"a1fe7f7c-62a7-42f3-b340-a37bf2940fc6":{"apiKey":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Your Prefetch API key. Obtain one from the dashboard.","scopes":[],"schemeName":"apiKey"}}},"servers":{"a72447d6-010c-4889-ae7b-b9e4d80db41a":{"url":"https://api.prefetch.io","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Your Prefetch API key. Obtain one from the dashboard.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"X-API-Key","type":"string","description":"Your Prefetch API key. Obtain one from the dashboard.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"X-API-Key"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"prefetch","siteName":"Prefetch API","title":"GET /map - Prefetch API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T00:20:50.196Z","originalFileLocation":"api-reference/endpoint/map.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"List every URL a site exposes, from its sitemaps and on-page links. 1 credit.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Prefetch API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/prefetch/LfH_u0wIgIMJj9SU/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/prefetch/LfH_u0wIgIMJj9SU/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/prefetch/LfH_u0wIgIMJj9SU/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/prefetch/LfH_u0wIgIMJj9SU/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/prefetch/LfH_u0wIgIMJj9SU/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/prefetch/LfH_u0wIgIMJj9SU/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/prefetch/LfH_u0wIgIMJj9SU/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/prefetch/LfH_u0wIgIMJj9SU/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/prefetch/LfH_u0wIgIMJj9SU/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"GET /map - Prefetch API\">\u003cmeta data-mint-head property=\"og:description\" content=\"List every URL a site exposes, from its sitemaps and on-page links. 1 credit.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Prefetch API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.prefetch.io/api-reference/endpoint/map\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://prefetch.mintlify.site/_mintlify/api/og/v2?division=Web+data\u0026amp;title=GET+%2Fmap\u0026amp;description=List+every+URL+a+site+exposes%2C+from+its+sitemaps+and+on-page+links.+1+credit.\u0026amp;theme=53a3f409698e98a035ca36d8\u0026amp;signature=d88dfaf075107d2fe8fd46978fe7e0bc4a17be3665bfd531b9d592e1fda39a82\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"GET /map - Prefetch API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"List every URL a site exposes, from its sitemaps and on-page links. 1 credit.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://prefetch.mintlify.site/_mintlify/api/og/v2?division=Web+data\u0026amp;title=GET+%2Fmap\u0026amp;description=List+every+URL+a+site+exposes%2C+from+its+sitemaps+and+on-page+links.+1+credit.\u0026amp;theme=53a3f409698e98a035ca36d8\u0026amp;signature=d88dfaf075107d2fe8fd46978fe7e0bc4a17be3665bfd531b9d592e1fda39a82\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/prefetch/LfH_u0wIgIMJj9SU/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Prefetch API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#8A5A00\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.prefetch.io/api-reference/endpoint/map\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/map.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.prefetch.io/#organization\",\"name\":\"Prefetch API\",\"url\":\"https://docs.prefetch.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/prefetch/0cLjeQZN2Dy6gN5Q/logo/light.svg?fit=max\u0026auto=format\u0026n=0cLjeQZN2Dy6gN5Q\u0026q=85\u0026s=7b9ea0ec7c23b929ff607e56c0de9713\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.prefetch.io#website\",\"name\":\"Prefetch API\",\"url\":\"https://docs.prefetch.io\",\"publisher\":{\"@id\":\"https://docs.prefetch.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.prefetch.io/api-reference/endpoint/map#webpage\",\"url\":\"https://docs.prefetch.io/api-reference/endpoint/map\",\"name\":\"GET /map\",\"description\":\"List every URL a site exposes, from its sitemaps and on-page links. 1 credit.\",\"dateModified\":\"2026-11-05T00:20:50.196Z\",\"isPartOf\":{\"@id\":\"https://docs.prefetch.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.prefetch.io/api-reference/endpoint/map#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.prefetch.io/api-reference/endpoint/map#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Web data\",\"item\":\"https://docs.prefetch.io/api-reference/endpoint/scrape\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"GET /map\",\"item\":\"https://docs.prefetch.io/api-reference/endpoint/map\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.prefetch.io/api-reference/endpoint/map#apireference\",\"headline\":\"GET /map\",\"name\":\"GET /map\",\"description\":\"List every URL a site exposes, from its sitemaps and on-page links. 1 credit.\",\"url\":\"https://docs.prefetch.io/api-reference/endpoint/map\",\"mainEntityOfPage\":{\"@id\":\"https://docs.prefetch.io/api-reference/endpoint/map#webpage\"},\"dateModified\":\"2026-11-05T00:20:50.196Z\",\"publisher\":{\"@id\":\"https://docs.prefetch.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.prefetch.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Prefetch API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Prefetch API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoint/map.md","siteName":"Prefetch API","nav":{"global":{},"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":""}]},{"tab":"Recipes","pages":[{"title":"Recipes","href":"/recipes/overview"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API reference","sidebarTitle":"Introduction","href":"/api-reference/introduction"}]},{"group":"Find a company","pages":[{"title":"GET /resolve","sidebarTitle":"Resolve a name","openapi":"GET /resolve","href":"/api-reference/endpoint/resolve"},{"title":"GET /transaction","sidebarTitle":"Card transaction","openapi":"GET /transaction","href":"/api-reference/endpoint/transaction"}]},{"group":"Company data","pages":[{"title":"GET /enrich","sidebarTitle":"Enrich","openapi":"GET /enrich","href":"/api-reference/endpoint/enrich"},{"title":"GET /brand","sidebarTitle":"Brand","openapi":"GET /brand","href":"/api-reference/endpoint/brand"},{"title":"GET /company","sidebarTitle":"Company","openapi":"GET /company","href":"/api-reference/endpoint/company"},{"title":"GET /classify","sidebarTitle":"Classify","openapi":"GET /classify","href":"/api-reference/endpoint/classify"},{"title":"GET /styleguide","sidebarTitle":"Styleguide","openapi":"GET /styleguide","href":"/api-reference/endpoint/styleguide"}]},{"group":"Web data","pages":[{"title":"GET /scrape","sidebarTitle":"Scrape","openapi":"GET /scrape","href":"/api-reference/endpoint/scrape"},{"title":"GET /search","sidebarTitle":"Search","description":"Search the web and get each result's title, URL and snippet, optionally with every result page scraped. 2 credits per 10 results.","openapi":"GET /search","href":"/api-reference/endpoint/search"},{"title":"GET /map","sidebarTitle":"Map","openapi":"GET /map","href":"/api-reference/endpoint/map"},{"title":"GET /screenshot","sidebarTitle":"Screenshot","description":"Capture a page, the full page or one element, on any device, in light or dark mode, as JPEG, PNG, WebP or PDF. 1 credit.","openapi":"GET /screenshot","href":"/api-reference/endpoint/screenshot"}]},{"group":"Crawls","pages":[{"title":"POST /crawl","sidebarTitle":"Start a crawl","openapi":"POST /crawl","href":"/api-reference/endpoint/crawl"},{"title":"GET /crawl/{id}","sidebarTitle":"Get crawl status","openapi":"GET /crawl/{id}","href":"/api-reference/endpoint/crawl-status"},{"title":"GET /crawl/{id}/errors","sidebarTitle":"Get crawl errors","openapi":"GET /crawl/{id}/errors","href":"/api-reference/endpoint/crawl-errors"},{"title":"DELETE /crawl/{id}","sidebarTitle":"Cancel a crawl","openapi":"DELETE /crawl/{id}","href":"/api-reference/endpoint/crawl-cancel"}]},{"group":"Batches","pages":[{"title":"POST /batch/scrape","sidebarTitle":"Start a batch scrape","openapi":"POST /batch/scrape","href":"/api-reference/endpoint/batch-scrape"},{"title":"GET /batch/scrape/{id}","sidebarTitle":"Get batch scrape status","openapi":"GET /batch/scrape/{id}","href":"/api-reference/endpoint/batch-scrape-status"},{"title":"GET /batch/scrape/{id}/errors","sidebarTitle":"Get batch scrape errors","openapi":"GET /batch/scrape/{id}/errors","href":"/api-reference/endpoint/batch-scrape-errors"},{"title":"DELETE /batch/scrape/{id}","sidebarTitle":"Cancel a batch scrape","openapi":"DELETE /batch/scrape/{id}","href":"/api-reference/endpoint/batch-scrape-cancel"},{"title":"POST /batch/{endpoint}","sidebarTitle":"Start a batch","openapi":"POST /batch/{endpoint}","href":"/api-reference/endpoint/batch"},{"title":"GET /batch/{endpoint}/{id}","sidebarTitle":"Get batch status","openapi":"GET /batch/{endpoint}/{id}","href":"/api-reference/endpoint/batch-status"},{"title":"GET /batch/{endpoint}/{id}/errors","sidebarTitle":"Get batch errors","openapi":"GET /batch/{endpoint}/{id}/errors","href":"/api-reference/endpoint/batch-errors"},{"title":"DELETE /batch/{endpoint}/{id}","sidebarTitle":"Cancel a batch","openapi":"DELETE /batch/{endpoint}/{id}","href":"/api-reference/endpoint/batch-cancel"}]},{"group":"Monitors","pages":[{"title":"POST /monitor","sidebarTitle":"Create a monitor","openapi":"POST /monitor","href":"/api-reference/endpoint/monitor"},{"title":"GET /monitor","sidebarTitle":"List monitors","openapi":"GET /monitor","href":"/api-reference/endpoint/monitor-list"},{"title":"GET /monitor/{id}","sidebarTitle":"Get a monitor","openapi":"GET /monitor/{id}","href":"/api-reference/endpoint/monitor-get"},{"title":"PATCH /monitor/{id}","sidebarTitle":"Update a monitor","openapi":"PATCH /monitor/{id}","href":"/api-reference/endpoint/monitor-update"},{"title":"DELETE /monitor/{id}","sidebarTitle":"Delete a monitor","openapi":"DELETE /monitor/{id}","href":"/api-reference/endpoint/monitor-delete"},{"title":"POST /monitor/{id}/run","sidebarTitle":"Run a check now","openapi":"POST /monitor/{id}/run","href":"/api-reference/endpoint/monitor-run"},{"title":"GET /monitor/{id}/checks","sidebarTitle":"List checks","openapi":"GET /monitor/{id}/checks","href":"/api-reference/endpoint/monitor-checks"},{"title":"GET /monitor/{id}/checks/{checkId}","sidebarTitle":"Get a check","openapi":"GET /monitor/{id}/checks/{checkId}","href":"/api-reference/endpoint/monitor-check"},{"group":"Webhooks","pages":[{"title":"monitor.page webhook","sidebarTitle":"monitor.page event","openapi":"WEBHOOK monitor.page","href":"/api-reference/endpoint/monitor-webhook-page"},{"title":"monitor.check.completed webhook","sidebarTitle":"monitor.check.completed event","openapi":"WEBHOOK monitor.check.completed","href":"/api-reference/endpoint/monitor-webhook-check"}]}]},{"group":"Logo CDN","pages":[{"title":"GET /logo/token","sidebarTitle":"Get logo token","openapi":"GET /logo/token","href":"/api-reference/endpoint/logo-token"},{"title":"POST /logo/token/rotate","sidebarTitle":"Rotate logo token","openapi":"POST /logo/token/rotate","href":"/api-reference/endpoint/logo-token-rotate"}]},{"group":"Service","pages":[{"title":"GET /health","sidebarTitle":"Health","openapi":"GET /health","href":"/api-reference/endpoint/health"},{"title":"GET /ready","sidebarTitle":"Readiness","openapi":"GET /ready","href":"/api-reference/endpoint/ready"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"GET /map - Prefetch API","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B6WFFOBL.js","utils-BN5um1KA.js","cloneDeep-C3md22mN.js","_Uint8Array-DLlL8L26.js","isObject-FP1Yky1u.js","utils-BSmbkXJR.js","addUniqueKeysToSchema-2tqcVnUE.js","snippetPresets-CtWfvr2J.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DkKHBy30.js","isEqual-O3q7y6pq.js","usePlaygroundInputsStore-Brc5H9UJ.js","shallow-C4L4xvbs.js","getApiPlaygroundDisplay-2bxyq_aI.js","CodeSnippet-BJu8ddd5.js","CodeSnippets-dazWmoqB.js","Page-CnLhKuUV.js","getPastedJson-Chy3Qa1S.js","icon-CyO7h3jh.js","MethodPill-Dle0_91v.js","DuplicateIcon-CVvWAf4a.js","createIcon-Di07A27B.js","DynamicMarkdown-C4w9kavL.js","SectionHeading-XiBebVYC.js","axios-vUo_bRtp.js","Markdown-DTeL0SpS.js","dist-OCScizqf.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-KcneGfMY.js"]}