> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Firecrawl

> Firecrawl automates web crawling and data extraction, enabling organizations to gather content, index sites, and gain insights from online sources at scale

![Firecrawl logo](https://mintcdn.com/composio-preview/GL28i3tBlbEbBd-f/images/toolkits/firecrawl.svg?fit=max\&auto=format\&n=GL28i3tBlbEbBd-f\&q=85\&s=0707d97a01add66b375d42a1b35dd628)

* **Category:** web scraping & browser
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 241
* **Triggers:** 0
* **Slug:** `FIRECRAWL`
* **Version:** 20261101\_00
* **Instant:** Supported on the latest version. Support varies by tool.

## Frequently Asked Questions

> [accordion] Batch fewer URLs or raise timeout for long Firecrawl scrape jobs
>
> For Firecrawl scrape timeouts, reduce the number of links per request, such as batching 1-2 links at a time for complex pages, or increase the scrape timeout if the tool call supports it. A useful starting timeout is `120000` milliseconds for roughly a 2-minute timeout.

## Tools

> [accordion] Cancel an agent job
>
> **Slug:** `FIRECRAWL_AGENT_CANCEL`
>
> Cancels an in-progress agent job by its ID. Returns a success boolean when the cancellation request succeeds.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier (UUID) of the agent job to cancel.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Bulk company enrichment with apollo
>
> **Slug:** `FIRECRAWL_APOLLO_COMPANIES_BULK_ENRICH`
>
> Enrich up to ten companies in one call, billed 30 Firecrawl credits per matched company; unmatched records are free.
>
> #### Input Parameters
>
> **details** `array`
>
> Up to ten objects with domain, linkedin\_url, name and/or website. Takes precedence over domains\[] if both are supplied.
>
> **domains** `array`
>
> Up to ten company domains, without [www](http://www). Use details for other identifiers.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Company enrichment with apollo
>
> **Slug:** `FIRECRAWL_APOLLO_COMPANIES_ENRICH`
>
> Use when you have a domain or LinkedIn company URL and need the company behind it. For a company you can only name, search first.
>
> #### Input Parameters
>
> **domain** `string`
>
> Company domain, for example firecrawl.dev. The reliable key: names collide.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **linkedin\_url** `string`
>
> LinkedIn company page, for example [https://www.linkedin.com/company/apolloio](https://www.linkedin.com/company/apolloio).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Complete company information with apollo
>
> **Slug:** `FIRECRAWL_APOLLO_COMPANIES_INFO`
>
> Look up a company by its Apollo ID; use companies/enrich when you have a domain instead.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Apollo organization ID from companies/search or companies/enrich.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Company job postings with apollo
>
> **Slug:** `FIRECRAWL_APOLLO_COMPANIES_JOB_POSTINGS`
>
> Find current hiring activity at a known company. Each requested page costs 30 Firecrawl credits.
>
> #### Input Parameters
>
> **page** `number`
>
> Page number starting at 1.
>
> **per\_page** `number`
>
> Results per page; Apollo limits this endpoint to 10,000 records.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **organization\_id** `string` *required*
>
> Apollo organization ID from companies/search or companies/enrich.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Company news search with apollo
>
> **Slug:** `FIRECRAWL_APOLLO_COMPANIES_NEWS`
>
> Find news about known Apollo companies, optionally filtered by category and dates. Each requested page costs 30 Firecrawl credits.
>
> #### Input Parameters
>
> **page** `number`
>
> Page number starting at 1.
>
> **per\_page** `number`
>
> Articles per page, maximum 25.
>
> **categories** `array`
>
> News categories, such as hires, investment or contract.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **organization\_ids** `array` *required*
>
> Apollo organization IDs to find news about.
>
> **published\_at\_max** `string`
>
> Latest publication date, YYYY-MM-DD; must follow the earliest date.
>
> **published\_at\_min** `string`
>
> Earliest publication date, YYYY-MM-DD.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Company search with apollo
>
> **Slug:** `FIRECRAWL_APOLLO_COMPANIES_SEARCH`
>
> Search Apollo companies by name or description, employee count, location, and technology. Results are billed per page.
>
> #### Input Parameters
>
> **page** `number`
>
> Page of results, from 1.
>
> **per\_page** `number`
>
> Results per page, maximum 100.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **q\_organization\_name** `string`
>
> Free text matched against company names and descriptions.
>
> **organization\_locations** `array`
>
> Locations to restrict to, for example "San Francisco, US".
>
> **organization\_num\_employees\_ranges** `array`
>
> Employee-count bands, for example \["1,10", "11,50"].
>
> **currently\_using\_any\_of\_technology\_uids** `array`
>
> Technologies the company must use, for example \["Stripe"].
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Bulk people enrichment with apollo
>
> **Slug:** `FIRECRAWL_APOLLO_PEOPLE_BULK_MATCH`
>
> Enrich up to ten identified people in one call, billed 30 Firecrawl credits per matched person; unmatched records are free.
>
> #### Input Parameters
>
> **details** `array` *required*
>
> Up to 10 people. Each object accepts id, first\_name, last\_name, name, email, hashed\_email, organization\_name, domain, linkedin\_url. Prefer IDs from people/search.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **reveal\_personal\_emails** `boolean`
>
> Request personal emails for all matches only when explicitly wanted. Defaults to false.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Complete person information with apollo
>
> **Slug:** `FIRECRAWL_APOLLO_PEOPLE_INFO`
>
> Retrieve a known Apollo person by ID. Use people/match to unlock contact information.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Apollo person ID from people/search.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Person match with apollo
>
> **Slug:** `FIRECRAWL_APOLLO_PEOPLE_MATCH`
>
> Use to resolve one person you have already found. Prefer the id from people/search, then a LinkedIn URL, then email; a bare name needs a domain beside it or it will match the wrong person.
>
> #### Input Parameters
>
> **id** `string`
>
> Apollo person id from people/search. The most reliable input by far.
>
> **name** `string`
>
> Full name, used with a company domain.
>
> **email** `string`
>
> Known email address.
>
> **domain** `string`
>
> Company domain, used with a name to disambiguate.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **linkedin\_url** `string`
>
> LinkedIn profile URL. Resolves even when the slug is stale.
>
> **reveal\_phone\_number** `boolean`
>
> Reveal a phone number. Substantially more expensive than the base match.
>
> **reveal\_personal\_emails** `boolean`
>
> Reveal a personal email as well as the work one. Bills extra and is a different consent question: ask for it only when the caller asked for it.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Batch scrape multiple URLs
>
> **Slug:** `FIRECRAWL_BATCH_SCRAPE`
>
> Start a batch scrape job for multiple URLs with concurrent processing, customizable formats and content filtering. Returns a job ID and status URL for checking progress or retrieving results.
>
> #### Input Parameters
>
> **urls** `array` *required*
>
> The URLs to be scraped in batch. At least one URL is required.
>
> **proxy** `string ("basic" | "stealth" | "auto")`
>
> Proxy type to use for requests.
>
> **maxAge** `integer`
>
> Cache validity period in milliseconds. Default is 2 days.
>
> **mobile** `boolean`
>
> If true, emulate a mobile device when scraping. Defaults to false.
>
> **actions** `array`
>
> Browser actions to perform on each page before scraping.
>
> **formats** `array`
>
> Desired output formats for the scraped content. Defaults to \['markdown'].
>
> **headers** `object`
>
> Custom HTTP headers to send with each request.
>
> **timeout** `integer`
>
> Request timeout in milliseconds.
>
> **waitFor** `integer`
>
> Delay in milliseconds before content retrieval. Useful for pages with dynamic content. Defaults to 0.
>
> **webhook** `object`
>
> Webhook configuration for batch scrape notifications
>
> **blockAds** `boolean`
>
> If true, block advertisements during scraping. Defaults to true.
>
> **location** `object`
>
> Location settings for the request
>
> **excludeTags** `array`
>
> HTML tags to specifically exclude from the output.
>
> **includeTags** `array`
>
> HTML tags to specifically include in the output.
>
> **storeInCache** `boolean`
>
> If true, store scraped content in cache for future use. Defaults to true.
>
> **maxConcurrency** `integer`
>
> Maximum number of concurrent scrape operations. Controls how many URLs are scraped simultaneously.
>
> **onlyMainContent** `boolean`
>
> If true, extract only the main content, excluding headers, footers, navigation bars, and ads. Defaults to true.
>
> **ignoreInvalidURLs** `boolean`
>
> If true, skip invalid URLs instead of failing the entire batch. Defaults to true.
>
> **zeroDataRetention** `boolean`
>
> If true, do not retain any scraped data. Defaults to false.
>
> **removeBase64Images** `boolean`
>
> If true, remove base64-encoded images from the scraped content. Defaults to true.
>
> **skipTlsVerification** `boolean`
>
> If true, skip TLS certificate verification. Defaults to true.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cancel a batch scrape job
>
> **Slug:** `FIRECRAWL_BATCH_SCRAPE_CANCEL`
>
> Tool to cancel a running batch scrape job using its unique identifier. Use when you need to terminate an in-progress batch scrape operation.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier (UUID) of the batch scrape job to cancel.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get batch scrape status
>
> **Slug:** `FIRECRAWL_BATCH_SCRAPE_GET`
>
> Retrieves the current status, progress and a page of results for a batch scrape job by ID. The response may include a next URL for additional results.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The ID of the batch scrape job. Must be a valid UUID format obtained when the batch scrape was initiated.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get errors from batch scrape job
>
> **Slug:** `FIRECRAWL_BATCH_SCRAPE_GET_ERRORS`
>
> Tool to retrieve error details from a batch scrape job, including failed URLs and URLs blocked by robots.txt. Use when you need to debug or understand why certain pages failed to scrape in a batch operation.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier (UUID) of the batch scrape job.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Consensus ratings with benzinga
>
> **Slug:** `FIRECRAWL_BENZINGA_CALENDAR_CONSENSUS_RATINGS`
>
> Use for where analysts stand in aggregate right now on one company. For the individual changes that moved the consensus, use calendar/ratings instead.
>
> #### Input Parameters
>
> **pagesize** `number`
>
> Records to return. Limit 1000.
>
> **simplify** `boolean`
>
> Collapse the aggregate to BUY, HOLD and SELL rather than the five-step scale.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **aggregate\_type** `string ("number" | "percentage")`
>
> Whether each rating bucket is reported as a count of analysts or as a percentage of them.
>
> **parameters\_date\_to** `string`
>
> Latest date, YYYY-MM-DD.
>
> **parameters\_tickers** `string`
>
> Exactly one ticker symbol to aggregate for; the endpoint takes a single ticker, not a list. Call once per company.
>
> **parameters\_date\_from** `string`
>
> Earliest date, YYYY-MM-DD.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Mergers and acquisitions with benzinga
>
> **Slug:** `FIRECRAWL_BENZINGA_CALENDAR_MERGERS_ACQUISITIONS`
>
> Use for who is buying whom, at what price, and whether the deal is pending or closed. For the coverage and commentary around a deal use news/search.
>
> #### Input Parameters
>
> **page** `number`
>
> Zero-based page offset, capped at 100000. Prefer narrowing by date over paging deep.
>
> **pagesize** `number`
>
> Number of records to return, limit 1000.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **parameters\_date** `string`
>
> A single date, YYYY-MM-DD, as shorthand when date\_from and date\_to would be the same. Leave unset to get the latest deals.
>
> **parameters\_date\_to** `string`
>
> Latest date, YYYY-MM-DD, interpreted against date\_sort.
>
> **parameters\_tickers** `string`
>
> Comma-separated ticker symbols, maximum 50. Set this when the caller asks whether a named company is acquiring or being acquired.
>
> **parameters\_updated** `number`
>
> Unix timestamp in UTC; returns only records updated at or after it. Set this when polling for changes since a previous call.
>
> **parameters\_date\_from** `string`
>
> Earliest date, YYYY-MM-DD, interpreted against date\_sort.
>
> **parameters\_date\_sort** `string ("expected" | "completed" | "announced")`
>
> Which deal date to sort on. Use announced for a chronology of new deals, expected for pending closes, or completed for deals that have closed.
>
> **parameters\_importance** `string ("0" | "1" | "2" | "3" | "4" | "5")`
>
> Minimum importance level, matched as greater than or equal to the value given. Raise it when the caller only wants large or notable deals.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Analyst ratings with benzinga
>
> **Slug:** `FIRECRAWL_BENZINGA_CALENDAR_RATINGS`
>
> Use for how analysts have moved on a stock: upgrades, downgrades, initiations and target changes. Filter by parameters\[analyst\_id] or parameters\[firm\_id] to follow one analyst or firm. It carries the ratings, not the reasoning behind them.
>
> #### Input Parameters
>
> **page** `number`
>
> Page offset, 0 to 100000.
>
> **fields** `string`
>
> Comma-separated response fields to return, or \* for every field including ratings\_accuracy. Available: id, date, time, ticker, exchange, name, currency, action\_pt, action\_company, rating\_current, pt\_current, rating\_prior, pt\_prior, pt\_pct\_change, url, url\_calendar, url\_news, analyst, analyst\_id, analyst\_name, firm\_id, ratings\_accuracy, importance, notes, updated. Set it to trim the payload when you only need the rating and target.
>
> **pagesize** `number`
>
> Records to return. Limit 1000.
>
> **simplify** `boolean`
>
> Collapse ratings to standardized categories.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **parameters\_date** `string`
>
> A single date, YYYY-MM-DD, as shorthand when date\_from and date\_to would be the same. Leave unset to get the latest ratings.
>
> **parameters\_action** `string ("Assumes" | "Downgrades" | "Firm Dissolved" | "Initiates Coverage On" | "Maintains" | "Reinstates" | "Reiterates" | "Removes" | "Suspends" | "Terminates Coverage On" | "Upgrades")`
>
> Ratings action to filter to, matched against action\_company.
>
> **parameters\_date\_to** `string`
>
> Latest rating date, YYYY-MM-DD.
>
> **parameters\_firm\_id** `string`
>
> Comma-separated firm ids. Take them from the id field of calendar/ratings-firms, or the firm\_id on a rating, to keep to one research firm's coverage.
>
> **parameters\_tickers** `string`
>
> Comma-separated ticker symbols, maximum 50.
>
> **parameters\_updated** `number`
>
> Unix timestamp. Returns records updated at or after it, for polling deltas.
>
> **parameters\_date\_from** `string`
>
> Earliest rating date, YYYY-MM-DD.
>
> **parameters\_analyst\_id** `string`
>
> Comma-separated analyst ids. Take them from the id field of calendar/ratings-analysts, or the analyst\_id on a rating, to follow one analyst's calls.
>
> **parameters\_importance** `string ("0" | "1" | "2" | "3" | "4" | "5")`
>
> Minimum importance level, matched as greater than or equal to the value given. Raise it when the caller only wants the notable calls.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Analyst roster with benzinga
>
> **Slug:** `FIRECRAWL_BENZINGA_CALENDAR_RATINGS_ANALYSTS`
>
> Use to resolve an analyst by name, or to judge how accurate a particular analyst has been, and to get the id you then pass to calendar/ratings as parameters\[analyst\_id]. For the ratings themselves use calendar/ratings; for the list of firms rather than people use calendar/ratings-firms.
>
> #### Input Parameters
>
> **firm** `string`
>
> Firm identifier to restrict to. Set this to list only the analysts working at one research firm.
>
> **page** `number`
>
> Page offset, limited to 0-100000. Set this only when walking past the first page of the analyst roster.
>
> **fields** `string`
>
> Comma-separated list of response fields to return. Set it to trim the payload when you only need names and ids and not the ratings\_accuracy block.
>
> **analyst** `string`
>
> Analyst identifier to look up. Set this when you already have an analyst\_id from a ratings record and want that analyst's profile and accuracy.
>
> **updated** `number`
>
> Unix timestamp (UTC); only records updated at or after this are returned, and the sort order follows it. Set this to poll for roster changes since your last sync.
>
> **pageSize** `number`
>
> Number of analysts to return, limit 1000. Raise it when you want the roster in one call rather than paging.
>
> **firm\_name** `string`
>
> Firm name to match. Use it when the caller names the bank, for example Morgan Stanley, instead of supplying a firm id.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **analyst\_name** `string`
>
> Analyst name to match. Set this when the caller names a person rather than supplying an id; the reference does not say whether matching is exact, so try the full name first.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Research firms with benzinga
>
> **Slug:** `FIRECRAWL_BENZINGA_CALENDAR_RATINGS_FIRMS`
>
> Use to enumerate the covering firms or to turn a firm name into the id that calendar/ratings filters on as parameters\[firm\_id]. For an individual analyst and their track record use calendar/ratings-analysts; for the ratings themselves use calendar/ratings.
>
> #### Input Parameters
>
> **firm** `string`
>
> Firm identifier to look up. Set this when you already hold a firm\_id from a ratings record and want the firm's details.
>
> **page** `number`
>
> Page offset, limited to 0-100000. Set this only when paging past the first block of firms.
>
> **fields** `string`
>
> Comma-separated list of response fields to return. Set it when you only need id and name.
>
> **updated** `number`
>
> Unix timestamp (UTC); only firms updated at or after this are returned. Set this to poll for newly added or renamed firms since your last sync.
>
> **pageSize** `number`
>
> Number of firms to return, limit 1000. Raise it to pull the whole firm list in one call.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Removed calendar events with benzinga
>
> **Slug:** `FIRECRAWL_BENZINGA_CALENDAR_REMOVED`
>
> Use when you keep a copy of the ratings or M\&A calendar and need to know which previously returned events have since been withdrawn, which Schedule C.10 requires you to act on. It answers only what disappeared; for the events themselves use calendar/ratings or calendar/mergers-acquisitions.
>
> #### Input Parameters
>
> **page** `number`
>
> Page offset, limited to 0-100000. Set this when walking a long backlog of removals.
>
> **type** `string ("ratings" | "ma")` *required*
>
> Which calendar to read removals for: ratings for calendar/ratings rows, ma for calendar/mergers-acquisitions rows. Always set it: left unset the feed returns removals from every Benzinga calendar, most of them for calendars not published here (probed 2026-09-21, the unfiltered first page was dividends).
>
> **updated** `number`
>
> Unix timestamp (UTC); only records updated at or after this are returned. Set this to the time of your last sync so you get just the newly withdrawn events.
>
> **pageSize** `number`
>
> Number of removal records to return, limit 1000.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Press releases with benzinga
>
> **Slug:** `FIRECRAWL_BENZINGA_NEWS_PRESS_RELEASES`
>
> Use this for company-issued announcements as distributed over the wires (PRNewswire, Globe Newswire, Business Wire, ACCESS Newswire, Newsfile), the primary-source wording behind a story. For Benzinga editorial coverage and the wider newswire use news/search, and for the one-line explanation of a price move use news/wiims.
>
> #### Input Parameters
>
> **date** `string`
>
> A single day to query, yyyy-mm-dd. Use it instead of dateFrom and dateTo when the caller names one date.
>
> **isin** `string`
>
> Comma-separated ISINs, maximum 50. Use it when the caller identifies companies by ISIN rather than ticker.
>
> **page** `number`
>
> Page offset, limited to 0-100000. Increase it to page past the first batch rather than widening the date range.
>
> **sort** `string ("id:asc" | "id:desc" | "created:asc" | "created:desc" | "updated:asc" | "updated:desc")`
>
> Sort order as field:direction. Use created:asc to read a period forwards, or updated:desc when tracking edits.
>
> **cusips** `string`
>
> Comma-separated CUSIPs, maximum 50; requires a license agreement. Use only when the caller supplies CUSIPs.
>
> **dateTo** `string`
>
> Latest publication date, yyyy-mm-dd. Pair it with dateFrom to bound a period.
>
> **format** `string`
>
> Desired response format. Set text only when you want plain text rather than the default JSON structures.
>
> **region** `string`
>
> Region filter, for example 'ca' or 'canada' for Canadian content. Set it when the caller scopes the question to a market.
>
> **topics** `string`
>
> Comma-separated words or phrases matched against title, tags and body in that order of priority. Use it when the caller asks about a subject rather than a company.
>
> **authors** `string`
>
> Comma-separated distributing wires, spelled as Benzinga does: PRNewswire, Globe Newswire, Business Wire, ACCESS Newswire, Newsfile. Set it to restrict to one wire.
>
> **tickers** `string`
>
> Comma-separated ticker symbols, maximum 50. Set this whenever the caller names a company.
>
> **dateFrom** `string`
>
> Earliest publication date, yyyy-mm-dd. Set it whenever the caller asks about a period rather than a single day.
>
> **pageSize** `number`
>
> Number of releases returned, maximum 100. Raise it when you want a full day of a company's releases in one call.
>
> **importance** `string ("low" | "medium" | "high")`
>
> Importance level of the release. Set high when the caller only wants the market-moving releases.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **updatedSince** `number`
>
> Unix timestamp in UTC; set it to your last sync time to pull only releases updated since then.
>
> **displayOutput** `string ("full" | "abstract" | "headline")`
>
> How much of each release to return: headline only, abstract (headline plus teaser) or full body text. Set full only when you need to quote the release.
>
> **primaryTickers** `string`
>
> Comma-separated primary ticker symbols. Use it instead of tickers when you want only releases whose primary subject is that company.
>
> **publishedSince** `number`
>
> Unix timestamp in UTC; set it to pull and sort by releases published since that moment.
>
> **topic\_group\_by** `string ("and" | "or")`
>
> Logical operator for the topics query. Set and when every topic must appear, or leave as or to match any.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Removed news with benzinga
>
> **Slug:** `FIRECRAWL_BENZINGA_NEWS_REMOVED`
>
> Use this when you keep a copy of Benzinga news and need to know which stories have been withdrawn so you can delete them, which Schedule C.10 requires. It never returns story content; for the stories themselves use news/search.
>
> #### Input Parameters
>
> **page** `number`
>
> Page offset. Upstream caps pageSize multiplied by page at 10000, so narrow with updatedSince rather than paging deep.
>
> **pageSize** `number`
>
> Number of removal records returned, maximum 1000. Raise it when reconciling a backlog in one call.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **updatedSince** `number`
>
> Unix timestamp in UTC; set it to the time of your last sync so you only receive removals recorded since then.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] News search with benzinga
>
> **Slug:** `FIRECRAWL_BENZINGA_NEWS_SEARCH`
>
> Use for what was reported about a company or subject, and when. Scope it to tickers or a date range: unscoped it returns the whole newswire. For the analyst reaction to a story use calendar/ratings.
>
> #### Input Parameters
>
> **date** `string`
>
> A single day to query, yyyy-mm-dd. Use it instead of dateFrom and dateTo when the caller names one date.
>
> **isin** `string`
>
> Comma-separated ISINs, maximum 50. Use it when the caller identifies companies by ISIN rather than ticker.
>
> **page** `number`
>
> Page offset, limited to 0-100000. Increase it to read past the first page of results rather than widening the date range.
>
> **sort** `string ("id:asc" | "id:desc" | "created:asc" | "created:desc" | "updated:asc" | "updated:desc")`
>
> Sort order as field:direction. Use created:asc to read a period forwards, or updated:desc when tracking edits.
>
> **cusips** `string`
>
> Comma-separated CUSIPs, maximum 50; requires a license agreement. Use only when the caller supplies CUSIPs.
>
> **dateTo** `string`
>
> Latest publication date, yyyy-mm-dd. Pair it with dateFrom to bound a period.
>
> **format** `string`
>
> Desired response format. Set text only when you want plain text rather than the default JSON structures.
>
> **region** `string`
>
> Region filter, for example 'ca' or 'canada' for Canadian content. Set it when the caller scopes the question to a market.
>
> **topics** `string`
>
> Comma-separated words or phrases matched against title, tags and body in that order of priority. Use it when the caller asks about a subject rather than a company.
>
> **authors** `string`
>
> Comma-separated authors. Set it to restrict to a particular desk or writer.
>
> **tickers** `string`
>
> Comma-separated ticker symbols, maximum 50. Set this whenever the caller names a company.
>
> **channels** `string`
>
> Comma-separated Benzinga channels to restrict to, for example Earnings or Analyst Ratings.
>
> **dateFrom** `string`
>
> Earliest publication date, yyyy-mm-dd. Set it whenever the caller asks about a period rather than a single day.
>
> **pageSize** `number`
>
> Stories to return, maximum 100. Raise it when you want a full day of coverage in one call.
>
> **importance** `string`
>
> Importance level filter. Set it when the caller only wants the market-moving stories.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **updatedSince** `number`
>
> Unix timestamp in UTC; set it to your last sync time to pull only stories updated since then.
>
> **content\_types** `string`
>
> Comma-separated content types. Set it when you need to keep the feed to a specific content type.
>
> **displayOutput** `string ("full" | "abstract" | "headline")`
>
> How much of each story to return: headline only, abstract (headline plus teaser) or full body text. Set full only when you need to quote the story.
>
> **importanceRank** `number`
>
> Importance rank from 1 to 5. Set a low number to keep only the highest-ranked stories.
>
> **primaryTickers** `string`
>
> Comma-separated primary ticker symbols. Use it instead of tickers when you want only stories whose primary subject is that company.
>
> **publishedSince** `number`
>
> Unix timestamp in UTC; set it to pull and sort by stories published since that moment.
>
> **topic\_group\_by** `string ("and" | "or")`
>
> Logical operator for the topics query. Set and when every topic must appear, or leave as or to match any.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Why Is It Moving with benzinga
>
> **Slug:** `FIRECRAWL_BENZINGA_NEWS_WIIMS`
>
> Use this to answer why a stock moved: WIIMs are the short attributed explanations Benzinga files against a ticker's price action. For the underlying coverage use news/search, and for the company's own announcement use news/press-releases.
>
> #### Input Parameters
>
> **date** `string`
>
> A single day to query, yyyy-mm-dd. Use it when the caller asks why a stock moved on a specific date.
>
> **isin** `string`
>
> Comma-separated ISINs, maximum 50. Use when the caller identifies companies by ISIN.
>
> **page** `number`
>
> Page offset, limited to 0-100000. Increase it to page further back rather than widening the date range.
>
> **sort** `string ("id:asc" | "id:desc" | "created:asc" | "created:desc" | "updated:asc" | "updated:desc")`
>
> Sort order as field:direction. Use created:asc to read a session forwards.
>
> **cusips** `string`
>
> Comma-separated CUSIPs, maximum 50; requires a license agreement.
>
> **dateTo** `string`
>
> Latest publication date, yyyy-mm-dd. Pair it with dateFrom to bound a period.
>
> **format** `string`
>
> Desired response format. Set text only when you want plain text rather than JSON structures.
>
> **region** `string`
>
> Region filter, for example 'ca' or 'canada' for Canadian content.
>
> **topics** `string`
>
> Comma-separated words or phrases matched against title, tags and body in that order of priority.
>
> **authors** `string`
>
> Comma-separated authors. Set it to restrict to a particular desk.
>
> **tickers** `string`
>
> Comma-separated ticker symbols, maximum 50. Set this whenever the caller names a company.
>
> **dateFrom** `string`
>
> Earliest publication date, yyyy-mm-dd. Set it when the caller asks about a period.
>
> **pageSize** `number`
>
> Number of WIIM items returned, maximum 100. Raise it when scanning a whole session's movers.
>
> **importance** `string`
>
> Importance level filter. Set it when the caller wants only the more significant move explanations.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **updatedSince** `number`
>
> Unix timestamp in UTC; set it to your last sync time to pull only items updated since then.
>
> **content\_types** `string`
>
> Comma-separated content types. Set it when you need to keep the feed to a specific content type.
>
> **displayOutput** `string ("full" | "abstract" | "headline")`
>
> How much of each item to return: headline only, abstract (headline plus teaser) or full body. WIIMs are short, so abstract is usually enough.
>
> **importanceRank** `number`
>
> Importance rank from 1 to 5. Set a low number to keep only the highest-ranked items.
>
> **primaryTickers** `string`
>
> Comma-separated primary ticker symbols; use it to keep only items whose primary subject is that company.
>
> **publishedSince** `number`
>
> Unix timestamp in UTC; set it to pull and sort by items published since that moment, which suits intraday polling.
>
> **topic\_group\_by** `string ("and" | "or")`
>
> Logical operator for the topics query. Set and when every topic must appear.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unusual options activity with benzinga
>
> **Slug:** `FIRECRAWL_BENZINGA_SIGNALS_OPTIONS_ACTIVITY`
>
> Use for positioning: large directional bets before a catalyst. It reports orders, not outcomes, and a sweep filled at or above the ask (execution\_estimate) is a stronger signal than one at the midpoint.
>
> #### Input Parameters
>
> **page** `number`
>
> Page offset.
>
> **pagesize** `number`
>
> Records to return, limit 1000.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **parameters\_id** `string`
>
> Benzinga id of one options-activity record. Set it to fetch a single signal you already hold the id for.
>
> **parameters\_date** `string`
>
> A single date, YYYY-MM-DD.
>
> **parameters\_date\_to** `string`
>
> Latest date, YYYY-MM-DD.
>
> **parameters\_tickers** `string`
>
> Comma-separated ticker symbols, maximum 50.
>
> **parameters\_updated** `number`
>
> Unix timestamp. Returns records updated at or after it.
>
> **parameters\_date\_from** `string`
>
> Earliest date, YYYY-MM-DD.
>
> **parameters\_date\_sort** `string`
>
> Date field to sort on. The only documented value is date; set it to read a period in date order.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Start a web crawl
>
> **Slug:** `FIRECRAWL_CRAWL`
>
> Initiates a Firecrawl web crawl from a given URL, applying various filtering and content extraction rules, and polls until the job is complete; ensure the URL is accessible and any regex patterns for paths are valid.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> The base URL to start crawling from. This is the initial entry point for the web crawler.
>
> **delay** `integer`
>
> Delay in milliseconds between requests to avoid overwhelming the server
>
> **limit** `integer`
>
> Maximum number of pages to crawl. The crawl will stop once this limit is reached. Default is 10.
>
> **webhook** `string`
>
> An optional webhook URL to receive real-time updates on the crawl job. Events include crawl start (`crawl.started`), page crawled (`crawl.page`), and crawl completion (`crawl.completed` or `crawl.failed`). The payload structure matches the `/scrape` endpoint response.
>
> **maxDepth** `integer`
>
> Maximum depth of subpages to crawl relative to the entered URL (not the base domain). A depth of 0 crawls only the entered URL, 1 crawls the entered URL plus pages one path segment deeper, 2 adds two segments deeper, etc. For example, if URL is '[https://example.com/docs/api/](https://example.com/docs/api/)', maxDepth=1 crawls '/docs/api/' and '/docs/api/something/'.
>
> **excludePaths** `array`
>
> A list of Regular Expression (regex) patterns for URL paths to exclude from the crawl. URLs whose paths match any of these patterns will be ignored. For example, `"blog/archive/.*"` would exclude all paths under `/blog/archive/`.
>
> **includePaths** `array`
>
> A list of Regular Expression (regex) patterns for URL paths to include in the crawl. Only URLs whose paths match one of these patterns will be processed. For example, `"products/featured/.*"` would only include paths under `/products/featured/`.
>
> **ignoreSitemap** `boolean`
>
> If true, the crawler will ignore any sitemap.xml found on the website.
>
> **crawlEntireDomain** `boolean`
>
> If true, allows the crawler to follow internal links to sibling or parent URLs, not just child paths. This is the recommended replacement for 'allowBackwardLinks'.
>
> **maxDiscoveryDepth** `integer`
>
> Maximum depth to crawl based on discovery order. The root site and sitemapped pages have a discovery depth of 0. For example, if you set it to 1 and set ignoreSitemap, you will only crawl the entered URL and all URLs that are linked on that page.
>
> **allowBackwardLinks** `boolean`
>
> DEPRECATED: Use 'crawlEntireDomain' instead. If true, allows the crawler to navigate to pages that were linked from pages already visited (i.e., navigate 'backwards').
>
> **allowExternalLinks** `boolean`
>
> If true, allows the crawler to follow links that lead to external websites (different domains).
>
> **scrapeOptionsProxy** `string`
>
> Proxy configuration for requests
>
> **scrapeOptionsMaxAge** `integer`
>
> Maximum age in seconds for cached content. If content is older than this, it will be re-scraped
>
> **scrapeOptionsMobile** `boolean`
>
> If true, emulate a mobile device when scraping
>
> **scrapeOptionsActions** `array`
>
> List of actions to perform on each page before scraping (e.g., clicking buttons, waiting)
>
> **scrapeOptionsFormats** `array`
>
> Specifies the desired output formats for the scraped content from each page. Default is `["markdown"]`. IMPORTANT: If "json" format is included, scrapeOptionsJsonOptions must also be provided.
>
> **scrapeOptionsHeaders** `object`
>
> Custom HTTP headers to send with each request
>
> **scrapeOptionsTimeout** `integer`
>
> Timeout in milliseconds for each page request. Default is 30000ms (30 seconds)
>
> **scrapeOptionsWaitFor** `integer`
>
> Additional milliseconds to wait after Firecrawl's smart wait, before scraping the page. Useful for pages with dynamically loaded content or heavy JavaScript. Use sparingly as Firecrawl already waits intelligently.
>
> **ignoreQueryParameters** `boolean`
>
> If true, ignore query parameters when determining if a URL has been visited
>
> **scrapeOptionsBlockAds** `boolean`
>
> If true, block advertisements during scraping
>
> **scrapeOptionsLocation** `object`
>
> Geolocation settings for the scraper
>
> **scrapeOptionsParsePDF** `boolean`
>
> If true, attempt to parse PDF files encountered during crawling
>
> **scrapeOptionsExcludeTags** `array`
>
> A list of HTML tags to exclude from the scraped output. Content within these tags (and their children) will be removed before processing.
>
> **scrapeOptionsIncludeTags** `array`
>
> A list of HTML tags to specifically include in the scraped output. Only content within these tags will be processed. If empty or null, all relevant content is considered based on other options.
>
> **scrapeOptionsJsonOptions** `object`
>
> Options for JSON format extraction including schema and prompts. REQUIRED when 'json' format is specified in scrapeOptionsFormats. Conversely, if this is provided, 'json' must be included in scrapeOptionsFormats.
>
> **scrapeOptionsStoreInCache** `boolean`
>
> If true, store scraped content in cache for future use
>
> **scrapeOptionsOnlyMainContent** `boolean`
>
> If true, attempts to extract only the main content of each page, excluding common elements like headers, navigation bars, and footers. Default is true.
>
> **scrapeOptionsRemoveBase64Images** `boolean`
>
> If true, remove base64-encoded images from the scraped content
>
> **scrapeOptionsSkipTlsVerification** `boolean`
>
> If true, skip TLS certificate verification
>
> **scrapeOptionsChangeTrackingOptions** `object`
>
> Options for tracking changes between crawls
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cancel a crawl job
>
> **Slug:** `FIRECRAWL_CRAWL_CANCEL`
>
> Cancels an active or queued web crawl job using its ID; attempting to cancel completed, failed, or previously canceled jobs will not change their state.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier (UUID) of the crawl job to be canceled.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cancel a crawl job
>
> **Slug:** `FIRECRAWL_CRAWL_DELETE`
>
> Tool to cancel a running crawl job by its ID. Use when you need to stop an active crawl operation. The API returns a status of 'cancelled' upon successful cancellation.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier (UUID) of the crawl job to cancel.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get crawl job status
>
> **Slug:** `FIRECRAWL_CRAWL_GET`
>
> Retrieves a Firecrawl crawl job's status, progress metrics, credits used and a page of crawled data. The response may include a next URL for additional results.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The ID of the crawl job to check status for. This is the UUID returned when the crawl was initiated.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get errors from a crawl job
>
> **Slug:** `FIRECRAWL_CRAWL_GET_ERRORS`
>
> Tool to retrieve errors from a Firecrawl crawl job. Use when you need to understand why certain pages failed to scrape or which URLs were blocked by robots.txt during a crawl operation.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier (UUID) of the crawl job to retrieve errors from.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get all active crawl jobs
>
> **Slug:** `FIRECRAWL_CRAWL_LIST_ACTIVE`
>
> Tool to retrieve all active crawl jobs for the authenticated team. Use when you need to see which crawl operations are currently running.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Preview crawl parameters
>
> **Slug:** `FIRECRAWL_CRAWL_PARAMS_PREVIEW`
>
> Preview crawl parameters before starting a crawl by generating optimal configuration from natural language instructions. Use this tool to understand what crawl settings will be applied based on your requirements before executing a full crawl operation. The endpoint intelligently interprets natural language prompts to configure crawl parameters like include/exclude paths, depth limits, and domain scope.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> The website address to be crawled. This is the target URL for which crawl parameters will be generated.
>
> **prompt** `string` *required*
>
> Natural language description of crawling requirements (max 10,000 characters). Describe what pages to crawl, what to include or exclude, and any specific crawl behavior needed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Start a web crawl (v2) \[NEW]
>
> **Slug:** `FIRECRAWL_CRAWL_V2`
>
> \[NEW v2 API] Initiates a Firecrawl v2 web crawl with enhanced features over v1: natural language prompts for automatic crawler configuration, crawlEntireDomain for sibling/parent page discovery, better depth control with maxDiscoveryDepth, subdomain support, and full webhook configuration. Polls until crawl is complete.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> The base URL to start crawling from. This is the initial entry point for the web crawler.
>
> **delay** `integer`
>
> Delay in seconds between scrapes to respect website rate limits.
>
> **limit** `integer`
>
> Maximum number of pages to crawl. The crawl will stop once this limit is reached. Default is 10.
>
> **prompt** `string`
>
> A natural language prompt to automatically generate crawler settings. Example: 'Only crawl blog posts and docs, skip marketing pages'. Explicitly set parameters will override the generated equivalents.
>
> **sitemap** `string ("include" | "skip" | "only")`
>
> Sitemap mode when crawling. 'include' (default) uses sitemap and discovers other pages. 'skip' ignores sitemap entirely and only discovers pages from the start URL. 'only' crawls exclusively URLs from the sitemap, ignoring other discovered links.
>
> **webhook** `object`
>
> Webhook configuration for receiving real-time crawl updates.
>
> **excludePaths** `array`
>
> A list of Regular Expression (regex) patterns for URL paths to exclude from the crawl. URLs whose paths match any of these patterns will be ignored. For example, `"blog/archive/.*"` would exclude all paths under `/blog/archive/`.
>
> **includePaths** `array`
>
> A list of Regular Expression (regex) patterns for URL paths to include in the crawl. Only URLs whose paths match one of these patterns will be processed. For example, `"products/featured/.*"` would only include paths under `/products/featured/`.
>
> **maxConcurrency** `integer`
>
> Maximum number of concurrent scrapes. If not specified, uses your team's concurrency limit.
>
> **allowSubdomains** `boolean`
>
> If true, allows the crawler to follow links to subdomains of the main domain.
>
> **crawlEntireDomain** `boolean`
>
> Allows the crawler to follow internal links to sibling or parent URLs, not just child paths. False: Only crawls deeper (child) URLs (e.g., /features/feature-1 → /features/feature-1/tips). True: Crawls any internal links including siblings and parents (e.g., /features/feature-1 → /pricing, /).
>
> **maxDiscoveryDepth** `integer`
>
> Maximum depth to crawl based on discovery order. The root site and sitemapped pages have a discovery depth of 0. For example, if you set it to 1 and set sitemap='skip', you will only crawl the entered URL and all URLs linked on that page.
>
> **zeroDataRetention** `boolean`
>
> If true, enables zero data retention for this crawl. Contact [help@firecrawl.dev](mailto:help@firecrawl.dev) to enable this feature.
>
> **allowExternalLinks** `boolean`
>
> If true, allows the crawler to follow links that lead to external websites (different domains). Defaults to false.
>
> **scrapeOptions\_proxy** `string`
>
> Proxy configuration for requests
>
> **scrapeOptions\_maxAge** `integer`
>
> Maximum age in milliseconds for cached content. If content is older than this, it will be re-scraped.
>
> **scrapeOptions\_mobile** `boolean`
>
> If true, emulate a mobile device when scraping
>
> **ignoreQueryParameters** `boolean`
>
> If true, do not re-scrape the same path with different (or no) query parameters
>
> **scrapeOptions\_actions** `array`
>
> List of actions to perform on each page before scraping (e.g., clicking buttons, waiting)
>
> **scrapeOptions\_formats** `array`
>
> Specifies the desired output formats for the scraped content from each page. Can be a list of format strings (e.g., \["markdown", "html"]) or format objects. For JSON extraction, use a JsonFormatOptions object with type="json", optional schema (JSON Schema), and optional prompt for guidance. Example: \[\{"type": "json", "schema": \{...}, "prompt": "Extract title"}]
>
> **scrapeOptions\_headers** `object`
>
> Custom HTTP headers to send with each request
>
> **scrapeOptions\_parsers** `array`
>
> List of parsers to use for specific content types (e.g., 'pdf')
>
> **scrapeOptions\_timeout** `integer`
>
> Timeout in milliseconds for each page request. Default is 30000ms (30 seconds)
>
> **scrapeOptions\_waitFor** `integer`
>
> The duration in milliseconds to wait for page JavaScript to execute and content to load before scraping.
>
> **scrapeOptions\_blockAds** `boolean`
>
> If true, block advertisements during scraping
>
> **scrapeOptions\_location** `object`
>
> Geolocation settings for the scraper
>
> **scrapeOptions\_excludeTags** `array`
>
> A list of HTML tags to exclude from the scraped output. Content within these tags will be removed.
>
> **scrapeOptions\_includeTags** `array`
>
> A list of HTML tags to specifically include in the scraped output. Only content within these tags will be processed.
>
> **scrapeOptions\_storeInCache** `boolean`
>
> If true, store scraped content in cache for future use
>
> **scrapeOptions\_onlyMainContent** `boolean`
>
> If true, attempts to extract only the main content of each page, excluding common elements like headers, navigation bars, and footers. Default is true.
>
> **scrapeOptions\_removeBase64Images** `boolean`
>
> If true, remove base64-encoded images from the scraped content
>
> **scrapeOptions\_skipTlsVerification** `boolean`
>
> If true, skip TLS certificate verification
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get team credit usage
>
> **Slug:** `FIRECRAWL_CREDIT_USAGE_GET`
>
> Tool to get current team credit usage information. Use when you need to check remaining credits or billing period details.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get historical team credit usage
>
> **Slug:** `FIRECRAWL_CREDIT_USAGE_GET_HISTORICAL`
>
> Tool to retrieve historical team credit usage on a monthly basis. Use when you need to analyze credit consumption patterns over time, optionally segmented by API key.
>
> #### Input Parameters
>
> **byApiKey** `boolean`
>
> When enabled, breaks down usage by individual API key. Defaults to false.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Company enrichment (base) with datalegion
>
> **Slug:** `FIRECRAWL_DATALEGION_COMPANIES_ENRICH_BASE`
>
> Use the base Data Legion product by default for company enrichment. Choose the premium action only when the caller explicitly requests premium enrichment. Name matching is global, so include a domain or social URL for ambiguous names.
>
> #### Input Parameters
>
> **name** `string`
>
> Company name (fuzzy matching)
>
> **domain** `string`
>
> Company website domain (e.g., google.com)
>
> **industry** `string`
>
> Industry filter (used with name matching for better accuracy)
>
> **legion\_id** `string`
>
> Company Legion ID (exact match)
>
> **titlecase** `boolean`
>
> If true, format text fields in title case (names, company names, locations). Raw fields, IDs, URLs, codes, and confidence fields are excluded.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **social\_url** `string`
>
> Social profile URL (LinkedIn, Facebook, Crunchbase, X/Twitter, GitHub - will be normalized and detected)
>
> **linkedin\_id** `string`
>
> LinkedIn company numeric ID
>
> **pretty\_print** `boolean`
>
> If true, pretty-print JSON response with indentation.
>
> **ticker\_symbol** `string`
>
> Stock ticker symbol (e.g., GOOGL)
>
> **exclude\_fields** `string`
>
> Comma-separated list of fields to exclude from response. Applied after include\_fields filter.
>
> **include\_fields** `string`
>
> Comma-separated list of fields to include in response. If omitted, all fields are returned.
>
> **min\_confidence** `string ("high" | "moderate" | "low")`
>
> Minimum match confidence: 'high', 'moderate', or 'low'
>
> **required\_fields** `string`
>
> Comma-separated list of fields that must be present, else the match is filtered out. Supports top-level fields ('domain,socials'), a non-empty list subfield ('socials.network'), or a subfield equal to a value ('type:public', 'socials.network:linkedin'). Unknown field names or out-of-range enum values return HTTP 400.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Company enrichment (premium) with datalegion
>
> **Slug:** `FIRECRAWL_DATALEGION_COMPANIES_ENRICH_PREMIUM`
>
> Use only when the caller explicitly requests Data Legion premium company enrichment; otherwise use the base action. Name matching is global, so include a domain or social URL for ambiguous names.
>
> #### Input Parameters
>
> **name** `string`
>
> Company name (fuzzy matching)
>
> **domain** `string`
>
> Company website domain (e.g., google.com)
>
> **industry** `string`
>
> Industry filter (used with name matching for better accuracy)
>
> **legion\_id** `string`
>
> Company Legion ID (exact match)
>
> **titlecase** `boolean`
>
> If true, format text fields in title case (names, company names, locations). Raw fields, IDs, URLs, codes, and confidence fields are excluded.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **social\_url** `string`
>
> Social profile URL (LinkedIn, Facebook, Crunchbase, X/Twitter, GitHub - will be normalized and detected)
>
> **linkedin\_id** `string`
>
> LinkedIn company numeric ID
>
> **pretty\_print** `boolean`
>
> If true, pretty-print JSON response with indentation.
>
> **ticker\_symbol** `string`
>
> Stock ticker symbol (e.g., GOOGL)
>
> **exclude\_fields** `string`
>
> Comma-separated list of fields to exclude from response. Applied after include\_fields filter.
>
> **include\_fields** `string`
>
> Comma-separated list of fields to include in response. If omitted, all fields are returned.
>
> **min\_confidence** `string ("high" | "moderate" | "low")`
>
> Minimum match confidence: 'high', 'moderate', or 'low'
>
> **required\_fields** `string`
>
> Comma-separated list of fields that must be present, else the match is filtered out. Supports top-level fields ('domain,socials'), a non-empty list subfield ('socials.network'), or a subfield equal to a value ('type:public', 'socials.network:linkedin'). Unknown field names or out-of-range enum values return HTTP 400.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Person enrichment (base-no-contact) with datalegion
>
> **Slug:** `FIRECRAWL_DATALEGION_PEOPLE_ENRICH_BASE_NO_CONTACT`
>
> Use the base Data Legion product by default for person enrichment when personal contact data is not wanted. Choose a with-contact action only when the caller explicitly requests contact data.
>
> #### Input Parameters
>
> **city** `string`
>
> City name
>
> **email** `string`
>
> Email address (will be normalized)
>
> **phone** `string`
>
> Phone number (will be normalized to E.164)
>
> **state** `string`
>
> State name or code
>
> **school** `string`
>
> School name, website, or social URL
>
> **address** `string`
>
> Full address string (will be parsed to extract city, state, postal\_code, and country)
>
> **company** `string`
>
> Company name, website, or social URL
>
> **country** `string`
>
> Country name or code
>
> **full\_name** `string`
>
> Full name (will be normalized)
>
> **job\_title** `string`
>
> Job title
>
> **last\_name** `string`
>
> Last name (will be normalized)
>
> **legion\_id** `string`
>
> Legion ID (exact match)
>
> **titlecase** `boolean`
>
> If true, format text fields in title case (names, job titles, company names, locations, skills, headlines). Raw fields, IDs, URLs, codes, and confidence fields are excluded.
>
> **birth\_date** `string`
>
> Birth date for matching or narrowing name-based results (YYYY-MM-DD, YYYY-MM, or YYYY). Can be used as name + birth\_date lookup or as a qualifier on other name-based combos.
>
> **email\_hash** `string`
>
> SHA-256 (64 chars), SHA-1 (40 chars), or MD5 (32 chars) hash of normalized email address (for privacy)
>
> **first\_name** `string`
>
> First name (will be normalized)
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **social\_url** `string`
>
> Social profile URL (LinkedIn, Twitter/X, GitHub, Facebook - will be normalized and detected)
>
> **linkedin\_id** `string`
>
> LinkedIn numeric ID
>
> **postal\_code** `string`
>
> Postal/ZIP code
>
> **pretty\_print** `boolean`
>
> If true, pretty-print JSON response with indentation.
>
> **exclude\_fields** `string`
>
> Comma-separated list of fields to exclude from response. Applied after include\_fields filter.
>
> **include\_fields** `string`
>
> Comma-separated list of fields to include in response. If omitted, all fields are returned.
>
> **min\_confidence** `string ("high" | "moderate" | "low")`
>
> Minimum match confidence level to include in results: 'high', 'moderate', or 'low'. Matches below this threshold will be filtered out.
>
> **required\_fields** `string`
>
> Comma-separated list of fields that must be present, else the match is filtered out. Supports top-level fields ('work\_email,phones'), a non-empty list subfield ('emails.type'), or a subfield equal to a value ('emails.type:personal', 'phones.type:mobile', 'socials.network:linkedin'). Unknown field names or out-of-range enum values return HTTP 400.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Person enrichment (base-with-contact) with datalegion
>
> **Slug:** `FIRECRAWL_DATALEGION_PEOPLE_ENRICH_BASE_WITH_CONTACT`
>
> Use the base Data Legion product when the caller explicitly requests personal contact data. Contact entitlement comes from the dedicated credential, never from field projection.
>
> #### Input Parameters
>
> **city** `string`
>
> City name
>
> **email** `string`
>
> Email address (will be normalized)
>
> **phone** `string`
>
> Phone number (will be normalized to E.164)
>
> **state** `string`
>
> State name or code
>
> **school** `string`
>
> School name, website, or social URL
>
> **address** `string`
>
> Full address string (will be parsed to extract city, state, postal\_code, and country)
>
> **company** `string`
>
> Company name, website, or social URL
>
> **country** `string`
>
> Country name or code
>
> **full\_name** `string`
>
> Full name (will be normalized)
>
> **job\_title** `string`
>
> Job title
>
> **last\_name** `string`
>
> Last name (will be normalized)
>
> **legion\_id** `string`
>
> Legion ID (exact match)
>
> **titlecase** `boolean`
>
> If true, format text fields in title case (names, job titles, company names, locations, skills, headlines). Raw fields, IDs, URLs, codes, and confidence fields are excluded.
>
> **birth\_date** `string`
>
> Birth date for matching or narrowing name-based results (YYYY-MM-DD, YYYY-MM, or YYYY). Can be used as name + birth\_date lookup or as a qualifier on other name-based combos.
>
> **email\_hash** `string`
>
> SHA-256 (64 chars), SHA-1 (40 chars), or MD5 (32 chars) hash of normalized email address (for privacy)
>
> **first\_name** `string`
>
> First name (will be normalized)
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **social\_url** `string`
>
> Social profile URL (LinkedIn, Twitter/X, GitHub, Facebook - will be normalized and detected)
>
> **linkedin\_id** `string`
>
> LinkedIn numeric ID
>
> **postal\_code** `string`
>
> Postal/ZIP code
>
> **pretty\_print** `boolean`
>
> If true, pretty-print JSON response with indentation.
>
> **exclude\_fields** `string`
>
> Comma-separated list of fields to exclude from response. Applied after include\_fields filter.
>
> **include\_fields** `string`
>
> Comma-separated list of fields to include in response. If omitted, all fields are returned.
>
> **min\_confidence** `string ("high" | "moderate" | "low")`
>
> Minimum match confidence level to include in results: 'high', 'moderate', or 'low'. Matches below this threshold will be filtered out.
>
> **required\_fields** `string`
>
> Comma-separated list of fields that must be present, else the match is filtered out. Supports top-level fields ('work\_email,phones'), a non-empty list subfield ('emails.type'), or a subfield equal to a value ('emails.type:personal', 'phones.type:mobile', 'socials.network:linkedin'). Unknown field names or out-of-range enum values return HTTP 400.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Person enrichment (premium-no-contact) with datalegion
>
> **Slug:** `FIRECRAWL_DATALEGION_PEOPLE_ENRICH_PREMIUM_NO_CONTACT`
>
> Use only when the caller explicitly requests premium Data Legion person enrichment without personal contact data. Otherwise use the base no-contact action.
>
> #### Input Parameters
>
> **city** `string`
>
> City name
>
> **email** `string`
>
> Email address (will be normalized)
>
> **phone** `string`
>
> Phone number (will be normalized to E.164)
>
> **state** `string`
>
> State name or code
>
> **school** `string`
>
> School name, website, or social URL
>
> **address** `string`
>
> Full address string (will be parsed to extract city, state, postal\_code, and country)
>
> **company** `string`
>
> Company name, website, or social URL
>
> **country** `string`
>
> Country name or code
>
> **full\_name** `string`
>
> Full name (will be normalized)
>
> **job\_title** `string`
>
> Job title
>
> **last\_name** `string`
>
> Last name (will be normalized)
>
> **legion\_id** `string`
>
> Legion ID (exact match)
>
> **titlecase** `boolean`
>
> If true, format text fields in title case (names, job titles, company names, locations, skills, headlines). Raw fields, IDs, URLs, codes, and confidence fields are excluded.
>
> **birth\_date** `string`
>
> Birth date for matching or narrowing name-based results (YYYY-MM-DD, YYYY-MM, or YYYY). Can be used as name + birth\_date lookup or as a qualifier on other name-based combos.
>
> **email\_hash** `string`
>
> SHA-256 (64 chars), SHA-1 (40 chars), or MD5 (32 chars) hash of normalized email address (for privacy)
>
> **first\_name** `string`
>
> First name (will be normalized)
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **social\_url** `string`
>
> Social profile URL (LinkedIn, Twitter/X, GitHub, Facebook - will be normalized and detected)
>
> **linkedin\_id** `string`
>
> LinkedIn numeric ID
>
> **postal\_code** `string`
>
> Postal/ZIP code
>
> **pretty\_print** `boolean`
>
> If true, pretty-print JSON response with indentation.
>
> **exclude\_fields** `string`
>
> Comma-separated list of fields to exclude from response. Applied after include\_fields filter.
>
> **include\_fields** `string`
>
> Comma-separated list of fields to include in response. If omitted, all fields are returned.
>
> **min\_confidence** `string ("high" | "moderate" | "low")`
>
> Minimum match confidence level to include in results: 'high', 'moderate', or 'low'. Matches below this threshold will be filtered out.
>
> **required\_fields** `string`
>
> Comma-separated list of fields that must be present, else the match is filtered out. Supports top-level fields ('work\_email,phones'), a non-empty list subfield ('emails.type'), or a subfield equal to a value ('emails.type:personal', 'phones.type:mobile', 'socials.network:linkedin'). Unknown field names or out-of-range enum values return HTTP 400.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Person enrichment (premium-with-contact) with datalegion
>
> **Slug:** `FIRECRAWL_DATALEGION_PEOPLE_ENRICH_PREMIUM_WITH_CONTACT`
>
> Use only when the caller explicitly requests both premium Data Legion person enrichment and personal contact data. Otherwise use a lower-tier or no-contact action.
>
> #### Input Parameters
>
> **city** `string`
>
> City name
>
> **email** `string`
>
> Email address (will be normalized)
>
> **phone** `string`
>
> Phone number (will be normalized to E.164)
>
> **state** `string`
>
> State name or code
>
> **school** `string`
>
> School name, website, or social URL
>
> **address** `string`
>
> Full address string (will be parsed to extract city, state, postal\_code, and country)
>
> **company** `string`
>
> Company name, website, or social URL
>
> **country** `string`
>
> Country name or code
>
> **full\_name** `string`
>
> Full name (will be normalized)
>
> **job\_title** `string`
>
> Job title
>
> **last\_name** `string`
>
> Last name (will be normalized)
>
> **legion\_id** `string`
>
> Legion ID (exact match)
>
> **titlecase** `boolean`
>
> If true, format text fields in title case (names, job titles, company names, locations, skills, headlines). Raw fields, IDs, URLs, codes, and confidence fields are excluded.
>
> **birth\_date** `string`
>
> Birth date for matching or narrowing name-based results (YYYY-MM-DD, YYYY-MM, or YYYY). Can be used as name + birth\_date lookup or as a qualifier on other name-based combos.
>
> **email\_hash** `string`
>
> SHA-256 (64 chars), SHA-1 (40 chars), or MD5 (32 chars) hash of normalized email address (for privacy)
>
> **first\_name** `string`
>
> First name (will be normalized)
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **social\_url** `string`
>
> Social profile URL (LinkedIn, Twitter/X, GitHub, Facebook - will be normalized and detected)
>
> **linkedin\_id** `string`
>
> LinkedIn numeric ID
>
> **postal\_code** `string`
>
> Postal/ZIP code
>
> **pretty\_print** `boolean`
>
> If true, pretty-print JSON response with indentation.
>
> **exclude\_fields** `string`
>
> Comma-separated list of fields to exclude from response. Applied after include\_fields filter.
>
> **include\_fields** `string`
>
> Comma-separated list of fields to include in response. If omitted, all fields are returned.
>
> **min\_confidence** `string ("high" | "moderate" | "low")`
>
> Minimum match confidence level to include in results: 'high', 'moderate', or 'low'. Matches below this threshold will be filtered out.
>
> **required\_fields** `string`
>
> Comma-separated list of fields that must be present, else the match is filtered out. Supports top-level fields ('work\_email,phones'), a non-empty list subfield ('emails.type'), or a subfield equal to a value ('emails.type:personal', 'phones.type:mobile', 'socials.network:linkedin'). Unknown field names or out-of-range enum values return HTTP 400.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Perform deep research
>
> **Slug:** `FIRECRAWL_DEEP_RESEARCH`
>
> Initiates a deprecated AI-powered deep research job to investigate a topic across web sources and synthesize findings, with a configurable URL limit. The response may include a job ID, status, analysis, activity timeline and sources.
>
> #### Input Parameters
>
> **query** `string` *required*
>
> The research question or topic to investigate. Provide a clear, specific question or topic for best results.
>
> **formats** `array`
>
> Output format list. Set to \["json"] to get structured JSON output. When using "json" format, you must also provide jsonOptions.
>
> **maxUrls** `integer`
>
> Maximum number of URLs to analyze during research. Range: 1-1000. Default: 20. Higher values provide more comprehensive results but consume more credits (1 credit per URL).
>
> **maxDepth** `integer`
>
> Controls how many iterations the research process goes through. Range: 1-10. Default: 7 (if not specified). Higher depth means more thorough research but longer processing time.
>
> **timeLimit** `integer`
>
> Time limit for the research job in seconds. Range: 30-300 seconds. Default: 270 (if not specified). Research will stop when this limit is reached.
>
> **jsonOptions** `object`
>
> Configuration for JSON structured output. Must contain either "schema" (a valid JSON Schema dict) or "prompt" (a string). When using schema, provide a complete JSON Schema with "type", "properties", etc., wrapped in a "schema" key.
>
> **systemPrompt** `string`
>
> Custom system-level prompt to guide the agentic research exploration process. Use this to set the context, tone, or specific behaviors for the research agent.
>
> **analysisPrompt** `string`
>
> Custom prompt to guide the final synthesis and analysis generation. Use this to specify how findings should be summarized or what aspects to emphasize in the final analysis.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Extract structured data
>
> **Slug:** `FIRECRAWL_EXTRACT`
>
> Extracts structured data from web pages by initiating an extraction job and polling for completion; requires a natural language `prompt` or a JSON `schema` (one must be provided).
>
> #### Input Parameters
>
> **urls** `array` *required*
>
> A list of URLs from which to extract data (maximum 10 URLs while in beta). Wildcards (e.g., `https://example.com/blog/*`) can be used for crawling multiple pages under a specific path. Note: You can also pass a single URL as 'url' (singular) which will be automatically converted to a list.
>
> **prompt** `string`
>
> Natural language query for information to extract from URL content. E.g., 'Extract the company mission, whether it supports SSO, etc.'. At least one of 'prompt' or 'schema' must be provided.
>
> **schema** `object`
>
> JSON object (dictionary) defining the desired structure for extracted data. Must be a valid JSON Schema object with properties and types. At least one of 'prompt' or 'schema' must be provided.
>
> **showSources** `boolean`
>
> When true, the sources used to extract the data will be included in the response as `sources` key.
>
> **ignoreSitemap** `boolean`
>
> Bypasses sitemap.xml during scanning.
>
> **scrapeOptions** `object`
>
> Advanced scraping configuration.
>
> **enableWebSearch** `boolean`
>
> If `True`, allows crawling links outside initial domains in `urls`; if `False`, restricts to same domains.
>
> **ignoreInvalidURLs** `boolean`
>
> Proceeds with valid URLs, returning invalid ones separately.
>
> **includeSubdomains** `boolean`
>
> Extends scanning to subdomains.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get extract job status
>
> **Slug:** `FIRECRAWL_EXTRACT_GET`
>
> Tool to retrieve the status and results of a previously submitted extract job. Use when you need to check the progress or get the final results of an extraction operation.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier (UUID format) of the extract job to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Company directory with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_COMPANY_LIST`
>
> Call to discover what is covered, or to resolve names to identifiers when you do not already have a ticker. Check the per-company dataset list before assuming a costlier capability will answer for it.
>
> #### Input Parameters
>
> **compact** `boolean`
>
> Return a slimmer row: fewer descriptors per company, for when the list is only being used to resolve identifiers.
>
> **pageNumber** `number`
>
> Page number, 1-indexed.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Company profile with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_COMPANY_PROFILE`
>
> Call first when starting from a ticker or stable company or security identifier. It returns every other identifier, peers, and secondary listings. Use company/list when starting from only a company name.
>
> #### Input Parameters
>
> **cik** `string`
>
> SEC Central Index Key. Use when a company has no ticker, or after a rename.
>
> **figi** `string`
>
> OpenFIGI identifier of the security. Licensed identifier.
>
> **fscl** `string`
>
> Fiscal.ai's stable company identifier, the `companyFiscalIdentifier` field. The only identifier that survives a ticker change or a relisting, so prefer it when carrying a company between calls.
>
> **isin** `string`
>
> ISIN of the security. Licensed identifier.
>
> **cusip** `string`
>
> CUSIP of the security. Licensed identifier.
>
> **ticker** `string`
>
> Ticker symbol, for example MSFT. Only unique within an exchange, so pass `exchange` with it.
>
> **exchange** `string`
>
> Exchange code for `ticker`, for example NASDAQ, or a MIC code for a non-US/CA listing.
>
> **companyKey** `string`
>
> Exchange and ticker joined by an underscore: `NASDAQ_MSFT` for US and Canadian listings, or MIC code and ticker elsewhere, as in `XWAR_PKN`.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Segments and KPIs with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_COMPANY_SEGMENTS_AND_KPIS`
>
> Call for the numbers a business is actually run on - segment revenue, units, subscribers - which never reach the three statements. Coverage is narrower than for financials, and varies by company.
>
> #### Input Parameters
>
> **cik** `string`
>
> SEC Central Index Key. Use when a company has no ticker, or after a rename.
>
> **figi** `string`
>
> OpenFIGI identifier of the security. Licensed identifier.
>
> **fscl** `string`
>
> Fiscal.ai's stable company identifier, the `companyFiscalIdentifier` field. The only identifier that survives a ticker change or a relisting, so prefer it when carrying a company between calls.
>
> **isin** `string`
>
> ISIN of the security. Licensed identifier.
>
> **cusip** `string`
>
> CUSIP of the security. Licensed identifier.
>
> **ticker** `string`
>
> Ticker symbol, for example MSFT. Only unique within an exchange, so pass `exchange` with it.
>
> **currency** `string`
>
> ISO 4217 code to convert into, for example USD or EUR. Defaults to the company's own reporting currency, and the response carries the rate that was applied.
>
> **exchange** `string`
>
> Exchange code for `ticker`, for example NASDAQ, or a MIC code for a non-US/CA listing.
>
> **companyKey** `string`
>
> Exchange and ticker joined by an underscore: `NASDAQ_MSFT` for US and Canadian listings, or MIC code and ticker elsewhere, as in `XWAR_PKN`.
>
> **periodType** `array`
>
> Comma-separated period filter: annual, quarterly, semi-annual, ltm, ytd, latest. Defaults to annual.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Shares outstanding with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_COMPANY_SHARES_OUTSTANDING`
>
> Call when a per-share figure has to be computed, or when a dual-class structure means the headline share count is misleading. Point-in-time, not a series.
>
> #### Input Parameters
>
> **cik** `string`
>
> SEC Central Index Key. Use when a company has no ticker, or after a rename.
>
> **figi** `string`
>
> OpenFIGI identifier of the security. Licensed identifier.
>
> **fscl** `string`
>
> Fiscal.ai's stable company identifier, the `companyFiscalIdentifier` field. The only identifier that survives a ticker change or a relisting, so prefer it when carrying a company between calls.
>
> **isin** `string`
>
> ISIN of the security. Licensed identifier.
>
> **cusip** `string`
>
> CUSIP of the security. Licensed identifier.
>
> **ticker** `string`
>
> Ticker symbol, for example MSFT. Only unique within an exchange, so pass `exchange` with it.
>
> **exchange** `string`
>
> Exchange code for `ticker`, for example NASDAQ, or a MIC code for a non-US/CA listing.
>
> **companyKey** `string`
>
> Exchange and ticker joined by an underscore: `NASDAQ_MSFT` for US and Canadian listings, or MIC code and ticker elsewhere, as in `XWAR_PKN`.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Earnings calendar with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_EVENTS_CALENDAR`
>
> Call to answer who reports when. Omit every company identifier for the whole calendar, which is what makes this the one capability here that answers a question not about a specific company. Read `eventStatus` before relying on a date - an estimated one moves.
>
> #### Input Parameters
>
> **cik** `string`
>
> SEC Central Index Key. Use when a company has no ticker, or after a rename.
>
> **figi** `string`
>
> OpenFIGI identifier of the security. Licensed identifier.
>
> **fscl** `string`
>
> Fiscal.ai's stable company identifier, the `companyFiscalIdentifier` field. The only identifier that survives a ticker change or a relisting, so prefer it when carrying a company between calls.
>
> **isin** `string`
>
> ISIN of the security. Licensed identifier.
>
> **page** `number`
>
> Page number, 1-indexed. Spelled `page` here, where every other Fiscal.ai list takes `pageNumber`.
>
> **cusip** `string`
>
> CUSIP of the security. Licensed identifier.
>
> **sector** `string`
>
> GICS sector, to restrict the calendar by industry.
>
> **status** `string ("confirmed" | "estimated" | "projected" | "reported")`
>
> Restrict by event status: confirmed, estimated, projected or reported. See `eventStatus` for what each means.
>
> **ticker** `string`
>
> Ticker symbol, for example MSFT. Only unique within an exchange, so pass `exchange` with it.
>
> **country** `string`
>
> ISO country code of the headquarters, to restrict the calendar by geography.
>
> **endDate** `string`
>
> Inclusive end of the event window, ISO 8601.
>
> **exchange** `string`
>
> Exchange code for `ticker`, for example NASDAQ, or a MIC code for a non-US/CA listing.
>
> **pageSize** `number`
>
> Rows per page, up to 250. Defaults to 250; page for more.
>
> **startDate** `string`
>
> Inclusive start of the event window, ISO 8601.
>
> **companyKey** `string`
>
> Exchange and ticker joined by an underscore: `NASDAQ_MSFT` for US and Canadian listings, or MIC code and ticker elsewhere, as in `XWAR_PKN`.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IR event resources with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_EVENTS_IR_EVENTS`
>
> Call to find what exists for a quarter before asking for any of it - the deck, the release, the report, the transcript. Rows sharing a fiscal year and quarter are one event, so group on that pair rather than on the date.
>
> #### Input Parameters
>
> **cik** `string`
>
> SEC Central Index Key. Use when a company has no ticker, or after a rename.
>
> **figi** `string`
>
> OpenFIGI identifier of the security. Licensed identifier.
>
> **fscl** `string`
>
> Fiscal.ai's stable company identifier, the `companyFiscalIdentifier` field. The only identifier that survives a ticker change or a relisting, so prefer it when carrying a company between calls.
>
> **isin** `string`
>
> ISIN of the security. Licensed identifier.
>
> **cusip** `string`
>
> CUSIP of the security. Licensed identifier.
>
> **ticker** `string`
>
> Ticker symbol, for example MSFT. Only unique within an exchange, so pass `exchange` with it.
>
> **exchange** `string`
>
> Exchange code for `ticker`, for example NASDAQ, or a MIC code for a non-US/CA listing.
>
> **companyKey** `string`
>
> Exchange and ticker joined by an underscore: `NASDAQ_MSFT` for US and Canadian listings, or MIC code and ticker elsewhere, as in `XWAR_PKN`.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Earnings call transcript with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_EVENTS_TRANSCRIPT`
>
> Call for what was said on the call, attributed and timed. The speaker mapping is what makes it worth more than the raw text: management's prepared remarks and an analyst's question can be told apart, and the Q\&A boundary is given rather than guessed.
>
> #### Input Parameters
>
> **cik** `string`
>
> SEC Central Index Key. Use when a company has no ticker, or after a rename.
>
> **figi** `string`
>
> OpenFIGI identifier of the security. Licensed identifier.
>
> **fscl** `string`
>
> Fiscal.ai's stable company identifier, the `companyFiscalIdentifier` field. The only identifier that survives a ticker change or a relisting, so prefer it when carrying a company between calls.
>
> **isin** `string`
>
> ISIN of the security. Licensed identifier.
>
> **cusip** `string`
>
> CUSIP of the security. Licensed identifier.
>
> **ticker** `string`
>
> Ticker symbol, for example MSFT. Only unique within an exchange, so pass `exchange` with it.
>
> **eventKey** `string` *required*
>
> The q\{quarter}-\{year} key of the event, for example q3-2026, from the events/ir-events list.
>
> **exchange** `string`
>
> Exchange code for `ticker`, for example NASDAQ, or a MIC code for a non-US/CA listing.
>
> **companyKey** `string`
>
> Exchange and ticker joined by an underscore: `NASDAQ_MSFT` for US and Canadian listings, or MIC code and ticker elsewhere, as in `XWAR_PKN`.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Company filings with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_FILINGS_LIST`
>
> Call to find out what exists and when it was filed, and to get the document links. The filing bytes themselves are not retrievable through this provider - see its page for why - so treat `pdfUrl` as a handoff.
>
> #### Input Parameters
>
> **cik** `string`
>
> SEC Central Index Key. Use when a company has no ticker, or after a rename.
>
> **figi** `string`
>
> OpenFIGI identifier of the security. Licensed identifier.
>
> **fscl** `string`
>
> Fiscal.ai's stable company identifier, the `companyFiscalIdentifier` field. The only identifier that survives a ticker change or a relisting, so prefer it when carrying a company between calls.
>
> **isin** `string`
>
> ISIN of the security. Licensed identifier.
>
> **cusip** `string`
>
> CUSIP of the security. Licensed identifier.
>
> **ticker** `string`
>
> Ticker symbol, for example MSFT. Only unique within an exchange, so pass `exchange` with it.
>
> **exchange** `string`
>
> Exchange code for `ticker`, for example NASDAQ, or a MIC code for a non-US/CA listing.
>
> **companyKey** `string`
>
> Exchange and ticker joined by an underscore: `NASDAQ_MSFT` for US and Canadian listings, or MIC code and ticker elsewhere, as in `XWAR_PKN`.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Adjusted metrics with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_FINANCIALS_ADJUSTED_METRICS`
>
> Call when comparing against analyst estimates or consensus, which are quoted on an adjusted basis rather than a GAAP one. Not a substitute for the statements: these are management's adjustments, and the exclusions are theirs.
>
> #### Input Parameters
>
> **cik** `string`
>
> SEC Central Index Key. Use when a company has no ticker, or after a rename.
>
> **figi** `string`
>
> OpenFIGI identifier of the security. Licensed identifier.
>
> **fscl** `string`
>
> Fiscal.ai's stable company identifier, the `companyFiscalIdentifier` field. The only identifier that survives a ticker change or a relisting, so prefer it when carrying a company between calls.
>
> **isin** `string`
>
> ISIN of the security. Licensed identifier.
>
> **cusip** `string`
>
> CUSIP of the security. Licensed identifier.
>
> **ticker** `string`
>
> Ticker symbol, for example MSFT. Only unique within an exchange, so pass `exchange` with it.
>
> **currency** `string`
>
> ISO 4217 code to convert into, for example USD or EUR. Defaults to the company's own reporting currency, and the response carries the rate that was applied.
>
> **exchange** `string`
>
> Exchange code for `ticker`, for example NASDAQ, or a MIC code for a non-US/CA listing.
>
> **companyKey** `string`
>
> Exchange and ticker joined by an underscore: `NASDAQ_MSFT` for US and Canadian listings, or MIC code and ticker elsewhere, as in `XWAR_PKN`.
>
> **periodType** `array`
>
> Comma-separated period filter: annual, quarterly, semi-annual, ltm, ytd, latest. Defaults to annual.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Balance sheet with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_FINANCIALS_BALANCE_SHEET`
>
> Call when comparing companies, screening, or computing anything that has to mean the same thing across two filers. The mapping is visible: each standardized metric names the as-reported lines behind it, so a surprising figure can be traced rather than trusted.
>
> #### Input Parameters
>
> **cik** `string`
>
> SEC Central Index Key. Use when a company has no ticker, or after a rename.
>
> **figi** `string`
>
> OpenFIGI identifier of the security. Licensed identifier.
>
> **fscl** `string`
>
> Fiscal.ai's stable company identifier, the `companyFiscalIdentifier` field. The only identifier that survives a ticker change or a relisting, so prefer it when carrying a company between calls.
>
> **isin** `string`
>
> ISIN of the security. Licensed identifier.
>
> **cusip** `string`
>
> CUSIP of the security. Licensed identifier.
>
> **ticker** `string`
>
> Ticker symbol, for example MSFT. Only unique within an exchange, so pass `exchange` with it.
>
> **currency** `string`
>
> ISO 4217 code to convert into, for example USD or EUR. Defaults to the company's own reporting currency, and the response carries the rate that was applied.
>
> **exchange** `string`
>
> Exchange code for `ticker`, for example NASDAQ, or a MIC code for a non-US/CA listing.
>
> **companyKey** `string`
>
> Exchange and ticker joined by an underscore: `NASDAQ_MSFT` for US and Canadian listings, or MIC code and ticker elsewhere, as in `XWAR_PKN`.
>
> **periodType** `array`
>
> Comma-separated period filter: annual, quarterly, semi-annual, ltm, ytd, latest. Defaults to annual.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **includeReportingTemplates** `boolean`
>
> Include which reporting templates each standardized metric belongs to.
>
> **includeMappingAlternatives** `boolean`
>
> Include the alternative as-reported line items that could have mapped to each standardized metric, which is how a mapping decision is audited.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Balance sheet, as reported with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_FINANCIALS_BALANCE_SHEET_AS_REPORTED`
>
> Call when fidelity to the filing matters more than comparability: the labels and groupings are the company's own, so two companies cannot be lined up against each other. Use the standardized view for that. Each value carries a link back to the filing page it came from.
>
> #### Input Parameters
>
> **cik** `string`
>
> SEC Central Index Key. Use when a company has no ticker, or after a rename.
>
> **figi** `string`
>
> OpenFIGI identifier of the security. Licensed identifier.
>
> **fscl** `string`
>
> Fiscal.ai's stable company identifier, the `companyFiscalIdentifier` field. The only identifier that survives a ticker change or a relisting, so prefer it when carrying a company between calls.
>
> **isin** `string`
>
> ISIN of the security. Licensed identifier.
>
> **cusip** `string`
>
> CUSIP of the security. Licensed identifier.
>
> **ticker** `string`
>
> Ticker symbol, for example MSFT. Only unique within an exchange, so pass `exchange` with it.
>
> **currency** `string`
>
> ISO 4217 code to convert into, for example USD or EUR. Defaults to the company's own reporting currency, and the response carries the rate that was applied.
>
> **exchange** `string`
>
> Exchange code for `ticker`, for example NASDAQ, or a MIC code for a non-US/CA listing.
>
> **companyKey** `string`
>
> Exchange and ticker joined by an underscore: `NASDAQ_MSFT` for US and Canadian listings, or MIC code and ticker elsewhere, as in `XWAR_PKN`.
>
> **periodType** `array`
>
> Comma-separated period filter: annual, quarterly, semi-annual, ltm, ytd, latest. Defaults to annual.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cash flow statement with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_FINANCIALS_CASH_FLOW_STATEMENT`
>
> Call when comparing companies, screening, or computing anything that has to mean the same thing across two filers. The mapping is visible: each standardized metric names the as-reported lines behind it, so a surprising figure can be traced rather than trusted.
>
> #### Input Parameters
>
> **cik** `string`
>
> SEC Central Index Key. Use when a company has no ticker, or after a rename.
>
> **figi** `string`
>
> OpenFIGI identifier of the security. Licensed identifier.
>
> **fscl** `string`
>
> Fiscal.ai's stable company identifier, the `companyFiscalIdentifier` field. The only identifier that survives a ticker change or a relisting, so prefer it when carrying a company between calls.
>
> **isin** `string`
>
> ISIN of the security. Licensed identifier.
>
> **cusip** `string`
>
> CUSIP of the security. Licensed identifier.
>
> **ticker** `string`
>
> Ticker symbol, for example MSFT. Only unique within an exchange, so pass `exchange` with it.
>
> **currency** `string`
>
> ISO 4217 code to convert into, for example USD or EUR. Defaults to the company's own reporting currency, and the response carries the rate that was applied.
>
> **exchange** `string`
>
> Exchange code for `ticker`, for example NASDAQ, or a MIC code for a non-US/CA listing.
>
> **companyKey** `string`
>
> Exchange and ticker joined by an underscore: `NASDAQ_MSFT` for US and Canadian listings, or MIC code and ticker elsewhere, as in `XWAR_PKN`.
>
> **periodType** `array`
>
> Comma-separated period filter: annual, quarterly, semi-annual, ltm, ytd, latest. Defaults to annual.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **includeReportingTemplates** `boolean`
>
> Include which reporting templates each standardized metric belongs to.
>
> **includeMappingAlternatives** `boolean`
>
> Include the alternative as-reported line items that could have mapped to each standardized metric, which is how a mapping decision is audited.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cash flow statement, as reported with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_FINANCIALS_CASH_FLOW_STATEMENT_AS_REPORTED`
>
> Call when fidelity to the filing matters more than comparability: the labels and groupings are the company's own, so two companies cannot be lined up against each other. Use the standardized view for that. Each value carries a link back to the filing page it came from.
>
> #### Input Parameters
>
> **cik** `string`
>
> SEC Central Index Key. Use when a company has no ticker, or after a rename.
>
> **figi** `string`
>
> OpenFIGI identifier of the security. Licensed identifier.
>
> **fscl** `string`
>
> Fiscal.ai's stable company identifier, the `companyFiscalIdentifier` field. The only identifier that survives a ticker change or a relisting, so prefer it when carrying a company between calls.
>
> **isin** `string`
>
> ISIN of the security. Licensed identifier.
>
> **cusip** `string`
>
> CUSIP of the security. Licensed identifier.
>
> **ticker** `string`
>
> Ticker symbol, for example MSFT. Only unique within an exchange, so pass `exchange` with it.
>
> **currency** `string`
>
> ISO 4217 code to convert into, for example USD or EUR. Defaults to the company's own reporting currency, and the response carries the rate that was applied.
>
> **exchange** `string`
>
> Exchange code for `ticker`, for example NASDAQ, or a MIC code for a non-US/CA listing.
>
> **companyKey** `string`
>
> Exchange and ticker joined by an underscore: `NASDAQ_MSFT` for US and Canadian listings, or MIC code and ticker elsewhere, as in `XWAR_PKN`.
>
> **periodType** `array`
>
> Comma-separated period filter: annual, quarterly, semi-annual, ltm, ytd, latest. Defaults to annual.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Income statement with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_FINANCIALS_INCOME_STATEMENT`
>
> Call when comparing companies, screening, or computing anything that has to mean the same thing across two filers. The mapping is visible: each standardized metric names the as-reported lines behind it, so a surprising figure can be traced rather than trusted.
>
> #### Input Parameters
>
> **cik** `string`
>
> SEC Central Index Key. Use when a company has no ticker, or after a rename.
>
> **figi** `string`
>
> OpenFIGI identifier of the security. Licensed identifier.
>
> **fscl** `string`
>
> Fiscal.ai's stable company identifier, the `companyFiscalIdentifier` field. The only identifier that survives a ticker change or a relisting, so prefer it when carrying a company between calls.
>
> **isin** `string`
>
> ISIN of the security. Licensed identifier.
>
> **cusip** `string`
>
> CUSIP of the security. Licensed identifier.
>
> **ticker** `string`
>
> Ticker symbol, for example MSFT. Only unique within an exchange, so pass `exchange` with it.
>
> **currency** `string`
>
> ISO 4217 code to convert into, for example USD or EUR. Defaults to the company's own reporting currency, and the response carries the rate that was applied.
>
> **exchange** `string`
>
> Exchange code for `ticker`, for example NASDAQ, or a MIC code for a non-US/CA listing.
>
> **companyKey** `string`
>
> Exchange and ticker joined by an underscore: `NASDAQ_MSFT` for US and Canadian listings, or MIC code and ticker elsewhere, as in `XWAR_PKN`.
>
> **periodType** `array`
>
> Comma-separated period filter: annual, quarterly, semi-annual, ltm, ytd, latest. Defaults to annual.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **includeReportingTemplates** `boolean`
>
> Include which reporting templates each standardized metric belongs to.
>
> **includeMappingAlternatives** `boolean`
>
> Include the alternative as-reported line items that could have mapped to each standardized metric, which is how a mapping decision is audited.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Income statement, as reported with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_FINANCIALS_INCOME_STATEMENT_AS_REPORTED`
>
> Call when fidelity to the filing matters more than comparability: the labels and groupings are the company's own, so two companies cannot be lined up against each other. Use the standardized view for that. Each value carries a link back to the filing page it came from.
>
> #### Input Parameters
>
> **cik** `string`
>
> SEC Central Index Key. Use when a company has no ticker, or after a rename.
>
> **figi** `string`
>
> OpenFIGI identifier of the security. Licensed identifier.
>
> **fscl** `string`
>
> Fiscal.ai's stable company identifier, the `companyFiscalIdentifier` field. The only identifier that survives a ticker change or a relisting, so prefer it when carrying a company between calls.
>
> **isin** `string`
>
> ISIN of the security. Licensed identifier.
>
> **cusip** `string`
>
> CUSIP of the security. Licensed identifier.
>
> **ticker** `string`
>
> Ticker symbol, for example MSFT. Only unique within an exchange, so pass `exchange` with it.
>
> **currency** `string`
>
> ISO 4217 code to convert into, for example USD or EUR. Defaults to the company's own reporting currency, and the response carries the rate that was applied.
>
> **exchange** `string`
>
> Exchange code for `ticker`, for example NASDAQ, or a MIC code for a non-US/CA listing.
>
> **companyKey** `string`
>
> Exchange and ticker joined by an underscore: `NASDAQ_MSFT` for US and Canadian listings, or MIC code and ticker elsewhere, as in `XWAR_PKN`.
>
> **periodType** `array`
>
> Comma-separated period filter: annual, quarterly, semi-annual, ltm, ytd, latest. Defaults to annual.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Companies in fund letters with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_FUND_LETTERS_COMPANIES`
>
> Call to find which companies professional investors are actually writing about, and how heavily, before asking what they said.
>
> #### Input Parameters
>
> **pageSize** `number`
>
> Rows per page, up to 250. Defaults to 250; page for more.
>
> **pageNumber** `number`
>
> Page number, 1-indexed.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Theses on a company with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_FUND_LETTERS_COMPANY`
>
> Call for the qualitative case on a company as professional investors put it, with the stance and conviction attached. The one capability here that answers what people think rather than what was reported.
>
> #### Input Parameters
>
> **cik** `string`
>
> SEC Central Index Key. Use when a company has no ticker, or after a rename.
>
> **figi** `string`
>
> OpenFIGI identifier of the security. Licensed identifier.
>
> **fscl** `string`
>
> Fiscal.ai's stable company identifier, the `companyFiscalIdentifier` field. The only identifier that survives a ticker change or a relisting, so prefer it when carrying a company between calls.
>
> **isin** `string`
>
> ISIN of the security. Licensed identifier.
>
> **cusip** `string`
>
> CUSIP of the security. Licensed identifier.
>
> **ticker** `string`
>
> Ticker symbol, for example MSFT. Only unique within an exchange, so pass `exchange` with it.
>
> **exchange** `string`
>
> Exchange code for `ticker`, for example NASDAQ, or a MIC code for a non-US/CA listing.
>
> **companyKey** `string`
>
> Exchange and ticker joined by an underscore: `NASDAQ_MSFT` for US and Canadian listings, or MIC code and ticker elsewhere, as in `XWAR_PKN`.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Fund letter with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_FUND_LETTERS_DETAIL`
>
> Call for what one letter actually argued. The narrative sections are the investor's own words; the theses are the extraction, and each names what it was based on so a thin mention is not mistaken for a conviction.
>
> #### Input Parameters
>
> **letterId** `string` *required*
>
> Letter id, from fund-letters/list.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Investor profile with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_FUND_LETTERS_INVESTOR`
>
> Call to understand how a firm invests before weighting what it says about a company. The profile is derived from its own letters rather than from marketing material.
>
> #### Input Parameters
>
> **investorId** `string` *required*
>
> Investor id, from fund-letters/investors. Permanent.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Fund letter investors with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_FUND_LETTERS_INVESTORS`
>
> Call to find the investorId for a firm, or to pick firms by style or sector focus before reading any letters. Sorted by coverage, so the most-covered firms come first.
>
> #### Input Parameters
>
> **pageSize** `number`
>
> Rows per page, up to 250. Defaults to 250; page for more.
>
> **pageNumber** `number`
>
> Page number, 1-indexed.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Fund letters with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_FUND_LETTERS_LIST`
>
> Call to see what was published in a quarter. Returns the letter index rather than the letters - take a letterId to fund-letters/detail for the content.
>
> #### Input Parameters
>
> **year** `number` *required*
>
> Calendar year of the reporting period, 2020 or later. Upstream refuses the call without it.
>
> **fundId** `string`
>
> Restrict to one fund, by id.
>
> **quarter** `number`
>
> Quarter, 1 to 4. Omit for the whole year.
>
> **pageSize** `number`
>
> Rows per page, up to 250. Defaults to 250; page for more.
>
> **investorId** `string`
>
> Restrict to one investment firm, by id from fund-letters/investors.
>
> **pageNumber** `number`
>
> Page number, 1-indexed.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Ratio definitions with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_METRICS_RATIOS_LIST`
>
> Call to find a ratio id before requesting a series, and to check `hasDailyData` before asking for a daily one - not every ratio has it.
>
> #### Input Parameters
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Standardized metrics with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_METRICS_STANDARDIZED`
>
> Call to find the standardized metric id for a concept before requesting statements, rather than guessing at a name. Free, and takes no company.
>
> #### Input Parameters
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Standardized metrics by template with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_METRICS_STANDARDIZED_BY_TEMPLATE`
>
> Call rather than the full list when the template is already known - it is the only place the prose definition and the sub-component breakdown of each metric are published, which is what settles what a line actually includes.
>
> #### Input Parameters
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **templateType** `string` *required*
>
> Reporting template, for example `standard`. A company's template is on its profile.
>
> **statementType** `string ("income-statement" | "balance-sheet" | "cash-flow-statement")` *required*
>
> Which statement to list metrics for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Holdings by institution with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_OWNERSHIP_HOLDER_HOLDINGS`
>
> Call to read ownership from the investor's end rather than the company's - what a fund holds and how it is weighted. The counterpart to institutional-holders, over the same 13F data.
>
> #### Input Parameters
>
> **year** `number`
>
> Calendar year of the reported quarter. Defaults to the latest reported.
>
> **quarter** `number`
>
> Quarter, 1 to 4.
>
> **holderId** `string` *required*
>
> Institutional holder id, from ownership/holders-list or an institutional-holders row.
>
> **pageSize** `number`
>
> Rows per page, up to 250. Defaults to 250; page for more.
>
> **pageNumber** `number`
>
> Page number, 1-indexed.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Institution directory with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_OWNERSHIP_HOLDERS_LIST`
>
> List institutions and their holder IDs in a paginated directory. The directory takes no company identifier.
>
> #### Input Parameters
>
> **pageSize** `number`
>
> Rows per page, up to 250. Defaults to 250; page for more.
>
> **pageNumber** `number`
>
> Page number, 1-indexed.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Insider holders with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_OWNERSHIP_INSIDER_HOLDERS`
>
> Call for the current standing position of officers and directors, including holdings held through trusts and other vehicles. Use insider-transactions for what they have been doing rather than what they hold.
>
> #### Input Parameters
>
> **cik** `string`
>
> SEC Central Index Key. Use when a company has no ticker, or after a rename.
>
> **figi** `string`
>
> OpenFIGI identifier of the security. Licensed identifier.
>
> **fscl** `string`
>
> Fiscal.ai's stable company identifier, the `companyFiscalIdentifier` field. The only identifier that survives a ticker change or a relisting, so prefer it when carrying a company between calls.
>
> **isin** `string`
>
> ISIN of the security. Licensed identifier.
>
> **cusip** `string`
>
> CUSIP of the security. Licensed identifier.
>
> **ticker** `string`
>
> Ticker symbol, for example MSFT. Only unique within an exchange, so pass `exchange` with it.
>
> **exchange** `string`
>
> Exchange code for `ticker`, for example NASDAQ, or a MIC code for a non-US/CA listing.
>
> **pageSize** `number`
>
> Rows per page, up to 250. Defaults to 250; page for more.
>
> **companyKey** `string`
>
> Exchange and ticker joined by an underscore: `NASDAQ_MSFT` for US and Canadian listings, or MIC code and ticker elsewhere, as in `XWAR_PKN`.
>
> **pageNumber** `number`
>
> Page number, 1-indexed.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **includeInactive** `boolean`
>
> Include holders marked inactive. Hidden by default; holders removed by an analyst override stay hidden either way.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Insider transactions with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_OWNERSHIP_INSIDER_TRANSACTIONS`
>
> Call to see insider activity over time. Read `transactionType` before drawing conclusions: an option exercise or a tax withholding is not a market sale, and they sit in the same series.
>
> #### Input Parameters
>
> **cik** `string`
>
> SEC Central Index Key. Use when a company has no ticker, or after a rename.
>
> **figi** `string`
>
> OpenFIGI identifier of the security. Licensed identifier.
>
> **fscl** `string`
>
> Fiscal.ai's stable company identifier, the `companyFiscalIdentifier` field. The only identifier that survives a ticker change or a relisting, so prefer it when carrying a company between calls.
>
> **isin** `string`
>
> ISIN of the security. Licensed identifier.
>
> **cusip** `string`
>
> CUSIP of the security. Licensed identifier.
>
> **ticker** `string`
>
> Ticker symbol, for example MSFT. Only unique within an exchange, so pass `exchange` with it.
>
> **exchange** `string`
>
> Exchange code for `ticker`, for example NASDAQ, or a MIC code for a non-US/CA listing.
>
> **pageSize** `number`
>
> Rows per page, up to 250. Defaults to 250; page for more.
>
> **companyKey** `string`
>
> Exchange and ticker joined by an underscore: `NASDAQ_MSFT` for US and Canadian listings, or MIC code and ticker elsewhere, as in `XWAR_PKN`.
>
> **pageNumber** `number`
>
> Page number, 1-indexed.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **includeInactive** `boolean`
>
> Include holders marked inactive. Hidden by default; holders removed by an analyst override stay hidden either way.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Institutional holders with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_OWNERSHIP_INSTITUTIONAL_HOLDERS`
>
> Call to see who institutionally owns a company and who moved last quarter. 13F data lags: the report date is the quarter end, the filing date is up to 45 days later, and both are returned so the lag is visible.
>
> #### Input Parameters
>
> **cik** `string`
>
> SEC Central Index Key. Use when a company has no ticker, or after a rename.
>
> **figi** `string`
>
> OpenFIGI identifier of the security. Licensed identifier.
>
> **fscl** `string`
>
> Fiscal.ai's stable company identifier, the `companyFiscalIdentifier` field. The only identifier that survives a ticker change or a relisting, so prefer it when carrying a company between calls.
>
> **isin** `string`
>
> ISIN of the security. Licensed identifier.
>
> **year** `number`
>
> Calendar year of the reported quarter. Defaults to the latest reported.
>
> **cusip** `string`
>
> CUSIP of the security. Licensed identifier.
>
> **ticker** `string`
>
> Ticker symbol, for example MSFT. Only unique within an exchange, so pass `exchange` with it.
>
> **quarter** `number`
>
> Quarter, 1 to 4. Pass with `year` to read a historical position rather than the latest.
>
> **exchange** `string`
>
> Exchange code for `ticker`, for example NASDAQ, or a MIC code for a non-US/CA listing.
>
> **pageSize** `number`
>
> Rows per page, up to 250. Defaults to 250; page for more.
>
> **companyKey** `string`
>
> Exchange and ticker joined by an underscore: `NASDAQ_MSFT` for US and Canadian listings, or MIC code and ticker elsewhere, as in `XWAR_PKN`.
>
> **pageNumber** `number`
>
> Page number, 1-indexed.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Daily prices with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_PRICES_DAILY`
>
> Call for a daily close series. Prices are split-adjusted already, so no correction against prices/splits is needed; the series is per listing, so a cross-listed company answers in whichever listing the identifier denoted.
>
> #### Input Parameters
>
> **cik** `string`
>
> SEC Central Index Key. Use when a company has no ticker, or after a rename.
>
> **figi** `string`
>
> OpenFIGI identifier of the security. Licensed identifier.
>
> **fscl** `string`
>
> Fiscal.ai's stable company identifier, the `companyFiscalIdentifier` field. The only identifier that survives a ticker change or a relisting, so prefer it when carrying a company between calls.
>
> **isin** `string`
>
> ISIN of the security. Licensed identifier.
>
> **cusip** `string`
>
> CUSIP of the security. Licensed identifier.
>
> **latest** `boolean`
>
> Return only the most recent bar, ignoring the date window.
>
> **ticker** `string`
>
> Ticker symbol, for example MSFT. Only unique within an exchange, so pass `exchange` with it.
>
> **endDate** `string`
>
> Inclusive end date, ISO 8601.
>
> **exchange** `string`
>
> Exchange code for `ticker`, for example NASDAQ, or a MIC code for a non-US/CA listing.
>
> **startDate** `string`
>
> Inclusive start date, ISO 8601.
>
> **companyKey** `string`
>
> Exchange and ticker joined by an underscore: `NASDAQ_MSFT` for US and Canadian listings, or MIC code and ticker elsewhere, as in `XWAR_PKN`.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Intraday prices with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_PRICES_INTRADAY`
>
> Call when the question is about movement within a session - a reaction to an announcement, say. Rounded to two decimals, so it is not a tick feed for execution purposes.
>
> #### Input Parameters
>
> **cik** `string`
>
> SEC Central Index Key. Use when a company has no ticker, or after a rename.
>
> **figi** `string`
>
> OpenFIGI identifier of the security. Licensed identifier.
>
> **fscl** `string`
>
> Fiscal.ai's stable company identifier, the `companyFiscalIdentifier` field. The only identifier that survives a ticker change or a relisting, so prefer it when carrying a company between calls.
>
> **isin** `string`
>
> ISIN of the security. Licensed identifier.
>
> **cusip** `string`
>
> CUSIP of the security. Licensed identifier.
>
> **ticker** `string`
>
> Ticker symbol, for example MSFT. Only unique within an exchange, so pass `exchange` with it.
>
> **endDate** `string`
>
> Inclusive end date, ISO 8601.
>
> **exchange** `string`
>
> Exchange code for `ticker`, for example NASDAQ, or a MIC code for a non-US/CA listing.
>
> **startDate** `string`
>
> Inclusive start date, ISO 8601.
>
> **companyKey** `string`
>
> Exchange and ticker joined by an underscore: `NASDAQ_MSFT` for US and Canadian listings, or MIC code and ticker elsewhere, as in `XWAR_PKN`.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Stock splits with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_PRICES_SPLITS`
>
> Call to explain a discontinuity, or to reconcile against a price series from elsewhere that is not split-adjusted. The series returned by prices/daily already is, so this is not needed to correct it.
>
> #### Input Parameters
>
> **cik** `string`
>
> SEC Central Index Key. Use when a company has no ticker, or after a rename.
>
> **figi** `string`
>
> OpenFIGI identifier of the security. Licensed identifier.
>
> **fscl** `string`
>
> Fiscal.ai's stable company identifier, the `companyFiscalIdentifier` field. The only identifier that survives a ticker change or a relisting, so prefer it when carrying a company between calls.
>
> **isin** `string`
>
> ISIN of the security. Licensed identifier.
>
> **cusip** `string`
>
> CUSIP of the security. Licensed identifier.
>
> **ticker** `string`
>
> Ticker symbol, for example MSFT. Only unique within an exchange, so pass `exchange` with it.
>
> **exchange** `string`
>
> Exchange code for `ticker`, for example NASDAQ, or a MIC code for a non-US/CA listing.
>
> **companyKey** `string`
>
> Exchange and ticker joined by an underscore: `NASDAQ_MSFT` for US and Canadian listings, or MIC code and ticker elsewhere, as in `XWAR_PKN`.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Daily ratio series with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_RATIOS_DAILY`
>
> Call when the question is how a ratio moved between reporting dates rather than what it was at them. Each day is recomputed against that day's close and the then-current fundamentals, so it is a real series, not a step function.
>
> #### Input Parameters
>
> **cik** `string`
>
> SEC Central Index Key. Use when a company has no ticker, or after a rename.
>
> **figi** `string`
>
> OpenFIGI identifier of the security. Licensed identifier.
>
> **fscl** `string`
>
> Fiscal.ai's stable company identifier, the `companyFiscalIdentifier` field. The only identifier that survives a ticker change or a relisting, so prefer it when carrying a company between calls.
>
> **isin** `string`
>
> ISIN of the security. Licensed identifier.
>
> **cusip** `string`
>
> CUSIP of the security. Licensed identifier.
>
> **ticker** `string`
>
> Ticker symbol, for example MSFT. Only unique within an exchange, so pass `exchange` with it.
>
> **ratioId** `string` *required*
>
> Which ratio to return a daily series for. Only ratios whose `hasDailyData` is true have one.
>
> **currency** `string`
>
> ISO 4217 code to convert into, for example USD or EUR. Defaults to the company's own reporting currency, and the response carries the rate that was applied.
>
> **exchange** `string`
>
> Exchange code for `ticker`, for example NASDAQ, or a MIC code for a non-US/CA listing.
>
> **companyKey** `string`
>
> Exchange and ticker joined by an underscore: `NASDAQ_MSFT` for US and Canadian listings, or MIC code and ticker elsewhere, as in `XWAR_PKN`.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Ratios by period with fiscal-ai
>
> **Slug:** `FIRECRAWL_FISCAL_AI_RATIOS_SERIES`
>
> Call for valuation, margin and leverage ratios already computed against the reported statements, rather than recomputing them from financials and risking a different denominator.
>
> #### Input Parameters
>
> **cik** `string`
>
> SEC Central Index Key. Use when a company has no ticker, or after a rename.
>
> **figi** `string`
>
> OpenFIGI identifier of the security. Licensed identifier.
>
> **fscl** `string`
>
> Fiscal.ai's stable company identifier, the `companyFiscalIdentifier` field. The only identifier that survives a ticker change or a relisting, so prefer it when carrying a company between calls.
>
> **isin** `string`
>
> ISIN of the security. Licensed identifier.
>
> **cusip** `string`
>
> CUSIP of the security. Licensed identifier.
>
> **ticker** `string`
>
> Ticker symbol, for example MSFT. Only unique within an exchange, so pass `exchange` with it.
>
> **ratioId** `string`
>
> Restrict to one ratio by id. Omit for every supported ratio. Ids come from metrics/ratios-list.
>
> **currency** `string`
>
> ISO 4217 code to convert into, for example USD or EUR. Defaults to the company's own reporting currency, and the response carries the rate that was applied.
>
> **exchange** `string`
>
> Exchange code for `ticker`, for example NASDAQ, or a MIC code for a non-US/CA listing.
>
> **companyKey** `string`
>
> Exchange and ticker joined by an underscore: `NASDAQ_MSFT` for US and Canadian listings, or MIC code and ticker elsewhere, as in `XWAR_PKN`.
>
> **periodType** `array`
>
> Comma-separated period filter: annual, quarterly, semi-annual, ltm, ytd, latest. Defaults to annual.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Company lookup with fullenrich
>
> **Slug:** `FIRECRAWL_FULLENRICH_COMPANIES_LOOKUP`
>
> Resolve one company from its domain, LinkedIn company URL, or LinkedIn company ID. Returns firmographics, technologies, social profiles, and locations.
>
> #### Input Parameters
>
> **domain** `string`
>
> Company domain, such as fullenrich.com.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **professional\_network\_id** `number`
>
> LinkedIn company ID.
>
> **professional\_network\_url** `string`
>
> LinkedIn company URL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Company match with fullenrich
>
> **Slug:** `FIRECRAWL_FULLENRICH_COMPANIES_MATCH`
>
> Use only for strict exact-match semantics with a LinkedIn company URL. For broader resolution from a domain, LinkedIn URL, or LinkedIn ID, prefer companies/lookup.
>
> #### Input Parameters
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **linkedin\_url** `string` *required*
>
> Canonical LinkedIn company URL, such as [https://www.linkedin.com/company/fullenrich](https://www.linkedin.com/company/fullenrich). Matched exactly.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Company search with fullenrich
>
> **Slug:** `FIRECRAWL_FULLENRICH_COMPANIES_SEARCH`
>
> Find companies by industry, size, location, technologies, or founding year. Combine filters and page through the results. Use companies/lookup when you already have a domain or LinkedIn identifier.
>
> #### Input Parameters
>
> **limit** `number`
>
> Records per page, up to 6. Each returned record costs 5 credits. Use pagination for more.
>
> **names** `array`
>
> Company names. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **types** `array`
>
> Company types, such as Public Company or Nonprofit. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **offset** `number`
>
> Records to skip. Use search\_after beyond 10,000.
>
> **domains** `array`
>
> Company domains. Exact matching recommended. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **keywords** `array`
>
> Keywords in company descriptions. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **headcounts** `array`
>
> Employee counts. Entries: \{ min?, max?, exclude? }; at least one inclusive bound.
>
> **industries** `array`
>
> Company industries. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **company\_ids** `array`
>
> FullEnrich company IDs. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **specialties** `array`
>
> Company specialties. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **search\_after** `string`
>
> Cursor from the previous response's metadata.search\_after. Keep the same filters.
>
> **technologies** `array`
>
> Technologies used by the company. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **founded\_years** `array`
>
> Founding years. Entries: \{ min?, max?, exclude? }; at least one inclusive bound.
>
> **headquarters\_locations** `array`
>
> Headquarters cities, regions, or countries. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **professional\_network\_ids** `array`
>
> LinkedIn company IDs. Entries: \{ value: number, exclude?: boolean, exact\_match?: boolean }.
>
> **professional\_network\_urls** `array`
>
> LinkedIn company URLs. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Mobile number with fullenrich
>
> **Slug:** `FIRECRAWL_FULLENRICH_CONTACTS_MOBILE`
>
> Find a person's mobile phone number from a LinkedIn URL, or from their name and employer. Each call enriches one contact; concurrent enrichments can hit rate limits.
>
> #### Input Parameters
>
> **domain** `string`
>
> Employer domain, such as fullenrich.com. Either this or company\_name identifies the company.
>
> **last\_name** `string`
>
> Family name.
>
> **first\_name** `string`
>
> Given name. With last\_name and a company, an alternative to linkedin\_url.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **company\_name** `string`
>
> Employer name, when the domain is not known.
>
> **linkedin\_url** `string`
>
> LinkedIn profile URL, standard or Sales Navigator. Enough on its own, improves match rates when added to a name, and returns the professional profile alongside the contact data.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Personal email with fullenrich
>
> **Slug:** `FIRECRAWL_FULLENRICH_CONTACTS_PERSONAL_EMAIL`
>
> Find a person's personal email from a LinkedIn URL, or from their name and employer; Schedule A bars marketing to personal addresses. Each call enriches one contact, and concurrent enrichments can hit rate limits.
>
> #### Input Parameters
>
> **domain** `string`
>
> Employer domain, such as fullenrich.com. Either this or company\_name identifies the company.
>
> **last\_name** `string`
>
> Family name.
>
> **first\_name** `string`
>
> Given name. With last\_name and a company, an alternative to linkedin\_url.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **company\_name** `string`
>
> Employer name, when the domain is not known.
>
> **linkedin\_url** `string`
>
> LinkedIn profile URL, standard or Sales Navigator. Enough on its own, improves match rates when added to a name, and returns the professional profile alongside the contact data.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Reverse email lookup with fullenrich
>
> **Slug:** `FIRECRAWL_FULLENRICH_CONTACTS_REVERSE_EMAIL`
>
> Identify the person and company behind a work or personal email address and return a professional profile. Each call looks up one email; concurrent enrichments can hit rate limits.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> The work or personal email address to identify.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Work email with fullenrich
>
> **Slug:** `FIRECRAWL_FULLENRICH_CONTACTS_WORK_EMAIL`
>
> Find a person's work email from a LinkedIn URL, or from their name and employer. Each call enriches one contact; concurrent enrichments can hit rate limits.
>
> #### Input Parameters
>
> **domain** `string`
>
> Employer domain, such as fullenrich.com. Either this or company\_name identifies the company.
>
> **last\_name** `string`
>
> Family name.
>
> **first\_name** `string`
>
> Given name. With last\_name and a company, an alternative to linkedin\_url.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **company\_name** `string`
>
> Employer name, when the domain is not known.
>
> **linkedin\_url** `string`
>
> LinkedIn profile URL, standard or Sales Navigator. Enough on its own, improves match rates when added to a name, and returns the professional profile alongside the contact data.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Person lookup with fullenrich
>
> **Slug:** `FIRECRAWL_FULLENRICH_PEOPLE_LOOKUP`
>
> Resolve a person from a LinkedIn URL or ID, or a full name combined with a company domain, LinkedIn URL, or ID. Returns a profile, not verified email addresses or phone numbers.
>
> #### Input Parameters
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **person\_name** `string`
>
> Full name. Combine with a company identifier.
>
> **company\_domain** `string`
>
> Employer domain, such as fullenrich.com.
>
> **person\_professional\_network\_id** `number`
>
> LinkedIn profile ID.
>
> **company\_professional\_network\_id** `number`
>
> Employer LinkedIn ID.
>
> **person\_professional\_network\_url** `string`
>
> LinkedIn profile URL.
>
> **company\_professional\_network\_url** `string`
>
> Employer LinkedIn URL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Person match with fullenrich
>
> **Slug:** `FIRECRAWL_FULLENRICH_PEOPLE_MATCH`
>
> Use only for strict exact-match semantics with a LinkedIn profile URL. For broader resolution from a LinkedIn URL or ID, or from a name plus company identifiers, prefer people/lookup.
>
> #### Input Parameters
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **linkedin\_url** `string` *required*
>
> Canonical LinkedIn profile URL, such as [https://www.linkedin.com/in/jane-doe](https://www.linkedin.com/in/jane-doe). Matched exactly.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get agent job status
>
> **Slug:** `FIRECRAWL_GET_AGENT_STATUS`
>
> Tool to get the status and results of an agent job. Use when you need to check if an agent job has completed and retrieve the collected data. Agent jobs autonomously search, navigate, and extract data from the web.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier (UUID) of the agent job.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get deep research status
>
> **Slug:** `FIRECRAWL_GET_DEEP_RESEARCH_STATUS`
>
> Retrieves the status and results of a deep research job by its ID. Use when you need to check the progress or retrieve the final analysis of a deep research operation.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier (UUID) of the deep research job. Must be the UUID returned by FIRECRAWL\_DEEP\_RESEARCH; arbitrary UUIDs are not valid.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get the status of a crawl job
>
> **Slug:** `FIRECRAWL_GET_THE_STATUS_OF_A_CRAWL_JOB`
>
> Retrieves the current status, progress, and details of a web crawl job, using the job ID obtained when the crawl was initiated.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier (UUID) of the crawl job.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List interact sessions
>
> **Slug:** `FIRECRAWL_LIST_INTERACT_SESSIONS`
>
> List standalone Firecrawl Interact browser sessions, optionally by status.
>
> #### Input Parameters
>
> **status** `string ("active" | "destroyed")`
>
> Supported Interact session status values.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List monitor checks
>
> **Slug:** `FIRECRAWL_LIST_MONITOR_CHECKS`
>
> List recent check runs for a Firecrawl monitor.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of checks to return, from 1 through 100.
>
> **offset** `integer`
>
> Number of checks to skip before returning results.
>
> **status** `string ("queued" | "running" | "completed" | "failed" | "partial" | "skipped_overlap" | "skipped_no_credits")`
>
> Return only checks in the selected provider status.
>
> **monitor\_id** `string` *required*
>
> UUID of the monitor whose check history should be returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate LLMs.txt for a website
>
> **Slug:** `FIRECRAWL_LLMS_TXT_GENERATE`
>
> Initiates an async job to generate an LLMs.txt file for a website, converting web content into LLM-friendly format. Returns a job ID to check status and retrieve results. Use when you need to create a standardized, machine-readable representation of website content for language models.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> The URL to generate LLMs.txt from. Must be a valid URI format.
>
> **maxUrls** `integer`
>
> Maximum number of URLs to analyze when generating the LLMs.txt file. Must be between 1 and 100. Default is 10.
>
> **showFullText** `boolean`
>
> Include full text content in the response. When true, generates both llmstxt and llmsfulltxt. Default is false.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get LLMs.txt generation job status
>
> **Slug:** `FIRECRAWL_LLMS_TXT_GET`
>
> Tool to get the status and results of an LLMs.txt generation job. Use when you need to check if a job has completed and retrieve the generated content.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier (UUID) of the LLMs.txt generation job.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Map multiple URLs
>
> **Slug:** `FIRECRAWL_MAP_MULTIPLE_URLS_BASED_ON_OPTIONS`
>
> Maps a website by discovering URLs from a starting base URL, with options to customize the crawl via search query, subdomain inclusion, sitemap handling, and result limits; search effectiveness is site-dependent.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.003 per basic Map call
>
> **Discount:** 79
>
> #### Input Parameters
>
> **url** `string` *required*
>
> The starting website URL to map and discover links from. Must be a valid HTTP/HTTPS URL string (e.g., '[https://example.com](https://example.com)'). Do NOT pass code snippets, SDK examples, or anything other than a plain URL.
>
> **limit** `integer`
>
> Maximum number of links to return. Defaults to 5000. Maximum allowed is 100000.
>
> **search** `string`
>
> Optional search query to guide URL mapping, prioritizing or finding specific page types. 'Smart' search is limited to 1000 initial results in Alpha, but overall mapping can exceed this.
>
> **sitemap** `string`
>
> Sitemap handling mode: 'skip' to exclude sitemaps, 'include' to use sitemaps with other discovery methods (default behavior), or 'only' to return only sitemap URLs.
>
> **timeout** `integer`
>
> Timeout in milliseconds. No timeout is applied by default.
>
> **location** `object`
>
> Geographic settings for location-based request processing. Object with 'country' (ISO 3166-1 alpha-2 code, e.g., 'US', 'DE', 'JP') and optionally 'languages' (array of language codes, e.g., \['en'], \['de', 'en']).
>
> **ignoreCache** `boolean`
>
> If true, bypasses cached sitemap data. Useful when sitemaps have been recently updated. Sitemap data is cached for up to 7 days. Defaults to false.
>
> **includeSubdomains** `boolean`
>
> If true, includes subdomains of the base URL in the mapping. E.g., if `url` is example.com, blog.example.com is mapped. Defaults to true.
>
> **ignoreQueryParameters** `boolean`
>
> If true, excludes URLs with query parameters from results. Defaults to true.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Look up Instagram post or reel with oriane
>
> **Slug:** `FIRECRAWL_ORIANE_INSTAGRAM_POST_LOOKUP`
>
> Resolve a canonical Instagram post/video URL against Oriane's index. Instagram uses the post shortcode; TikTok uses the numeric video ID. Empty results do not trigger ingestion. Choose projection: basic 20 credits, default 30 credits, full 40 credits per nonempty call. Search limit is at most 100; URL lookup targets one record. Empty results cost zero.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Canonical Instagram /p/ or /reel/ URL. Short links are unsupported.
>
> **projection** `string ("basic" | "default" | "full")`
>
> Response detail and fixed price per nonempty call: basic 20 credits, default 30 credits, full 40 credits. Empty results cost zero. Result limit does not change the tier price.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Instagram posts and reels with oriane
>
> **Slug:** `FIRECRAWL_ORIANE_INSTAGRAM_POSTS_SEARCH`
>
> Search Oriane's indexed Instagram posts, captions and engagement. Platform is fixed to Instagram. Coverage and freshness depend on the existing index; this is not a complete live feed. Results include profileUrl; an empty result does not trigger ingestion. Choose projection: basic 20 credits, default 30 credits, full 40 credits per nonempty call. Search limit is at most 100; URL lookup targets one record. Empty results cost zero.
>
> #### Input Parameters
>
> **sort** `string`
>
> Comma-separated post sort fields with optional :asc or :desc: viewsCount, likesCount, sharesCount, commentsCount, interactionsCount, engagementRatePerViews, engagementRatePerFollowers, profileFollowersCount, publishedAt, visualSimilarity, transcriptRelevance.
>
> **limit** `number`
>
> Maximum results, default 20.
>
> **handle** `string`
>
> Account username to match exactly, for example mrbeast. A leading @ is optional; usernames are matched without regard to case. Provide this or another search field; multiple fields must all match.
>
> **offset** `number`
>
> Result offset, default 0.
>
> **caption** `string`
>
> Text to match in the caption. Provide this or another search field; multiple fields must all match.
>
> **projection** `string ("basic" | "default" | "full")`
>
> Response detail and fixed price per nonempty call: basic 20 credits, default 30 credits, full 40 credits. Empty results cost zero. Result limit does not change the tier price.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **aiSearchAnchor** `string`
>
> Anchor from the first visual search page, required for subsequent pages.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Look up Instagram profile with oriane
>
> **Slug:** `FIRECRAWL_ORIANE_INSTAGRAM_PROFILE_LOOKUP`
>
> Pass a canonical Instagram profile URL to look up account details in Oriane's index. Returns profileUrl with each match. Short links and post URLs are unsupported; empty results do not trigger ingestion. Choose projection: basic 20 credits, default 30 credits, full 40 credits per nonempty call. Search limit is at most 100; URL lookup targets one record. Empty results cost zero.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Canonical Instagram profile URL.
>
> **projection** `string ("basic" | "default" | "full")`
>
> Response detail and fixed price per nonempty call: basic 20 credits, default 30 credits, full 40 credits. Empty results cost zero. Result limit does not change the tier price.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Instagram profiles with oriane
>
> **Slug:** `FIRECRAWL_ORIANE_INSTAGRAM_PROFILES_SEARCH`
>
> Search Oriane's indexed Instagram profiles, bios and follower counts. Platform is fixed to Instagram. Coverage and freshness depend on the existing index; this is not a complete live feed. Results include profileUrl; an empty result does not trigger ingestion. Choose projection: basic 20 credits, default 30 credits, full 40 credits per nonempty call. Search limit is at most 100; URL lookup targets one record. Empty results cost zero.
>
> #### Input Parameters
>
> **bio** `string`
>
> Text to match in the bio. Provide this or another search field; multiple fields must all match.
>
> **sort** `string`
>
> Comma-separated profile sort fields with optional :asc or :desc: followersCount, createdAt, updatedAt.
>
> **limit** `number`
>
> Maximum results, default 20.
>
> **handle** `string`
>
> Account username to match exactly, for example mrbeast. A leading @ is optional; usernames are matched without regard to case. Provide this or another search field; multiple fields must all match.
>
> **offset** `number`
>
> Result offset, default 0. Exact handle searches return at most one profile and require offset 0; paginate displayName or bio searches instead.
>
> **projection** `string ("basic" | "default" | "full")`
>
> Response detail and fixed price per nonempty call: basic 20 credits, default 30 credits, full 40 credits. Empty results cost zero. Result limit does not change the tier price.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **displayName** `string`
>
> Text to match in the display name. Provide this or another search field; multiple fields must all match.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search TikTok videos with oriane
>
> **Slug:** `FIRECRAWL_ORIANE_TIKTOK_POSTS_SEARCH`
>
> Search Oriane's indexed TikTok posts, captions and engagement. Platform is fixed to TikTok. Coverage and freshness depend on the existing index; this is not a complete live feed. Results include profileUrl; an empty result does not trigger ingestion. Choose projection: basic 20 credits, default 30 credits, full 40 credits per nonempty call. Search limit is at most 100; URL lookup targets one record. Empty results cost zero.
>
> #### Input Parameters
>
> **sort** `string`
>
> Comma-separated post sort fields with optional :asc or :desc: viewsCount, likesCount, sharesCount, commentsCount, interactionsCount, engagementRatePerViews, engagementRatePerFollowers, profileFollowersCount, publishedAt, visualSimilarity, transcriptRelevance.
>
> **limit** `number`
>
> Maximum results, default 20.
>
> **handle** `string`
>
> Account username to match exactly, for example mrbeast. A leading @ is optional; usernames are matched without regard to case. Provide this or another search field; multiple fields must all match.
>
> **offset** `number`
>
> Result offset, default 0.
>
> **caption** `string`
>
> Text to match in the caption. Provide this or another search field; multiple fields must all match.
>
> **projection** `string ("basic" | "default" | "full")`
>
> Response detail and fixed price per nonempty call: basic 20 credits, default 30 credits, full 40 credits. Empty results cost zero. Result limit does not change the tier price.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **aiSearchAnchor** `string`
>
> Anchor from the first visual search page, required for subsequent pages.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Look up TikTok profile with oriane
>
> **Slug:** `FIRECRAWL_ORIANE_TIKTOK_PROFILE_LOOKUP`
>
> Pass a canonical TikTok profile URL to look up account details in Oriane's index. Returns profileUrl with each match. Short links and post URLs are unsupported; empty results do not trigger ingestion. Choose projection: basic 20 credits, default 30 credits, full 40 credits per nonempty call. Search limit is at most 100; URL lookup targets one record. Empty results cost zero.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Canonical TikTok profile URL.
>
> **projection** `string ("basic" | "default" | "full")`
>
> Response detail and fixed price per nonempty call: basic 20 credits, default 30 credits, full 40 credits. Empty results cost zero. Result limit does not change the tier price.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search TikTok profiles with oriane
>
> **Slug:** `FIRECRAWL_ORIANE_TIKTOK_PROFILES_SEARCH`
>
> Search Oriane's indexed TikTok profiles, bios and follower counts. Platform is fixed to TikTok. Coverage and freshness depend on the existing index; this is not a complete live feed. Results include profileUrl; an empty result does not trigger ingestion. Choose projection: basic 20 credits, default 30 credits, full 40 credits per nonempty call. Search limit is at most 100; URL lookup targets one record. Empty results cost zero.
>
> #### Input Parameters
>
> **bio** `string`
>
> Text to match in the bio. Provide this or another search field; multiple fields must all match.
>
> **sort** `string`
>
> Comma-separated profile sort fields with optional :asc or :desc: followersCount, createdAt, updatedAt.
>
> **limit** `number`
>
> Maximum results, default 20.
>
> **handle** `string`
>
> Account username to match exactly, for example mrbeast. A leading @ is optional; usernames are matched without regard to case. Provide this or another search field; multiple fields must all match.
>
> **offset** `number`
>
> Result offset, default 0. Exact handle searches return at most one profile and require offset 0; paginate displayName or bio searches instead.
>
> **projection** `string ("basic" | "default" | "full")`
>
> Response detail and fixed price per nonempty call: basic 20 credits, default 30 credits, full 40 credits. Empty results cost zero. Result limit does not change the tier price.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **displayName** `string`
>
> Text to match in the display name. Provide this or another search field; multiple fields must all match.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Look up TikTok video with oriane
>
> **Slug:** `FIRECRAWL_ORIANE_TIKTOK_VIDEO_LOOKUP`
>
> Resolve a canonical TikTok post/video URL against Oriane's index. Instagram uses the post shortcode; TikTok uses the numeric video ID. Empty results do not trigger ingestion. Choose projection: basic 20 credits, default 30 credits, full 40 credits per nonempty call. Search limit is at most 100; URL lookup targets one record. Empty results cost zero.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Canonical TikTok /@handle/video/ URL. Short links are unsupported.
>
> **projection** `string ("basic" | "default" | "full")`
>
> Response detail and fixed price per nonempty call: basic 20 credits, default 30 credits, full 40 credits. Empty results cost zero. Result limit does not change the tier price.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Company profile with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ADVERTISING_COMPANY`
>
> Use for the company record behind a sponsor, an entity or a companies/search hit. For its podcast advertising footprint use advertising/company/overview; for firmographics or funding, a company data provider is the better source.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Company slug (for example nvidia), domain (nvidia.com), or id.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Company advertising profile with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ADVERTISING_COMPANY_OVERVIEW`
>
> Use for a company's podcast advertising footprint in one call, across all its brands. For the show list use advertising/company/shows.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Company slug (for example nvidia), domain (nvidia.com), or id.
>
> **since** `string`
>
> Only episodes published on or after this ISO 8601 date or date-time.
>
> **until** `string`
>
> Only episodes published before this ISO 8601 date or date-time. A bare date covers that whole UTC day.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Company ad placements with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ADVERTISING_COMPANY_PLACEMENTS`
>
> Use for the feed of a company's actual ad reads, episode by episode, to read or audit them.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Company slug (for example nvidia), domain (nvidia.com), or id.
>
> **limit** `number`
>
> Maximum records to return.
>
> **since** `string`
>
> Only episodes published on or after this ISO 8601 date or date-time.
>
> **until** `string`
>
> Only episodes published before this ISO 8601 date or date-time. A bare date covers that whole UTC day.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **podcast\_id** `string`
>
> Only placements on one show.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **sponsor\_id** `string`
>
> Only placements attributed to this sponsor, keeping co-sponsors in the response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Shows a company could advertise on with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ADVERTISING_COMPANY_PROSPECTS`
>
> Use as a buy-side prospect list: where an advertiser could go next, with the shows it already buys as the reason.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Company slug (for example nvidia), domain (nvidia.com), or id.
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **include** `string`
>
> Pass via to attach, per recommendation, the company's own shows that led to it.
>
> **language** `string`
>
> Only shows in this ISO 639-1 language.
>
> **min\_score** `number`
>
> Only recommendations at or above this score, within the 200 strongest.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Shows carrying a company's ads with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ADVERTISING_COMPANY_SHOWS`
>
> Use for where a company advertises, ranked by volume, with the reads to sample. Pages are at most 24 rows.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Company slug (for example nvidia), domain (nvidia.com), or id.
>
> **limit** `number`
>
> Rows per page. This endpoint caps at 24.
>
> **since** `string`
>
> Only episodes published on or after this ISO 8601 date or date-time.
>
> **until** `string`
>
> Only episodes published before this ISO 8601 date or date-time. A bare date covers that whole UTC day.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **podcast\_id** `string`
>
> Only one show.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **sponsor\_id** `string`
>
> Narrow rows to this sponsor identity while keeping the company constraint.
>
> **publisher\_id** `string`
>
> Only one publisher's shows.
>
> **preview\_limit** `number`
>
> Previews per show when previews are included.
>
> **include\_facets** `boolean`
>
> Include exhaustive show and network filter metadata; honoured only without a cursor.
>
> **include\_previews** `string ("true" | "false")`
>
> Include recent ad segment previews per show.
>
> **include\_sponsors** `string ("true" | "false")`
>
> Include company-wide sponsor totals.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Sponsors that appear together with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ADVERTISING_CO_OCCURRENCE`
>
> Use for who a sponsor shares ad breaks with: the advertisers that buy the same inventory.
>
> #### Input Parameters
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **company\_id** `string`
>
> Only pairs involving this company, by id, domain or entity slug.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **sponsor\_id** `string`
>
> Only pairs involving this sponsor.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Ads in an episode with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ADVERTISING_EPISODE`
>
> Use for exactly who advertised in one episode, with the offer and where in the episode the read sits.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Episode slug or id.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Sponsor leaderboard with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ADVERTISING_LEADERBOARD`
>
> Use for the biggest podcast advertisers overall, in a period, or on one network. For the top-ten snapshot use advertising/leaderboard/preview.
>
> #### Input Parameters
>
> **limit** `number`
>
> Maximum records to return.
>
> **since** `string`
>
> Only episodes published on or after this ISO 8601 date or date-time.
>
> **until** `string`
>
> Only episodes published before this ISO 8601 date or date-time. A bare date covers that whole UTC day.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **metric** `string ("ad_count" | "podcast_reach" | "episode_reach")`
>
> Metric to rank by.
>
> **company\_id** `string`
>
> Only sponsors linked to this company.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **publisher\_id** `string`
>
> Only ads on this publisher's shows, by slug or id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Sponsor leaderboard, top ten with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ADVERTISING_LEADERBOARD_PREVIEW`
>
> Retrieve the top-ten podcast sponsor leaderboard for the trailing seven days, with ranking movement against a prior window. Rank by ad count, podcast reach, or episode reach.
>
> #### Input Parameters
>
> **metric** `string ("ad_count" | "podcast_reach" | "episode_reach")`
>
> Metric to rank by.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Publisher advertising profile with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ADVERTISING_PUBLISHER`
>
> Use for how a network is monetised and who buys across it. For its shows ranked by ad volume use advertising/publisher/shows.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Publisher slug (for example iheartpodcasts, bbc-radio-4) or id, as carried on a podcast record's publisher.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Shows of a publisher by ad volume with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ADVERTISING_PUBLISHER_SHOWS`
>
> Use for which of a network's shows carry the advertising. For the same catalogue by popularity use podcasts/publisher/shows.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Publisher slug (for example iheartpodcasts, bbc-radio-4) or id, as carried on a podcast record's publisher.
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Publisher advertising leaderboard with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ADVERTISING_PUBLISHERS_LEADERBOARD`
>
> Use for which networks carry the most advertising, or monetise their catalogue most densely.
>
> #### Input Parameters
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **metric** `string ("ad_count" | "unique_sponsors" | "podcast_reach" | "episode_reach" | "ads_per_active_podcast")`
>
> Metric to rank publishers by. ads\_per\_active\_podcast is monetisation density, where small sub-networks outrank broad catalogues.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **min\_active\_podcasts** `number`
>
> Only publishers with at least this many shows that have run an ad.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Sponsors of a publisher with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ADVERTISING_PUBLISHER_SPONSORS`
>
> Use for who buys a network, and which of them buy it as a bundle: sort by podcast\_coverage with a minimum.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Publisher slug (for example iheartpodcasts, bbc-radio-4) or id, as carried on a podcast record's publisher.
>
> **sort** `string ("ad_count" | "podcast_coverage" | "episode_reach")`
>
> ad\_count for volume, podcast\_coverage for network buyers, episode\_reach for breadth.
>
> **limit** `number`
>
> Maximum records to return.
>
> **query** `string`
>
> Sponsor name, case-insensitive partial match.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **min\_podcast\_coverage** `number`
>
> Only sponsors on at least this many of the publisher's shows.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Show advertising profile with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ADVERTISING_SHOW`
>
> Use for who sponsors a show and how heavily it is monetised. For the full per-sponsor list use advertising/show/sponsors.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Sponsors a show could pitch with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ADVERTISING_SHOW_PROSPECTS`
>
> Use as a prospecting list for a show selling its own inventory: who buys shows like mine and has not bought me.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **include** `array`
>
> Optional sections, comma-separated: via for the related shows that run each sponsor; contacts for up to three people at the sponsor's company likely to own the decision.
>
> **min\_score** `number`
>
> Only recommendations at or above this score; band is the recommended filter.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **active\_since** `string`
>
> Only sponsors whose most recent ad across the related shows is on or after this date.
>
> **exclude\_top\_advertisers** `number`
>
> Drop the N most active advertisers corpus-wide, which every list already names.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Sponsors of a show with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ADVERTISING_SHOW_SPONSORS`
>
> Use for every advertiser on one show with counts and recency, or one company's brands on it. Set since and until on shows with extensive ad history to keep the query bounded.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
>
> **limit** `number`
>
> Maximum records to return.
>
> **since** `string`
>
> Only episodes published on or after this ISO 8601 date or date-time.
>
> **until** `string`
>
> Only episodes published before this ISO 8601 date or date-time. A bare date covers that whole UTC day.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **company\_id** `string`
>
> Only sponsors linked to this company: a multi-brand advertiser's footprint on one show.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Sponsor profile with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ADVERTISING_SPONSOR`
>
> Use to find who is buying advertising, or to go from a sponsor back to the company paying for it. For where it runs use advertising/sponsor/shows.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Sponsor id, or a company slug, domain, or id: a company reference aggregates across every sponsor linked to it.
>
> **since** `string`
>
> Only episodes published on or after this ISO 8601 date or date-time.
>
> **until** `string`
>
> Only episodes published before this ISO 8601 date or date-time. A bare date covers that whole UTC day.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Publishers a sponsor buys across with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ADVERTISING_SPONSOR_PUBLISHERS`
>
> Use to tell network buys from per-show buys: a sponsor at 60 to 100 percent coverage of several publishers is buying bundles.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Sponsor id, or a company slug, domain, or id: a company reference aggregates across every sponsor linked to it.
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Sponsor directory with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ADVERTISING_SPONSORS`
>
> Use to find a sponsor by name or by company and pick up its id. For the biggest spenders use advertising/leaderboard.
>
> #### Input Parameters
>
> **limit** `number`
>
> Maximum records to return.
>
> **query** `string`
>
> Sponsor name, case-insensitive partial match.
>
> **since** `string`
>
> Scope each sponsor's counts to ads from episodes published on or after this date. Sponsors with no activity in the window are still listed.
>
> **until** `string`
>
> Scope each sponsor's counts to ads from episodes published before this date.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **company\_id** `string`
>
> Only sponsors linked to this company, by id, domain or entity slug.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Ad reads of a sponsor with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ADVERTISING_SPONSOR_SEGMENTS`
>
> Use to read the actual ad reads for a sponsor, then podcasts/segment/transcript for the words of one.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Sponsor id, or a company slug, domain, or id: a company reference aggregates across every sponsor linked to it.
>
> **limit** `number`
>
> Maximum records to return.
>
> **since** `string`
>
> Only episodes published on or after this ISO 8601 date or date-time.
>
> **until** `string`
>
> Only episodes published before this ISO 8601 date or date-time. A bare date covers that whole UTC day.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **podcast\_id** `string`
>
> Only ads on one show, by slug, id or Apple collection id.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Shows a sponsor buys with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ADVERTISING_SPONSOR_SHOWS`
>
> Use for where an advertiser buys: the canonical footprint of one sponsor, or of a whole company across its brands.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Sponsor id, or a company slug, domain, or id: a company reference aggregates across every sponsor linked to it.
>
> **limit** `number`
>
> Maximum records to return.
>
> **since** `string`
>
> Only episodes published on or after this ISO 8601 date or date-time.
>
> **until** `string`
>
> Only episodes published before this ISO 8601 date or date-time. A bare date covers that whole UTC day.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Trending sponsors with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ADVERTISING_SPONSORS_TRENDING`
>
> Use for which advertisers are ramping podcast spend right now, by airdate.
>
> #### Input Parameters
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **window\_days** `number`
>
> Length of each comparison window; the trailing window is ranked against the equal window before it.
>
> **min\_podcast\_reach** `number`
>
> Only sponsors whose in-window ads span at least this many shows.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Ad placements over time with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ADVERTISING_TIMESERIES`
>
> Use for how an advertiser's podcast spend trends by week or month, optionally on one show or network, and its host-read mix.
>
> #### Input Parameters
>
> **interval** `string ("day" | "week" | "month")`
>
> Bucket width. Weeks start on Monday; all buckets are UTC-aligned.
>
> **company\_id** `string`
>
> Company id, domain or entity slug; aggregates every sponsor linked to it.
>
> **podcast\_id** `string`
>
> Only placements on one show.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **sponsor\_id** `string`
>
> Sponsor id. Exactly one of sponsor\_id or company\_id.
>
> **publisher\_id** `string`
>
> Only placements on one publisher's shows.
>
> **published\_after** `string`
>
> Inclusive start of the range. Omit for all time.
>
> **published\_before** `string`
>
> End of the range; a bare date covers the whole day. Defaults to now.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Publisher bias profile with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_BIAS_PUBLISHER`
>
> Use for a network's political profile as a whole: how political its catalogue is and which way it leans.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Publisher slug (for example iheartpodcasts, bbc-radio-4) or id, as carried on a podcast record's publisher.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Publishers with shows in a bias bucket with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_BIAS_PUBLISHERS_BY_BUCKET`
>
> Use for which publishers carry the most shows of one lean: the flip of a publisher's own bias profile.
>
> #### Input Parameters
>
> **sort** `string ("count" | "share")`
>
> count ranks by shows in the bucket; share by their fraction of the analysed catalogue.
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **result** `string ("NOT_POLITICAL" | "EXTREME_LEFT" | "LEFT" | "LEANS_LEFT" | "CENTER" | "LEANS_RIGHT" | "RIGHT" | "EXTREME_RIGHT")` *required*
>
> The bias bucket: one of NOT\_POLITICAL, EXTREME\_LEFT, LEFT, LEANS\_LEFT, CENTER, LEANS\_RIGHT, RIGHT, EXTREME\_RIGHT.
>
> **min\_count** `number`
>
> Only publishers with at least this many shows in the bucket.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **political\_context** `string ("US" | "UK" | "EU" | "CANADA" | "AUSTRALIA" | "INDIA" | "OTHER" | "UNKNOWN")`
>
> Restrict the corpus to one political framework before aggregating.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Analysed shows of a publisher with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_BIAS_PUBLISHER_SHOWS`
>
> Use to list a network's shows by political lean, or only the ones in a bucket.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Publisher slug (for example iheartpodcasts, bbc-radio-4) or id, as carried on a podcast record's publisher.
>
> **bias** `array`
>
> Only these buckets, comma-separated to match any, for example LEFT,LEANS\_LEFT.
>
> **sort** `string ("lean_score" | "evaluated_at" | "name")`
>
> lean\_score on the -3 to +3 scale, evaluated\_at by recency, or name.
>
> **limit** `number`
>
> Maximum records to return.
>
> **order** `string ("asc" | "desc")`
>
> Sort direction.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **political\_context** `string ("US" | "UK" | "EU" | "CANADA" | "AUSTRALIA" | "INDIA" | "OTHER" | "UNKNOWN")`
>
> Restrict the corpus to one political framework before aggregating.
>
> **include\_non\_political** `string ("true" | "false")`
>
> Include shows rated NOT\_POLITICAL. Set false for political shows only.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Publisher bias leaderboard with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_BIAS_PUBLISHERS_LEADERBOARD`
>
> Use for which networks lean furthest left or right, are most political, or most ideologically diverse.
>
> #### Input Parameters
>
> **limit** `number`
>
> Maximum records to return.
>
> **since** `string`
>
> Only analyses evaluated on or after this RFC 3339 timestamp.
>
> **until** `string`
>
> Only analyses evaluated before this RFC 3339 timestamp.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **metric** `string ("most_left_leaning" | "most_right_leaning" | "most_political" | "most_diverse" | "most_monolithic" | "most_analyzed")` *required*
>
> most\_left\_leaning and most\_right\_leaning rank by average lean; most\_political by share of political shows; most\_diverse and most\_monolithic by spread of lean; most\_analyzed by coverage.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **political\_context** `string ("US" | "UK" | "EU" | "CANADA" | "AUSTRALIA" | "INDIA" | "OTHER" | "UNKNOWN")`
>
> Restrict the corpus to one political framework before aggregating.
>
> **min\_analyzed\_podcasts** `number`
>
> Only publishers with at least this many analysed shows.
>
> **min\_political\_podcasts** `number`
>
> Only publishers with at least this many political shows; applies to score and diversity metrics.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Show bias analysis with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_BIAS_SHOW`
>
> Use for where a show sits politically and why, with the evidence to quote. The bucket alone rides on every show record as bias.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Entity chart edition with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_CHARTS_CHART`
>
> Use for what podcasts are talking about most this week in one domain: the most-mentioned shows, films, games, teams or players, or the most-booked guests, with movement since last edition.
>
> #### Input Parameters
>
> **sort** `string ("rank" | "acceleration")`
>
> rank as published, or acceleration to reorder by each entry's growth multiple, fastest first.
>
> **limit** `number`
>
> Ranked entries to return from rank 1 down.
>
> **window** `string ("7d" | "24h")`
>
> Measurement window of the edition. Composite charts (all, all-entertainment, all-sports) publish 7d only.
>
> **include** `array`
>
> Optional sections, comma-separated: timeseries for each entry's daily history, driven\_by for the entry whose coverage drives a derivative one.
>
> **category** `string` *required*
>
> Chart identifier from charts/list, for example all, tv-series, movies, video-games, guests.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Entity charts with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_CHARTS_LIST`
>
> Use to see which charts exist (all, tv-series, movies, video-games, nfl, nba, guests and so on) and who leads each, before fetching one with charts/chart.
>
> #### Input Parameters
>
> **window** `string ("7d" | "24h")`
>
> Measurement window of the edition. Composite charts (all, all-entertainment, all-sports) publish 7d only.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Company competitors with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_COMPANIES_COMPETITORS`
>
> Use for a company's competitive set with the reason each one is on it, before comparing their podcast presence or advertising.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Company slug (for example nvidia), domain (nvidia.com), or id.
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Company profile links with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_COMPANIES_EXTERNAL_LINKS`
>
> Use to get a company's handles, domain, CIK or ticker. The reverse, identifier to company, is entities/lookup.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Company slug (for example nvidia), domain (nvidia.com), or id.
>
> **limit** `number`
>
> Maximum records to return. Omit for all of them.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] People at a company with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_COMPANIES_PEOPLE`
>
> Use to find executives and role holders at a company, or the marketing, brand and partnerships contacts a sponsorship conversation would go to.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Company slug (for example nvidia), domain (nvidia.com), or id.
>
> **role** `string ("marketing" | "brand" | "partnerships" | "media_advertising" | "communications" | "growth" | "executive" | "other")`
>
> Only people in this contact role class, the ones a sponsorship pitch would reach.
>
> **limit** `number`
>
> Maximum records to return.
>
> **title** `string`
>
> Case-insensitive substring of the role title, for example chief or founder.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **current\_only** `string ("true" | "false")`
>
> Only people currently in a role there. Set false to include past roles.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Company products with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_COMPANIES_PRODUCTS`
>
> Use to see what a company sells, structured by segment and product line, for example to match an ad read's offer to a product.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Company slug (for example nvidia), domain (nvidia.com), or id.
>
> **status** `array`
>
> Lifecycle statuses to include, comma-separated. Default active.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Company directory with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_COMPANIES_SEARCH`
>
> Use to resolve a company by name, ticker, domain, CIK or Wikidata QID to the slug every company capability takes. The record itself is advertising/company.
>
> #### Input Parameters
>
> **cik** `string`
>
> SEC CIKs, comma-separated.
>
> **ids** `string`
>
> Bulk get: comma-separated slugs, domains or ids, up to 100. Other filters and paging are ignored when set.
>
> **qid** `string`
>
> Wikidata QIDs, comma-separated.
>
> **limit** `number`
>
> Maximum records to return.
>
> **query** `string`
>
> Company name, case-insensitive partial match.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **domain** `string`
>
> Company domains, comma-separated.
>
> **ticker** `string`
>
> Stock ticker symbols, comma-separated.
>
> **entity\_id** `string`
>
> Knowledge-graph entity slugs or ids, comma-separated.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **updated\_after** `string`
>
> Only companies updated after this ISO 8601 date or date-time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Entity record with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ENTITIES_GET`
>
> Resolve one entity slug or ID to its knowledge-graph record and linked company or person. For where the entity was mentioned, use podcasts/mentions or podcasts/episodes/list with entity\_id.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Entity slug (sam-altman, apple) or id. A person slug also resolves, to that person's linked entity.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Entity directory with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ENTITIES_LIST`
>
> Use for the most-discussed entities overall, in one show, or of one kind, or to fetch several entities by slug at once. Takes no free text; for a name use entities/search.
>
> #### Input Parameters
>
> **ids** `string`
>
> Bulk get: comma-separated entity slugs or ids, up to 100. Other filters and paging are ignored when set; unresolved refs are omitted.
>
> **type** `string`
>
> Only this entity category slug, from entities/types: person, company, movie, sports-team.
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **podcast\_id** `string`
>
> Only entities appearing in this show, by slug, id or Apple collection id.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Entity lookup by external identifier with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ENTITIES_LOOKUP`
>
> Use when you hold a LinkedIn slug, a handle, a domain, a ticker or a CIK and need the Particle person or company: the reverse of the external-links capabilities.
>
> #### Input Parameters
>
> **type** `string ("person" | "company")`
>
> Restrict to people or companies.
>
> **platform** `string`
>
> Restrict to one platform: any slug the external-links capabilities report, or the company namespaces domain, ticker, sec and wikidata. Omit to match on any platform.
>
> **identifier** `string` *required*
>
> One or more external identifiers, comma-separated, up to 100: LinkedIn slugs, social handles, domains, tickers, SEC CIKs, Wikidata QIDs. A profile URL works in place of a bare handle.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Entity search with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ENTITIES_SEARCH`
>
> Use to turn what someone typed into a specific person, company or entity and its slug, before asking what was said about it with podcasts/mentions or filtering episodes by it. Searching episodes directly is better when the topic, not a name, is the question.
>
> #### Input Parameters
>
> **type** `string ("person" | "company" | "knowledge_graph_entity")`
>
> Restrict to one kind. Omit to search people, companies and knowledge-graph entities together.
>
> **limit** `number`
>
> Maximum records to return.
>
> **query** `string` *required*
>
> A name, partial name, nickname, stock ticker, @handle or website domain: sam altman, coca cola, AAPL, @sama, apple.com.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Topic profile with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ENTITIES_TOPIC`
>
> Use to place a topic in the taxonomy and see its neighbours. For the shows in it use podcasts/list with topic\_id; for episodes, podcasts/episodes/list. This returns classification, not passages.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Topic id, ancestry slug (technology/artificial-intelligence) or path hash.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Topics with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ENTITIES_TOPICS`
>
> Use to find the topic\_id that podcasts/search, podcasts/list and the guest capabilities filter on. Walk down from the roots by passing parent\_id.
>
> #### Input Parameters
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **parent\_id** `string`
>
> Only children of this topic, by id, ancestry slug or path hash. Omit for the top-level roots.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **ancestry\_path** `string`
>
> Only the topic with exactly this path hash.
>
> **ancestry\_path\_prefix** `string`
>
> Only descendants under this path prefix.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Types with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_ENTITIES_TYPES`
>
> Use to see what the type filter on entities/list can take. Skip it when listing without a filter.
>
> #### Input Parameters
>
> **limit** `number`
>
> Maximum records to return. Omit for all of them.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Person profile links with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PEOPLE_EXTERNAL_LINKS`
>
> Use to get a person's LinkedIn or social handles. The reverse, handle to person, is entities/lookup.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Person slug (recommended), the person's knowledge-graph entity slug, or the encoded person id.
>
> **limit** `number`
>
> Maximum records to return. Omit for all of them.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Guest profile with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PEOPLE_GUEST`
>
> Use when the question is about someone as a podcast guest: how often they appear, where, and since when. For the episode list use people/guest/appearances.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Person slug (recommended), the person's knowledge-graph entity slug, or the encoded person id.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Guest appearances with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PEOPLE_GUEST_APPEARANCES`
>
> Use for where someone has appeared, episode by episode, to read what they said: take episode.id to podcasts/transcript with speaker set to their name.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Person slug (recommended), the person's knowledge-graph entity slug, or the encoded person id.
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **topic\_id** `string`
>
> Only appearances on episodes under this topic.
>
> **podcast\_id** `string`
>
> Only appearances on one show.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **published\_after** `string`
>
> Only episodes published after this ISO 8601 date or date-time.
>
> **published\_before** `string`
>
> Only episodes published before this ISO 8601 date or date-time.
>
> **min\_speaking\_seconds** `number`
>
> Only appearances with at least this much identified speaking time.
>
> **suitability\_tier\_max** `string ("SAFE" | "LIMITED" | "SENSITIVE" | "UNSAFE")`
>
> Only appearances on podcasts at or below this IAB Tech Lab brand-suitability tier.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Shows a guest could appear on with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PEOPLE_GUEST_PITCH_LIST`
>
> Use to build a pitch list for a guest: the shows most like the ones that already booked them, with the venues to cite.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Person slug (recommended), the person's knowledge-graph entity slug, or the encoded person id.
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **include** `string`
>
> Pass via to attach, per recommendation, the person's own shows that led to it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Guest directory with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PEOPLE_GUESTS`
>
> Use to find guests by name, by show, by topic or by how often they appear, and pick up the person slug. For who is currently making the rounds use people/guests/trending.
>
> #### Input Parameters
>
> **sort** `string ("appearances" | "recency")`
>
> appearances (default) or recency.
>
> **limit** `number`
>
> Maximum records to return.
>
> **query** `string`
>
> Case-insensitive substring of the guest's display name.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **topic\_id** `string`
>
> Only guests with an appearance on an episode under this topic.
>
> **podcast\_id** `string`
>
> Only guests who have appeared on this show.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **appeared\_since** `string`
>
> Only guests with an appearance published on or after this ISO 8601 date.
>
> **min\_appearances** `number`
>
> Only guests with at least this many lifetime appearances.
>
> **suitability\_tier\_max** `string ("SAFE" | "LIMITED" | "SENSITIVE" | "UNSAFE")`
>
> Only appearances on podcasts at or below this IAB Tech Lab brand-suitability tier.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Shows a guest has appeared on with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PEOPLE_GUEST_SHOWS`
>
> Use for the set of shows behind a guest rather than the episodes: which shows book them and how often.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Person slug (recommended), the person's knowledge-graph entity slug, or the encoded person id.
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Trending guests with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PEOPLE_GUESTS_TRENDING`
>
> Use for who is doing the podcast circuit right now: a book launch, a product unveil, a news moment, or someone new. For a steady-state directory use people/guests.
>
> #### Input Parameters
>
> **limit** `number`
>
> Maximum records to return.
>
> **since** `string`
>
> Inclusive start of the trend window. Default 30 days ago.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **topic\_id** `string`
>
> Only guests with an in-window appearance under this topic.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **suitability\_tier\_max** `string ("SAFE" | "LIMITED" | "SENSITIVE" | "UNSAFE")`
>
> Only appearances on podcasts at or below this IAB Tech Lab brand-suitability tier.
>
> **min\_distinct\_podcasts** `number`
>
> Minimum distinct shows appeared on inside the window. Default 2.
>
> **first\_appearance\_since** `string`
>
> Only guests whose first ever appearance is on or after this date: the new-on-the-scene cut.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Person profile with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PEOPLE_PROFILE`
>
> Retrieve a person's profile by person slug, knowledge-graph entity slug, or encoded person ID, including available work history and profile links.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Person slug (recommended), the person's knowledge-graph entity slug, or the encoded person id.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Guest roster of a show with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PEOPLE_SHOW_GUESTS`
>
> Use for who has been on a show and how often. For who it could book next use people/show-recommended-guests.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Guests a show could book with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PEOPLE_SHOW_RECOMMENDED_GUESTS`
>
> Use as a booking pipeline for a show: guests its peers chose that it has not had yet.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **include** `string`
>
> Pass via to attach, per recommended guest, the related shows that booked them.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Episode clip with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_CLIP`
>
> Use when a segment needs to be cited as a playable range rather than as text. For its words call podcasts/clip/transcript.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Clip id, from a search match's clips or a clip list.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Clip directory with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_CLIPS`
>
> Use to browse quotable moments by show, speaker or kind. For clips about a subject, search episodes: matching clips ride inside each search result.
>
> #### Input Parameters
>
> **type** `string ("SPICY" | "CONTROVERSIAL" | "EMOTIONAL" | "FUNNY" | "SHOCKING" | "INSIGHTFUL" | "INFORMATIVE" | "EDUCATIONAL" | "PHILOSOPHICAL" | "AHA_MOMENT" | "NOTABLE_LINE" | "BEST_STORY" | "DEBATE_DISAGREEMENT")`
>
> Clip kind: SPICY, CONTROVERSIAL, EMOTIONAL, FUNNY, SHOCKING, INSIGHTFUL, INFORMATIVE, EDUCATIONAL, PHILOSOPHICAL, AHA\_MOMENT, NOTABLE\_LINE, BEST\_STORY or DEBATE\_DISAGREEMENT.
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **speaker** `string`
>
> Only clips whose primary speaker is this person, by person slug, entity slug or id.
>
> **episode\_id** `string`
>
> Only clips from one episode.
>
> **podcast\_id** `string`
>
> Only clips from one show.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **min\_engagement** `number`
>
> Minimum engagement potential, 0 to 100; above 70 is a strong clip.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Clip transcript with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_CLIP_TRANSCRIPT`
>
> Use to quote a clip verbatim with speaker labels, or export it as subtitles with format srt.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Clip id.
>
> **format** `string ("dialogue" | "text" | "srt")`
>
> Output format: dialogue (speaker-attributed JSON lines, the shape described here), text (Speaker: text lines), or srt (SubRip). The text and srt bodies are not the lines shape.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Podcast episode with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_EPISODE`
>
> Use episode.id from a search match to get the full record and, when available, its web URL or direct audio stream. Neither link is guaranteed. For what was said, fetch podcasts/transcript.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Episode slug or id: episode.id on a search match, or id on an episode list row. A podcast slug is not an episode id.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Episode clips with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_EPISODE_CLIPS`
>
> Use for the quotable moments of an episode as bounded, playable ranges with a kind and a speaker.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Episode slug or id: episode.id on a search match, or id on an episode list row. A podcast slug is not an episode id.
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Entities in an episode with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_EPISODE_ENTITIES`
>
> Use for what an episode was about in named things: the companies, people and products it discussed, ranked by salience. For where each one came up in the dialogue use podcasts/transcript/mentions.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Episode slug or id: episode.id on a search match, or id on an episode list row. A podcast slug is not an episode id.
>
> **limit** `number`
>
> Maximum records to return. Omit for all of them.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Related episodes with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_EPISODE_RELATED`
>
> Use for who else covered this: the same story or subject on other shows, optionally within a week of the episode.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Episode slug or id: episode.id on a search match, or id on an episode list row. A podcast slug is not an episode id.
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **include** `string`
>
> Pass basis to attach the signals behind each match: content similarity, shared entities, topics, news story, guests, and days apart.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **same\_podcast** `boolean`
>
> Admit episodes of the same show. Off by default: a show's own episodes are its episode list.
>
> **published\_within\_days** `number`
>
> Only episodes published within this many days of the query episode, either side. A short window (7 to 30) answers who else covered this story.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Episode segments with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_EPISODE_SEGMENTS`
>
> Use to see the structure of an episode and pick the section to read: which time ranges are ads to skip, where the interview starts, what each discussion covers. Then podcasts/segment/transcript for the words.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Episode slug or id: episode.id on a search match, or id on an episode list row. A podcast slug is not an episode id.
>
> **limit** `number`
>
> Maximum records to return. Omit for all of them.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Episode feed with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_EPISODES_FEED`
>
> Use to poll for new episodes of a set of shows or topics as they are transcribed: a resumable, strictly ordered pull. A filter is required. For a one-off list by date use podcasts/episodes/list.
>
> #### Input Parameters
>
> **limit** `number`
>
> Maximum records to return.
>
> **since** `string`
>
> ISO 8601 start when no cursor is supplied. Omit both to start from now.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **include** `array`
>
> Heavy relations to embed per episode, comma-separated: transcript, segments, clips, or all. Only valid when the milestone guarantees the data.
>
> **milestone** `string ("discovered" | "transcribed" | "segmented" | "fully_ingested")`
>
> Deliver episodes once they reach this ingestion stage; ordered discovered, transcribed, segmented, fully\_ingested.
>
> **topic\_ids** `string`
>
> Topics to follow, comma-separated slug paths (sports/football), ids or path hashes. A topic matches its descendants.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **podcast\_ids** `string`
>
> Shows to follow, comma-separated slugs or ids, at most 100.
>
> **popularity\_threshold** `number`
>
> Follow the most popular shows at or above this percentile, in (0, 1). The feed covers at most 100 shows in total.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Episode directory with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_EPISODES_LIST`
>
> Use for episode-level filtering without dialogue: every episode a person spoke on, every episode featuring a company, a show's episodes in a date range, episodes in a language. When the question is about what was said, search episodes instead.
>
> #### Input Parameters
>
> **role** `string ("guest" | "host" | "panelist" | "correspondent" | "speaker" | "mention")`
>
> How the entity must relate to the episode: a speaking role, speaker for any speaking role, or mention for being talked about.
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **language** `string`
>
> ISO 639-1 language code, for example en or fr. Matches the primary subtag, so fr covers fr-CA.
>
> **entity\_id** `string`
>
> Episodes featuring this entity as a speaker or a mention, by slug (elon-musk, openai) or id.
>
> **person\_id** `string`
>
> Episodes where this person speaks, by person slug, entity slug or id. Works when the speaker has no knowledge-graph entity.
>
> **company\_id** `string`
>
> Episodes featuring this company, by slug, domain or id.
>
> **podcast\_id** `string`
>
> Restrict to one show, by slug, id or Apple collection id.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **max\_duration** `number`
>
> Maximum length in seconds.
>
> **min\_duration** `number`
>
> Minimum length in seconds.
>
> **fully\_ingested** `boolean`
>
> Only episodes that reached the terminal ingestion milestone.
>
> **has\_transcript** `boolean`
>
> Only episodes with a completed transcript.
>
> **published\_after** `string`
>
> Only episodes published after this ISO 8601 date or date-time.
>
> **published\_before** `string`
>
> Only episodes published before this ISO 8601 date or date-time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Episode lookup by platform id with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_EPISODES_LOOKUP`
>
> Use when you hold a Spotify, Apple Podcasts or YouTube episode link, a platform episode id, or an RSS guid and need the Particle episode id to read its transcript. A transcript\_status of transcribed means the transcript can be read now; requestable means it has not been transcribed yet. Guids match exactly as supplied.
>
> #### Input Parameters
>
> **platform** `string ("apple" | "itunes" | "spotify" | "youtube" | "guid" | "podcastindex" | "megaphone" | "omny" | "acast" | "art19")`
>
> Kind of identifier, needed for bare ids and optional when every identifier is a link: apple (alias itunes) for Apple Podcasts episode ids, spotify for Spotify episode ids, youtube for video ids, guid for the RSS guid, podcastindex, or the hosting platforms megaphone, omny, acast and art19.
>
> **identifier** `string` *required*
>
> One or more identifiers or links, comma-separated, up to 100. Spotify (open.spotify.com/episode/... or a spotify:episode: URI), Apple Podcasts and YouTube episode links are resolved by the platform they point to and may be mixed in one call.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Episode speakers with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_EPISODE_SPEAKERS`
>
> Use to find who was on an episode and in what role, with the person slug to follow into people/profile or people/guest. Ask for the advertiser role to see who voiced the sponsor reads.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Episode slug or id: episode.id on a search match, or id on an episode list row. A podcast slug is not an episode id.
>
> **role** `array`
>
> Speaker roles to include, comma-separated and case-insensitive. Defaults to host,guest,panelist,correspondent; add advertiser for sponsor reads, soundbite\_speaker for played clips, narrator or announcer for scripted voices.
>
> **limit** `number`
>
> Maximum records to return. Omit for all of them.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Episode search with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_EPISODES_SEARCH`
>
> Use to find episodes that discussed something. This is the entry point: it returns ids the other podcast capabilities take. For every line about one person or company use podcasts/mentions instead.
>
> #### Input Parameters
>
> **role** `string ("guest" | "host" | "panelist" | "correspondent" | "speaker" | "mention")`
>
> How the entity must relate to the episode: a speaking role, speaker for any speaking role, or mention for being talked about.
>
> **sort** `string ("relevance" | "recency")`
>
> relevance (default) or recency.
>
> **type** `string ("INTRO" | "PERSONAL_BANTER" | "TOPIC_DISCUSSION" | "INTERVIEW" | "TRANSITION" | "AD" | "OUTRO")`
>
> Only segments of this type.
>
> **limit** `number`
>
> Maximum records to return.
>
> **since** `string`
>
> Only segments from episodes published after this date.
>
> **until** `string`
>
> Only segments from episodes published on or before this date. A bare date covers the whole day.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **context** `number`
>
> Lines of surrounding dialogue around each matched line. Widen this instead of fetching the transcript.
>
> **language** `string`
>
> ISO 639-1 language code, for example en or fr. Matches the primary subtag, so fr covers fr-CA.
>
> **entity\_id** `string`
>
> Restrict to episodes featuring this entity, by slug or id. Ranking still comes from the search terms.
>
> **company\_id** `string`
>
> Restrict to episodes featuring this company, by slug, domain or id.
>
> **episode\_id** `string`
>
> Restrict to one episode, by slug or id.
>
> **podcast\_id** `string`
>
> Restrict to one show, by slug, id or Apple collection id.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **entity\_type** `string`
>
> Restrict to episodes that mention any entity of this category slug (company, school, book). Not combinable with role.
>
> **keyword\_match** `string ("required" | "ranked")`
>
> How unquoted keyword terms apply: required filters to segments containing every term (and constrains a hybrid query to their intersection); ranked lets them only boost.
>
> **keyword\_search** `string`
>
> Exact tokens or phrases to match in the transcript, ranked BM25. Use for tickers, drug names, product codes. Wrap a phrase in double quotes to require it contiguously.
>
> **semantic\_search** `string`
>
> What was talked about, in your own words. Paraphrase-tolerant, so it finds dialogue that means this without containing these exact words. Describe a topic, not a name: for a person or company use entity\_id or podcasts/mentions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Episode counts over time with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_EPISODES_TIMESERIES`
>
> Use for a trend rather than a list: how often a person appeared by month, how a show's output changed, how many episodes discussed a term each week. One call replaces paging the episode list per period.
>
> #### Input Parameters
>
> **role** `string ("guest" | "host" | "panelist" | "correspondent" | "speaker" | "mention")`
>
> How the entity must relate to the episode: a speaking role, speaker for any speaking role, or mention for being talked about.
>
> **interval** `string ("day" | "week" | "month")`
>
> Bucket width. Weeks start on Monday; all buckets are UTC-aligned.
>
> **language** `string`
>
> ISO 639-1 language code, for example en or fr. Matches the primary subtag, so fr covers fr-CA.
>
> **entity\_id** `string`
>
> Episodes featuring this entity as a speaker or a mention, by slug (elon-musk, openai) or id.
>
> **person\_id** `string`
>
> Episodes where this person speaks, by person slug, entity slug or id. Works when the speaker has no knowledge-graph entity.
>
> **company\_id** `string`
>
> Episodes featuring this company, by slug, domain or id.
>
> **podcast\_id** `string`
>
> Restrict to one show, by slug, id or Apple collection id.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **max\_duration** `number`
>
> Maximum length in seconds.
>
> **min\_duration** `number`
>
> Minimum length in seconds.
>
> **fully\_ingested** `boolean`
>
> Only episodes that reached the terminal ingestion milestone.
>
> **has\_transcript** `boolean`
>
> Only episodes with a completed transcript.
>
> **keyword\_search** `string`
>
> Count episodes whose transcripts contain these terms (quoted phrases exact). Adds per-bucket mention\_count. Not combinable with semantic\_search.
>
> **published\_after** `string`
>
> Only episodes published after this ISO 8601 date or date-time.
>
> **semantic\_search** `string`
>
> Count episodes whose transcripts match this meaning, at the search endpoint's threshold. Requires published\_after. Not combinable with keyword\_search.
>
> **published\_before** `string`
>
> Only episodes published before this ISO 8601 date or date-time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Episode topics with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_EPISODE_TOPICS`
>
> Use to classify an episode by subject area, or to pick up a topic\_id for filtering shows and episodes.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Episode slug or id: episode.id on a search match, or id on an episode list row. A podcast slug is not an episode id.
>
> **limit** `number`
>
> Maximum records to return. Omit for all of them.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Show directory with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_LIST`
>
> Use to browse shows by attribute rather than by name: a topic, a language, a brand-suitability tier, a length band, a cadence, an ad-free or interview format. For a name, podcasts/search is the canonical search.
>
> #### Input Parameters
>
> **slug** `string`
>
> Exact slug of one show.
>
> **sort** `string ("relevance" | "popularity")`
>
> relevance ranks by match quality (the default with q); popularity orders by global popularity percentile.
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **has\_ads** `string ("true" | "false")`
>
> true for shows with detected advertising, false for ad-free shows with enough analysed episodes to say so.
>
> **language** `string`
>
> ISO 639-1 language code, for example en or fr. Matches the primary subtag, so fr covers fr-CA.
>
> **topic\_id** `string`
>
> Restrict to a topic, by topic id or ancestry slug such as technology/artificial-intelligence. Matches shows where the topic is at least a fifth of their episodes.
>
> **has\_video** `string ("true" | "false")`
>
> Whether episodes have discovered video versions.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **format\_signal** `array`
>
> Detected production formats, comma-separated to match any: interview, panel, call\_in, solo\_narrated.
>
> **guest\_frequency** `array`
>
> How often episodes feature a guest, comma-separated to match any: for example regular,always for interview shows, never for shows without guests.
>
> **suitability\_tier** `string ("SAFE" | "LIMITED" | "SENSITIVE" | "UNSAFE")`
>
> Only shows whose latest brand-suitability assessment is this IAB Tech Lab tier. Shows never assessed are excluded when set.
>
> **publishing\_status** `string ("active" | "dormant")`
>
> active has released an episode in the last 90 days; dormant has not.
>
> **popularity\_threshold** `number`
>
> Only shows at or above this global popularity percentile, in (0, 1].
>
> **max\_episodes\_per\_week** `number`
>
> Only shows publishing at most this many episodes a week.
>
> **min\_episodes\_per\_week** `number`
>
> Only shows publishing at least this many episodes a week over the trailing 90 days.
>
> **max\_avg\_episode\_minutes** `number`
>
> Only shows whose average episode runs at most this many minutes.
>
> **min\_avg\_episode\_minutes** `number`
>
> Only shows whose average episode runs at least this many minutes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Show lookup by platform id with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_LOOKUP`
>
> Use when you already hold an Apple collection id, Spotify show id, YouTube channel id or RSS feed URL and need the Particle podcast deterministically. For a name, use podcasts/search.
>
> #### Input Parameters
>
> **platform** `string` *required*
>
> The identifier's platform: apple (alias itunes), spotify, youtube, any slug reported by podcasts/show/external-links, or rss to match a feed URL.
>
> **identifier** `string` *required*
>
> One or more platform-native identifiers, comma-separated, up to 100 per call.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Dialogue mentions of an entity with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_MENTIONS`
>
> Find podcast dialogue mentions of a person or company, optionally filtered by show, publisher, episode, role, language, or date. Results are paginated by episode and mention windows may be truncated.
>
> #### Input Parameters
>
> **role** `string ("guest" | "host" | "panelist" | "correspondent" | "mention")`
>
> Constrain how the entity participates.
>
> **sort** `string ("recency" | "popularity" | "favorites")`
>
> recency (default), popularity of the parent show, or favorites.
>
> **limit** `number`
>
> Episodes per page; each episode's full set of windows arrives in one page.
>
> **since** `string`
>
> Only episodes published after this date.
>
> **until** `string`
>
> Only episodes published before this date.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **language** `string`
>
> ISO 639-1 language code, for example en or fr. Matches the primary subtag, so fr covers fr-CA.
>
> **entity\_id** `string`
>
> Entity slug (sam-altman) or id. A person slug also resolves; a person without a linked entity falls back to name matching.
>
> **company\_id** `string`
>
> Company slug, domain or id; resolves to its linked entity or falls back to name matching.
>
> **episode\_id** `string`
>
> Only mentions inside one episode.
>
> **podcast\_id** `string`
>
> Only mentions inside one show.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **include\_ads** `boolean`
>
> Include mentions inside ad reads, which are excluded by default.
>
> **publisher\_id** `string`
>
> Only mentions on one publisher's shows, by slug or id.
>
> **context\_lines** `number`
>
> Surrounding dialogue lines around each mention.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Mention counts over time with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_MENTIONS_TIMESERIES`
>
> Use for how mentions of a person or company trend by day, week or month, optionally within one show or network. One call instead of paging podcasts/mentions per period.
>
> #### Input Parameters
>
> **role** `string ("guest" | "host" | "panelist" | "correspondent" | "mention")`
>
> Constrain how the entity participates.
>
> **interval** `string ("day" | "week" | "month")`
>
> Bucket width. Weeks start on Monday; all buckets are UTC-aligned.
>
> **language** `string`
>
> ISO 639-1 language code, for example en or fr. Matches the primary subtag, so fr covers fr-CA.
>
> **entity\_id** `string`
>
> Entity slug or id.
>
> **company\_id** `string`
>
> Company slug, domain or id.
>
> **podcast\_id** `string`
>
> Only mentions inside one show.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **include\_ads** `boolean`
>
> Count mentions inside ad reads too.
>
> **publisher\_id** `string`
>
> Only mentions on one publisher's shows.
>
> **published\_after** `string`
>
> Only episodes published on or after this date. Omit for all time.
>
> **published\_before** `string`
>
> Only episodes published on or before this date. Defaults to now.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Publisher profile with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_PUBLISHER`
>
> Use to go from a show's publisher reference to the network record. For the network's shows call podcasts/publisher/shows; for its advertising, bias or suitability roll-ups use the capabilities under those concepts.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Publisher slug (for example iheartpodcasts, bbc-radio-4) or id, as carried on a podcast record's publisher.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Publisher directory with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_PUBLISHERS`
>
> Use to find a network's slug by name before asking about its shows, advertising, bias or suitability.
>
> #### Input Parameters
>
> **sort** `string ("podcast_count" | "name")`
>
> podcast\_count ranks by catalogue size (default); name is alphabetical.
>
> **limit** `number`
>
> Maximum records to return.
>
> **query** `string`
>
> Case-insensitive substring of the publisher's name or slug; an exact name match sorts first.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Shows of a publisher with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_PUBLISHER_SHOWS`
>
> Use to walk a network's catalogue by audience. For the same catalogue ranked by ad volume use advertising/publisher/shows.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Publisher slug (for example iheartpodcasts, bbc-radio-4) or id, as carried on a podcast record's publisher.
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Show search with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_SEARCH`
>
> Use to turn a show name into its slug and record. To find what was said inside one, search episodes instead: this matches show metadata, not transcripts. For an Apple, Spotify or YouTube id use podcasts/lookup.
>
> #### Input Parameters
>
> **sort** `string ("relevance" | "popularity")`
>
> relevance ranks by match quality (the default with q); popularity orders by global popularity percentile.
>
> **limit** `number`
>
> Maximum records to return.
>
> **query** `string` *required*
>
> Show name, forgiving of typos, missing words and qualifiers (offline jon favreau, equity techcrunch).
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **has\_ads** `string ("true" | "false")`
>
> true for shows with detected advertising, false for ad-free shows with enough analysed episodes to say so.
>
> **language** `string`
>
> ISO 639-1 language code, for example en or fr. Matches the primary subtag, so fr covers fr-CA.
>
> **topic\_id** `string`
>
> Restrict to a topic, by topic id or ancestry slug such as technology/artificial-intelligence. Matches shows where the topic is at least a fifth of their episodes.
>
> **has\_video** `string ("true" | "false")`
>
> Whether episodes have discovered video versions.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **format\_signal** `array`
>
> Detected production formats, comma-separated to match any: interview, panel, call\_in, solo\_narrated.
>
> **guest\_frequency** `array`
>
> How often episodes feature a guest, comma-separated to match any: for example regular,always for interview shows, never for shows without guests.
>
> **suitability\_tier** `string ("SAFE" | "LIMITED" | "SENSITIVE" | "UNSAFE")`
>
> Only shows whose latest brand-suitability assessment is this IAB Tech Lab tier. Shows never assessed are excluded when set.
>
> **publishing\_status** `string ("active" | "dormant")`
>
> active has released an episode in the last 90 days; dormant has not.
>
> **popularity\_threshold** `number`
>
> Only shows at or above this global popularity percentile, in (0, 1].
>
> **max\_episodes\_per\_week** `number`
>
> Only shows publishing at most this many episodes a week.
>
> **min\_episodes\_per\_week** `number`
>
> Only shows publishing at least this many episodes a week over the trailing 90 days.
>
> **max\_avg\_episode\_minutes** `number`
>
> Only shows whose average episode runs at most this many minutes.
>
> **min\_avg\_episode\_minutes** `number`
>
> Only shows whose average episode runs at least this many minutes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Episode segment with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_SEGMENT`
>
> Use to see what a matched segment is (an interview, a topic discussion, an ad) and its time range. For its text call podcasts/segment/transcript.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Segment id, from a search match or a segment list.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Segment directory with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_SEGMENTS`
>
> Use to pull one kind of section across a show: every interview, every ad read, every topic discussion in a date range. For one episode's structure use podcasts/episode/segments.
>
> #### Input Parameters
>
> **type** `string ("INTRO" | "PERSONAL_BANTER" | "TOPIC_DISCUSSION" | "INTERVIEW" | "TRANSITION" | "AD" | "OUTRO")`
>
> Only this segment type.
>
> **limit** `number`
>
> Maximum records to return.
>
> **since** `string`
>
> Only episodes published on or after this ISO 8601 date or date-time.
>
> **until** `string`
>
> Only episodes published before this ISO 8601 date or date-time. A bare date covers that whole UTC day.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **episode\_id** `string`
>
> Only segments of one episode, by slug or id.
>
> **podcast\_id** `string`
>
> Only segments from one show, by slug, id or Apple collection id.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Segment transcript with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_SEGMENT_TRANSCRIPT`
>
> Use to read the words of one segment in full and in order, at the price of a segment rather than an episode.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Segment id.
>
> **format** `string ("dialogue" | "text" | "srt")`
>
> Output format: dialogue (speaker-attributed JSON lines, the shape described here), text (Speaker: text lines), or srt (SubRip). The text and srt bodies are not the lines shape.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Show profile with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_SHOW`
>
> Use when a search or an episode record gave you a podcast id and the full show record is needed, including the publisher to go up to and the slug every other show capability takes.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
>
> **include** `array`
>
> Optional sections, comma-separated: related (five most related shows), recommended\_guests (five bookable guests), recommended\_sponsors (five prospective advertisers; premium-grade).
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **topic\_limit** `number`
>
> How many aggregated topics to return; 0 for none.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Episodes of a show with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_SHOW_EPISODES`
>
> Use to get from a show to its episodes and their ids: the latest episode, an episode by title, or the run of episodes in a date range. A podcast slug is never an episode id; this is how you get one.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
>
> **limit** `number`
>
> Maximum records to return.
>
> **query** `string`
>
> Only episodes whose title contains this text, case-insensitively. Titles only; to search what was said use podcasts/episodes/search with podcast\_id.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **published\_after** `string`
>
> Only episodes published after this ISO 8601 date or date-time.
>
> **published\_before** `string`
>
> Only episodes published before this ISO 8601 date or date-time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Show platform links with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_SHOW_EXTERNAL_LINKS`
>
> Use to get a show's Apple, Spotify or YouTube ids and links, its social handles, or its website. The reverse direction, platform id to show, is podcasts/lookup.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
>
> **limit** `number`
>
> Maximum records to return. Omit for all of them.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Show format profile with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_SHOW_FORMAT`
>
> Use for the exact rates and distributions behind a show's format: how often it has guests, how long episodes run, how often it publishes and on which days. The compact form rides on every show record as format.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Entity mentions in a show with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_SHOW_MENTIONS`
>
> Use for how much one show talks about a person or company: an episode-level roll-up inside one podcast. For the dialogue lines themselves, across shows, use podcasts/mentions.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
>
> **role** `string ("guest" | "host" | "panelist" | "correspondent" | "mention")`
>
> Constrain how the entity participates.
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **entity\_id** `string`
>
> Entity slug (sam-altman, openai) or id.
>
> **company\_id** `string`
>
> Company slug, domain or id; resolves to its linked entity.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **published\_after** `string`
>
> Only episodes published after this ISO 8601 date or date-time.
>
> **published\_before** `string`
>
> Only episodes published before this ISO 8601 date or date-time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Show ratings with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_SHOW_RATINGS`
>
> Use to read what listeners wrote about a show. For the averages and histogram use podcasts/show/ratings-summary.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
>
> **limit** `number`
>
> Maximum records to return.
>
> **since** `string`
>
> Lower bound on posted\_at, ISO 8601.
>
> **until** `string`
>
> Upper bound on posted\_at, ISO 8601.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **locale** `string`
>
> Only one platform locale, for example the Apple storefront us.
>
> **min\_stars** `number`
>
> Lower bound on the star rating.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **platform\_slug** `string`
>
> Only ratings from one platform, for example apple.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Show ratings summary with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_SHOW_RATINGS_SUMMARY`
>
> Use for a show's average rating and count per storefront, plus the combined figure and what recent reviews say in aggregate.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Related shows with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_SHOW_RELATED`
>
> Use for shows like this one: competitive sets, a listener's next show, or the peer set a sponsor or guest pitch cites. Branch on band rather than on the raw score.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **include** `string`
>
> Pass basis to attach, per result, the signals behind the pairing: content similarity, shared topics, shared guests by name, same publisher, shared sponsors.
>
> **language** `string`
>
> ISO 639-1 language code, for example en or fr. Matches the primary subtag, so fr covers fr-CA.
>
> **min\_score** `number`
>
> Only results at or above this fused score; the band field is the recommended way to filter.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **min\_popularity** `number`
>
> Only shows at or above this popularity percentile.
>
> **suitability\_tier** `string ("SAFE" | "LIMITED" | "SENSITIVE" | "UNSAFE")`
>
> Only shows whose latest brand-suitability assessment is this IAB Tech Lab tier. Shows never assessed are excluded when set.
>
> **publishing\_status** `string ("active" | "dormant")`
>
> Only active (episode in the last 90 days) or dormant shows.
>
> **exclude\_same\_publisher** `boolean`
>
> Drop shows from the source show's own publisher.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Top-level topics by show count with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_TOPICS`
>
> Use to see which subject areas have the most shows. For the full taxonomy tree use entities/topics; for the shows in one topic use podcasts/list with topic\_id.
>
> #### Input Parameters
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Episode transcript with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_TRANSCRIPT`
>
> Use to read a whole episode rather than the excerpt a search returned. For one passage, podcasts/segment/transcript is smaller and cheaper; for a moment, podcasts/transcript/preview.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Episode slug or id: episode.id on a search match, or id on an episode list row. A podcast slug is not an episode id.
>
> **end** `number`
>
> Clip to lines ending by this offset in seconds.
>
> **start** `number`
>
> Clip to lines starting at this offset in seconds.
>
> **format** `string ("dialogue" | "text" | "srt")`
>
> Output format: dialogue (speaker-attributed JSON lines, the shape described here), text (Speaker: text lines), or srt (SubRip). The text and srt bodies are not the lines shape.
>
> **speaker** `string`
>
> Only lines from this speaker: a full or partial name, case-insensitive, or an entity id or slug.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Entity mentions in a transcript with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_TRANSCRIPT_MENTIONS`
>
> Use to see exactly where and how a company, person or product was discussed within one episode, with the dialogue around each mention. Across episodes, use podcasts/mentions.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Episode slug or id: episode.id on a search match, or id on an episode list row. A podcast slug is not an episode id.
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **entity\_id** `string`
>
> Entity id or slug. Omit to return mentions of every entity in the episode.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **context\_lines** `number`
>
> Dialogue lines of context on each side of every mention line; adjacent windows merge.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Transcript excerpt at a moment with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_PODCASTS_TRANSCRIPT_PREVIEW`
>
> Use to read what was being said at a timestamp, or the opening of an episode, at a fifth of the full transcript's price. For a whole episode use podcasts/transcript.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Episode slug or id: episode.id on a search match, or id on an episode list row. A podcast slug is not an episode id.
>
> **format** `string ("dialogue" | "text" | "srt")`
>
> Output format: dialogue (speaker-attributed JSON lines, the shape described here), text (Speaker: text lines), or srt (SubRip). The text and srt bodies are not the lines shape.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **timestamp\_seconds** `number`
>
> A moment in the episode, in seconds. Returns the latest segment starting at or before it; a moment outside the episode clamps to the first or last segment. Omit for the opening segment.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Ranking categories with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_RANKINGS_CATEGORIES`
>
> Use to find the category\_slug the chart capabilities take.
>
> #### Input Parameters
>
> **limit** `number`
>
> Maximum records to return. Omit for all of them.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **source** `string ("apple" | "spotify")`
>
> Ranking source platform.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Chart entries with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_RANKINGS_CHARTS`
>
> Use for today's chart: the US Apple overall top podcasts with no arguments, or a country and category. Use rankings/categories and rankings/countries for the valid slugs.
>
> #### Input Parameters
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **source** `string ("apple" | "spotify")`
>
> Ranking source platform.
>
> **country** `string`
>
> ISO 3166-1 alpha-2 country code, for example us, gb, jp. Case-insensitive.
>
> **max\_rank** `number`
>
> Highest-numbered rank to include.
>
> **min\_rank** `number`
>
> Lowest-numbered rank to include.
>
> **chart\_type** `string`
>
> Chart variant within the source. Only top\_podcasts exists today.
>
> **podcast\_id** `string`
>
> Only this show's current chart appearances across the matching slots.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **category\_slug** `string`
>
> Category slug, for example comedy or business. Omit for the overall chart.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Ranking countries with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_RANKINGS_COUNTRIES`
>
> Use to find the country codes the chart capabilities take.
>
> #### Input Parameters
>
> **limit** `number`
>
> Maximum records to return. Omit for all of them.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **source** `string ("apple" | "spotify")`
>
> Ranking source platform.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Chart slot history with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_RANKINGS_HISTORY`
>
> Use for how a chart looked on past days, or how one show moved within it. For one show across every chart use rankings/show/history.
>
> #### Input Parameters
>
> **limit** `number`
>
> Maximum records to return.
>
> **since** `string`
>
> Lower bound on captured\_at, ISO 8601.
>
> **until** `string`
>
> Upper bound on captured\_at, ISO 8601.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **source** `string ("apple" | "spotify")`
>
> Ranking source platform.
>
> **country** `string`
>
> ISO 3166-1 alpha-2 country code, for example us, gb, jp. Case-insensitive.
>
> **chart\_type** `string`
>
> Chart variant within the source. Only top\_podcasts exists today.
>
> **podcast\_id** `string`
>
> Only one show within the slot.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **category\_slug** `string`
>
> Category slug, for example comedy or business. Omit for the overall chart.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Chart movers with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_RANKINGS_MOVERS`
>
> Use for what debuted, climbed, fell or dropped off a chart since yesterday or over a window.
>
> #### Input Parameters
>
> **limit** `number`
>
> Maximum records to return.
>
> **change** `string ("all" | "up" | "down" | "new" | "exit")`
>
> Which changes: up, down, new debuts, exits, or all.
>
> **source** `string ("apple" | "spotify")`
>
> Ranking source platform.
>
> **country** `string`
>
> ISO 3166-1 alpha-2 country code, for example us, gb, jp. Case-insensitive.
>
> **chart\_type** `string`
>
> Chart variant within the source. Only top\_podcasts exists today.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **window\_days** `number`
>
> Compare against the snapshot this many days ago.
>
> **category\_slug** `string`
>
> Category slug, for example comedy or business. Omit for the overall chart.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Current rankings of a show with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_RANKINGS_SHOW`
>
> Use for where a show charts today, everywhere it charts. For a one-number summary use rankings/show/summary.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
>
> **limit** `number`
>
> Maximum records to return. Omit for all of them.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Ranking history of a show with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_RANKINGS_SHOW_HISTORY`
>
> Use for a show's chart trajectory over time.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
>
> **limit** `number`
>
> Maximum records to return.
>
> **since** `string`
>
> Lower bound on captured\_at, ISO 8601.
>
> **until** `string`
>
> Upper bound on captured\_at, ISO 8601.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **source** `string ("apple" | "spotify")`
>
> Ranking source platform.
>
> **country** `string`
>
> ISO 3166-1 alpha-2 country code, for example us, gb, jp. Case-insensitive.
>
> **chart\_type** `string`
>
> Chart variant within the source. Only top\_podcasts exists today.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **category\_slug** `string`
>
> Category slug, for example comedy or business. Omit for the overall chart.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Chart presence summary with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_RANKINGS_SHOW_SUMMARY`
>
> Use for how big a show is on the charts in one call: its best rank and how widely it charts.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Ranking sources with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_RANKINGS_SOURCES`
>
> Use to check which chart sources exist and how fresh the snapshot is.
>
> #### Input Parameters
>
> **limit** `number`
>
> Maximum records to return. Omit for all of them.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Publishers by exposure to a category with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_SUITABILITY_CATEGORY_PUBLISHERS`
>
> Use to pivot on one category for a regulated or family brand: which networks carry the most, or least, alcohol, weapons, adult or hate-speech exposure.
>
> #### Input Parameters
>
> **code** `string ("adult_sexual" | "arms_ammunition" | "crime_harmful_acts" | "death_injury_military_conflict" | "online_piracy" | "hate_speech_aggression" | "obscenity_profanity" | "illegal_drugs_alcohol_tobacco" | "spam_harmful" | "terrorism" | "debated_social_issues" | "misinformation")` *required*
>
> The brand-safety category to pivot on.
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **direction** `string ("most_exposed" | "least_exposed")`
>
> most\_exposed ranks by exposure share descending; least\_exposed inverts it.
>
> **treatment** `string ("DOCUMENTARY" | "EDITORIAL" | "PROMOTIONAL" | "GLAMORIZING")`
>
> With category: only count exposure whose treatment equals this value.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **min\_prevalence** `string ("INCIDENTAL" | "OCCASIONAL" | "FREQUENT" | "PERVASIVE")`
>
> With category: only count exposure at or above this prevalence. INCIDENTAL is any non-NONE prevalence.
>
> **min\_analyzed\_podcasts** `number`
>
> Exclude publishers with fewer analysed shows than this.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Guest suitability exposure with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_SUITABILITY_GUEST`
>
> Use for what kind of shows a guest tends to appear on, in brand-safety terms.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Person slug (recommended), the person's knowledge-graph entity slug, or the encoded person id.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Publisher suitability profile with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_SUITABILITY_PUBLISHER`
>
> Use for how brand-safe a network's catalogue is as a whole and where its exposure sits.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Publisher slug (for example iheartpodcasts, bbc-radio-4) or id, as carried on a podcast record's publisher.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Assessed shows of a publisher with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_SUITABILITY_PUBLISHER_SHOWS`
>
> Use to build an inclusion or exclusion list inside one network: its shows by tier, or the ones exposed in a category.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Publisher slug (for example iheartpodcasts, bbc-radio-4) or id, as carried on a podcast record's publisher.
>
> **sort** `string ("risk_desc" | "risk_asc" | "recently_evaluated")`
>
> risk\_desc puts the riskiest first, risk\_asc the safest, recently\_evaluated the newest assessment.
>
> **tier** `array`
>
> Only these tiers, comma-separated to match any, for example UNSAFE,SENSITIVE.
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **category** `string ("adult_sexual" | "arms_ammunition" | "crime_harmful_acts" | "death_injury_military_conflict" | "online_piracy" | "hate_speech_aggression" | "obscenity_profanity" | "illegal_drugs_alcohol_tobacco" | "spam_harmful" | "terrorism" | "debated_social_issues" | "misinformation")`
>
> Only shows exposed in this category.
>
> **treatment** `string ("DOCUMENTARY" | "EDITORIAL" | "PROMOTIONAL" | "GLAMORIZING")`
>
> With category: only count exposure whose treatment equals this value.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **min\_prevalence** `string ("INCIDENTAL" | "OCCASIONAL" | "FREQUENT" | "PERVASIVE")`
>
> With category: only count exposure at or above this prevalence. INCIDENTAL is any non-NONE prevalence.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Publisher suitability leaderboard with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_SUITABILITY_PUBLISHERS_LEADERBOARD`
>
> Use for the safest or riskiest networks to buy, or the most broadly placeable.
>
> #### Input Parameters
>
> **limit** `number`
>
> Maximum records to return.
>
> **cursor** `string`
>
> Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
>
> **metric** `string ("safest" | "riskiest" | "most_placeable" | "most_analyzed")`
>
> safest by SAFE share, riskiest by UNSAFE share, most\_placeable by SAFE plus LIMITED share, most\_analyzed by analysed count.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **min\_analyzed\_podcasts** `number`
>
> Only publishers with at least this many analysed shows.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Show suitability assessment with particle
>
> **Slug:** `FIRECRAWL_PARTICLE_SUITABILITY_SHOW`
>
> Use for whether a show is safe to advertise on and in which categories it is exposed, with the evidence. The tier alone rides on every show record as suitability\_tier.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
>
> **include** `array`
>
> Optional sections, comma-separated: trend for the comparison against the prior assessment, history for the list of prior assessments.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Company enrichment with people-data-labs
>
> **Slug:** `FIRECRAWL_PEOPLE_DATA_LABS_COMPANY_ENRICH`
>
> Use when you have one company and want its firmographics, funding and headcount. Give it a domain, ticker or social profile if you possibly can - a bare name is the identifier most likely to miss.
>
> #### Input Parameters
>
> **name** `string`
>
> Company name, for example "Google, Inc.". The weakest identifier by a distance - an ambiguous name answers 404 rather than guessing - so prefer website, ticker or profile whenever you have one.
>
> **pdl\_id** `string`
>
> PDL company id, or a LinkedIn company slug such as `google`. A hard override: sent alongside anything else, every other match input is ignored.
>
> **region** `string`
>
> State or region, one value. Never sufficient on its own.
>
> **ticker** `string`
>
> Stock ticker.
>
> **country** `string`
>
> Country, one value. Never sufficient on its own.
>
> **profile** `string`
>
> Social profile URL, for example linkedin.com/company/google.
>
> **website** `string`
>
> Company domain. The most reliable single identifier.
>
> **locality** `string`
>
> City, one value. Never sufficient on its own.
>
> **location** `string`
>
> Free-form location. Raises the likelihood of a name match; never sufficient on its own.
>
> **required** `string`
>
> Boolean expression over required top-level output fields using AND, OR and parentheses. Fields used as matching inputs cannot also be required. Access depends on the key's field bundles.
>
> **titlecase** `boolean`
>
> Return titlecased values. Responses are lowercase otherwise, which matters when the output is shown to a person rather than matched on.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **postal\_code** `string`
>
> Postal code, one value. Never sufficient on its own.
>
> **data\_include** `string`
>
> Comma-separated schema fields to return, dot notation for subfields, a leading `-` to exclude instead, `""` for none. Use it to reduce response size.
>
> **min\_likelihood** `number`
>
> Refuse a match below this confidence, 1-10, default 2. At 2 the match is only 10-30% likely to be the record asked for. Raising it turns a weak match into a 404, which is the cheaper answer: a 404 is free here and a wrong record is not.
>
> **street\_address** `string`
>
> Street address, one value. Never sufficient on its own.
>
> **include\_if\_matched** `boolean`
>
> Return matching inputs: top-level matched for enrichment, or matched\_on within Identify candidates.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Company search with people-data-labs
>
> **Slug:** `FIRECRAWL_PEOPLE_DATA_LABS_COMPANY_SEARCH`
>
> Search companies by attributes such as industry, headcount, funding stage, and location using a query or SQL. Each returned company costs 50 credits; pages contain at most two companies.
>
> #### Input Parameters
>
> **sql** `string`
>
> `SELECT * FROM company WHERE ...`. Column selection and LIMIT are ignored, and at most 20 LIKE '%...%' terms are allowed. Send this or query, never both.
>
> **size** `integer`
>
> Request 1-2 companies per call, costing 50 credits per returned company. PDL supports 1-100 upstream, but Exchange authorization is capped at 100 credits, so callers must use size 1 or 2.
>
> **query** `object`
>
> Elasticsearch 7.7 query object over the company schema. Only term, terms, exists, bool, match, range, match\_phrase, wildcard, prefix and match\_all are accepted. Any array inside it is capped at 100 elements - a tenth of what the person endpoints allow, so a filter list carried over from there will fail. Send this or sql, never both.
>
> **titlecase** `boolean`
>
> Return titlecased values. Responses are lowercase otherwise, which matters when the output is shown to a person rather than matched on.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **scroll\_token** `string`
>
> The scroll\_token from the previous response, replayed with the identical query, for the next page. A 404 while scrolling means the results are exhausted, not that the query broke.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get team queue status
>
> **Slug:** `FIRECRAWL_QUEUE_GET`
>
> Tool to retrieve metrics about the team's scrape queue. Use when you need to check queue status, job counts, or concurrency limits.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape URL
>
> **Slug:** `FIRECRAWL_SCRAPE`
>
> Scrapes a publicly accessible URL in specified formats, optionally using browser actions or structured JSON extraction. Managed Firecrawl connections support only basic formats without browser actions or extraction add-ons.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.003 per basic page scraped
>
> **Discount:** 79
>
> #### Input Parameters
>
> **url** `string` *required*
>
> The fully qualified URL of the web page to scrape. Must start with 'http\://' or 'https\://' and be a valid web URL.
>
> **actions** `array`
>
> An optional list of browser actions (e.g., click, write, wait, press) to perform on the page before scraping. Useful for interacting with dynamic content, filling forms, or navigating through page elements.
>
> **formats** `array`
>
> A list of desired output formats for the scraped content. Defaults to \['markdown']. Cannot include both 'screenshot' and 'screenshot\@fullPage'. If 'json' is included, jsonOptions must be provided.
>
> **timeout** `integer`
>
> Maximum time in milliseconds to wait for the scraping request to complete. Defaults to 30000.
>
> **waitFor** `integer`
>
> Time in milliseconds to wait for the page to load or for dynamic content to render before starting the scrape. Defaults to 0.
>
> **location** `object`
>
> Location settings for the request
>
> **excludeTags** `array`
>
> A list of HTML tags to specifically exclude from the output. Content within these tags will be removed.
>
> **includeTags** `array`
>
> A list of HTML tags to specifically include in the output. Content within these tags will be prioritized.
>
> **jsonOptions** `object`
>
> Options for JSON extraction
>
> **onlyMainContent** `boolean`
>
> If true, attempts to extract only the main article content, excluding headers, footers, navigation bars, and ads. Defaults to true.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search
>
> **Slug:** `FIRECRAWL_SEARCH`
>
> Searches the web for a query, optionally scraping result content in specified formats. Managed Firecrawl connections support only basic content formats.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.007 per basic search with up to 10 results
>
> **Discount:** 79
>
> #### Input Parameters
>
> **q** `string` *required*
>
> The search query to execute. Can be provided as 'query' or 'q'.
>
> **lang** `string`
>
> Language code for search results (e.g., 'en' for English, default 'en').
>
> **limit** `integer`
>
> Maximum number of search results to return (1-100, default 5).
>
> **country** `string`
>
> Country code to tailor search results (e.g., 'us' for United States, default 'us').
>
> **formats** `array`
>
> Desired output formats for scraped content of each search result. If None, default scraping applies. Available string formats: 'markdown', 'html', 'rawHtml', 'links'. For screenshots, use object format: \{'type': 'screenshot', 'fullPage': true/false, 'quality': 1-100}. For other advanced formats, consult Firecrawl API documentation.
>
> **timeout** `integer`
>
> Maximum time in milliseconds for search and scrape operations (1000-300000, default 60000).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search people with Apollo
>
> **Slug:** `FIRECRAWL_SEARCH_PEOPLE_APOLLO`
>
> Search professional profile previews by role, company, keywords and location through Firecrawl Alexandria Apollo. Returns first names, masked surnames, titles, organizations and contact-availability flags, not revealed email addresses. Request one page at a time with page and per\_page (maximum 100).
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0 per Apollo people-search request
>
> #### Input Parameters
>
> **page** `integer`
>
> Page of results, from 1.
>
> **keywords** `string`
>
> Free text matched across the person and their company.
>
> **per\_page** `integer`
>
> Results per page, maximum 100.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse the same value when retrying an ambiguous timeout to avoid a second paid execution.
>
> **person\_titles** `array`
>
> Job titles to match, for example "VP of Sales". Several titles widen the net.
>
> **person\_locations** `array`
>
> Locations to restrict to, for example "San Francisco, US".
>
> **organization\_domains** `array`
>
> Company domains to restrict to, for example firecrawl.dev.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search people with FullEnrich
>
> **Slug:** `FIRECRAWL_SEARCH_PEOPLE_FULLENRICH`
>
> Search professional profiles by current or past roles, employers, skills, education and location through Firecrawl Alexandria FullEnrich. Returns one page with provider pagination metadata. Use offset up to 10,000, then metadata.search\_after with unchanged filters. Up to 6 records per page; default 2. Contact email and phone enrichment is separate. A team administrator must accept FullEnrich terms in Firecrawl before use.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.019 per returned person
>
> **Discount:** 79
>
> #### Input Parameters
>
> **limit** `integer`
>
> Records per page, up to 6. Each returned record costs 5 credits. Use pagination for more.
>
> **offset** `integer`
>
> Records to skip. Use search\_after beyond 10,000.
>
> **person\_ids** `array`
>
> FullEnrich person IDs. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse the same value when retrying an ambiguous timeout to avoid a second paid execution.
>
> **person\_names** `array`
>
> Person names. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **search\_after** `string`
>
> Cursor from the previous response's metadata.search\_after. Keep the same filters.
>
> **person\_skills** `array`
>
> Professional skills. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **person\_languages** `array`
>
> Languages spoken. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **person\_locations** `array`
>
> Cities, regions, or countries. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **past\_company\_names** `array`
>
> Previous employer names. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **current\_company\_ids** `array`
>
> Current employer FullEnrich IDs. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **person\_universities** `array`
>
> Universities attended. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **past\_company\_domains** `array`
>
> Previous employer domains. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **past\_position\_titles** `array`
>
> Previous job titles. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **current\_company\_names** `array`
>
> Current employer names. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **current\_company\_types** `array`
>
> Company types, such as Public Company or Nonprofit. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **current\_company\_domains** `array`
>
> Current employer domains. Exact matching recommended. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **current\_position\_titles** `array`
>
> Current job titles. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **current\_company\_years\_at** `array`
>
> Years at the current employer. Entries: \{ min?, max?, exclude? }; at least one inclusive bound.
>
> **current\_position\_years\_in** `array`
>
> Years in the current position. Entries: \{ min?, max?, exclude? }; at least one inclusive bound.
>
> **current\_company\_headcounts** `array`
>
> Current employer employee counts. Entries: \{ min?, max?, exclude? }; at least one inclusive bound.
>
> **current\_company\_industries** `array`
>
> Current employer industries. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **current\_company\_specialties** `array`
>
> Current employer specialties. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **current\_company\_headquarters** `array`
>
> Current employer headquarters locations. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **current\_company\_technologies** `array`
>
> Technologies used by the current employer. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **current\_company\_founded\_years** `array`
>
> Current employer founding years. Entries: \{ min?, max?, exclude? }; at least one inclusive bound.
>
> **current\_position\_job\_functions** `array`
>
> Current job functions. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **current\_position\_sub\_functions** `array`
>
> Current job subfunctions. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **person\_professional\_network\_ids** `array`
>
> LinkedIn profile IDs. Entries: \{ value: number, exclude?: boolean, exact\_match?: boolean }.
>
> **current\_position\_seniority\_level** `array`
>
> Seniority levels, such as Founder, VP, or Manager. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **person\_professional\_network\_urls** `array`
>
> LinkedIn profile URLs. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **current\_company\_professional\_network\_ids** `array`
>
> Current employer LinkedIn IDs. Entries: \{ value: number, exclude?: boolean, exact\_match?: boolean }.
>
> **current\_company\_professional\_network\_urls** `array`
>
> Current employer LinkedIn URLs. Entries: \{ value: string, exclude?: boolean, exact\_match?: boolean }.
>
> **current\_company\_days\_since\_last\_job\_change** `array`
>
> Days since the last job change. Entries: \{ min?, max?, exclude? }; at least one inclusive bound.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Marketing channel shares with similarweb
>
> **Slug:** `FIRECRAWL_SIMILARWEB_CHANNELS_SHARE`
>
> Use for marketing channel shares for one complete month. Subscription availability applies. The Similarweb-only monthly credit allowance applies.
>
> #### Input Parameters
>
> **asc** `boolean`
>
> Ascending sort when true.
>
> **sort** `string`
>
> Response field to sort by.
>
> **limit** `number`
>
> Maximum records in this page; Exchange bounds pages to 100.
>
> **domain** `string` *required*
>
> Lowercase bare domain without [www](http://www). or a URL path.
>
> **offset** `number`
>
> Number of records to skip.
>
> **country** `string`
>
> Two-letter lowercase country code or ww.
>
> **end\_date** `string` *required*
>
> Same month as start\_date, as YYYY-MM.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **start\_date** `string` *required*
>
> Requested month as YYYY-MM; initial contract supports one complete month.
>
> **web\_source** `string ("desktop" | "mobile_web" | "total")`
>
> Device scope.
>
> **granularity** `string`
>
> Monthly observations.
>
> **main\_domain\_only** `boolean`
>
> Exclude subdomains when true.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Marketing channel traffic with similarweb
>
> **Slug:** `FIRECRAWL_SIMILARWEB_CHANNELS_TRAFFIC`
>
> Use for marketing channel traffic for one complete month. Subscription availability applies. The Similarweb-only monthly credit allowance applies.
>
> #### Input Parameters
>
> **domain** `string` *required*
>
> Lowercase bare domain without [www](http://www). or a URL path.
>
> **country** `string`
>
> Two-letter lowercase country code or ww.
>
> **end\_date** `string` *required*
>
> Same month as start\_date, as YYYY-MM.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **start\_date** `string` *required*
>
> Requested month as YYYY-MM; initial contract supports one complete month.
>
> **web\_source** `string ("desktop" | "mobile_web" | "total")`
>
> Device scope.
>
> **granularity** `string`
>
> Monthly observations.
>
> **main\_domain\_only** `boolean`
>
> Exclude subdomains when true.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Traffic geography with similarweb
>
> **Slug:** `FIRECRAWL_SIMILARWEB_WEB_GEOGRAPHY`
>
> Use for traffic geography for one complete month. Subscription availability applies. The Similarweb-only monthly credit allowance applies.
>
> #### Input Parameters
>
> **asc** `boolean`
>
> Ascending sort when true.
>
> **sort** `string`
>
> Response field to sort by.
>
> **limit** `number`
>
> Maximum records in this page; Exchange bounds pages to 100.
>
> **domain** `string` *required*
>
> Lowercase bare domain without [www](http://www). or a URL path.
>
> **offset** `number`
>
> Page number, starting at 1 per the endpoint documentation.
>
> **metrics** `string` *required*
>
> Comma-separated metrics: visits, rank, share.
>
> **end\_date** `string` *required*
>
> Same month as start\_date, as YYYY-MM.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **start\_date** `string` *required*
>
> Requested month as YYYY-MM; initial contract supports one complete month.
>
> **web\_source** `string ("desktop" | "mobile_web" | "total")`
>
> Device scope.
>
> **granularity** `string`
>
> Monthly observations.
>
> **main\_domain\_only** `boolean`
>
> Exclude subdomains when true.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Incoming referral domains with similarweb
>
> **Slug:** `FIRECRAWL_SIMILARWEB_WEB_INCOMING_REFERRALS`
>
> List domains sending referral traffic to the supplied domain for one complete month, using record-offset pagination. Use web/referrals when page-number pagination is preferable.
>
> #### Input Parameters
>
> **asc** `boolean`
>
> Ascending sort when true.
>
> **sort** `string`
>
> Response field to sort by.
>
> **limit** `number`
>
> Maximum records in this page; Exchange bounds pages to 100.
>
> **domain** `string` *required*
>
> Lowercase bare domain without [www](http://www). or a URL path.
>
> **offset** `number`
>
> Number of records to skip.
>
> **country** `string`
>
> Two-letter lowercase country code or ww.
>
> **end\_date** `string` *required*
>
> Same month as start\_date, as YYYY-MM.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **start\_date** `string` *required*
>
> Requested month as YYYY-MM; initial contract supports one complete month.
>
> **web\_source** `string ("desktop" | "mobile_web" | "total")`
>
> Device scope.
>
> **granularity** `string`
>
> Monthly observations.
>
> **main\_domain\_only** `boolean`
>
> Exclude subdomains when true.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Paid search spend with similarweb
>
> **Slug:** `FIRECRAWL_SIMILARWEB_WEB_PPC_SPEND`
>
> Use for paid search spend for one complete month. Subscription availability applies. The Similarweb-only monthly credit allowance applies.
>
> #### Input Parameters
>
> **domain** `string` *required*
>
> Lowercase bare domain without [www](http://www). or a URL path.
>
> **country** `string`
>
> Two-letter lowercase country code or ww.
>
> **currency** `string ("usd" | "eur" | "gbp" | "jpy" | "aud")`
>
> Spend currency.
>
> **end\_date** `string` *required*
>
> Same month as start\_date, as YYYY-MM.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **start\_date** `string` *required*
>
> Requested month as YYYY-MM; initial contract supports one complete month.
>
> **web\_source** `string ("desktop" | "mobile_web" | "total")`
>
> Device scope.
>
> **granularity** `string`
>
> Monthly observations.
>
> **main\_domain\_only** `boolean`
>
> Exclude subdomains when true.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Referral traffic with similarweb
>
> **Slug:** `FIRECRAWL_SIMILARWEB_WEB_REFERRALS`
>
> List domains sending referral traffic to the supplied domain for one complete month, using page-number pagination. Use web/incoming-referrals when record-offset pagination is preferable.
>
> #### Input Parameters
>
> **asc** `boolean`
>
> Ascending sort when true.
>
> **sort** `string`
>
> Response field to sort by.
>
> **limit** `number`
>
> Maximum records in this page; Exchange bounds pages to 100.
>
> **domain** `string` *required*
>
> Lowercase bare domain without [www](http://www). or a URL path.
>
> **offset** `number`
>
> Page number, starting at 1 per the endpoint documentation.
>
> **country** `string`
>
> Two-letter lowercase country code or ww.
>
> **end\_date** `string` *required*
>
> Same month as start\_date, as YYYY-MM.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **start\_date** `string` *required*
>
> Requested month as YYYY-MM; initial contract supports one complete month.
>
> **web\_source** `string ("desktop" | "mobile_web" | "total")`
>
> Device scope.
>
> **granularity** `string`
>
> Monthly observations.
>
> **referral\_type** `string`
>
> Incoming referral traffic.
>
> **main\_domain\_only** `boolean`
>
> Exclude subdomains when true.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Traffic and engagement with similarweb
>
> **Slug:** `FIRECRAWL_SIMILARWEB_WEB_TRAFFIC`
>
> Use for traffic and engagement for one complete month. Subscription availability applies. The Similarweb-only monthly credit allowance applies.
>
> #### Input Parameters
>
> **domain** `string` *required*
>
> Lowercase bare domain without [www](http://www). or a URL path.
>
> **country** `string`
>
> Two-letter lowercase country code or ww.
>
> **metrics** `string` *required*
>
> Comma-separated metrics: visits, average\_visit\_duration, pages\_per\_visit, bounce\_rate, unique\_visitors.
>
> **end\_date** `string` *required*
>
> Same month as start\_date, as YYYY-MM.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **start\_date** `string` *required*
>
> Requested month as YYYY-MM; initial contract supports one complete month.
>
> **web\_source** `string ("desktop" | "mobile_web" | "total")`
>
> Device scope.
>
> **granularity** `string`
>
> Monthly observations.
>
> **main\_domain\_only** `boolean`
>
> Exclude subdomains when true.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Outgoing referrals with similarweb
>
> **Slug:** `FIRECRAWL_SIMILARWEB_WEB_WEBSITE_REFERRALS_OUTGOING_REFERRALS`
>
> List domains that receive referral traffic from the supplied domain, optionally filtered by date, country, device, and granularity. Use incoming-referrals to find domains sending traffic to the supplied domain.
>
> #### Input Parameters
>
> **asc** `boolean`
>
> Orders the results by ascending or descending
>
> **sort** `string`
>
> Selects a specific metric to order results by
>
> **limit** `number`
>
> Sets how many results to return.
>
> **domain** `string` *required*
>
> Enter website of interest, without '[www](http://www).' or brackets \{}
>
> **offset** `number`
>
> Defines the number of results to skip
>
> **country** `string`
>
> Two-letter country code (e.g., 'us', 'gb', 'ww')
>
> **end\_date** `string`
>
> End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X\_months\_ago, X\_days\_ago
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **start\_date** `string`
>
> Start date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X\_months\_ago, X\_days\_ago
>
> **web\_source** `string ("desktop" | "mobile_web" | "total")`
>
> The device/platform the traffic is coming from
>
> **granularity** `string ("daily" | "monthly")`
>
> Time granularity for the returned values
>
> **main\_domain\_only** `boolean`
>
> True' will include only the main domain, 'false' will include subdomains. Default is 'false'
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Start an agent job
>
> **Slug:** `FIRECRAWL_START_AGENT`
>
> Tool to start an agent job for agentic web extraction with multi-page navigation and interaction capabilities. Use when you need to autonomously gather data from the web with complex navigation requirements. The agent can search, navigate, and extract information across multiple pages based on your natural language prompt.
>
> #### Input Parameters
>
> **urls** `array`
>
> Specific URLs to constrain the agent's search. If provided, the agent will start from these URLs. If not provided, the agent will autonomously search the web.
>
> **prompt** `string` *required*
>
> Natural language description of what data you want to extract. The agent will autonomously navigate and interact with web pages to gather this information.
>
> **schema** `object`
>
> JSON schema defining the structure of data you want returned. Must be a valid JSON Schema object with properties and types. This ensures the extracted data matches your desired format.
>
> **maxCredits** `integer`
>
> Maximum credits to spend on the request. The agent will stop when this limit is reached, preventing unexpected costs. If not specified, the agent will continue until the task is complete.
>
> **strictConstrainToURLs** `boolean`
>
> Whether to strictly limit the agent to only the provided URLs. If true, the agent will not navigate to external links. If false or not specified, the agent can follow links to gather more information.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Stop scrape interaction
>
> **Slug:** `FIRECRAWL_STOP_SCRAPE_INTERACTION`
>
> Stop a scrape job's interactive browser session, releasing browser resources and finalizing duration-based billing.
>
> #### Input Parameters
>
> **scrape\_id** `string` *required*
>
> UUID of the scrape job whose interactive browser session should be stopped.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get team token usage
>
> **Slug:** `FIRECRAWL_TOKEN_USAGE_GET`
>
> Tool to retrieve the current team's token usage and balance information for Firecrawl's Extract feature. Use when you need to check remaining token credits, plan allocation, or billing period details.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get historical team token usage
>
> **Slug:** `FIRECRAWL_TOKEN_USAGE_GET_HISTORICAL`
>
> Tool to retrieve historical team token usage on a monthly basis. Use when you need to analyze token consumption patterns over time, optionally segmented by API key.
>
> #### Input Parameters
>
> **byApiKey** `boolean`
>
> When enabled, breaks down usage by individual API key. Defaults to false.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Creative breakdown with upspring
>
> **Slug:** `FIRECRAWL_UPSPRING_ADS_BREAKDOWN`
>
> Use for how a market advertises: the share of hooks, personas, offers or formats across a vertical, brand or filter. Run it twice, once with min\_impressions=4, to see what the winning ads over-index on.
>
> #### Input Parameters
>
> **funnel** `array`
>
> Only ads with this funnel id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **persona** `array`
>
> Only ads with this persona id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **category** `string`
>
> One category id within a vertical, from taxonomy/verticals.
>
> **group\_by** `string ("media_type" | "hook_archetype" | "hook_polarity" | "funnel" | "persona" | "archetype" | "mechanism" | "positioning" | "offer_type" | "persuasion_technique" | "claim_type" | "evidence_type")` *required*
>
> Dimension to break the matching ads down by.
>
> **vertical** `array`
>
> Vertical id(s), for example beverages or skincare. Ids come from taxonomy/verticals.
>
> **archetype** `array`
>
> Only ads with this archetype id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **is\_active** `string ("true" | "false")`
>
> true for ads running now, false for stopped ones. Omit for both.
>
> **mechanism** `array`
>
> Only ads with this mechanism id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **claim\_type** `array`
>
> Only ads that use this claim type (an ad can carry several). Ids from taxonomy/vertical's dimensions.
>
> **media\_type** `array`
>
> Only ads with this media type id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **offer\_type** `array`
>
> Only ads with this offer type id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **has\_product** `string ("true" | "false")`
>
> true for ads whose landing page has store data (price, vendor), false for ads without. Omit for both.
>
> **positioning** `array`
>
> Only ads with this positioning id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **recency\_days** `number`
>
> Only ads first seen in the last N days (1 to 365).
>
> **advertiser\_id** `array`
>
> Only ads from these advertiser ids.
>
> **evidence\_type** `array`
>
> Only ads that use this evidence type (an ad can carry several). Ids from taxonomy/vertical's dimensions.
>
> **hook\_polarity** `array`
>
> Only ads with this hook polarity id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **hook\_archetype** `array`
>
> Only ads with this hook archetype id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **min\_impressions** `number`
>
> Winners-only floor on Meta's 1 to 5 delivery-strength indicator. Excludes ads without one.
>
> **persuasion\_technique** `array`
>
> Only ads that use this persuasion technique (an ad can carry several). Ids from taxonomy/vertical's dimensions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Browse ads with upspring
>
> **Slug:** `FIRECRAWL_UPSPRING_ADS_BROWSE`
>
> Use to list a brand's or a vertical's ads by filter: what an advertiser is running now (advertiser\_id + is\_active=true), or the winners in a category (order\_by=best, min\_impressions=4).
>
> #### Input Parameters
>
> **limit** `number`
>
> Ads per page, 1 to 100 (1 to 50 with include=descriptors). Default 25.
>
> **cursor** `string`
>
> meta.next\_cursor from the previous page, verbatim. Send the same filters with it; a cursor replayed with changed filters is refused.
>
> **funnel** `array`
>
> Only ads with this funnel id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **include** `array`
>
> Comma-separated: descriptors adds synopsis and long\_form narration per ad (token-heavy); media adds durable \{video\_url, image\_url, thumbnail\_url, width, height}.
>
> **persona** `array`
>
> Only ads with this persona id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **category** `string`
>
> One category id within a vertical, from taxonomy/verticals.
>
> **order\_by** `string ("random" | "recent" | "best")`
>
> random (a fresh sample each call), recent, or best (performance-signal ranked).
>
> **vertical** `array`
>
> Vertical id(s), for example beverages or skincare. Ids come from taxonomy/verticals.
>
> **archetype** `array`
>
> Only ads with this archetype id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **is\_active** `string ("true" | "false")`
>
> true for ads running now, false for stopped ones. Omit for both.
>
> **mechanism** `array`
>
> Only ads with this mechanism id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **claim\_type** `array`
>
> Only ads that use this claim type (an ad can carry several). Ids from taxonomy/vertical's dimensions.
>
> **media\_type** `array`
>
> Only ads with this media type id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **offer\_type** `array`
>
> Only ads with this offer type id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **has\_product** `string ("true" | "false")`
>
> true for ads whose landing page has store data (price, vendor), false for ads without. Omit for both.
>
> **positioning** `array`
>
> Only ads with this positioning id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **recency\_days** `number`
>
> Only ads first seen in the last N days (1 to 365).
>
> **advertiser\_id** `array`
>
> Only ads from these advertiser ids.
>
> **evidence\_type** `array`
>
> Only ads that use this evidence type (an ad can carry several). Ids from taxonomy/vertical's dimensions.
>
> **hook\_polarity** `array`
>
> Only ads with this hook polarity id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **hook\_archetype** `array`
>
> Only ads with this hook archetype id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **min\_impressions** `number`
>
> Winners-only floor on Meta's 1 to 5 delivery-strength indicator. Excludes ads without one.
>
> **persuasion\_technique** `array`
>
> Only ads that use this persuasion technique (an ad can carry several). Ids from taxonomy/vertical's dimensions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Ad detail with upspring
>
> **Slug:** `FIRECRAWL_UPSPRING_ADS_DETAIL`
>
> Use for everything about one ad: the hook, offer, landing page and whether the page delivers what the ad promises. Add include=full for scenes, transcript, overlays and narrative.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Ad id from an ads/search, ads/browse or ads/similar row.
>
> **include** `array`
>
> Comma-separated deep blocks: scenes, transcript, overlays, narrative, full (those four), media (asset URLs, not part of full).
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search ads with upspring
>
> **Slug:** `FIRECRAWL_UPSPRING_ADS_SEARCH`
>
> Use to find Meta ads matching a free-text idea, relevance-ranked across Upspring's competitor ad corpus. Re-rank the page by strength.impressions, then open the finalists with ads/detail. For the newest or best-performing ads without a query use ads/browse.
>
> #### Input Parameters
>
> **limit** `number`
>
> Ads per page, 1 to 100 (1 to 50 with include=descriptors). Default 25.
>
> **query** `string` *required*
>
> Free-text brief, for example prebiotic soda or greens powder daily drink. Hybrid semantic and keyword match.
>
> **cursor** `string`
>
> meta.next\_cursor from the previous page, verbatim. Send the same filters with it; a cursor replayed with changed filters is refused.
>
> **funnel** `array`
>
> Only ads with this funnel id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **include** `array`
>
> Comma-separated: descriptors adds synopsis and long\_form narration per ad (token-heavy); media adds durable \{video\_url, image\_url, thumbnail\_url, width, height}.
>
> **persona** `array`
>
> Only ads with this persona id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **category** `string`
>
> One category id within a vertical, from taxonomy/verticals.
>
> **vertical** `array`
>
> Vertical id(s), for example beverages or skincare. Ids come from taxonomy/verticals.
>
> **archetype** `array`
>
> Only ads with this archetype id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **is\_active** `string ("true" | "false")`
>
> true for ads running now, false for stopped ones. Omit for both.
>
> **mechanism** `array`
>
> Only ads with this mechanism id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **claim\_type** `array`
>
> Only ads that use this claim type (an ad can carry several). Ids from taxonomy/vertical's dimensions.
>
> **media\_type** `array`
>
> Only ads with this media type id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **offer\_type** `array`
>
> Only ads with this offer type id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **has\_product** `string ("true" | "false")`
>
> true for ads whose landing page has store data (price, vendor), false for ads without. Omit for both.
>
> **positioning** `array`
>
> Only ads with this positioning id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **recency\_days** `number`
>
> Only ads first seen in the last N days (1 to 365).
>
> **advertiser\_id** `array`
>
> Only ads from these advertiser ids.
>
> **evidence\_type** `array`
>
> Only ads that use this evidence type (an ad can carry several). Ids from taxonomy/vertical's dimensions.
>
> **hook\_polarity** `array`
>
> Only ads with this hook polarity id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **hook\_archetype** `array`
>
> Only ads with this hook archetype id (OR across values). Ids from taxonomy/vertical's dimensions.
>
> **min\_impressions** `number`
>
> Winners-only floor on Meta's 1 to 5 delivery-strength indicator. Excludes ads without one.
>
> **persuasion\_technique** `array`
>
> Only ads that use this persuasion technique (an ad can carry several). Ids from taxonomy/vertical's dimensions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Similar ads with upspring
>
> **Slug:** `FIRECRAWL_UPSPRING_ADS_SIMILAR`
>
> Use to find ads creatively like one ad, from the same brand and from its competitors.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Ad id from an ads/search, ads/browse or ads/similar row.
>
> **include** `string`
>
> descriptors adds synopsis and long\_form per ad.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Advertiser brief with upspring
>
> **Slug:** `FIRECRAWL_UPSPRING_ADVERTISERS_BRIEF`
>
> Use for a brand's ad strategy at a glance: size grades, Facebook and Instagram followers, Reddit sentiment, its creative fingerprint (personas, mechanisms, hooks, media mix, funnel), hook themes and its top ads.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Advertiser id from advertisers/search, advertisers/by-domain or an ad's advertiser.id. It is the brand's Facebook page id.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Advertiser by domain with upspring
>
> **Slug:** `FIRECRAWL_UPSPRING_ADVERTISERS_BY_DOMAIN`
>
> Use when all you have is a company's website: resolves it to one advertiser and returns the same brief as advertisers/brief. Never 404s; a domain Upspring cannot source answers status unavailable and is not charged.
>
> #### Input Parameters
>
> **sync** `string ("true" | "false")`
>
> true (default) waits a few seconds for a brand Upspring has to fetch; false answers pending at once.
>
> **domain** `string` *required*
>
> Company domain or URL, for example mudwtr.com; normalized to the root domain.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Compare advertisers with upspring
>
> **Slug:** `FIRECRAWL_UPSPRING_ADVERTISERS_COMPARE`
>
> Use to put two brands' ad strategies side by side: where they overlap, where they differ, and what each leaves open.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Advertiser id from advertisers/search, advertisers/by-domain or an ad's advertiser.id. It is the brand's Facebook page id.
>
> **otherId** `string` *required*
>
> The second advertiser's id.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Peer advertisers with upspring
>
> **Slug:** `FIRECRAWL_UPSPRING_ADVERTISERS_PEERS`
>
> Use for brands like this one: same category, vertical, geography or size band. For creative similarity instead use advertisers/similar.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Advertiser id from advertisers/search, advertisers/by-domain or an ad's advertiser.id. It is the brand's Facebook page id.
>
> **limit** `number`
>
> Advertisers to return, 1 to 25. Default 10.
>
> **match** `array`
>
> Comma-separated facets to share with this advertiser: vertical, category, geo, spend\_tier, traffic\_tier, sales\_tier. Default category,spend\_tier.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Request an advertiser with upspring
>
> **Slug:** `FIRECRAWL_UPSPRING_ADVERTISERS_REQUEST`
>
> Use when advertisers/brief answers not found or status unavailable for an advertiser id you know exists: asks Upspring to source it, then poll advertisers/brief. Idempotent; each new advertiser counts against a daily limit.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Advertiser id from advertisers/search, advertisers/by-domain or an ad's advertiser.id. It is the brand's Facebook page id.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Find advertisers with upspring
>
> **Slug:** `FIRECRAWL_UPSPRING_ADVERTISERS_SEARCH`
>
> Use to find a brand's advertiser id by name, website or Facebook page, or to list the advertisers in a vertical, category or size tier. For one brand from its domain with the full brief in one call use advertisers/by-domain.
>
> #### Input Parameters
>
> **geo** `string`
>
> Primary geography, for example US.
>
> **name** `string`
>
> Fuzzy brand name, typo and accent tolerant.
>
> **limit** `number`
>
> Advertisers per page, 1 to 50. Default 25.
>
> **cursor** `string`
>
> meta.next\_cursor from the previous page, verbatim. Send the same filters with it; a cursor replayed with changed filters is refused.
>
> **domain** `string`
>
> Website: full URL, bare domain, name without TLD or a partial term.
>
> **fb\_page** `string`
>
> Facebook page URL or numeric page id (exact); a vanity URL falls back to a name match.
>
> **min\_ads** `number`
>
> Only advertisers with at least this many active ads.
>
> **category** `string`
>
> One category id within a vertical, from taxonomy/verticals.
>
> **vertical** `array`
>
> Vertical id(s), for example beverages or skincare. Ids come from taxonomy/verticals.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> **sales\_tier** `string ("D" | "C" | "B" | "A" | "A+")`
>
> Only advertisers whose sales scale grade is this tier or bigger (D \< C \< B \< A \< A+). Coarse estimates, never exact figures.
>
> **spend\_tier** `string ("D" | "C" | "B" | "A" | "A+")`
>
> Only advertisers whose spend scale grade is this tier or bigger (D \< C \< B \< A \< A+). Coarse estimates, never exact figures.
>
> **traffic\_tier** `string ("D" | "C" | "B" | "A" | "A+")`
>
> Only advertisers whose traffic scale grade is this tier or bigger (D \< C \< B \< A \< A+). Coarse estimates, never exact figures.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Similar advertisers with upspring
>
> **Slug:** `FIRECRAWL_UPSPRING_ADVERTISERS_SIMILAR`
>
> Use for a brand's closest competitors: advertisers going after the same audience with comparable creative strategies.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Advertiser id from advertisers/search, advertisers/by-domain or an ad's advertiser.id. It is the brand's Facebook page id.
>
> **limit** `number`
>
> Advertisers to return, 1 to 25. Default 10.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Vertical vocabulary with upspring
>
> **Slug:** `FIRECRAWL_UPSPRING_TAXONOMY_VERTICAL`
>
> Use, free, before filtering ads by persona, hook or another dimension: lists the valid ids in one vertical.
>
> #### Input Parameters
>
> **vertical** `string` *required*
>
> Vertical id from taxonomy/verticals, for example beverages.
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Verticals and categories with upspring
>
> **Slug:** `FIRECRAWL_UPSPRING_TAXONOMY_VERTICALS`
>
> Use first, free, to learn the vertical and category ids the ads and advertiser filters accept.
>
> #### Input Parameters
>
> **request\_id** `string`
>
> Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
