# PhantomBuster Documentation

> API-fy the Web: All-in-one scraping platform to automate all websites. Everything out of the box.

## Guides
- [Developer quick start](https://hub.phantombuster.com/docs/developer-quick-start.md): Welcome to Phantombuster! As a developer, in just a few minutes you'll be able to navigate to any page, extract and export its data.  To get started, we wrote the following step-by-step guide to extract the data on the front page of [Hacker News](https://news.ycombinator.com/) and download the data in various formats (CSV and JSON).
- [API](https://hub.phantombuster.com/docs/api.md): Programmatically control your Phantombuster account. **[Phantombuster API reference →](/reference)**
- [Using webhooks](https://hub.phantombuster.com/docs/using-webhooks.md)
- [Creating and updating leads lists using filters](https://hub.phantombuster.com/docs/creating-and-updating-leads-lists-using-filters.md): This tutorial explains how to use the POST /api/v2/org-storage/lists/save endpoint to create and update dynamic lists of leads using filters.
- [MCP server](https://hub.phantombuster.com/docs/mcp-server.md): Give AI tools a secured access to your PhantomBuster automations and data
- [Managing my custom scripts](https://hub.phantombuster.com/docs/managing-my-custom-scripts.md): This walkthrough will guide you from the creation of a script to its public release into the catalog of your org.
- [Coding a custom script](https://hub.phantombuster.com/docs/coding-a-custom-script.md): All you need to know to code a custom script on Phantombuster.
- [Script directives](https://hub.phantombuster.com/docs/script-directives.md): Important general informations on how to create and configure the environment your custom scripts will run in.
- [Packages & modules](https://hub.phantombuster.com/docs/packages.md): Know which modules are bundled with your scripts
- [BusterJS agent module](https://hub.phantombuster.com/docs/agent-module.md): Give your bots superpowers. **[BusterJS API reference →](/reference#buster-save)**
- [The agent & global objects](https://hub.phantombuster.com/docs/the-agent-and-global-object.md): A simple guide to help you understand what are the agent and global objects in Phantombuster
- [SDK: automatically publish code to Phantombuster](https://hub.phantombuster.com/docs/sdk.md): Code locally on your machine, within your favorite IDE, using your favorite tools!
- [Using external node dependencies](https://hub.phantombuster.com/docs/using-external-node-dependencies.md): This guide will teach you how to setup a project with Webpack to bundle your Phantombuster script.
- [Log in to a website](https://hub.phantombuster.com/docs/log-in-to-a-website.md): A simple guide to understand how to log in to any website with Phantombuster.
- [Take a screenshot](https://hub.phantombuster.com/docs/take-a-screenshot.md): A simple guide to take a screenshot and store it in the cloud with Phantombuster
- [Injectable client JS](https://hub.phantombuster.com/docs/injectable-client-js.md): Inject and use JavaScript libraries in the pages you visit
- [Use TypeScript](https://hub.phantombuster.com/docs/use-typescript.md): TypeScript provides highly productive development tools for JavaScript IDEs and practices, like static checking. It makes code easier to read and understand, there is a lot to gain using TypeScript over plain JavaScript.

## API Reference
- [/branches/fetch-all](https://hub.phantombuster.com/reference/get_branches-fetch-all.md): Gets the branches associated with the current organization's id.
- [/branches/diff](https://hub.phantombuster.com/reference/get_branches-diff.md): Gets the length difference between the staging and release branch of all scripts.
- [/branches/create](https://hub.phantombuster.com/reference/post_branches-create.md): Creates a new branch.
- [/branches/delete](https://hub.phantombuster.com/reference/post_branches-delete.md): Deletes a branch by id.
- [/branches/release](https://hub.phantombuster.com/reference/post_branches-release.md): Releases a script branch.
- [/scripts/fetch](https://hub.phantombuster.com/reference/get_scripts-fetch.md): Gets a script by id.
- [/scripts/fetch-all](https://hub.phantombuster.com/reference/get_scripts-fetch-all.md): Gets all the scripts associated with the current user.
- [/scripts/code](https://hub.phantombuster.com/reference/get_scripts-code.md): Gets the code of a script.
- [/scripts/visibility](https://hub.phantombuster.com/reference/post_scripts-visibility.md): Updates the visibility of a script.
- [/scripts/access-list](https://hub.phantombuster.com/reference/post_scripts-access-list.md): Updates the access list of a script.
- [/scripts/save](https://hub.phantombuster.com/reference/post_scripts-save.md): Updates or creates a new script. If an id is provided, the corresponding script will be updated. Otherwise, a new script will be created.
- [/scripts/delete](https://hub.phantombuster.com/reference/post_scripts-delete.md): Deletes a script by id.
- [/users/fetch-me](https://hub.phantombuster.com/reference/get_users-fetch-me.md): Gets the current user's info. If a sessionId is not provided the endpoint will create a new session and return the newly created id.
- [/users/update-me](https://hub.phantombuster.com/reference/post_users-update-me.md): Updates the current user's info.
- [/orgs/export-agent-usage](https://hub.phantombuster.com/reference/get_orgs-export-agent-usage-1.md): Gets a csv file containing agent usage info of the current user's organization.
- [/orgs/export-container-usage](https://hub.phantombuster.com/reference/get_orgs-export-container-usage-1.md): Gets a csv file containing container usage info of the current user's organization.
- [/orgs/fetch-agent-groups](https://hub.phantombuster.com/reference/get_orgs-fetch-agent-groups.md): Gets the agent groups and order of the current user's organization.
- [/orgs/save-agent-groups](https://hub.phantombuster.com/reference/post_orgs-save-agent-groups.md): Updates the agent groups and order of the current user's organization.
- [/orgs/fetch](https://hub.phantombuster.com/reference/get_orgs-fetch.md): Gets the current organization.
- [/orgs/fetch-resources](https://hub.phantombuster.com/reference/get_orgs-fetch-resources.md): Gets the current organization's resources and usage.
- [/orgs/fetch-running-containers](https://hub.phantombuster.com/reference/get_orgs-fetch-running-containers.md): Gets the current organization's running containers.
- [/orgs/save](https://hub.phantombuster.com/reference/post_orgs-save.md): Updates the current organization's info. Only web or MCP sessions are allowed to call this endpoint. Omit the `X-Phantombuster-Org` header to call this endpoint.
- [/orgs/fetch-crm-access](https://hub.phantombuster.com/reference/get_orgs-fetch-crm-access.md): Get the organization's CRM access to be able to fetch CRM resources.
- [/orgs/fetch-crm-resources](https://hub.phantombuster.com/reference/get_orgs-fetch-crm-resources.md): Gets the current organization's CRM requested resources.
- [/orgs/save-crm-contact](https://hub.phantombuster.com/reference/post_orgs-save-crm-contact.md): Save new contacts to CRM.
- [/containers/fetch-all](https://hub.phantombuster.com/reference/get_containers-fetch-all.md): Gets all containers associated to a specified agent.
- [/containers/fetch-result-object](https://hub.phantombuster.com/reference/get_containers-fetch-result-object.md): Gets the result object associated with a container.
- [/containers/fetch-output](https://hub.phantombuster.com/reference/get_containers-fetch-output.md): Gets the output of a container.
- [/containers/fetch](https://hub.phantombuster.com/reference/get_containers-fetch.md): Gets a container by id.
- [/containers/attach](https://hub.phantombuster.com/reference/get_containers-attach.md): Attaches to a running container and streams its output in real-time.
- [/agents/launch](https://hub.phantombuster.com/reference/post_agents-launch.md): Adds an agent to the launch queue.
- [/agents/launch-soon](https://hub.phantombuster.com/reference/post_agents-launch-soon.md): Schedules an agent to launch before a specific time.
- [/agents/launch-sync](https://hub.phantombuster.com/reference/post_agents-launch-sync.md): Launches an agent and streams execution status in real-time using NDJSON format. The stream begins with a start message exposing the containerId (so clients can reconnect via /containers/attach on disconnect) and then includes heartbeat messages, execution summary, and error messages if any occur. Optionally includes log lines when the includeLogs body parameter is set to true.
- [/agents/stop](https://hub.phantombuster.com/reference/post_agents-stop.md): Stops an agent.
- [/agents/unschedule-all](https://hub.phantombuster.com/reference/post_agents-unschedule-all.md): Disables the automatic launch for all of the agents from the current organization.
- [/agents/fetch-output](https://hub.phantombuster.com/reference/get_agents-fetch-output.md): Gets the output of the most recent container of an agent. This API endpoint is specifically designed so that it's easy to get incremental data from an agent.
- [/agents/fetch](https://hub.phantombuster.com/reference/get_agents-fetch.md): Gets an agent by id.
- [/agents/fetch-all](https://hub.phantombuster.com/reference/get_agents-fetch-all.md): Gets all agents of the current user's organization.
- [/agents/save](https://hub.phantombuster.com/reference/post_agents-save.md): Updates or creates a new agent. If an id is provided, the corresponding agent will be updated. Otherwise, a new agent will be created.
- [/agents/fetch-deleted](https://hub.phantombuster.com/reference/get_agents-fetch-deleted.md): Gets all deleted agents of the current user's organization.
- [/agents/delete](https://hub.phantombuster.com/reference/post_agents-delete.md): Deletes an agent by id.
- [/org-storage/leads/save-many](https://hub.phantombuster.com/reference/post_org-storage-leads-save-many.md): Save many leads - Beta.
- [/org-storage/leads/save](https://hub.phantombuster.com/reference/post_org-storage-leads-save.md): Save one lead - Beta.
- [/org-storage/leads/delete-many](https://hub.phantombuster.com/reference/post_org-storage-leads-delete-many.md): Delete many leads.
- [/org-storage/leads/by-list/{listId}](https://hub.phantombuster.com/reference/post_org-storage-leads-by-list-listid.md): Fetch leads by their list id.
- [/org-storage/lists/save](https://hub.phantombuster.com/reference/post_org-storage-lists-save.md): Save a list - Beta. For more information, see the [Creating and updating leads lists using filters](https://hub.phantombuster.com/docs/creating-and-updating-leads-lists-using-filters) page in the Developer Guides.
- [/org-storage/lists/delete](https://hub.phantombuster.com/reference/post_org-storage-lists-delete.md): Delete a list - Beta.
- [/org-storage/lists/fetch-all](https://hub.phantombuster.com/reference/get_org-storage-lists-fetch-all.md): Get all the lists - Beta.
- [/org-storage/lists/fetch](https://hub.phantombuster.com/reference/get_org-storage-lists-fetch.md): Get one list by ID - Beta.
- [/org-storage/leads-objects/save](https://hub.phantombuster.com/reference/post_org-storage-leads-objects-save.md): Save one lead object.
- [/org-storage/leads-objects/save-many](https://hub.phantombuster.com/reference/post_org-storage-leads-objects-save-many.md): Save many lead objects.
- [/org-storage/leads-objects/delete](https://hub.phantombuster.com/reference/post_org-storage-leads-objects-delete.md): Delete one or more leads objects.
- [/org-storage/leads-objects/search](https://hub.phantombuster.com/reference/post_org-storage-leads-objects-search.md): Search leads objects.
- [/org-storage/companies-objects/save](https://hub.phantombuster.com/reference/post_org-storage-companies-objects-save.md): Save one company object.
- [/org-storage/companies-objects/save-many](https://hub.phantombuster.com/reference/post_org-storage-companies-objects-save-many.md): Save many company objects.
- [/org-storage/companies-objects/search](https://hub.phantombuster.com/reference/post_org-storage-companies-objects-search.md): Search companies objects.
- [/identities/save-with-token](https://hub.phantombuster.com/reference/post_identities-save-with-token.md): Save identity.
- [/identities/generate-token](https://hub.phantombuster.com/reference/post_identities-generate-token.md): Generate identity token.
- [/identities/search](https://hub.phantombuster.com/reference/post_identities-search.md): Search identities.
- [/identities/events/save](https://hub.phantombuster.com/reference/post_identities-events-save.md): Save the identity event.
- [/identities/save](https://hub.phantombuster.com/reference/post_identities-save.md): Save identity.
- [/brightdata/serp](https://hub.phantombuster.com/reference/get_brightdata-serp.md): Perform a search using brightdata.
- [/location/ip](https://hub.phantombuster.com/reference/get_location-ip.md): Retrieves the country of the IP address.
- [/hcaptcha](https://hub.phantombuster.com/reference/post_hcaptcha.md): Solves an hCaptcha challenge. This endpoint will return a 200 status code even if an error occurs. The error will be set in the response body.
- [/recaptcha](https://hub.phantombuster.com/reference/post_recaptcha.md): Solves a reCAPTCHA challenge. Supports reCAPTCHA v3 and v2. This endpoint will return a 200 status code even if an error occurs. The error will be set in the response body.
- [/ai/completions](https://hub.phantombuster.com/reference/post_ai-completions.md): Get a completion from the AI.
- [/ai/advice](https://hub.phantombuster.com/reference/post_ai-advice.md): Get a recommendation from the AI.
- [/ai/tasks](https://hub.phantombuster.com/reference/post_ai-tasks.md): Get a task run by the AI.
- [/icps/fetch-all](https://hub.phantombuster.com/reference/get_icps-fetch-all.md): Fetch all ICPs for an org.
- [/buyers-personas/fetch-all](https://hub.phantombuster.com/reference/get_buyers-personas-fetch-all.md): Fetch all buyer personas for an org.
- [/agent/{id}](https://hub.phantombuster.com/reference/getagentrecord-1.md): Get an agent record.
- [/agent/{id}/launch](https://hub.phantombuster.com/reference/launchagent-1.md): Add an agent to the launch queue. The most important parameters is `output`, carefully choose yours when launching your agent with the API. For agents which take times to end, Phantombuster will send a space character every 10 seconds to prevent any timeout.
- [/agent/{id}/abort](https://hub.phantombuster.com/reference/abortagent-1.md): Abort all running instances of the agent.
- [/agent/{id}/output](https://hub.phantombuster.com/reference/outputagent-1.md): Get data from an agent: console output, status, progress and messages. This API endpoint is specifically designed so that it’s easy to get incremental data from an agent.
- [/agent/{id}/containers](https://hub.phantombuster.com/reference/containeragent-1.md): Get a list of ended containers for an agent, ordered by date. Useful for listing the last available output logs from an agent.
- [/script/by-name/{mode}/{name}](https://hub.phantombuster.com/reference/getscriptbyname-1.md): Get a script record by its name.
- [/script/{name}](https://hub.phantombuster.com/reference/updatescript-1.md): Update an existing script or create a new one if it does not exist (in this case, the new script ID is returned in the data field).
- [/user](https://hub.phantombuster.com/reference/getuser-1.md): Get information about your Phantombuster account and your agents.
- [save()](https://hub.phantombuster.com/reference/buster-save.md): save(urlOrPath [, saveAs, headers, callback])
- [saveBase64()](https://hub.phantombuster.com/reference/buster-savebase64.md): saveBase64(base64String, saveAs [, mime, callback])
- [saveFolder()](https://hub.phantombuster.com/reference/buster-savefolder.md): saveFolder([path, saveAs, callback])
- [saveText()](https://hub.phantombuster.com/reference/buster-savetext.md): saveText(text, saveAs [, mime, callback])
- [mail()](https://hub.phantombuster.com/reference/buster-mail.md): mail(subject, text [, to, callback])
- [pushover()](https://hub.phantombuster.com/reference/buster-pushover.md): pushover(message [, options , callback])
- [progressHint()](https://hub.phantombuster.com/reference/buster-progresshint.md): progressHint(progress [, label])
- [setResultObject()](https://hub.phantombuster.com/reference/buster-setresultobject.md): setResultObject(object [, callback])
- [agentId](https://hub.phantombuster.com/reference/buster-agentid.md): Contains the ID of the currently running agent as a `Number`.
- [apiKey](https://hub.phantombuster.com/reference/buster-apikey.md): Contains your Phantombuster API key as a `String`.
- [argument](https://hub.phantombuster.com/reference/buster-argument.md): Contains the agent's argument as a `PlainObject`.
- [containerId](https://hub.phantombuster.com/reference/buster-containerid.md): Contains the ID of the currently running container as a `Number`.
- [retryCount](https://hub.phantombuster.com/reference/retrycount.md): `Number` indicating on which retry run the bot is currently running.
- [maxRetries](https://hub.phantombuster.com/reference/maxretries.md): `Number` indicating how many times the agent will automatically restart in case of failure.
- [proxyAddress](https://hub.phantombuster.com/reference/buster-proxyaddress.md): Contains the proxy address currently being used by your agent as a `String`.
- [download()](https://hub.phantombuster.com/reference/buster-download.md): download(url [, saveAs, headers, callback])
- [getAgentObject()](https://hub.phantombuster.com/reference/buster-getagentobject.md): getAgentObject([agentId, callback])
- [getGlobalObject()](https://hub.phantombuster.com/reference/buster-getglobalobject.md): getGlobalObject([callback])
- [overrideTimeLimit()](https://hub.phantombuster.com/reference/buster-overridetimelimit.md): overrideTimeLimit(seconds [, callback])
- [setAgentObject()](https://hub.phantombuster.com/reference/buster-setagentobject.md): setAgentObject([agentId,] object [, callback])
- [setGlobalObject()](https://hub.phantombuster.com/reference/buster-setglobalobject.md): setGlobalObject(object [, callback])
- [solveCaptcha()](https://hub.phantombuster.com/reference/buster-solvecaptcha.md): solveCaptcha(selector, casperInstance [, callback])
- [solveCaptchaBase64()](https://hub.phantombuster.com/reference/buster-solvecaptchabase64.md): solveCaptchaBase64(base64String [, callback])
- [solveCaptchaImage()](https://hub.phantombuster.com/reference/buster-solvecaptchaimage.md): solveCaptchaImage(urlOrPath [, headers, callback])
- [solveNoCaptcha()](https://hub.phantombuster.com/reference/solverecaptcha.md): solveNoCaptcha(siteUrl, captchaToken [, secret, callback])
- [getTimeLeft()](https://hub.phantombuster.com/reference/gettimeleft.md): getTimeLeft([callback])