POST/v1/maps

Maps

This endpoint allows users to get all the urls on a certain website. It can take up to 120 seconds for complex websites. For large websites, results are paginated using cursor-based pagination

Olostep·$0.01 per call

Example code

// Using @orth/sdk - The simplest way to call APIs
// Install: npm install @orth/sdk
import Orthogonal from "@orth/sdk";

const orthogonal = new Orthogonal({
  apiKey: process.env.ORTHOGONAL_API_KEY,
});

const output = await orthogonal.run({
  api: "olostep",
  path: "/v1/maps",
  body: {
    "url": "example"
  }
});

console.log(output);

Body parameters

urlrequired

string

The URL of the website for which you want the links

search_query

string

An optional search query to sort the links by search relevance.

top_n

number

An optional number to limit to only top n links for a search query.

include_subdomain

boolean

Include subdomains of the given URL. `true` by default.

include_urls

string

URL path patterns to include using glob syntax. For example: `/blog/**` to only include blog URLs. Only URLs matching these patterns will be returned.

exclude_urls

string

URL path patterns to exclude using glob syntax. For example: `/careers/**`. Excluded URLs will supersede included URLs.

cursor

string

OPTIONAL: Pagination cursor from a previous response. When provided, returns the next set of URLs from where the previous request left off due to response size limit.

Response

string

urls.0

string

urls_count

number