Skip to content
PubIndexAPI

API Endpoints

The Publisher Indexing API currently has three API endpoints available to paid users.

  • /api/ping
  • /api/rss
  • /api/sitemap

/api/ping

Instantly triggers a crawl of the specified feed.

This endpoint is suitable if you are sure that you have published new content or updated existing content, and the content is in your RSS feed and available on the site for Google to crawl.

Example request:

https://api.pubindex.dev/api/ping?feed=your_rss_feed&api-key=xxxx

Replace your_rss_feed with your RSS feed URL, and xxxx with your API key.

/api/rss

Checks an RSS feed for updates. Instantly triggers a crawl of the specified RSS feed if an update is found.

Suitable for medium-large-enterprise sites that have caching in place of feeds.

Designed to be used with scheduled fetching - such as using a Cron job or indexing application.

Example request:

https://api.pubindex.dev/api/rss?feed=your_rss_feed&api-key=xxxx

Replace your_rss_feed with your RSS feed URL, and xxxx with your API key.

/api/sitemap

Checks an XML sitemap for updates. Pings Google Search Console to request a crawl of the specified sitemap.

Primarily designed to be used with News XML Sitemaps.

Example request:

https://api.pubindex.dev/api/sitemap?feed=your_news_sitemap&api-key=xxxx

Replace your_news_sitemap with your RSS feed URL, and xxxx with your API key.

Server Host/Base URL

The base URL of the API is:

https://api.pubindex.dev