Skip to main content

Get Actor

GET 
https://api.apify.com/v2/acts/:actorId

ClientsApify API Python Client ReferenceApify API JavaScript Client ReferenceGets an object that contains all the details about a specific Actor.

Request​

Path Parameters

    actorId stringrequired

    Actor ID or a tilde-separated owner's username and Actor name.

Responses​

Response Headers
    Schema
      data objectrequired
      idstringrequired
      Example: zdc3Pyhyz3m8vjDeM
      userIdstringrequired
      Example: wRsJZtadYvn4mBZmm
      namestringrequired
      Example: MyActor
      usernamestringrequired
      Example: jane35
      descriptionstringnullable
      Example: My favourite actor!
      restartOnErrorbooleannullable
      Example: false
      isPublicbooleanrequired
      Example: false
      createdAtstringrequired
      Example: 2019-07-08T11:27:57.401Z
      modifiedAtstringrequired
      Example: 2019-07-08T14:01:05.546Z
      stats objectrequired
      totalBuildsnumberrequired
      Example: 9
      totalRunsnumberrequired
      Example: 16
      totalUsersnumberrequired
      Example: 6
      totalUsers7Daysnumberrequired
      Example: 2
      totalUsers30Daysnumberrequired
      Example: 6
      totalUsers90Daysnumberrequired
      Example: 6
      totalMetamorphsnumberrequired
      Example: 2
      lastRunStartedAtstringrequired
      Example: 2019-07-08T14:01:05.546Z
      versions object[]required
    • Array [
      • versionNumberstringrequired
      Example: 0.0
      sourceType objectrequired
      oneOf
      envVars object[]nullable
    • Array [
      • namestringrequired
      Example: MY_ENV_VAR
      valuestringrequired
      Example: my-value
      isSecretbooleannullable
      Example: false
    • ]
      • applyEnvVarsToBuildbooleannullable
      Example: false
      buildTagstringrequired
      Example: latest
      sourceFiles object[]
    • Array [
      • anyOf
      formatstringrequired

      Possible values: [BASE64, TEXT]

      Example: TEXT
      contentstringrequired
      Example: console.log('This is the main.js file');
      namestringrequired
      Example: src/main.js
    • ]
    • ]
      • pricingInfos object[]
    • Array [
      • oneOf
      apifyMarginPercentagenumberrequired

      In [0, 1], fraction of pricePerUnitUsd that goes to Apify

      createdAtdate-timerequired

      When this pricing info record has been created

      startedAtdate-timerequired

      Since when is this pricing info record effective for a given Actor

      notifiedAboutFutureChangeAtdate-timenullable
      notifiedAboutChangeAtdate-timenullable
      reasonForChangestringnullable
      pricingModelstringrequired

      Possible values: [PAY_PER_EVENT]

      pricingPerEvent objectrequired
      actorChargeEvents object
      property name* ActorChargeEvent
      eventPriceUsdnumberrequired
      eventTitlestringrequired
      eventDescriptionstringrequired
      minimalMaxTotalChargeUsdnumbernullable
    • ]
      • defaultRunOptions objectrequired
      buildstringrequired
      Example: latest
      timeoutSecsnumberrequired
      Example: 3600
      memoryMbytesnumberrequired
      Example: 2048
      exampleRunInput object
      oneOf
      isDeprecatedbooleannullable
      Example: false
      deploymentKeystringrequired
      Example: ssh-rsa AAAA ...
      titlestringnullable
      Example: My Actor
      taggedBuilds object
      oneOf

    Authorization: http

    name: httpBearertype: httpscheme: bearerdescription: API authentication token.
    apify actors info <ACTOR ID>
    curl -L 'https://api.apify.com/v2/acts/:actorId' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer <token>'
    Request Collapse all
    Base URL
    https://api.apify.com
    Auth
    Parameters
    — pathrequired
    ResponseClear

    Click the Send API Request button above and see the response here!