/apify/actors

POST /api/apify/actors

Price: 1 credit

Get Apify Store actor details by 'username/actor-name', actor ID, or store URL

How to use it

Get full details of an Apify Store actor by 'username/actor-name', actor ID, or store URL. Returns title, description, readme summary, categories, author username, version, timestamps, usage statistics (runs, users, reviews, bookmarks), and complete pricing information (pricing model such as FREE, FLAT_PRICE_PER_MONTH, PRICE_PER_DATASET_ITEM or PAY_PER_EVENT, unit prices, trial period, and per-event price tiers).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• actor string required — Actor as 'username/actor-name', an actor ID, or an Apify Store URL (examples: "apify/instagram-scraper", "moJRLRc85AitArpNN", "https://apify.com/apify/web-scraper"; minLength: 1)

Response

• @type string (default: "ApifyActor")
• id string required
• name string required
• username string required
• user_id string nullable
• alias string required
• web_url string required
• description string nullable
• readme_summary string nullable
• image string nullable
• categories array (default: [])
• version string nullable
• notice string nullable
• is_public boolean (default: false)
• is_deprecated boolean (default: false)
• created_at string nullable
• modified_at string nullable
• stats object nullable
  • @type string (default: "ApifyActorStats")
  • run_count integer (default: 0)
  • user_count integer (default: 0)
  • user_count_7_days integer nullable
  • user_count_30_days integer nullable
  • user_count_90_days integer nullable
  • build_count integer nullable
  • bookmark_count integer nullable
  • review_count integer nullable
  • review_rating number nullable
  • last_run_at string nullable
  • run_stats_30_days object nullable
    • @type string (default: "ApifyActorRunStats")
    • succeeded_count integer (default: 0)
    • failed_count integer (default: 0)
    • aborted_count integer (default: 0)
    • timed_out_count integer (default: 0)
    • total_count integer (default: 0)
• pricing object nullable
  • @type string (default: "ApifyActorPricing")
  • pricing_model string required
  • price_per_unit_usd number nullable
  • unit_name string nullable
  • trial_minutes integer nullable
  • minimal_max_total_charge_usd number nullable
  • apify_margin_percentage number nullable
  • started_at string nullable
  • created_at string nullable
  • events array (default: [])
    • @type string (default: "ApifyActorPricingEvent")
    • key string required
    • description string nullable
    • is_primary boolean (default: false)
    • is_one_time boolean (default: false)
    • price_usd number nullable
    • tiered_prices_usd object (default: {})
      • * number

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Actor not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.