Sitemap Architect API

Welcome to the Sitemap Architect API. Our API provides a simple, programmatic way to generate XML sitemaps for any website, designed for easy integration into your applications and workflows.

Authentication

To use the API, you need an API key. Include this key in the X-API-Key header of every request.

API Key

Your API key is: QOjoHBVjZitAPPqugKlPFV8aS70jSRfGx70EVCZM0l0

Rate Limiting

The free tier of our API is limited to 5 requests per IP address per day. The rate limit resets daily at midnight (UTC).

If you exceed this limit, you will receive a 429 Too Many Requests error. If you require a higher request limit, please contact us about our premium plans.

How It Works

1. Send Request

Make a POST request to our endpoint with your API key and the target URL.

2. We Crawl

Our service intelligently crawls the website to discover all internal links and pages.

3. Receive XML

You receive a JSON response containing the complete sitemap in XML format.

Endpoint

There is a single endpoint for generating sitemaps.

Generate Sitemap

POST /api/generate

This endpoint initiates a crawl of the specified URL and returns the generated sitemap data.

Headers

{
  "Content-Type": "application/json",
  "X-API-Key": "QOjoHBVjZitAPPqugKlPFV8aS70jSRfGx70EVCZM0l0"
}

Body Parameters

{
  "url": "https://www.example.com"
}

url (string, required): The full, valid URL of the website you want to generate a sitemap for. Must include http:// or https://.

Responses

Success Response (200 OK)

If the request is successful, the API returns a JSON object containing the sitemap data and metadata.

{
  "success": true,
  "message": "Sitemap generated successfully.",
  "data": { ... }
}

Error Responses (4xx/5xx)

If there is an error, the API will return a JSON object with an appropriate error message.

{
  "success": false,
  "message": "Authentication failed. Invalid or missing API key."
}

{
  "success": false,
  "message": "API rate limit exceeded (5 requests per day). Please contact us for premium access."
}

Example Request (cURL)

Here's how you can make a request using cURL from your terminal.

curl -X POST 'https://sitemap.softmaji.in/api/generate' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: QOjoHBVjZitAPPqugKlPFV8aS70jSRfGx70EVCZM0l0' \
--data-raw '{
    "url": "https://www.softmaji.in"
}'