Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: 'superagnt Web: Map API'
description: Unified API for social media data. Access LinkedIn, YouTube, TikTok, X, Instagram, Reddit, and Facebook through a single API key.
version: 1.0.0
contact:
name: superagnt
url: https://superagnt.com
servers:
- url: https://api.superagnt.com
description: superagnt API
security:
- ApiKeyAuth: []
tags:
- name: 'Web: Map'
description: Discover the URLs on a website.
paths:
/v1/data/web/map:
post:
operationId: map
summary: Map a website's URLs
description: Returns a list of URLs found on a website, quickly. Useful for discovering the structure of a site before scraping specific pages. Optionally order results by relevance to a `search` term.
tags:
- 'Web: Map'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- url
properties:
url:
type: string
format: uri
description: The base URL of the site to map.
search:
type: string
description: Order returned URLs by relevance to this query.
sitemap:
type: string
enum:
- skip
- include
- only
description: How to use the site's sitemap. Default 'include'.
default: include
includeSubdomains:
type: boolean
description: Include URLs on subdomains.
default: true
ignoreQueryParameters:
type: boolean
description: Treat URLs that differ only by query string as the same URL.
default: true
limit:
type: integer
description: Maximum number of URLs to return. Default 5000, max 100000.
minimum: 1
maximum: 100000
default: 5000
timeout:
type: integer
description: Request timeout in milliseconds.
minimum: 1000
location:
type: object
description: Geographic proxy location and language settings.
properties:
country:
type: string
description: ISO 3166-1 alpha-2 country code.
languages:
type: array
items:
type: string
example:
url: https://example.com
responses:
'200':
description: The list of URLs discovered on the site.
content:
application/json:
schema:
type: object
'400':
description: Bad request — missing `url` or invalid parameter.
'401':
description: Unauthorized.
'402':
description: Insufficient balance.
'429':
description: Too many requests.
5XX:
description: Upstream error.
security:
- ApiKeyAuth: []
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: Authorization
description: 'Bearer token. Pass your agntdata API key as: Authorization: Bearer agnt_live_...'