Coding a custom script

All you need to know to code a custom script on Phantombuster.

Before diving deeper into the way you can code a custom scriptscript - The source code that will be executed by NodeJS in the cloud, using Puppeteers, Buster library, and more., please take some time to read the main technical concepts living within Phantombuster. Those concepts really are all over the place, so you better understand them correctly :smile:.

Why should I code a custom script?

At its core, Phantombuster allows you to script "web robots" in JavaScript. We call them scriptscript - The source code that will be executed by NodeJS in the cloud, using Puppeteers, Buster library, and more.s.

We provide more than 100 scripts to our users in our Store (which is basically Phantombuster's org catalogcatalog - An org's catalog is page listing the scripts owned by that particular org. Each org has a catalog accessible at an URL following this format: phantombuster.com/<org_slug>. For example, Phantombuster provides a public catalog of scripts at https://phantombuster.com/phantombuster. Your catalog is accessible through your developer's page, under the link "Org Store"), but they obviously don't cover all the use-cases of the web. You can create any scraper you want, corresponding exactly to your use case!

Important concepts

📘

Script

A scriptscript - The source code that will be executed by NodeJS in the cloud, using Puppeteers, Buster library, and more. The source code that will be executed by NodeJS in the cloud, using Puppeteers, Buster library, and more. It defines the behavior of your scraping and automations.

📘

Agent

An agentagent - An agent is an "instance of a script". It can be configured through its setup. An org's agents are listed in its dashboard. Every agent has its own page, where you can see details about the previous launches, debug your script live and so on... is an "instance of a script". It can be configured through its setup. An org's agents are listed in its dashboard. Every agent has its own page, where you can see details about the previous launches, debug your script live and so on...

❗️

Phantom

⚠️ You might see the use of the word "PhantomPhantom - ⚠️ A Phantom is a term intended for non-technical users which designates both a script (which is listed in an org's catalog) and an agent (which is an "instance of a script" listed in an org's dashboard). When developing on the Phantombuster platform, we recommend not using this term as it conflates both concepts." on our website.
A Phantom is a term intended for non-technical users which designates both a script (which is listed in an org's catalog) and an agent (which is an "instance of a script" listed in an org's dashboard). When developing on the Phantombuster platform, we recommend not using this term as it conflates both concepts.

Creating and configuring custom scriptscript - The source code that will be executed by NodeJS in the cloud, using Puppeteers, Buster library, and more.s is what we'll explain in this set of guides.

Updated 4 months ago


Coding a custom script


All you need to know to code a custom script on Phantombuster.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.