Sitemap Ping API Documentation

Introduction

The Sitemap Ping API allows you to ping search engines (e.g., Google, Yandex) with either a sitemap URL or a single URL. This documentation provides details on how to use the API, including the endpoint information, request formats, and sample responses.

Base URL

The base URL for the API is https://seox.p.rapidapi.com/.

Endpoint

Endpoint

• URL: /api/ping
• Method: GET

Query Parameters

• sitemap or url (required): The sitemap URL or a single URL to ping.
• engines (optional): Comma-separated list of search engines to ping (e.g., "google,yandex"). Default is both Google and Yandex.

Response

The API responds with a JSON object containing the ping results for each specified search engine.

Example Response:

{
  "results": [
    { "engine": "Google", "message": "Ping successful" },
    { "engine": "Yandex", "message": "Ping successful" }
  ]
}

400 Bad Request:

If neither sitemap nor url is provided. json { "error": "Either sitemap URL or single URL is required" }

500 Internal Server Error:

If an unexpected error occurs during the ping process. json { "error": "Internal Server Error" }

Example Usage

cURL Command

curl "https://seox.p.rapidapi.com/ping?sitemap=https://example.com/sitemap.xml&engines=google,yandex"

JavaScript (axios)

const axios = require('axios');

const target = 'https://example.com/sitemap.xml';
const engines = 'google,yandex';

axios.get(`https://seox.p.rapidapi.com/ping?sitemap=${target}&engines=${engines}`)
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error(error.response ? error.response.data : error.message);
  });