POST /map

POST

map

{
  "url": "https://www.amazon.com",
  "includeSubdomains": true,
  "ignoreQueryParameters": true,
  "limit": 1000
}

{
  "success": true,
  "links": [
    {
      "url": "https://example.com/deals",
      "type": "product-list",
      "title": "Deals",
      "description": "Today's featured deals."
    }
  ]
}

{
  "detail": "Invalid map request \u2014 e.g. malformed `url` or missing hostname."
}

Discover URLs for a website. By default the endpoint checks robots.txt for one or more sitemap URLs, follows sitemap indexes, and collects page URLs from sitemap XML (including .xml.gz files).

Authorization

Send your pline API key in the X-API-Key header on every request.

Body

string

required

Base website URL to discover URLs for.

any

default:"include"

Sitemap handling. include returns URLs found in the sitemap; skip skips the sitemap; only returns URLs from the sitemap exclusively.

boolean

default:"true"

Whether to include subdomains of the registrable domain. Set false to stay on the exact host.

boolean

default:"true"

Whether URLs with query parameters should be excluded.

boolean

default:"false"

Bypass cached discovery results and refresh discovery.

integer

default:"1000"

Maximum number of links to return (1–1,000,000).

integer

Optional overall request timeout in milliseconds.

Response

boolean

required

Whether discovery completed successfully.

object[]

required

Best-effort flat list of discovered URLs.

Show links properties

string

required

Discovered URL.

string

Best-effort category for the discovered URL. One of product-details, product-list, event-details, event-list, article, faq, about, image, pdf, document, video, cart-checkout, account, homepage, search, contact, legal, maps, unknown.

string

Page title, when available.

string

Page description, when available.

Response codes

Code	Meaning
`200`	Best-effort URL discovery response
`422`	Invalid map request — e.g. malformed `url` or missing hostname.

{
  "url": "https://www.amazon.com",
  "includeSubdomains": true,
  "ignoreQueryParameters": true,
  "limit": 1000
}

{
  "success": true,
  "links": [
    {
      "url": "https://example.com/deals",
      "type": "product-list",
      "title": "Deals",
      "description": "Today's featured deals."
    }
  ]
}

{
  "detail": "Invalid map request \u2014 e.g. malformed `url` or missing hostname."
}

{
  "url": "https://www.amazon.com",
  "includeSubdomains": true,
  "ignoreQueryParameters": true,
  "limit": 1000
}

{
  "success": true,
  "links": [
    {
      "url": "https://example.com/deals",
      "type": "product-list",
      "title": "Deals",
      "description": "Today's featured deals."
    }
  ]
}

{
  "detail": "Invalid map request \u2014 e.g. malformed `url` or missing hostname."
}

Scrape

Batch scrape

Map

Crawl

SERP

Authorization

Body

Response

Response codes

​Authorization

​Body

​Response

​Response codes

Authorization

Body

Response

Response codes