Lists a website’s page URLs without scraping them, optionally ranked by how well they match a search. It answers in the same request, so there’s no job to poll. Guide: Map.
URLs come from the site’s sitemaps and from the links on its pages. Without search, current pages come before older versions and translations. With search, only matching URLs come back, best matches first. A map that takes longer than 45 seconds fails with 502.
The site to map, starting with http:// or https://. Usually the home page or a section such as https://docs.python.org/3/. Private and internal addresses are rejected.
include reads the sitemaps and the links on the site's pages, which finds the most. skip reads only page links. only reads only the sitemaps, which is fastest.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Spidra","description":"Spidra documentation — REST API reference, SDK guides, browser automation, CAPTCHA solving, and proxy scraping for AI-powered web data extraction.","colors":{"primary":"#007AFF","light":"#007AFF","dark":"#007AFF"},"logo":{"light":"https://mintcdn.com/spidra/tjYTncBEy2qwqvSx/logo/logo-light.png?fit=max\u0026auto=format\u0026n=tjYTncBEy2qwqvSx\u0026q=85\u0026s=9ee4bb079b87d8aea61a7d42bfecf118","dark":"https://mintcdn.com/spidra/tjYTncBEy2qwqvSx/logo/logo-dark.png?fit=max\u0026auto=format\u0026n=tjYTncBEy2qwqvSx\u0026q=85\u0026s=3633ab236061c0e8200d4d9e0f1a9c05"},"favicon":"https://mintcdn.com/spidra/47EJpglRIcFOVcnQ/favicon.ico?fit=max\u0026auto=format\u0026n=47EJpglRIcFOVcnQ\u0026q=85\u0026s=3c0c6b781fffaaa0dd242f4b886d8917","navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.spidra.io"}},"footer":{"socials":{"x":"https://x.com/spidra_io","github":"https://github.com/spidra-io","linkedin":"https://www.linkedin.com/company/spidra-io"}},"seo":{"indexing":"all"},"interaction":{"drilldown":false},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Dashboard","icon":"book-open-cover","href":"https://app.spidra.io"},{"anchor":"GitHub","icon":"github","href":"https://github.com/spidra-io"},{"anchor":"Blog","icon":"newspaper","href":"https://spidra.io/blog"},{"anchor":"Changelog","icon":"clock-rotate-left","href":"https://spidra.io/changelog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"spidra","hasAudioNarration":false,"actualSubdomain":"spidra","customDomains":["docs.spidra.io"],"gitSource":{"type":"github","owner":"spidra-io","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aeb7b05330d696ca47f944e","collectionId":"36e399aa-f8e1-4ef5-90c7-a20764aa6e5e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aeb7b05330d696ca47f944e"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6aeb7b05330d696ca47f944e","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API Reference","count":68},{"language":"default","tag":"Documentation","count":51},{"language":"default","tag":"SDKs","count":31},{"language":"default","tag":"Popular sites","count":24},{"language":"default","tag":"More sites","count":18},{"language":"default","tag":"Monitors","count":13},{"language":"default","tag":"Crawl","count":10},{"language":"default","tag":"Guides","count":8},{"language":"default","tag":"Logs","count":7},{"language":"default","tag":"Parse","count":7}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","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":"llms-txt-v2","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":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"table{width:100%!important;display:table!important}th,td{white-space:normal}"},{"filePath":"style.css","content":"#table-of-contents-layout{flex:0 1 auto;min-height:0;max-height:none}#spidra-toc-cta{position:relative;flex-shrink:0;overflow:hidden;width:16.5rem;margin:1rem 0 1.5rem 2.5rem;border-radius:14px;background:radial-gradient(120% 140% at 0% 0%, #2d8cff 0%, #007aff 40%, #0657c2 100%);color:#fff;box-shadow:0 18px 40px -24px rgba(0, 40, 120, 0.55)}#spidra-toc-cta .spidra-cta-dots{position:absolute;inset:0;opacity:0.18;background-image:radial-gradient(rgba(255, 255, 255, 0.95) 1px, transparent 1.3px);background-size:12px 12px;-webkit-mask-image:linear-gradient(110deg, transparent 25%, black 80%);mask-image:linear-gradient(110deg, transparent 25%, black 80%);pointer-events:none}#spidra-toc-cta .spidra-cta-rings{position:absolute;right:-70px;top:-40px;pointer-events:none}#spidra-toc-cta .spidra-cta-rings i{position:absolute;left:50%;top:50%;border:1px solid rgba(255, 255, 255, 0.22);border-radius:9999px;transform:translate(-50%, -50%)}#spidra-toc-cta .spidra-cta-rings i:nth-child(1){width:220px;height:220px}#spidra-toc-cta .spidra-cta-rings i:nth-child(2){width:150px;height:150px}#spidra-toc-cta .spidra-cta-rings i:nth-child(3){width:80px;height:80px}#spidra-toc-cta .spidra-cta-body{position:relative;padding:1.1rem 1.15rem}#spidra-toc-cta .spidra-cta-logo{height:18px;width:auto;margin:0 0 0.7rem}#spidra-toc-cta .spidra-cta-title{margin:0;font-size:1.05rem;font-weight:600;line-height:1.3;letter-spacing:-0.01em;color:#fff}#spidra-toc-cta .spidra-cta-text{margin:0.5rem 0 1.1rem;font-size:0.8rem;line-height:1.5;color:rgba(255, 255, 255, 0.8)}#spidra-toc-cta a{display:block;text-align:center;font-size:0.85rem;font-weight:500;border-radius:9999px;padding:0.55rem 1rem;text-decoration:none;transition:background-color 0.15s ease, transform 0.15s ease}#spidra-toc-cta .spidra-cta-primary{background:#fff;color:#007aff;box-shadow:0 10px 24px -12px rgba(0, 20, 80, 0.6)}#spidra-toc-cta .spidra-cta-primary:hover{transform:translateY(-1px)}#spidra-toc-cta .spidra-cta-secondary{margin-top:0.5rem;color:#fff;border:1px solid rgba(255, 255, 255, 0.35)}#spidra-toc-cta .spidra-cta-secondary:hover{background:rgba(255, 255, 255, 0.1)}.tool-picker{margin:1.25rem 0 1.5rem;border:1px solid rgba(15, 23, 42, 0.08);border-radius:14px;overflow:hidden;background:#fff}.tool-picker .tp-head,.tool-picker .tp-row{display:grid;grid-template-columns:minmax(0, 1.15fr) minmax(0, 0.7fr) minmax(0, 1.35fr);gap:1.25rem;align-items:center;padding:0.85rem 1.25rem}.tool-picker .tp-head{padding-top:0.7rem;padding-bottom:0.7rem;background:linear-gradient(180deg, #f5f9ff 0%, #ffffff 100%);border-bottom:1px solid rgba(15, 23, 42, 0.08);font-size:0.75rem;font-weight:500;letter-spacing:0.02em;color:rgba(15, 23, 42, 0.5)}.tool-picker .tp-row{position:relative;border-bottom:1px solid rgba(15, 23, 42, 0.06);text-decoration:none!important;border-image:none;transition:background-color 0.15s ease}.tool-picker .tp-row:last-child{border-bottom:0}.tool-picker .tp-row::before{content:\"\";position:absolute;left:0;top:18%;bottom:18%;width:2px;border-radius:2px;background:#007aff;transform:scaleY(0);transition:transform 0.18s ease}.tool-picker .tp-row:hover{background:#f5f9ff}.tool-picker .tp-row:hover::before{transform:scaleY(1)}.tool-picker .tp-have{font-weight:500;font-size:0.9rem;line-height:1.45;color:#0f172a}.tool-picker .tp-tool{font-size:0.9rem;font-weight:600;color:#007aff;white-space:nowrap}.tool-picker .tp-get{font-weight:400;font-size:0.875rem;line-height:1.45;color:rgba(15, 23, 42, 0.62)}html.dark .tool-picker{background:rgba(255, 255, 255, 0.02);border-color:rgba(255, 255, 255, 0.08)}html.dark .tool-picker .tp-head{background:linear-gradient(180deg, rgba(0, 122, 255, 0.1) 0%, rgba(0, 122, 255, 0) 100%);border-bottom-color:rgba(255, 255, 255, 0.08);color:rgba(255, 255, 255, 0.45)}html.dark .tool-picker .tp-row{border-bottom-color:rgba(255, 255, 255, 0.06)}html.dark .tool-picker .tp-row:hover{background:rgba(0, 122, 255, 0.08)}html.dark .tool-picker .tp-have{color:rgba(255, 255, 255, 0.92)}html.dark .tool-picker .tp-tool{color:#4da3ff}html.dark .tool-picker .tp-row::before{background:#4da3ff}html.dark .tool-picker .tp-get{color:rgba(255, 255, 255, 0.55)}@media (max-width: 640px){.tool-picker .tp-head{display:none}.tool-picker .tp-row{grid-template-columns:1fr;gap:0.2rem;padding:0.9rem 1rem}.tool-picker .tp-tool{order:-1}}.plan-table-wrap{margin:1.25rem 0 1.5rem;border:1px solid rgba(15, 23, 42, 0.08);border-radius:14px;overflow-x:auto;background:#fff}.plan-table{width:100%;min-width:620px;margin:0!important;border-collapse:collapse;font-size:0.875rem}.plan-table th,.plan-table td{padding:0.8rem 1rem;border:0!important;border-bottom:1px solid rgba(15, 23, 42, 0.06)!important;text-align:center;vertical-align:middle;color:#0f172a;background:transparent}.plan-table tbody tr:last-child th,.plan-table tbody tr:last-child td{border-bottom:0!important}.plan-table thead th{padding-top:1.25rem;padding-bottom:1rem;border-bottom:1px solid rgba(15, 23, 42, 0.08)!important;vertical-align:bottom}.plan-table td{white-space:nowrap}.plan-table .pt-label{width:30%;text-align:left;font-weight:500}.plan-table .pt-hint{display:block;margin-top:0.15rem;font-size:0.75rem;font-weight:400;color:rgba(15, 23, 42, 0.5)}.plan-table .pt-sr{position:absolute;width:1px;height:1px;overflow:hidden;clip:rect(0 0 0 0)}.plan-table .pt-name{display:block;font-size:0.95rem;font-weight:600}.plan-table .pt-price{display:block;margin-top:0.2rem;font-size:1.35rem;font-weight:600;letter-spacing:-0.02em}.plan-table .pt-per{margin-left:0.15rem;font-size:0.75rem;font-weight:400;letter-spacing:0;color:rgba(15, 23, 42, 0.5)}.plan-table .pt-badge{display:inline-block;margin-bottom:0.45rem;padding:0.1rem 0.55rem;border-radius:9999px;background:#007aff;color:#fff;font-size:0.68rem;font-weight:500}.plan-table .pt-hl{background:#f5f9ff}.plan-table thead .pt-hl{background:linear-gradient(180deg, #e8f2ff 0%, #f5f9ff 100%)}.plan-table .pt-hl .pt-price{color:#007aff}.plan-table .pt-check{display:inline-flex;align-items:center;justify-content:center;width:1.25rem;height:1.25rem;border-radius:9999px;background:rgba(0, 122, 255, 0.1);color:#007aff;font-size:0.7rem;font-weight:700}.plan-table .pt-dash{color:rgba(15, 23, 42, 0.3)}html.dark .plan-table-wrap{background:rgba(255, 255, 255, 0.02);border-color:rgba(255, 255, 255, 0.08)}html.dark .plan-table th,html.dark .plan-table td{color:rgba(255, 255, 255, 0.92);border-bottom-color:rgba(255, 255, 255, 0.06)!important}html.dark .plan-table thead th{border-bottom-color:rgba(255, 255, 255, 0.08)!important}html.dark .plan-table .pt-hint,html.dark .plan-table .pt-per{color:rgba(255, 255, 255, 0.45)}html.dark .plan-table .pt-hl{background:rgba(0, 122, 255, 0.08)}html.dark .plan-table thead .pt-hl{background:linear-gradient(180deg, rgba(0, 122, 255, 0.18) 0%, rgba(0, 122, 255, 0.08) 100%)}html.dark .plan-table .pt-hl .pt-price,html.dark .plan-table .pt-check{color:#4da3ff}html.dark .plan-table .pt-dash{color:rgba(255, 255, 255, 0.3)}"}],"page":{"pagePath":"api-reference/crawling/map","slug":"/api-reference/crawling/map","pageMetadata":{"title":"Map","openapi":"POST /map","keywords":["POST /map","map API","list site URLs","sitemap API"],"description":"Lists a website's page URLs without scraping them, optionally ranked by how well they match a search. It answers in the same request, so there's no job to poll. Guide: [Map](/map).\n\nURLs come from the site's sitemaps and from the links on its pages. Without `search`, current pages come before older versions and translations. With `search`, only matching URLs come back, best matches first. A map that takes longer than 45 seconds fails with `502`.\n\nEvery call is recorded in your [map logs](/api-reference/logs/map-logs).\n\n**Credits:** 1 per call. A map that finds no URLs, or fails, costs nothing.\n\n**Rate limits:** 60 requests a minute.\n","href":"/api-reference/crawling/map"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Lists a website’s page URLs without scraping them, optionally ranked by how well they match a search. It answers in the same request, so there’s no job to poll. Guide: \", _jsx(_components.a, {\n href: \"/map\",\n children: \"Map\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"URLs come from the site’s sitemaps and from the links on its pages. Without \", _jsx(_components.code, {\n children: \"search\"\n }), \", current pages come before older versions and translations. With \", _jsx(_components.code, {\n children: \"search\"\n }), \", only matching URLs come back, best matches first. A map that takes longer than 45 seconds fails with \", _jsx(_components.code, {\n children: \"502\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Every call is recorded in your \", _jsx(_components.a, {\n href: \"/api-reference/logs/map-logs\",\n children: \"map logs\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Credits:\"\n }), \" 1 per call. A map that finds no URLs, or fails, costs nothing.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Rate limits:\"\n }), \" 60 requests a minute.\"]\n })]\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Map","openapi":"POST /map","keywords":["POST /map","map API","list site URLs","sitemap API"],"description":"Lists a website's page URLs without scraping them, optionally ranked by how well they match a search. It answers in the same request, so there's no job to poll. Guide: [Map](/map).\n\nURLs come from the site's sitemaps and from the links on its pages. Without `search`, current pages come before older versions and translations. With `search`, only matching URLs come back, best matches first. A map that takes longer than 45 seconds fails with `502`.\n\nEvery call is recorded in your [map logs](/api-reference/logs/map-logs).\n\n**Credits:** 1 per call. A map that finds no URLs, or fails, costs nothing.\n\n**Rate limits:** 60 requests a minute.\n","href":"/api-reference/crawling/map"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/spidra/fe44716c737c36c1/toc-cta.js"],"openApiReferenceData":{"operation":{"summary":"Map","description":"Lists a website's page URLs without scraping them, optionally ranked by how well they match a search. It answers in the same request, so there's no job to poll. Guide: [Map](/map).\n\nURLs come from the site's sitemaps and from the links on its pages. Without `search`, current pages come before older versions and translations. With `search`, only matching URLs come back, best matches first. A map that takes longer than 45 seconds fails with `502`.\n\nEvery call is recorded in your [map logs](/api-reference/logs/map-logs).\n\n**Credits:** 1 per call. A map that finds no URLs, or fails, costs nothing.\n\n**Rate limits:** 60 requests a minute.\n","requestBody":"81b837f1-bd24-4f29-9988-e1a176dd30bd","responses":{"200":"b5c7f698-1140-40bb-9633-ee7b5615fee5","401":"ae0d9338-21ec-46c0-8f75-b239539d279a","402":"95d231e2-d846-4f83-8401-8c13c0f8fc41","403":"4d759854-b0f1-4290-9fc6-c0aec3894822","422":"928a8ee5-5039-4a1a-95cb-089703c6e09c","429":"acc539f9-869f-4750-912a-03ea955cfbee","502":"97c6c62e-0aff-4e19-a95d-82e21bd3127f"},"tags":["Crawling"],"method":"post","type":"path","servers":["bf13fe36-aa6a-4de6-964d-d06f33bc1bb9"],"security":["6ae77587-e60d-4803-9173-0a1617725897","696cbdd8-eb13-4014-a8dd-ee43246169e7"],"path":"/map","baseUrlOptions":["https://api.spidra.io/api"],"title":"Map","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri","description":"The site to map, starting with `http://` or `https://`. Usually the home page or a section such as `https://docs.python.org/3/`. Private and internal addresses are rejected.","example":"https://docs.python.org/3/","isRequired":true,"uniqueKey":"url","typeLabel":"string\u003curi>"},"search":{"type":"string","maxLength":500,"description":"Only return URLs related to this text, best matches first. Matches the link text and the URL.","example":"asyncio","uniqueKey":"search","typeLabel":"string"},"limit":{"type":"integer","minimum":1,"maximum":5000,"default":500,"description":"The most URLs to return. `total` still counts every match.","uniqueKey":"limit","typeLabel":"integer"},"sitemap":{"type":"string","enum":["include","skip","only"],"default":"include","description":"`include` reads the sitemaps and the links on the site's pages, which finds the most. `skip` reads only page links. `only` reads only the sitemaps, which is fastest.","uniqueKey":"sitemap","typeLabel":"enum\u003cstring>"},"includeSubdomains":{"type":"boolean","default":false,"description":"Also returns URLs on the site's subdomains, such as `blog.example.com` for `example.com`.","uniqueKey":"includeSubdomains","typeLabel":"boolean"},"ignoreQueryParams":{"type":"boolean","default":true,"description":"Treats URLs that differ only by their query string as one URL.","uniqueKey":"ignoreQueryParams","typeLabel":"boolean"},"respectRobots":{"type":"boolean","default":false,"description":"Leaves out URLs the site's `robots.txt` asks crawlers not to visit.","uniqueKey":"respectRobots","typeLabel":"boolean"},"cookies":{"type":"string","description":"Cookies from your own signed-in browser session, as `name=value; name2=value2`, to map pages that need an account. Never stored.","uniqueKey":"cookies","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"search":{"title":"search","value":{"url":"https://docs.python.org/3/","search":"asyncio","limit":20}},"page_links_only":{"title":"page_links_only","value":{"url":"https://docs.python.org/3/","search":"asyncio","limit":20,"sitemap":"skip"}},"sitemap_only":{"title":"sitemap_only","value":{"url":"https://docs.python.org/3/","sitemap":"only"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"b5c7f698-1140-40bb-9633-ee7b5615fee5":{"description":"The map finished. `links` is empty, with a `message` saying why, when no URLs were found. You aren't charged then.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["success"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"links":{"type":"array","description":"The URLs, best matches first with `search`, up to `limit`.","items":{"type":"object","properties":{"url":{"type":"string","description":"The page's URL.","uniqueKey":"links.items.[INDEX].url","typeLabel":"string"},"title":{"type":"string","description":"The text of the link it was found with. Missing for URLs that only came from a sitemap.","uniqueKey":"links.items.[INDEX].title","typeLabel":"string"}},"uniqueKey":"links.items.[INDEX]","typeLabel":"object"},"uniqueKey":"links","typeLabel":"object[]"},"total":{"type":"integer","description":"How many URLs matched the search, or how many were found without one. Can be more than `links` holds when it's capped by `limit`.","uniqueKey":"total","typeLabel":"integer"},"scanned":{"type":"integer","description":"Every URL found on the site, before the search filter. Missing when no URLs were found.","uniqueKey":"scanned","typeLabel":"integer"},"sources":{"type":"object","description":"Where the URLs came from.","properties":{"sitemap":{"type":"integer","description":"URLs found in the site's sitemaps.","uniqueKey":"sources.sitemap","typeLabel":"integer"},"pages":{"type":"integer","description":"URLs found in the links on its pages.","uniqueKey":"sources.pages","typeLabel":"integer"}},"uniqueKey":"sources","typeLabel":"object"},"creditsUsed":{"type":"integer","description":"`1`, or `0` when no URLs were found.","uniqueKey":"creditsUsed","typeLabel":"integer"},"message":{"type":"string","description":"Only when no URLs were found. Says why and what to try.","uniqueKey":"message","typeLabel":"string"},"durationMs":{"type":"integer","description":"How long the map took, in milliseconds.","uniqueKey":"durationMs","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"search":{"title":"search","value":{"status":"success","links":[{"url":"https://docs.python.org/3/library/asyncio.html","title":"asyncio"},{"url":"https://docs.python.org/3/library/asyncio-threading.html","title":"asyncio and free-threaded Python"},{"url":"https://docs.python.org/3/howto/a-conceptual-overview-of-asyncio.html","title":"A conceptual overview of asyncio"},"..."],"total":21,"scanned":595,"sources":{"sitemap":7,"pages":588},"creditsUsed":1,"durationMs":9552}},"page_links_only":{"title":"page_links_only","value":{"status":"success","links":[{"url":"https://docs.python.org/3/library/asyncio.html","title":"asyncio"},{"url":"https://docs.python.org/3/library/asyncio-threading.html","title":"asyncio and free-threaded Python"},{"url":"https://docs.python.org/3/howto/a-conceptual-overview-of-asyncio.html","title":"A conceptual overview of asyncio"},"..."],"total":21,"scanned":595,"sources":{"sitemap":0,"pages":595},"creditsUsed":1,"durationMs":7337}},"sitemap_only":{"title":"sitemap_only","value":{"status":"success","links":[{"url":"https://docs.python.org/3/"},{"url":"https://docs.python.org/3.11/"},{"url":"https://docs.python.org/3.12/"},"..."],"total":7,"scanned":7,"sources":{"sitemap":7,"pages":0},"creditsUsed":1,"durationMs":24}},"no_match":{"title":"no_match","value":{"status":"success","links":[],"total":0,"sources":{"sitemap":7,"pages":0},"creditsUsed":0,"message":"No URLs on this site matched your search.","durationMs":39}}},"exampleType":"examples"}},"exampleType":"examples"},"ae0d9338-21ec-46c0-8f75-b239539d279a":{"description":"The API key is missing, wrong, or turned off.","content":{"application/json":{"schema":{"type":"object","required":["status","message"],"properties":{"status":{"type":"string","enum":["error"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"What went wrong, as a sentence you can show to a person.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"A stable code for the error, when there is one, such as `JOB_NOT_FOUND` or `SERVICE_BUSY`. Branch on this rather than on `message`.","uniqueKey":"code","typeLabel":"string"},"errors":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"On validation errors (`422`), every problem with the request. Scrape, batch, crawl, map and search return a list of sentences. Templates, presets and monitors return `{ field, message }` objects.","uniqueKey":"errors.oneOf.0","typeLabel":"string[]"},{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"errors.oneOf.1.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.oneOf.1.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.oneOf.1.items.[INDEX]","typeLabel":"object"},"description":"On validation errors (`422`), every problem with the request. Scrape, batch, crawl, map and search return a list of sentences. Templates, presets and monitors return `{ field, message }` objects.","uniqueKey":"errors.oneOf.1","typeLabel":"object[]"}],"uniqueKey":"errors","typeLabel":"string[] | object[]"},"retry_after":{"type":"integer","description":"On `503 SERVICE_BUSY`, how many seconds to wait before sending the request again.","uniqueKey":"retry_after","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"missing":{"title":"missing","value":{"status":"error","message":"Missing authentication"}},"invalid":{"title":"invalid","value":{"status":"error","message":"Invalid token or API key"}}},"exampleType":"examples"}},"exampleType":"examples"},"95d231e2-d846-4f83-8401-8c13c0f8fc41":{"description":"The account's payment is overdue. Update the payment method in the dashboard to continue.","content":{"application/json":{"schema":{"type":"object","required":["status","message"],"properties":{"status":{"type":"string","enum":["error"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"What went wrong, as a sentence you can show to a person.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"A stable code for the error, when there is one, such as `JOB_NOT_FOUND` or `SERVICE_BUSY`. Branch on this rather than on `message`.","uniqueKey":"code","typeLabel":"string"},"errors":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"On validation errors (`422`), every problem with the request. Scrape, batch, crawl, map and search return a list of sentences. Templates, presets and monitors return `{ field, message }` objects.","uniqueKey":"errors.oneOf.0","typeLabel":"string[]"},{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"errors.oneOf.1.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.oneOf.1.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.oneOf.1.items.[INDEX]","typeLabel":"object"},"description":"On validation errors (`422`), every problem with the request. Scrape, batch, crawl, map and search return a list of sentences. Templates, presets and monitors return `{ field, message }` objects.","uniqueKey":"errors.oneOf.1","typeLabel":"object[]"}],"uniqueKey":"errors","typeLabel":"string[] | object[]"},"retry_after":{"type":"integer","description":"On `503 SERVICE_BUSY`, how many seconds to wait before sending the request again.","uniqueKey":"retry_after","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"example":{"status":"error","message":"Your payment is overdue. Please update your payment method to continue.","code":"PAYMENT_OVERDUE"},"examples":{"Example":{"title":"Example","value":{"status":"error","message":"Your payment is overdue. Please update your payment method to continue.","code":"PAYMENT_OVERDUE"}}},"exampleType":"examples"}},"exampleType":"examples"},"4d759854-b0f1-4290-9fc6-c0aec3894822":{"description":"Your account doesn't have enough credits left to start this job. Top up or upgrade, then send the request again.","content":{"application/json":{"schema":{"type":"object","required":["status","message"],"properties":{"status":{"type":"string","enum":["error"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"What went wrong, as a sentence you can show to a person.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"A stable code for the error, when there is one, such as `JOB_NOT_FOUND` or `SERVICE_BUSY`. Branch on this rather than on `message`.","uniqueKey":"code","typeLabel":"string"},"errors":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"On validation errors (`422`), every problem with the request. Scrape, batch, crawl, map and search return a list of sentences. Templates, presets and monitors return `{ field, message }` objects.","uniqueKey":"errors.oneOf.0","typeLabel":"string[]"},{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"errors.oneOf.1.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.oneOf.1.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.oneOf.1.items.[INDEX]","typeLabel":"object"},"description":"On validation errors (`422`), every problem with the request. Scrape, batch, crawl, map and search return a list of sentences. Templates, presets and monitors return `{ field, message }` objects.","uniqueKey":"errors.oneOf.1","typeLabel":"object[]"}],"uniqueKey":"errors","typeLabel":"string[] | object[]"},"retry_after":{"type":"integer","description":"On `503 SERVICE_BUSY`, how many seconds to wait before sending the request again.","uniqueKey":"retry_after","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"example":{"status":"error","message":"You have exceeded your monthly credit limit."},"examples":{"Example":{"title":"Example","value":{"status":"error","message":"You have exceeded your monthly credit limit."}}},"exampleType":"examples"}},"exampleType":"examples"},"928a8ee5-5039-4a1a-95cb-089703c6e09c":{"description":"The request isn't valid. `errors` lists every problem.","content":{"application/json":{"schema":{"type":"object","required":["status","message"],"properties":{"status":{"type":"string","enum":["error"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"What went wrong, as a sentence you can show to a person.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"A stable code for the error, when there is one, such as `JOB_NOT_FOUND` or `SERVICE_BUSY`. Branch on this rather than on `message`.","uniqueKey":"code","typeLabel":"string"},"errors":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"On validation errors (`422`), every problem with the request. Scrape, batch, crawl, map and search return a list of sentences. Templates, presets and monitors return `{ field, message }` objects.","uniqueKey":"errors.oneOf.0","typeLabel":"string[]"},{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"errors.oneOf.1.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.oneOf.1.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.oneOf.1.items.[INDEX]","typeLabel":"object"},"description":"On validation errors (`422`), every problem with the request. Scrape, batch, crawl, map and search return a list of sentences. Templates, presets and monitors return `{ field, message }` objects.","uniqueKey":"errors.oneOf.1","typeLabel":"object[]"}],"uniqueKey":"errors","typeLabel":"string[] | object[]"},"retry_after":{"type":"integer","description":"On `503 SERVICE_BUSY`, how many seconds to wait before sending the request again.","uniqueKey":"retry_after","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"missing_url":{"title":"missing_url","value":{"status":"error","message":"\"url\" is required.","errors":["\"url\" is required.","\"limit\" must be an integer between 1 and 5000."]}},"bad_sitemap":{"title":"bad_sitemap","value":{"status":"error","message":"\"sitemap\" must be \"include\", \"skip\" or \"only\".","errors":["\"sitemap\" must be \"include\", \"skip\" or \"only\"."]}},"private_url":{"title":"private_url","value":{"status":"error","message":"private and internal URLs are not allowed","errors":["private and internal URLs are not allowed"]}}},"exampleType":"examples"}},"exampleType":"examples"},"acc539f9-869f-4750-912a-03ea955cfbee":{"description":"More than 60 maps in a minute. Wait, then send the request again.","content":{"application/json":{"schema":{"type":"object","required":["status","message"],"properties":{"status":{"type":"string","enum":["error"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"What went wrong, as a sentence you can show to a person.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"A stable code for the error, when there is one, such as `JOB_NOT_FOUND` or `SERVICE_BUSY`. Branch on this rather than on `message`.","uniqueKey":"code","typeLabel":"string"},"errors":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"On validation errors (`422`), every problem with the request. Scrape, batch, crawl, map and search return a list of sentences. Templates, presets and monitors return `{ field, message }` objects.","uniqueKey":"errors.oneOf.0","typeLabel":"string[]"},{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"errors.oneOf.1.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.oneOf.1.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.oneOf.1.items.[INDEX]","typeLabel":"object"},"description":"On validation errors (`422`), every problem with the request. Scrape, batch, crawl, map and search return a list of sentences. Templates, presets and monitors return `{ field, message }` objects.","uniqueKey":"errors.oneOf.1","typeLabel":"object[]"}],"uniqueKey":"errors","typeLabel":"string[] | object[]"},"retry_after":{"type":"integer","description":"On `503 SERVICE_BUSY`, how many seconds to wait before sending the request again.","uniqueKey":"retry_after","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"example":{"status":"error","message":"Too many map requests. Please slow down and try again shortly."},"examples":{"Example":{"title":"Example","value":{"status":"error","message":"Too many map requests. Please slow down and try again shortly."}}},"exampleType":"examples"}},"exampleType":"examples"},"97c6c62e-0aff-4e19-a95d-82e21bd3127f":{"description":"The site couldn't be mapped, most often because it took longer than 45 seconds. You aren't charged. Try again, or use `sitemap` `only`, which is faster.","content":{"application/json":{"schema":{"type":"object","required":["status","message"],"properties":{"status":{"type":"string","enum":["error"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"What went wrong, as a sentence you can show to a person.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"A stable code for the error, when there is one, such as `JOB_NOT_FOUND` or `SERVICE_BUSY`. Branch on this rather than on `message`.","uniqueKey":"code","typeLabel":"string"},"errors":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"On validation errors (`422`), every problem with the request. Scrape, batch, crawl, map and search return a list of sentences. Templates, presets and monitors return `{ field, message }` objects.","uniqueKey":"errors.oneOf.0","typeLabel":"string[]"},{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"errors.oneOf.1.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.oneOf.1.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.oneOf.1.items.[INDEX]","typeLabel":"object"},"description":"On validation errors (`422`), every problem with the request. Scrape, batch, crawl, map and search return a list of sentences. Templates, presets and monitors return `{ field, message }` objects.","uniqueKey":"errors.oneOf.1","typeLabel":"object[]"}],"uniqueKey":"errors","typeLabel":"string[] | object[]"},"retry_after":{"type":"integer","description":"On `503 SERVICE_BUSY`, how many seconds to wait before sending the request again.","uniqueKey":"retry_after","typeLabel":"integer"},"creditsUsed":{"type":"integer","description":"Always `0`.","uniqueKey":"creditsUsed","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"example":{"status":"error","message":"The site took too long to map. Try again, or use sitemap: \"only\".","creditsUsed":0},"examples":{"Example":{"title":"Example","value":{"status":"error","message":"The site took too long to map. Try again, or use sitemap: \"only\".","creditsUsed":0}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"6ae77587-e60d-4803-9173-0a1617725897":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API key","scopes":[],"schemeName":"BearerAuth"}},"696cbdd8-eb13-4014-a8dd-ee43246169e7":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"bf13fe36-aa6a-4de6-964d-d06f33bc1bb9":{"url":"https://api.spidra.io/api"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API key","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"spidra","siteName":"Spidra","title":"Map - Spidra","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-25T09:08:39.060Z","originalFileLocation":"api-reference/crawling/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=\"system\"}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=\"Lists a website\u0026#x27;s page URLs without scraping them, optionally ranked by how well they match a search. It answers in the same request, so there\u0026#x27;s no job to poll. Guide: Map. URLs come from the site\u0026#x27;s sitemaps and from the links on its pages. Without search, current pages come before older versions and translations. With search, only matching URLs come back, best matches first. A map that takes longer than 45 seconds fails with 502. Every call is recorded in your map logs. Credits: 1 per call. A map that finds no URLs, or fails, costs nothing. Rate limits: 60 requests a minute.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Spidra\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/spidra/JYxAUddv93IVFozP/_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/spidra/JYxAUddv93IVFozP/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/spidra/JYxAUddv93IVFozP/_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/spidra/JYxAUddv93IVFozP/_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/spidra/JYxAUddv93IVFozP/_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/spidra/JYxAUddv93IVFozP/_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/spidra/JYxAUddv93IVFozP/_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/spidra/JYxAUddv93IVFozP/_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/spidra/JYxAUddv93IVFozP/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Map - Spidra\">\u003cmeta data-mint-head property=\"og:description\" content=\"Lists a website\u0026#x27;s page URLs without scraping them, optionally ranked by how well they match a search. It answers in the same request, so there\u0026#x27;s no job to poll. Guide: Map. URLs come from the site\u0026#x27;s sitemaps and from the links on its pages. Without search, current pages come before older versions and translations. With search, only matching URLs come back, best matches first. A map that takes longer than 45 seconds fails with 502. Every call is recorded in your map logs. Credits: 1 per call. A map that finds no URLs, or fails, costs nothing. Rate limits: 60 requests a minute.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Spidra\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.spidra.io/api-reference/crawling/map\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://spidra.mintlify.site/_mintlify/api/og/v2?division=Map\u0026amp;title=Map\u0026amp;description=Lists+a+website%27s+page+URLs+without+scraping+them%2C+optionally+ranked+by+how+well+they+match+a+search.+It+answers+in+the+same+request%2C+so+there%27s+no+job+to+poll.\u0026amp;theme=fd0fe7fea6781527f1876f07\u0026amp;signature=2619b3cc162f4ace504a6d44c8bf547bae577ed3b7e8d182e2c5264fce9a3fa1\">\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=\"Map - Spidra\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Lists a website\u0026#x27;s page URLs without scraping them, optionally ranked by how well they match a search. It answers in the same request, so there\u0026#x27;s no job to poll. Guide: Map. URLs come from the site\u0026#x27;s sitemaps and from the links on its pages. Without search, current pages come before older versions and translations. With search, only matching URLs come back, best matches first. A map that takes longer than 45 seconds fails with 502. Every call is recorded in your map logs. Credits: 1 per call. A map that finds no URLs, or fails, costs nothing. Rate limits: 60 requests a minute.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://spidra.mintlify.site/_mintlify/api/og/v2?division=Map\u0026amp;title=Map\u0026amp;description=Lists+a+website%27s+page+URLs+without+scraping+them%2C+optionally+ranked+by+how+well+they+match+a+search.+It+answers+in+the+same+request%2C+so+there%27s+no+job+to+poll.\u0026amp;theme=fd0fe7fea6781527f1876f07\u0026amp;signature=2619b3cc162f4ace504a6d44c8bf547bae577ed3b7e8d182e2c5264fce9a3fa1\">\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/spidra/JYxAUddv93IVFozP/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Spidra\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#007AFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.spidra.io/api-reference/crawling/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/crawling/map.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.spidra.io/#organization\",\"name\":\"Spidra\",\"url\":\"https://docs.spidra.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/spidra/tjYTncBEy2qwqvSx/logo/logo-light.png?fit=max\u0026auto=format\u0026n=tjYTncBEy2qwqvSx\u0026q=85\u0026s=9ee4bb079b87d8aea61a7d42bfecf118\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.spidra.io#website\",\"name\":\"Spidra\",\"url\":\"https://docs.spidra.io\",\"publisher\":{\"@id\":\"https://docs.spidra.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.spidra.io/api-reference/crawling/map#webpage\",\"url\":\"https://docs.spidra.io/api-reference/crawling/map\",\"name\":\"Map\",\"description\":\"Lists a website's page URLs without scraping them, optionally ranked by how well they match a search. It answers in the same request, so there's no job to poll. Guide: Map. URLs come from the site's sitemaps and from the links on its pages. Without search, current pages come before older versions and translations. With search, only matching URLs come back, best matches first. A map that takes longer than 45 seconds fails with 502. Every call is recorded in your map logs. Credits: 1 per call. A map that finds no URLs, or fails, costs nothing. Rate limits: 60 requests a minute.\",\"dateModified\":\"2026-10-25T09:08:39.060Z\",\"isPartOf\":{\"@id\":\"https://docs.spidra.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.spidra.io/api-reference/crawling/map#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.spidra.io/api-reference/crawling/map#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Spidra\",\"item\":\"https://docs.spidra.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Map\",\"item\":\"https://docs.spidra.io/api-reference/crawling/map\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.spidra.io/api-reference/crawling/map#apireference\",\"headline\":\"Map\",\"name\":\"Map\",\"description\":\"Lists a website's page URLs without scraping them, optionally ranked by how well they match a search. It answers in the same request, so there's no job to poll. Guide: Map. URLs come from the site's sitemaps and from the links on its pages. Without search, current pages come before older versions and translations. With search, only matching URLs come back, best matches first. A map that takes longer than 45 seconds fails with 502. Every call is recorded in your map logs. Credits: 1 per call. A map that finds no URLs, or fails, costs nothing. Rate limits: 60 requests a minute.\",\"url\":\"https://docs.spidra.io/api-reference/crawling/map\",\"mainEntityOfPage\":{\"@id\":\"https://docs.spidra.io/api-reference/crawling/map#webpage\"},\"dateModified\":\"2026-10-25T09:08:39.060Z\",\"keywords\":\"POST /map, map API, list site URLs, sitemap API\",\"publisher\":{\"@id\":\"https://docs.spidra.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.spidra.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Spidra\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Spidra","nav":{"global":{"anchors":[{"anchor":"Dashboard","icon":"book-open-cover","href":"https://app.spidra.io"},{"anchor":"GitHub","icon":"github","href":"https://github.com/spidra-io"},{"anchor":"Blog","icon":"newspaper","href":"https://spidra.io/blog"},{"anchor":"Changelog","icon":"clock-rotate-left","href":"https://spidra.io/changelog"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/overview"}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/sdks/overview"}]},{"tab":"API Reference","groups":[{"group":"Using the API","pages":[{"title":"API introduction","icon":"book","href":"/api-reference/introduction"},{"title":"Errors","icon":"triangle-exclamation","href":"/api-reference/errors"},{"title":"Rate limits","icon":"gauge","href":"/api-reference/rate-limits"},{"title":"Webhooks","icon":"webhook","href":"/api-reference/webhooks"}]},{"group":"Scrape","pages":[{"title":"Start a scrape","openapi":"POST /scrape","href":"/api-reference/scraping/scrape"},{"title":"Get a scrape","openapi":"GET /scrape/{jobId}","href":"/api-reference/scraping/scrape-status"}]},{"group":"Batch scrape","pages":[{"title":"Batch scrape","openapi":"POST /batch/scrape","href":"/api-reference/scraping/batch-scrape"},{"title":"Get a batch","openapi":"GET /batch/scrape/{batchId}","href":"/api-reference/scraping/batch-scrape-status"},{"title":"List batches","openapi":"GET /batch/scrape","href":"/api-reference/scraping/batch-scrape-list"},{"title":"Retry a batch","openapi":"POST /batch/scrape/{batchId}/retry","href":"/api-reference/scraping/batch-scrape-retry"},{"title":"Cancel a batch","openapi":"DELETE /batch/scrape/{batchId}","href":"/api-reference/scraping/batch-scrape-cancel"}]},{"group":"Crawl","pages":[{"title":"Crawl","openapi":"POST /crawl","href":"/api-reference/crawling/crawl"},{"title":"Get a crawl","openapi":"GET /crawl/{jobId}","href":"/api-reference/crawling/crawl-status"},{"title":"Get crawl pages","openapi":"GET /crawl/{jobId}/pages","href":"/api-reference/crawling/crawl-pages"},{"title":"Get a crawl report","openapi":"GET /crawl/{jobId}/report","href":"/api-reference/crawling/crawl-report"},{"title":"Extract from a crawl","openapi":"POST /crawl/{jobId}/extract","href":"/api-reference/crawling/crawl-extract"},{"title":"Retry a crawl page","openapi":"POST /crawl/{jobId}/retry/{pageId}","href":"/api-reference/crawling/crawl-retry-page"},{"title":"Download a crawl","openapi":"GET /crawl/{jobId}/download","href":"/api-reference/crawling/crawl-download"},{"title":"Get crawl details","openapi":"GET /crawl/job/{jobId}","href":"/api-reference/crawling/crawl-details"},{"title":"List crawls","openapi":"GET /crawl/history","href":"/api-reference/crawling/crawl-history"},{"title":"Cancel a crawl","openapi":"DELETE /crawl/{jobId}","description":"Cancels a queued or running crawl. A crawl that hasn't started is removed and its held credits are returned.\n\nA running crawl stops at its next check. If it had already returned pages, it finishes as `completed` with those pages, and they're charged as usual. If it hadn't, it ends as `cancelled` and costs nothing. A crawl about to finish may still complete.\n","href":"/api-reference/crawling/crawl-cancel"}]},{"group":"Map","pages":[{"title":"Map","openapi":"POST /map","href":"/api-reference/crawling/map"}]},{"group":"Search","pages":[{"title":"Search","openapi":"POST /search","description":"Searches the web, news, images, videos, research papers or GitHub issues and pull requests, and returns a `jobId`. Poll [Get a search](/api-reference/search/search-status) until `status` is `completed` or `failed`. Guide: [Search](/search).\n\nWith `wait: true`, the request waits up to 20 seconds and answers `200` with the result. If the search takes longer, you get the usual `202` and poll. `wait` is ignored when you send `scrapeOptions`, since reading pages takes longer.\n\n`limit` is per source, so 3 sources at 10 can return 30 results. To get the next page of a source, send its token from `nextPageTokens` back as `pageTokens`. If you send the same search again within 5 seconds, you get the first job's `jobId` back with `deduplicated: true`.\n\n**Credits:** 1 per 10 results per source, rounded up, so 20 web results cost 2 and 3 cost 1. A source with no results costs nothing. With `scrapeOptions`, each page read is billed as a scrape. See [How credits work](/billing/how-credits-work).\n\n**Rate limits:** 60 requests a minute, and up to 10 unfinished searches at a time.\n","href":"/api-reference/search/search"},{"title":"Get a search","openapi":"GET /search/{jobId}","href":"/api-reference/search/search-status"},{"title":"Cancel a search","openapi":"DELETE /search/{jobId}","href":"/api-reference/search/search-cancel"}]},{"group":"Parse","pages":[{"title":"Parse","openapi":"POST /parse","href":"/api-reference/parse/parse"},{"title":"Get a parse job","openapi":"GET /parse/{jobId}","href":"/api-reference/parse/parse-status"},{"title":"Parse a batch","openapi":"POST /parse/batch","href":"/api-reference/parse/parse-batch"},{"title":"Get a parse batch","openapi":"GET /parse/batch/{batchId}","href":"/api-reference/parse/parse-batch-status"},{"title":"Prepare a large upload","openapi":"POST /parse/uploads","href":"/api-reference/parse/parse-uploads"},{"title":"Delete a document","openapi":"DELETE /parse/files/{fileId}","href":"/api-reference/parse/parse-delete-file"},{"title":"List formats","openapi":"GET /parse/formats","href":"/api-reference/parse/parse-formats"}]},{"group":"Templates","pages":[{"title":"List templates","openapi":"GET /templates","href":"/api-reference/templates/list"},{"title":"Get a template","openapi":"GET /templates/{slug}","href":"/api-reference/templates/get"},{"title":"Estimate a template run","openapi":"POST /templates/{slug}/estimate","href":"/api-reference/templates/estimate"},{"title":"Run a template","openapi":"POST /templates/{slug}/runs","href":"/api-reference/templates/run"},{"title":"Get a template run","openapi":"GET /template-runs/{runId}","href":"/api-reference/templates/get-run"},{"title":"List template runs","openapi":"GET /template-runs","href":"/api-reference/templates/list-runs"},{"title":"Look up airports","openapi":"GET /templates/lookups/airports","href":"/api-reference/templates/airports"}]},{"group":"Presets","pages":[{"title":"Create a preset","openapi":"POST /presets","href":"/api-reference/presets/create"},{"title":"List presets","openapi":"GET /presets","href":"/api-reference/presets/list"},{"title":"Get a preset","openapi":"GET /presets/{presetId}","href":"/api-reference/presets/get"},{"title":"Update a preset","openapi":"PATCH /presets/{presetId}","href":"/api-reference/presets/update"},{"title":"Delete a preset","openapi":"DELETE /presets/{presetId}","href":"/api-reference/presets/delete"},{"title":"Run a preset","openapi":"POST /presets/{presetId}/runs","href":"/api-reference/presets/run"}]},{"group":"Monitors","pages":[{"title":"Create a monitor","openapi":"POST /monitors","href":"/api-reference/monitors/create"},{"title":"List monitors","openapi":"GET /monitors","href":"/api-reference/monitors/list"},{"title":"Get a monitor","openapi":"GET /monitors/{monitorId}","href":"/api-reference/monitors/get"},{"title":"Update a monitor","openapi":"PATCH /monitors/{monitorId}","href":"/api-reference/monitors/update"},{"title":"Delete a monitor","openapi":"DELETE /monitors/{monitorId}","href":"/api-reference/monitors/delete"},{"title":"Check a monitor now","openapi":"POST /monitors/{monitorId}/check","href":"/api-reference/monitors/check-now"},{"title":"Pause a monitor","openapi":"POST /monitors/{monitorId}/pause","href":"/api-reference/monitors/pause"},{"title":"Resume a monitor","openapi":"POST /monitors/{monitorId}/resume","href":"/api-reference/monitors/resume"},{"title":"List monitor checks","openapi":"GET /monitors/{monitorId}/checks","href":"/api-reference/monitors/list-checks"},{"title":"Get a monitor check","openapi":"GET /monitors/{monitorId}/checks/{checkId}","href":"/api-reference/monitors/get-check"},{"title":"Estimate a monitor","openapi":"POST /monitors/estimate","href":"/api-reference/monitors/estimate"},{"title":"Get monitor limits","openapi":"GET /monitors/limits","href":"/api-reference/monitors/limits"},{"title":"Send a test notification","openapi":"POST /monitors/test-notification","href":"/api-reference/monitors/test-notification"}]},{"group":"Logs","pages":[{"title":"List scrape logs","openapi":"GET /scrape-logs","href":"/api-reference/scraping/scrape-logs"},{"title":"Get a scrape log","openapi":"GET /scrape-logs/{uuid}","href":"/api-reference/scraping/scrape-logs-detail"},{"title":"List search logs","openapi":"GET /search-logs","href":"/api-reference/search/search-logs"},{"title":"Get a search log","openapi":"GET /search-logs/{uuid}","href":"/api-reference/search/search-logs-detail"},{"title":"List map logs","openapi":"GET /map-logs","href":"/api-reference/logs/map-logs"},{"title":"Get a map log","openapi":"GET /map-logs/{uuid}","href":"/api-reference/logs/map-logs-detail"},{"title":"List parse logs","openapi":"GET /parse-logs","href":"/api-reference/logs/parse-logs"}]},{"group":"Account","pages":[{"title":"Account","openapi":"GET /account","href":"/api-reference/account/account"},{"title":"Usage stats","openapi":"GET /usage-stats","href":"/api-reference/account/usage-stats"},{"title":"Usage by tool","openapi":"GET /usage-stats/breakdown","href":"/api-reference/account/usage-breakdown"}]}]}]},"basePath":"","title":"Map - Spidra","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}