Map API

Overview

Use Map when you need a list of URLs from a website before deciding what to scrape, crawl, or analyze. Map discovers links; it does not return page body content. For multi-page content extraction, use Crawl. For a single page, use Scraper or Extract.

Endpoint

POST /api/v2/map

Quickstart

import { LLMLayerClient } from 'llmlayer';

const client = new LLMLayerClient({
  apiKey: process.env.LLMLAYER_API_KEY,
});

const site = await client.map('https://www.ycombinator.com', {
  limit: 100,
  search: 'blog',
});

for (const link of site.links.slice(0, 10)) {
  console.log(link.url, link.title);
}

from llmlayer import LLMLayerClient

client = LLMLayerClient(api_key="YOUR_LLMLAYER_API_KEY")

site = client.map(
    "https://www.ycombinator.com",
    limit=100,
    search="blog",
)

for link in site.links[:10]:
    print(str(link.url), link.title)

curl -X POST https://api.llmlayer.dev/api/v2/map \
  -H "Authorization: Bearer YOUR_LLMLAYER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://www.ycombinator.com",
    "limit": 100,
    "search": "blog"
  }'

Request Parameters

Parameter	Type	Required	Default	Description
`url`	`string`	Yes	-	Website URL to map
`ignoreSitemap`	`boolean`	No	`false`	Ignore sitemap.xml discovery
`includeSubdomains`	`boolean`	No	`false`	Include subdomains
`search`	`string \| null`	No	`null`	Filter discovered URLs/titles by text
`limit`	`integer`	No	`5000`	Maximum links to return
`timeout`	`integer \| null`	No	`45000`	Timeout in milliseconds

The raw API uses camelCase for map request fields: ignoreSitemap and includeSubdomains. The Python SDK maps these to ignore_sitemap and include_subdomains.

Response

{
  "links": [
    {
      "url": "https://www.ycombinator.com/blog",
      "title": "YC Blog"
    }
  ],
  "statusCode": 200,
  "cost": 0.002
}

Field	Type	Description
`links`	`array`	Discovered links with `url` and `title`
`statusCode`	`integer`	`200` on success
`cost`	`number \| null`	Cost in USD

Common Patterns

Map then crawl

Use Map to inspect the URL surface before crawling.

const site = await client.map('https://www.ycombinator.com', {
  limit: 50,
});

const blogPages = site.links.filter((link) => link.url.includes('/blog'));
console.log(blogPages.map((link) => link.url));

Map then scrape selected pages

site = client.map("https://www.ycombinator.com", search="blog", limit=20)

for link in site.links[:3]:
    page = client.scrape(str(link.url), formats=["markdown"], main_content_only=True)
    print(page.title, page.markdown[:200] if page.markdown else "")

Pricing

Map costs $0.002 per request.

Errors

Status	Meaning
`400`	Invalid URL or request parameters
`401`	Missing or invalid LLMLayer API key
`403`	Blocked private/unsafe target
`500`	Mapping provider or internal error

See Errors & Refunds for the shared error format.

More Examples

Search + Scrape Pipeline

Find and process selected pages.

Crawl API

Stream markdown from multiple pages.

Get Started

Resources

Examples

Overview

Endpoint

Quickstart

Request Parameters

Response

Common Patterns

Map then crawl

Map then scrape selected pages

Pricing

Errors

More Examples

Search + Scrape Pipeline

Crawl API

​Overview

​Endpoint

​Quickstart

​Request Parameters

​Response

​Common Patterns

​Map then crawl

​Map then scrape selected pages

​Pricing

​Errors

​More Examples

Search + Scrape Pipeline

Crawl API

Overview

Endpoint

Quickstart

Request Parameters

Response

Common Patterns

Map then crawl

Map then scrape selected pages

Pricing

Errors

More Examples