GET
/
web
/
map
import { Supadata } from '@supadata/js';

const supadata = new Supadata({
  apiKey: 'YOUR_API_KEY',
});
const siteMap = await supadata.web.map('https://example.com');
console.log(siteMap);
{
  "urls": [
    "https://supadata.ai",
    "https://supadata.ai/documentation"
  ]
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
url
string
required

URL of the webpage

Example:

"https://supadata.ai"

​
noLinks
boolean
default:false

When true, removes markdown links from the content, leaving only the URL text.

​
lang
string
default:en

Preferred language for the scraped content (ISO 639-1 code). Sets Accept-Language header to influence website language selection.

Example:

"en"

Response

200
application/json

Successfully mapped web page

The response is of type object.