v3

OpenAPI 3.1.2Apache 2.02026-07-31231237972.0 KB

Store

Get list of Actors in Store

Gets the list of public Actors in Apify Store. You can use search parameter to search Actors by string in title, name, description, username and readme. If you need detailed info about a specific Actor, use the Get Actor endpoint.

The endpoint supports pagination using the limit and offset parameters. It will not return more than 1,000 records.

get/v2/store

Query parameters

limitnumber double

Example:1000

Maximum number of items to return. The default value as well as the maximum is 1000.

offsetnumber double

Number of items that should be skipped at the start. The default value is 0.

searchstring

Example:web scraper

String to search by. The search runs on the following fields: title, name, description, username, readme.

sortBystring

Example:'popularity'

Specifies the field by which to sort the results. The supported values are relevance (default), popularity, newest and lastUpdate.

categorystring

Example:'AI'

Filters the results by the specified category.

usernamestring

Example:'apify'

Filters the results by the specified username.

pricingModel'FREE' | 'FLAT_PRICE_PER_MONTH' | 'PRICE_PER_DATASET_ITEM' | 'PAY_PER_EVENT'

Example:FREE

Only return Actors with the specified pricing model.

allowsAgenticUsersboolean

Example:true

If true, only return Actors that allow agentic users. If false, only return Actors that do not allow agentic users.

responseFormat'full' | 'agent'

Example:agent

Controls the shape of the response. Use full (default) for the complete response including image URLs and all fields. Use agent for a reduced field set optimized for LLM consumers, which only includes id, title, name, username, description, notice, badge, categories, and minimal stats.

includeUnrunnableActorsboolean

Example:true

By default, search results exclude Actors that are not safe to run automatically (e.g. Actors from developers who haven't passed KYC, or full-permission Actors without a large user base). Set to true to bypass this safety filtering and include all Actors in the results.

Response

Example response

{
  "data": {
    "total": 100,
    "offset": 0,
    "limit": 1000,
    "desc": false,
    "count": 1,
    "items": [
      {
        "id": "zdc3Pyhyz3m8vjDeM",
        "title": "My Public Actor",
        "name": "my-public-actor",
        "username": "jane35",
        "userFullName": "Jane Doe",
        "description": "My public Actor!",
        "pictureUrl": "https://...",
        "userPictureUrl": "https://...",
        "url": "https://...",
        "stats": {
          "totalBuilds": 9,
          "totalRuns": 16,
          "totalUsers": 6,
          "totalUsers7Days": 2,
          "totalUsers30Days": 6,
          "totalUsers90Days": 6,
          "totalMetamorphs": 2,
          "lastRunStartedAt": "2019-07-08T14:01:05.546Z"
        },
        "currentPricingInfo": {
          "pricingModel": "FREE"
        },
        "isWhiteListedForAgenticPayments": true
      },
      {
        "id": "zdc3Pyhyz3m8vjDeM",
        "title": "My Public Actor",
        "name": "my-public-actor",
        "username": "jane35",
        "userFullName": "Jane H. Doe",
        "categories": [
          "MARKETING",
          "LEAD_GENERATION"
        ],
        "description": "My public Actor!",
        "pictureUrl": "https://...",
        "userPictureUrl": "https://...",
        "url": "https://...",
        "stats": {
          "totalBuilds": 9,
          "totalRuns": 16,
          "totalUsers": 6,
          "totalUsers7Days": 2,
          "totalUsers30Days": 6,
          "totalUsers90Days": 6,
          "totalMetamorphs": 2,
          "lastRunStartedAt": "2019-07-08T14:01:05.546Z"
        },
        "currentPricingInfo": {
          "pricingModel": "FREE"
        },
        "isWhiteListedForAgenticPayments": false
      }
    ]
  }
}