Map Discover all URLs on a website without scraping their content.
The Map API discovers URLs on a website without extracting page content. It returns a list of links found via sitemaps, link following, and optional relevance ranking — useful for site audits, building crawl plans, or understanding site structure.
POST https://api.octivas.com/api/v1/map Parameter Type Required Default Description urlstring (URL)Yes — The website URL to map limitintegerNo 5000Maximum number of links to return (1–100,000)
Parameter Type Required Default Description searchstringNo — Search query to rank returned URLs by relevance include_subdomainsbooleanNo — Include URLs from subdomains of the website ignore_query_parametersbooleanNo — Do not return URLs with query parameters sitemapstringNo — Sitemap usage mode: "only" (sitemap URLs only), "include" (sitemap + discovery), "skip" (no sitemap)
Parameter Type Required Default Description timeoutintegerNo — Request timeout in milliseconds (1,000–120,000) locationobjectNo — Geographic settings (see Location Object )
Field Type Required Description countrystringYes ISO 3166-1 alpha-2 country code (e.g. "US", "DE") languagesstring[]No Preferred languages (defaults to ["en"])
cURL JavaScript Python
curl -X POST https://api.octivas.com/api/v1/map \ -H "Authorization: Bearer your_api_key" \ -H "Content-Type: application/json" \ -d '{ "url": "https://example.com", "limit": 100 }' const response = await fetch ( "https://api.octivas.com/api/v1/map" , { method : "POST" , headers : { "Authorization" : "Bearer your_api_key" , "Content-Type" : "application/json" , }, body : JSON . stringify ({ url : "https://example.com" , limit : 100 , }), }); const result = await response. json (); console. log ( `Found ${ result . links_count } URLs` ); result.links. forEach ( link => console. log (link.url)); import requests response = requests.post( "https://api.octivas.com/api/v1/map" , headers = { "Authorization" : "Bearer your_api_key" , "Content-Type" : "application/json" , }, json = { "url" : "https://example.com" , "limit" : 100 , }, ) result = response.json() print ( f "Found { result[ 'links_count' ] } URLs" ) for link in result[ "links" ]: print (link[ "url" ]) Use search ranking and filtering to discover specific sections of a site:
cURL JavaScript Python
curl -X POST https://api.octivas.com/api/v1/map \ -H "Authorization: Bearer your_api_key" \ -H "Content-Type: application/json" \ -d '{ "url": "https://example.com", "limit": 500, "search": "pricing", "include_subdomains": true, "ignore_query_parameters": true, "sitemap": "include", "timeout": 30000 }' const response = await fetch ( "https://api.octivas.com/api/v1/map" , { method: "POST" , headers: { "Authorization" : "Bearer your_api_key" , "Content-Type" : "application/json" , }, body: JSON . stringify ({ url: "https://example.com" , limit: 500 , search: "pricing" , include_subdomains: true , ignore_query_parameters: true , sitemap: "include" , timeout: 30000 , }), }); const result = await response. json (); console. log ( `Found ${ result . links_count } URLs matching "pricing"` ); import requests response = requests.post( "https://api.octivas.com/api/v1/map" , headers = { "Authorization" : "Bearer your_api_key" , "Content-Type" : "application/json" , }, json = { "url" : "https://example.com" , "limit" : 500 , "search" : "pricing" , "include_subdomains" : True , "ignore_query_parameters" : True , "sitemap" : "include" , "timeout" : 30000 , }, ) result = response.json() print ( f "Found { result[ 'links_count' ] } URLs matching 'pricing'" ) { "success" : true , "url" : "https://example.com" , "links_count" : 3 , "links" : [ { "url" : "https://example.com/" , "title" : "Home" , "description" : "Main page" }, { "url" : "https://example.com/about" , "title" : "About" }, { "url" : "https://example.com/blog" } ] } Field Type Description successbooleanWhether the request succeeded urlstringThe mapped website URL links_countintegerNumber of links returned linksarrayArray of discovered link objects links[].urlstringURL of the discovered page links[].titlestring | nullPage title (when available) links[].descriptionstring | nullPage description (when available)