Follow this guide for step-by-step instructions on using PhantomBuster’s API to automate your actions directly from your app.
How to enable developer features
- Navigate to your PhantomBuster Dashboard and sign in.
- Hover over your name in the upper right corner of the page and go to the My personal settings page.
- Click on Enable developer mode, and then on Save settings.
- You’re all set.
How to create an API key?
1. Hover over your name in the top-right corner of your PhantomBuster workspace.
2. If you have more than one workspace, ensure the correct workspace is selected from the drop-down menu next to your currently active workspace.
💡Look for the ✔️ symbol next to the active workspace name.
3. Under your Technical section, select API Keys:
4. Click on Add API key:
5. Copy your API key and save it somewhere secure for future use.
How to launch a Phantom via API call
⚠️ Before launching Phantoms via API, we recommend testing the automation settings in manual launch.
1. Navigate to the Solutions page and click on Use now to select the Phantom you wish to use.
2. Fill in all the required settings.
3. After the test, go back to Phantom settings and switch them to JSON.
4. A visible argument can be used in your API Connector or directly in the hub.phantombuster.com - launch endpoint page.
5. To launch a Phantom with specific settings, feed the API call with settings, fill in the corresponding argument, and provide the PhantomBuster API key and the agent (Phantom) ID.
💡You can find the Phantom ID at the end of your Phantom URL.For example, for this URL: https://phantombuster.com/xxx/phantoms/yyy/console - The Phantom ID is yyy.
6. To launch a Phantom with existing settings, you need to feed the API call request with the agent (Phantom) ID and PhantomBuster API key.
💡 You can find whole argument under API subpage directly from Phantom console page.
Code a Phantom
If none of the Phantoms available on the PhantomBuster Solutions page meet your needs, you can find handy instructions on how to code your own Phantom here.
Related guides
How to Connect PhantomBuster with Make
You can contact Support at any time for additional details on using PhantomBuster’s API.