Phantombuster

  • Home
  • Guides & tutorials
  • API reference
  • Back to Phantombuster.com →

Phantombuster developer hub

Welcome to the Phantombuster developer hub. You'll find comprehensive guides and documentation to help you start working with Phantombuster APIs and web automation as quickly as possible, as well as support if you get stuck. Let's jump right in!

HomeGuides & tutorialsRecipesAPI referenceReferenceChangelogDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API Logs
    HomeGuides & tutorialsAPI reference
discard

Developer guides

  • Developer quick start
  • API
  • Using webhooks

Custom scripts

  • Managing my custom scripts
  • Coding a custom script
    • Script directives
    • Packages & modules
    • BusterJS agent module
    • The agent & global objects
    • SDK: automatically publish code to Phantombuster
    • Using external node dependencies

Scraping how-tos

  • Log in to a website
  • Take a screenshot
  • Injectable client JS
  • Use TypeScript

Developer guides

  • Developer quick start
  • API
  • Using webhooks

Custom scripts

  • Managing my custom scripts
  • Coding a custom script
    • Script directives
    • Packages & modules
    • BusterJS agent module
    • The agent & global objects
    • SDK: automatically publish code to Phantombuster
    • Using external node dependencies

Scraping how-tos

  • Log in to a website
  • Take a screenshot
  • Injectable client JS
  • Use TypeScript

API v1

  • Agent
    • get
      /agent/{id}
    • post
      /agent/{id}/launch
    • post
      /agent/{id}/abort
    • get
      /agent/{id}/output
    • get
      /agent/{id}/containers
  • Script
    • get
      /script/by-name/{mode}/{name}
    • post
      /script/{name}
  • User
    • get
      /user

Phantombuster API v2

  • orgs
    • get
      /orgs/export-agent-usage
    • get
      /orgs/export-container-usage
    • get
      /orgs/fetch-agent-groups
    • post
      /orgs/save-agent-groups
    • get
      /orgs/fetch
    • get
      /orgs/fetch-resources
    • get
      /orgs/fetch-running-containers
  • events
    • get
      /events/org/fetch-all
  • containers
    • get
      /containers/fetch-all
    • get
      /containers/fetch-result-object
    • get
      /containers/fetch-output
    • get
      /containers/fetch
  • branches
    • get
      /branches/fetch-all
    • get
      /branches/diff
    • post
      /branches/create
    • post
      /branches/delete
    • post
      /branches/release
  • agents
    • post
      /agents/launch
    • post
      /agents/launch-soon
    • post
      /agents/stop
    • post
      /agents/unschedule-all
    • get
      /agents/fetch-output
    • get
      /agents/fetch
    • get
      /agents/fetch-all
    • post
      /agents/save
    • post
      /agents/delete
  • scripts
    • get
      /scripts/fetch
    • get
      /scripts/fetch-all
    • get
      /scripts/code
    • post
      /scripts/visibility
    • post
      /scripts/save
    • post
      /scripts/delete

Buster

  • save()
  • saveBase64()
  • saveFolder()
  • saveText()
  • mail()
  • pushover()
  • progressHint()
  • setResultObject()
  • agentId
  • apiKey
  • argument
  • containerId
  • retryCount
  • maxRetries
  • proxyAddress
  • download()
  • getAgentObject()
  • getGlobalObject()
  • overrideTimeLimit()
  • setAgentObject()
  • setGlobalObject()
  • solveCaptcha()
  • solveCaptchaBase64()
  • solveCaptchaImage()
  • solveNoCaptcha()
  • getTimeLeft()
Powered by

Developer guides

  • Developer quick start
  • API
  • Using webhooks

Custom scripts

  • Managing my custom scripts
  • Coding a custom script

Scraping how-tos

  • Log in to a website
  • Take a screenshot
  • Injectable client JS
View All 4

API v1

  • Agent
  • Script
  • User

Phantombuster API v2

  • orgs
  • events
  • containers
View All 6

Buster

  • fnsave()
  • fnsaveBase64()
  • fnsaveFolder()
View All 26