Skip to main content
POST
/
v1
/
map
Map
curl --request POST \
  --url https://sdk.nimbleway.com/v1/map \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com",
  "sitemap": "include",
  "country": "US",
  "locale": "en-US",
  "domain_filter": "all",
  "limit": 100
}
'
{
  "task_id": "1ed1dbeb-8f34-4fd1-bb2d-a72bacae2ef3",
  "success": true,
  "links": [
    {
      "title": "Web Scraping API",
      "url": "https://www.example.com/page1",
      "description": "Complete guide to web scraping"
    },
    {
      "url": "https://www.nimbleway.com/nimble-api/web"
    },
    {
      "title": "API Documentation",
      "url": "https://www.example.com/docs"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body model for the /map endpoint

​
url
string<uri>
required

Url to map

Example:

"https://example.com"

​
sitemap
enum<string>

Sitemap and other methods will be used together to find URLs

Available options:
skip,
include,
only
Example:

"include"

​
country
string

Country used to access the target URL, use ISO Alpha-2 Codes

Example:

"US"

​
locale
string

LCID standard locale used for the URL request. Alternatively, user can use 'auto' for automatic locale based on geo-location

Example:

"en-US"

​
domain_filter
enum<string>

Includes subdomains of the main domain in the mapping process

Available options:
domain,
subdomain,
all
Example:

"all"

​
limit
integer

Maximum number of links to return

Required range: 1 <= x <= 100000

Response

Successful Response

Response schema for map requests

​
task_id
string
required

Unique identifier for the map task

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
success
boolean
required

Indicates if the map request was successful

Example:

true

​
links
object[]
required

Array of mapped links with optional titles and descriptions

Examples:
{
  "url": "https://example.com/page1",
  "title": "Example Page 1",
  "description": "This is an example description for page 1"
}
{ "url": "https://example.com/page2" }