Skip to main content

Actor status badge

Copy for LLM

You can embed the Actor status badge in your README or documentation to show users the current status and usage information of your Actor on the Apify platform.

Actor status badge in GitHub README

Supported statuses

The badge displays the status of your Actor in the Apify platform based on the result of the automated testing process. The following statuses are supported:

  • Actor OK Actor OK status badge
  • Actor under maintenance Actor under maintenance status badge
  • Actor deprecated Actor deprecated status badge
  • Actor not found Actor not found status badge

Embed the status badge

The status badge is a dynamic SVG image loaded from the Apify platform and served from the following URL template:

https://apify.com/actor-badge?actor=<USERNAME>/<ACTOR>

Where:

  • <USERNAME> is your Apify username.
  • <ACTOR> is the name of your Actor.

To embed the badge in your HTML documentation, use the badge URL as an image wrapped in a link:

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