Actor status badge

Apify Actor status badge can be embedded in 3rd party documentation to show current health status and engagement of the Actor in the Apify Platform.

---

Actor status badge example

This is the badge generated for the Apify's Website Content Crawler Actor.

How to embed the Actor status badge

The Badge is a dynamic SVG image loaded from the Apify platform. The Badge is served from the URL Template:

https://apify.com/actor-badge?actor=:username/:actor-name

In order to embed the badge in the HTML documentation, just use it as an image wrapped in a link as shown in the example below. Don't froget to use the username and actor-name of your Actor.

Example

HTML Example

<a href="https://apify.com/apify/website-content-crawler">
  <img src="https://apify.com/actor-badge?actor=apify/website-content-crawler">
</a>

Markdown Example

[![Website Content Crawler Actor](https://apify.com/actor-badge?actor=apify/website-content-crawler\)](https://apify.com/apify/website-content-crawler)

Supported Actor states

The badge indicates the state of the Actor in the Apify Platform as the result of the automated testing.

Actor OK

Actor under maintenance

Actor deprecated

Actor not found

Example of the Badge in Github README