The README.md file documents what your actor does and how to use it, which is then displayed in the Console or Apify Store. It's always a good idea to write a README.md. In a few months, not even you will remember all the details about the actor.

You can use Markdown language for rich formatting.

Documentation reference

Writing a README

See our tutorial on writing READMEs for your actors if you need more inspiration.

On this page

Getting started with Apify actors
- Documentation reference
- Writing a README

Share Actor:

Logs a lot then sleeps

frantisek/logs-a-lot-then-sleeps

An actor which logs 100000 lines and then sleeps for 2 hours. Useful for testing logging.

František Nesveda

5.0

Send Mail

apify/send-mail

The actor automatically sends an email to a specific address. This actor is useful for notifications and reporting. With only 3 lines of JavaScript code, you'll be on top of your scraping actors and never miss important results or issues.

Apify Technologies

4.0

PPE Test charging

jkuzz/ppe-test-charging

This is an Actor for testing PPE charging. Charge any amount of events via the input. Thanks for your money.

Jan Kuželík

5.0

Yet Another Paid Actor

pepa.valek/ActorWithAllDetailsForStore2

Scrape and download Instagram posts, profiles, places, hashtags, photos, and comments. Supports search queries and URL lists. Download your data as HTML table, JSON, CSV, Excel, XML, and RSS feed.

Josef Válek

Test-title

honzakirchner43/screenshot-url-mine

Actor serving as an example of Input Schema. Takes URL of website and screenshot configuration parameters as input and outputs a screenshot of the website into Key-Value store.

Jan Kirchner

Screen URL Duplicate

matej-test/screenshot-url-duplicate

Actor serving as an example of Input Schema. Takes URL of website and screenshot configuration parameters as input and outputs a screenshot of the website into Key-Value store.

Matej Hamaš

Screenshot Url

apify/screenshot-url

Actor serving as an example of Input Schema. Takes URL of website and screenshot configuration parameters as input and outputs a screenshot of the website into Key-Value store.

Apify Technologies

Instagram Profile Scraper

pepa.valek/ActorWithAllDetailsForStore

Scrape and download Instagram posts, profiles, places, hashtags, photos, and comments. Supports search queries and URL lists. Download your data as HTML table, JSON, CSV, Excel, XML, and RSS feed.

Josef Válek

Screenshot Url 21

honzakirchner43/screenshot-url-21

Actor serving as an example of Input Schema. Takes URL of website and screenshot configuration parameters as input and outputs a screenshot of the website into Key-Value store.

Jan Kirchner

screenshot-url-copy-paid-2

pavel-at/screenshot-url-copy-paid-2

Actor serving as an example of Input Schema. Takes URL of website and screenshot configuration parameters as input and outputs a screenshot of the website into Key-Value store.

Pavel