Skip to main content
Firecrawl logo
  • 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

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

Slug: FIRECRAWL_AGENT_CANCELCancels an in-progress agent job by its ID. Returns a success boolean when the cancellation request succeeds.

Input Parameters

string
required
The unique identifier (UUID) of the agent job to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_APOLLO_COMPANIES_BULK_ENRICHEnrich up to ten companies in one call, billed 30 Firecrawl credits per matched company; unmatched records are free.

Input Parameters

array
Up to ten objects with domain, linkedin_url, name and/or website. Takes precedence over domains[] if both are supplied.
array
Up to ten company domains, without www. Use details for other identifiers.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_APOLLO_COMPANIES_ENRICHUse 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

string
Company domain, for example firecrawl.dev. The reliable key: names collide.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
LinkedIn company page, for example https://www.linkedin.com/company/apolloio.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_APOLLO_COMPANIES_INFOLook up a company by its Apollo ID; use companies/enrich when you have a domain instead.

Input Parameters

string
required
Apollo organization ID from companies/search or companies/enrich.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_APOLLO_COMPANIES_JOB_POSTINGSFind current hiring activity at a known company. Each requested page costs 30 Firecrawl credits.

Input Parameters

number
Page number starting at 1.
number
Results per page; Apollo limits this endpoint to 10,000 records.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
required
Apollo organization ID from companies/search or companies/enrich.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_APOLLO_COMPANIES_NEWSFind news about known Apollo companies, optionally filtered by category and dates. Each requested page costs 30 Firecrawl credits.

Input Parameters

number
Page number starting at 1.
number
Articles per page, maximum 25.
array
News categories, such as hires, investment or contract.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
array
required
Apollo organization IDs to find news about.
string
Latest publication date, YYYY-MM-DD; must follow the earliest date.
string
Earliest publication date, YYYY-MM-DD.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_APOLLO_COMPANIES_SEARCHSearch Apollo companies by name or description, employee count, location, and technology. Results are billed per page.

Input Parameters

number
Page of results, from 1.
number
Results per page, maximum 100.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Free text matched against company names and descriptions.
array
Locations to restrict to, for example “San Francisco, US”.
array
Employee-count bands, for example [“1,10”, “11,50”].
array
Technologies the company must use, for example [“Stripe”].

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_APOLLO_PEOPLE_BULK_MATCHEnrich up to ten identified people in one call, billed 30 Firecrawl credits per matched person; unmatched records are free.

Input Parameters

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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
boolean
Request personal emails for all matches only when explicitly wanted. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_APOLLO_PEOPLE_INFORetrieve a known Apollo person by ID. Use people/match to unlock contact information.

Input Parameters

string
required
Apollo person ID from people/search.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_APOLLO_PEOPLE_MATCHUse 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

string
Apollo person id from people/search. The most reliable input by far.
string
Full name, used with a company domain.
string
Known email address.
string
Company domain, used with a name to disambiguate.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
LinkedIn profile URL. Resolves even when the slug is stale.
boolean
Reveal a phone number. Substantially more expensive than the base match.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_BATCH_SCRAPEStart 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

array
required
The URLs to be scraped in batch. At least one URL is required.
string ("basic" | "stealth" | "auto")
Proxy type to use for requests.
integer
Cache validity period in milliseconds. Default is 2 days.
boolean
If true, emulate a mobile device when scraping. Defaults to false.
array
Browser actions to perform on each page before scraping.
array
Desired output formats for the scraped content. Defaults to [‘markdown’].
object
Custom HTTP headers to send with each request.
integer
Request timeout in milliseconds.
integer
Delay in milliseconds before content retrieval. Useful for pages with dynamic content. Defaults to 0.
object
Webhook configuration for batch scrape notifications
boolean
If true, block advertisements during scraping. Defaults to true.
object
Location settings for the request
array
HTML tags to specifically exclude from the output.
array
HTML tags to specifically include in the output.
boolean
If true, store scraped content in cache for future use. Defaults to true.
integer
Maximum number of concurrent scrape operations. Controls how many URLs are scraped simultaneously.
boolean
If true, extract only the main content, excluding headers, footers, navigation bars, and ads. Defaults to true.
boolean
If true, skip invalid URLs instead of failing the entire batch. Defaults to true.
boolean
If true, do not retain any scraped data. Defaults to false.
boolean
If true, remove base64-encoded images from the scraped content. Defaults to true.
boolean
If true, skip TLS certificate verification. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_BATCH_SCRAPE_CANCELTool 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

string
required
The unique identifier (UUID) of the batch scrape job to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_BATCH_SCRAPE_GETRetrieves 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

string
required
The ID of the batch scrape job. Must be a valid UUID format obtained when the batch scrape was initiated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_BATCH_SCRAPE_GET_ERRORSTool 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

string
required
Unique identifier (UUID) of the batch scrape job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_BENZINGA_CALENDAR_CONSENSUS_RATINGSUse 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

number
Records to return. Limit 1000.
boolean
Collapse the aggregate to BUY, HOLD and SELL rather than the five-step scale.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string ("number" | "percentage")
Whether each rating bucket is reported as a count of analysts or as a percentage of them.
string
Latest date, YYYY-MM-DD.
string
Exactly one ticker symbol to aggregate for; the endpoint takes a single ticker, not a list. Call once per company.
string
Earliest date, YYYY-MM-DD.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_BENZINGA_CALENDAR_MERGERS_ACQUISITIONSUse 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

number
Zero-based page offset, capped at 100000. Prefer narrowing by date over paging deep.
number
Number of records to return, limit 1000.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
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.
string
Latest date, YYYY-MM-DD, interpreted against date_sort.
string
Comma-separated ticker symbols, maximum 50. Set this when the caller asks whether a named company is acquiring or being acquired.
number
Unix timestamp in UTC; returns only records updated at or after it. Set this when polling for changes since a previous call.
string
Earliest date, YYYY-MM-DD, interpreted against 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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_BENZINGA_CALENDAR_RATINGSUse 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

number
Page offset, 0 to 100000.
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.
number
Records to return. Limit 1000.
boolean
Collapse ratings to standardized categories.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
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.
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.
string
Latest rating date, YYYY-MM-DD.
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.
string
Comma-separated ticker symbols, maximum 50.
number
Unix timestamp. Returns records updated at or after it, for polling deltas.
string
Earliest rating date, YYYY-MM-DD.
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_BENZINGA_CALENDAR_RATINGS_ANALYSTSUse 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

string
Firm identifier to restrict to. Set this to list only the analysts working at one research firm.
number
Page offset, limited to 0-100000. Set this only when walking past the first page of the analyst roster.
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.
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.
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.
number
Number of analysts to return, limit 1000. Raise it when you want the roster in one call rather than paging.
string
Firm name to match. Use it when the caller names the bank, for example Morgan Stanley, instead of supplying a firm id.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_BENZINGA_CALENDAR_RATINGS_FIRMSUse 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

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.
number
Page offset, limited to 0-100000. Set this only when paging past the first block of firms.
string
Comma-separated list of response fields to return. Set it when you only need id and name.
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.
number
Number of firms to return, limit 1000. Raise it to pull the whole firm list in one call.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_BENZINGA_CALENDAR_REMOVEDUse 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

number
Page offset, limited to 0-100000. Set this when walking a long backlog of removals.
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).
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.
number
Number of removal records to return, limit 1000.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_BENZINGA_NEWS_PRESS_RELEASESUse 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

string
A single day to query, yyyy-mm-dd. Use it instead of dateFrom and dateTo when the caller names one date.
string
Comma-separated ISINs, maximum 50. Use it when the caller identifies companies by ISIN rather than ticker.
number
Page offset, limited to 0-100000. Increase it to page past the first batch rather than widening the date range.
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.
string
Comma-separated CUSIPs, maximum 50; requires a license agreement. Use only when the caller supplies CUSIPs.
string
Latest publication date, yyyy-mm-dd. Pair it with dateFrom to bound a period.
string
Desired response format. Set text only when you want plain text rather than the default JSON structures.
string
Region filter, for example ‘ca’ or ‘canada’ for Canadian content. Set it when the caller scopes the question to a market.
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.
string
Comma-separated distributing wires, spelled as Benzinga does: PRNewswire, Globe Newswire, Business Wire, ACCESS Newswire, Newsfile. Set it to restrict to one wire.
string
Comma-separated ticker symbols, maximum 50. Set this whenever the caller names a company.
string
Earliest publication date, yyyy-mm-dd. Set it whenever the caller asks about a period rather than a single day.
number
Number of releases returned, maximum 100. Raise it when you want a full day of a company’s releases in one call.
string ("low" | "medium" | "high")
Importance level of the release. Set high when the caller only wants the market-moving releases.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
number
Unix timestamp in UTC; set it to your last sync time to pull only releases updated since then.
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.
string
Comma-separated primary ticker symbols. Use it instead of tickers when you want only releases whose primary subject is that company.
number
Unix timestamp in UTC; set it to pull and sort by releases published since that moment.
string ("and" | "or")
Logical operator for the topics query. Set and when every topic must appear, or leave as or to match any.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_BENZINGA_NEWS_REMOVEDUse 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

number
Page offset. Upstream caps pageSize multiplied by page at 10000, so narrow with updatedSince rather than paging deep.
number
Number of removal records returned, maximum 1000. Raise it when reconciling a backlog in one call.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
number
Unix timestamp in UTC; set it to the time of your last sync so you only receive removals recorded since then.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_BENZINGA_NEWS_SEARCHUse 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

string
A single day to query, yyyy-mm-dd. Use it instead of dateFrom and dateTo when the caller names one date.
string
Comma-separated ISINs, maximum 50. Use it when the caller identifies companies by ISIN rather than ticker.
number
Page offset, limited to 0-100000. Increase it to read past the first page of results rather than widening the date range.
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.
string
Comma-separated CUSIPs, maximum 50; requires a license agreement. Use only when the caller supplies CUSIPs.
string
Latest publication date, yyyy-mm-dd. Pair it with dateFrom to bound a period.
string
Desired response format. Set text only when you want plain text rather than the default JSON structures.
string
Region filter, for example ‘ca’ or ‘canada’ for Canadian content. Set it when the caller scopes the question to a market.
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.
string
Comma-separated authors. Set it to restrict to a particular desk or writer.
string
Comma-separated ticker symbols, maximum 50. Set this whenever the caller names a company.
string
Comma-separated Benzinga channels to restrict to, for example Earnings or Analyst Ratings.
string
Earliest publication date, yyyy-mm-dd. Set it whenever the caller asks about a period rather than a single day.
number
Stories to return, maximum 100. Raise it when you want a full day of coverage in one call.
string
Importance level filter. Set it when the caller only wants the market-moving stories.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
number
Unix timestamp in UTC; set it to your last sync time to pull only stories updated since then.
string
Comma-separated content types. Set it when you need to keep the feed to a specific content type.
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.
number
Importance rank from 1 to 5. Set a low number to keep only the highest-ranked stories.
string
Comma-separated primary ticker symbols. Use it instead of tickers when you want only stories whose primary subject is that company.
number
Unix timestamp in UTC; set it to pull and sort by stories published since that moment.
string ("and" | "or")
Logical operator for the topics query. Set and when every topic must appear, or leave as or to match any.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_BENZINGA_NEWS_WIIMSUse 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

string
A single day to query, yyyy-mm-dd. Use it when the caller asks why a stock moved on a specific date.
string
Comma-separated ISINs, maximum 50. Use when the caller identifies companies by ISIN.
number
Page offset, limited to 0-100000. Increase it to page further back rather than widening the date range.
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.
string
Comma-separated CUSIPs, maximum 50; requires a license agreement.
string
Latest publication date, yyyy-mm-dd. Pair it with dateFrom to bound a period.
string
Desired response format. Set text only when you want plain text rather than JSON structures.
string
Region filter, for example ‘ca’ or ‘canada’ for Canadian content.
string
Comma-separated words or phrases matched against title, tags and body in that order of priority.
string
Comma-separated authors. Set it to restrict to a particular desk.
string
Comma-separated ticker symbols, maximum 50. Set this whenever the caller names a company.
string
Earliest publication date, yyyy-mm-dd. Set it when the caller asks about a period.
number
Number of WIIM items returned, maximum 100. Raise it when scanning a whole session’s movers.
string
Importance level filter. Set it when the caller wants only the more significant move explanations.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
number
Unix timestamp in UTC; set it to your last sync time to pull only items updated since then.
string
Comma-separated content types. Set it when you need to keep the feed to a specific content type.
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.
number
Importance rank from 1 to 5. Set a low number to keep only the highest-ranked items.
string
Comma-separated primary ticker symbols; use it to keep only items whose primary subject is that company.
number
Unix timestamp in UTC; set it to pull and sort by items published since that moment, which suits intraday polling.
string ("and" | "or")
Logical operator for the topics query. Set and when every topic must appear.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_BENZINGA_SIGNALS_OPTIONS_ACTIVITYUse 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

number
Page offset.
number
Records to return, limit 1000.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Benzinga id of one options-activity record. Set it to fetch a single signal you already hold the id for.
string
A single date, YYYY-MM-DD.
string
Latest date, YYYY-MM-DD.
string
Comma-separated ticker symbols, maximum 50.
number
Unix timestamp. Returns records updated at or after it.
string
Earliest date, YYYY-MM-DD.
string
Date field to sort on. The only documented value is date; set it to read a period in date order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_CRAWLInitiates 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

string
required
The base URL to start crawling from. This is the initial entry point for the web crawler.
integer
Delay in milliseconds between requests to avoid overwhelming the server
integer
Maximum number of pages to crawl. The crawl will stop once this limit is reached. Default is 10.
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.
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/’, maxDepth=1 crawls ‘/docs/api/’ and ‘/docs/api/something/’.
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/.
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/.
boolean
If true, the crawler will ignore any sitemap.xml found on the website.
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’.
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.
DEPRECATED: Use ‘crawlEntireDomain’ instead. If true, allows the crawler to navigate to pages that were linked from pages already visited (i.e., navigate ‘backwards’).
If true, allows the crawler to follow links that lead to external websites (different domains).
string
Proxy configuration for requests
integer
Maximum age in seconds for cached content. If content is older than this, it will be re-scraped
boolean
If true, emulate a mobile device when scraping
array
List of actions to perform on each page before scraping (e.g., clicking buttons, waiting)
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.
object
Custom HTTP headers to send with each request
integer
Timeout in milliseconds for each page request. Default is 30000ms (30 seconds)
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.
boolean
If true, ignore query parameters when determining if a URL has been visited
boolean
If true, block advertisements during scraping
object
Geolocation settings for the scraper
boolean
If true, attempt to parse PDF files encountered during crawling
array
A list of HTML tags to exclude from the scraped output. Content within these tags (and their children) will be removed before processing.
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.
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.
boolean
If true, store scraped content in cache for future use
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.
boolean
If true, remove base64-encoded images from the scraped content
boolean
If true, skip TLS certificate verification
object
Options for tracking changes between crawls

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_CRAWL_CANCELCancels 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

string
required
The unique identifier (UUID) of the crawl job to be canceled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_CRAWL_DELETETool 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

string
required
The unique identifier (UUID) of the crawl job to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_CRAWL_GETRetrieves 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

string
required
The ID of the crawl job to check status for. This is the UUID returned when the crawl was initiated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_CRAWL_GET_ERRORSTool 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

string
required
The unique identifier (UUID) of the crawl job to retrieve errors from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_CRAWL_LIST_ACTIVETool to retrieve all active crawl jobs for the authenticated team. Use when you need to see which crawl operations are currently running.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_CRAWL_PARAMS_PREVIEWPreview 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

string
required
The website address to be crawled. This is the target URL for which crawl parameters will be generated.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string
required
The base URL to start crawling from. This is the initial entry point for the web crawler.
integer
Delay in seconds between scrapes to respect website rate limits.
integer
Maximum number of pages to crawl. The crawl will stop once this limit is reached. Default is 10.
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.
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.
object
Webhook configuration for receiving real-time crawl updates.
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/.
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/.
integer
Maximum number of concurrent scrapes. If not specified, uses your team’s concurrency limit.
boolean
If true, allows the crawler to follow links to subdomains of the main domain.
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, /).
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.
boolean
If true, enables zero data retention for this crawl. Contact help@firecrawl.dev to enable this feature.
If true, allows the crawler to follow links that lead to external websites (different domains). Defaults to false.
string
Proxy configuration for requests
integer
Maximum age in milliseconds for cached content. If content is older than this, it will be re-scraped.
boolean
If true, emulate a mobile device when scraping
boolean
If true, do not re-scrape the same path with different (or no) query parameters
array
List of actions to perform on each page before scraping (e.g., clicking buttons, waiting)
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”}]
object
Custom HTTP headers to send with each request
array
List of parsers to use for specific content types (e.g., ‘pdf’)
integer
Timeout in milliseconds for each page request. Default is 30000ms (30 seconds)
integer
The duration in milliseconds to wait for page JavaScript to execute and content to load before scraping.
boolean
If true, block advertisements during scraping
object
Geolocation settings for the scraper
array
A list of HTML tags to exclude from the scraped output. Content within these tags will be removed.
array
A list of HTML tags to specifically include in the scraped output. Only content within these tags will be processed.
boolean
If true, store scraped content in cache for future use
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.
boolean
If true, remove base64-encoded images from the scraped content
boolean
If true, skip TLS certificate verification

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_CREDIT_USAGE_GETTool to get current team credit usage information. Use when you need to check remaining credits or billing period details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_CREDIT_USAGE_GET_HISTORICALTool 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

boolean
When enabled, breaks down usage by individual API key. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_DATALEGION_COMPANIES_ENRICH_BASEUse 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

string
Company name (fuzzy matching)
string
Company website domain (e.g., google.com)
string
Industry filter (used with name matching for better accuracy)
string
Company Legion ID (exact match)
boolean
If true, format text fields in title case (names, company names, locations). Raw fields, IDs, URLs, codes, and confidence fields are excluded.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Social profile URL (LinkedIn, Facebook, Crunchbase, X/Twitter, GitHub - will be normalized and detected)
string
LinkedIn company numeric ID
boolean
If true, pretty-print JSON response with indentation.
string
Stock ticker symbol (e.g., GOOGL)
string
Comma-separated list of fields to exclude from response. Applied after include_fields filter.
string
Comma-separated list of fields to include in response. If omitted, all fields are returned.
string ("high" | "moderate" | "low")
Minimum match confidence: ‘high’, ‘moderate’, or ‘low’
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_DATALEGION_COMPANIES_ENRICH_PREMIUMUse 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

string
Company name (fuzzy matching)
string
Company website domain (e.g., google.com)
string
Industry filter (used with name matching for better accuracy)
string
Company Legion ID (exact match)
boolean
If true, format text fields in title case (names, company names, locations). Raw fields, IDs, URLs, codes, and confidence fields are excluded.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Social profile URL (LinkedIn, Facebook, Crunchbase, X/Twitter, GitHub - will be normalized and detected)
string
LinkedIn company numeric ID
boolean
If true, pretty-print JSON response with indentation.
string
Stock ticker symbol (e.g., GOOGL)
string
Comma-separated list of fields to exclude from response. Applied after include_fields filter.
string
Comma-separated list of fields to include in response. If omitted, all fields are returned.
string ("high" | "moderate" | "low")
Minimum match confidence: ‘high’, ‘moderate’, or ‘low’
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_DATALEGION_PEOPLE_ENRICH_BASE_NO_CONTACTUse 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

string
City name
string
Email address (will be normalized)
string
Phone number (will be normalized to E.164)
string
State name or code
string
School name, website, or social URL
string
Full address string (will be parsed to extract city, state, postal_code, and country)
string
Company name, website, or social URL
string
Country name or code
string
Full name (will be normalized)
string
Job title
string
Last name (will be normalized)
string
Legion ID (exact match)
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.
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.
string
SHA-256 (64 chars), SHA-1 (40 chars), or MD5 (32 chars) hash of normalized email address (for privacy)
string
First name (will be normalized)
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Social profile URL (LinkedIn, Twitter/X, GitHub, Facebook - will be normalized and detected)
string
LinkedIn numeric ID
string
Postal/ZIP code
boolean
If true, pretty-print JSON response with indentation.
string
Comma-separated list of fields to exclude from response. Applied after include_fields filter.
string
Comma-separated list of fields to include in response. If omitted, all fields are returned.
string ("high" | "moderate" | "low")
Minimum match confidence level to include in results: ‘high’, ‘moderate’, or ‘low’. Matches below this threshold will be filtered out.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_DATALEGION_PEOPLE_ENRICH_BASE_WITH_CONTACTUse 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

string
City name
string
Email address (will be normalized)
string
Phone number (will be normalized to E.164)
string
State name or code
string
School name, website, or social URL
string
Full address string (will be parsed to extract city, state, postal_code, and country)
string
Company name, website, or social URL
string
Country name or code
string
Full name (will be normalized)
string
Job title
string
Last name (will be normalized)
string
Legion ID (exact match)
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.
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.
string
SHA-256 (64 chars), SHA-1 (40 chars), or MD5 (32 chars) hash of normalized email address (for privacy)
string
First name (will be normalized)
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Social profile URL (LinkedIn, Twitter/X, GitHub, Facebook - will be normalized and detected)
string
LinkedIn numeric ID
string
Postal/ZIP code
boolean
If true, pretty-print JSON response with indentation.
string
Comma-separated list of fields to exclude from response. Applied after include_fields filter.
string
Comma-separated list of fields to include in response. If omitted, all fields are returned.
string ("high" | "moderate" | "low")
Minimum match confidence level to include in results: ‘high’, ‘moderate’, or ‘low’. Matches below this threshold will be filtered out.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_DATALEGION_PEOPLE_ENRICH_PREMIUM_NO_CONTACTUse only when the caller explicitly requests premium Data Legion person enrichment without personal contact data. Otherwise use the base no-contact action.

Input Parameters

string
City name
string
Email address (will be normalized)
string
Phone number (will be normalized to E.164)
string
State name or code
string
School name, website, or social URL
string
Full address string (will be parsed to extract city, state, postal_code, and country)
string
Company name, website, or social URL
string
Country name or code
string
Full name (will be normalized)
string
Job title
string
Last name (will be normalized)
string
Legion ID (exact match)
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.
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.
string
SHA-256 (64 chars), SHA-1 (40 chars), or MD5 (32 chars) hash of normalized email address (for privacy)
string
First name (will be normalized)
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Social profile URL (LinkedIn, Twitter/X, GitHub, Facebook - will be normalized and detected)
string
LinkedIn numeric ID
string
Postal/ZIP code
boolean
If true, pretty-print JSON response with indentation.
string
Comma-separated list of fields to exclude from response. Applied after include_fields filter.
string
Comma-separated list of fields to include in response. If omitted, all fields are returned.
string ("high" | "moderate" | "low")
Minimum match confidence level to include in results: ‘high’, ‘moderate’, or ‘low’. Matches below this threshold will be filtered out.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_DATALEGION_PEOPLE_ENRICH_PREMIUM_WITH_CONTACTUse 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

string
City name
string
Email address (will be normalized)
string
Phone number (will be normalized to E.164)
string
State name or code
string
School name, website, or social URL
string
Full address string (will be parsed to extract city, state, postal_code, and country)
string
Company name, website, or social URL
string
Country name or code
string
Full name (will be normalized)
string
Job title
string
Last name (will be normalized)
string
Legion ID (exact match)
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.
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.
string
SHA-256 (64 chars), SHA-1 (40 chars), or MD5 (32 chars) hash of normalized email address (for privacy)
string
First name (will be normalized)
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Social profile URL (LinkedIn, Twitter/X, GitHub, Facebook - will be normalized and detected)
string
LinkedIn numeric ID
string
Postal/ZIP code
boolean
If true, pretty-print JSON response with indentation.
string
Comma-separated list of fields to exclude from response. Applied after include_fields filter.
string
Comma-separated list of fields to include in response. If omitted, all fields are returned.
string ("high" | "moderate" | "low")
Minimum match confidence level to include in results: ‘high’, ‘moderate’, or ‘low’. Matches below this threshold will be filtered out.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_DEEP_RESEARCHInitiates 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

string
required
The research question or topic to investigate. Provide a clear, specific question or topic for best results.
array
Output format list. Set to [“json”] to get structured JSON output. When using “json” format, you must also provide jsonOptions.
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).
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.
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.
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.
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_EXTRACTExtracts 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

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.
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.
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.
boolean
When true, the sources used to extract the data will be included in the response as sources key.
boolean
Bypasses sitemap.xml during scanning.
object
Advanced scraping configuration.
If True, allows crawling links outside initial domains in urls; if False, restricts to same domains.
boolean
Proceeds with valid URLs, returning invalid ones separately.
boolean
Extends scanning to subdomains.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_EXTRACT_GETTool 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

string
required
The unique identifier (UUID format) of the extract job to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_COMPANY_LISTCall 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

boolean
Return a slimmer row: fewer descriptors per company, for when the list is only being used to resolve identifiers.
number
Page number, 1-indexed.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_COMPANY_PROFILECall 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

string
SEC Central Index Key. Use when a company has no ticker, or after a rename.
string
OpenFIGI identifier of the security. Licensed identifier.
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.
string
ISIN of the security. Licensed identifier.
string
CUSIP of the security. Licensed identifier.
string
Ticker symbol, for example MSFT. Only unique within an exchange, so pass exchange with it.
string
Exchange code for ticker, for example NASDAQ, or a MIC code for a non-US/CA listing.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_COMPANY_SEGMENTS_AND_KPISCall 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

string
SEC Central Index Key. Use when a company has no ticker, or after a rename.
string
OpenFIGI identifier of the security. Licensed identifier.
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.
string
ISIN of the security. Licensed identifier.
string
CUSIP of the security. Licensed identifier.
string
Ticker symbol, for example MSFT. Only unique within an exchange, so pass exchange with it.
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.
string
Exchange code for ticker, for example NASDAQ, or a MIC code for a non-US/CA listing.
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.
array
Comma-separated period filter: annual, quarterly, semi-annual, ltm, ytd, latest. Defaults to annual.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_COMPANY_SHARES_OUTSTANDINGCall 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

string
SEC Central Index Key. Use when a company has no ticker, or after a rename.
string
OpenFIGI identifier of the security. Licensed identifier.
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.
string
ISIN of the security. Licensed identifier.
string
CUSIP of the security. Licensed identifier.
string
Ticker symbol, for example MSFT. Only unique within an exchange, so pass exchange with it.
string
Exchange code for ticker, for example NASDAQ, or a MIC code for a non-US/CA listing.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_EVENTS_CALENDARCall 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

string
SEC Central Index Key. Use when a company has no ticker, or after a rename.
string
OpenFIGI identifier of the security. Licensed identifier.
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.
string
ISIN of the security. Licensed identifier.
number
Page number, 1-indexed. Spelled page here, where every other Fiscal.ai list takes pageNumber.
string
CUSIP of the security. Licensed identifier.
string
GICS sector, to restrict the calendar by industry.
string ("confirmed" | "estimated" | "projected" | "reported")
Restrict by event status: confirmed, estimated, projected or reported. See eventStatus for what each means.
string
Ticker symbol, for example MSFT. Only unique within an exchange, so pass exchange with it.
string
ISO country code of the headquarters, to restrict the calendar by geography.
string
Inclusive end of the event window, ISO 8601.
string
Exchange code for ticker, for example NASDAQ, or a MIC code for a non-US/CA listing.
number
Rows per page, up to 250. Defaults to 250; page for more.
string
Inclusive start of the event window, ISO 8601.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_EVENTS_IR_EVENTSCall 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

string
SEC Central Index Key. Use when a company has no ticker, or after a rename.
string
OpenFIGI identifier of the security. Licensed identifier.
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.
string
ISIN of the security. Licensed identifier.
string
CUSIP of the security. Licensed identifier.
string
Ticker symbol, for example MSFT. Only unique within an exchange, so pass exchange with it.
string
Exchange code for ticker, for example NASDAQ, or a MIC code for a non-US/CA listing.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_EVENTS_TRANSCRIPTCall 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

string
SEC Central Index Key. Use when a company has no ticker, or after a rename.
string
OpenFIGI identifier of the security. Licensed identifier.
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.
string
ISIN of the security. Licensed identifier.
string
CUSIP of the security. Licensed identifier.
string
Ticker symbol, for example MSFT. Only unique within an exchange, so pass exchange with it.
string
required
The q{quarter}-{year} key of the event, for example q3-2026, from the events/ir-events list.
string
Exchange code for ticker, for example NASDAQ, or a MIC code for a non-US/CA listing.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_FILINGS_LISTCall 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

string
SEC Central Index Key. Use when a company has no ticker, or after a rename.
string
OpenFIGI identifier of the security. Licensed identifier.
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.
string
ISIN of the security. Licensed identifier.
string
CUSIP of the security. Licensed identifier.
string
Ticker symbol, for example MSFT. Only unique within an exchange, so pass exchange with it.
string
Exchange code for ticker, for example NASDAQ, or a MIC code for a non-US/CA listing.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_FINANCIALS_ADJUSTED_METRICSCall 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

string
SEC Central Index Key. Use when a company has no ticker, or after a rename.
string
OpenFIGI identifier of the security. Licensed identifier.
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.
string
ISIN of the security. Licensed identifier.
string
CUSIP of the security. Licensed identifier.
string
Ticker symbol, for example MSFT. Only unique within an exchange, so pass exchange with it.
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.
string
Exchange code for ticker, for example NASDAQ, or a MIC code for a non-US/CA listing.
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.
array
Comma-separated period filter: annual, quarterly, semi-annual, ltm, ytd, latest. Defaults to annual.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_FINANCIALS_BALANCE_SHEETCall 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

string
SEC Central Index Key. Use when a company has no ticker, or after a rename.
string
OpenFIGI identifier of the security. Licensed identifier.
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.
string
ISIN of the security. Licensed identifier.
string
CUSIP of the security. Licensed identifier.
string
Ticker symbol, for example MSFT. Only unique within an exchange, so pass exchange with it.
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.
string
Exchange code for ticker, for example NASDAQ, or a MIC code for a non-US/CA listing.
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.
array
Comma-separated period filter: annual, quarterly, semi-annual, ltm, ytd, latest. Defaults to annual.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
boolean
Include which reporting templates each standardized metric belongs to.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_FINANCIALS_BALANCE_SHEET_AS_REPORTEDCall 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

string
SEC Central Index Key. Use when a company has no ticker, or after a rename.
string
OpenFIGI identifier of the security. Licensed identifier.
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.
string
ISIN of the security. Licensed identifier.
string
CUSIP of the security. Licensed identifier.
string
Ticker symbol, for example MSFT. Only unique within an exchange, so pass exchange with it.
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.
string
Exchange code for ticker, for example NASDAQ, or a MIC code for a non-US/CA listing.
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.
array
Comma-separated period filter: annual, quarterly, semi-annual, ltm, ytd, latest. Defaults to annual.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_FINANCIALS_CASH_FLOW_STATEMENTCall 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

string
SEC Central Index Key. Use when a company has no ticker, or after a rename.
string
OpenFIGI identifier of the security. Licensed identifier.
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.
string
ISIN of the security. Licensed identifier.
string
CUSIP of the security. Licensed identifier.
string
Ticker symbol, for example MSFT. Only unique within an exchange, so pass exchange with it.
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.
string
Exchange code for ticker, for example NASDAQ, or a MIC code for a non-US/CA listing.
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.
array
Comma-separated period filter: annual, quarterly, semi-annual, ltm, ytd, latest. Defaults to annual.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
boolean
Include which reporting templates each standardized metric belongs to.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_FINANCIALS_CASH_FLOW_STATEMENT_AS_REPORTEDCall 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

string
SEC Central Index Key. Use when a company has no ticker, or after a rename.
string
OpenFIGI identifier of the security. Licensed identifier.
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.
string
ISIN of the security. Licensed identifier.
string
CUSIP of the security. Licensed identifier.
string
Ticker symbol, for example MSFT. Only unique within an exchange, so pass exchange with it.
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.
string
Exchange code for ticker, for example NASDAQ, or a MIC code for a non-US/CA listing.
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.
array
Comma-separated period filter: annual, quarterly, semi-annual, ltm, ytd, latest. Defaults to annual.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_FINANCIALS_INCOME_STATEMENTCall 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

string
SEC Central Index Key. Use when a company has no ticker, or after a rename.
string
OpenFIGI identifier of the security. Licensed identifier.
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.
string
ISIN of the security. Licensed identifier.
string
CUSIP of the security. Licensed identifier.
string
Ticker symbol, for example MSFT. Only unique within an exchange, so pass exchange with it.
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.
string
Exchange code for ticker, for example NASDAQ, or a MIC code for a non-US/CA listing.
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.
array
Comma-separated period filter: annual, quarterly, semi-annual, ltm, ytd, latest. Defaults to annual.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
boolean
Include which reporting templates each standardized metric belongs to.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_FINANCIALS_INCOME_STATEMENT_AS_REPORTEDCall 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

string
SEC Central Index Key. Use when a company has no ticker, or after a rename.
string
OpenFIGI identifier of the security. Licensed identifier.
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.
string
ISIN of the security. Licensed identifier.
string
CUSIP of the security. Licensed identifier.
string
Ticker symbol, for example MSFT. Only unique within an exchange, so pass exchange with it.
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.
string
Exchange code for ticker, for example NASDAQ, or a MIC code for a non-US/CA listing.
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.
array
Comma-separated period filter: annual, quarterly, semi-annual, ltm, ytd, latest. Defaults to annual.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_FUND_LETTERS_COMPANIESCall to find which companies professional investors are actually writing about, and how heavily, before asking what they said.

Input Parameters

number
Rows per page, up to 250. Defaults to 250; page for more.
number
Page number, 1-indexed.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_FUND_LETTERS_COMPANYCall 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

string
SEC Central Index Key. Use when a company has no ticker, or after a rename.
string
OpenFIGI identifier of the security. Licensed identifier.
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.
string
ISIN of the security. Licensed identifier.
string
CUSIP of the security. Licensed identifier.
string
Ticker symbol, for example MSFT. Only unique within an exchange, so pass exchange with it.
string
Exchange code for ticker, for example NASDAQ, or a MIC code for a non-US/CA listing.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_FUND_LETTERS_DETAILCall 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

string
required
Letter id, from fund-letters/list.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_FUND_LETTERS_INVESTORCall 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

string
required
Investor id, from fund-letters/investors. Permanent.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_FUND_LETTERS_INVESTORSCall 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

number
Rows per page, up to 250. Defaults to 250; page for more.
number
Page number, 1-indexed.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_FUND_LETTERS_LISTCall 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

number
required
Calendar year of the reporting period, 2020 or later. Upstream refuses the call without it.
string
Restrict to one fund, by id.
number
Quarter, 1 to 4. Omit for the whole year.
number
Rows per page, up to 250. Defaults to 250; page for more.
string
Restrict to one investment firm, by id from fund-letters/investors.
number
Page number, 1-indexed.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_METRICS_RATIOS_LISTCall 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

string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_METRICS_STANDARDIZEDCall 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

string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_METRICS_STANDARDIZED_BY_TEMPLATECall 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

string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
required
Reporting template, for example standard. A company’s template is on its profile.
string ("income-statement" | "balance-sheet" | "cash-flow-statement")
required
Which statement to list metrics for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_OWNERSHIP_HOLDER_HOLDINGSCall 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

number
Calendar year of the reported quarter. Defaults to the latest reported.
number
Quarter, 1 to 4.
string
required
Institutional holder id, from ownership/holders-list or an institutional-holders row.
number
Rows per page, up to 250. Defaults to 250; page for more.
number
Page number, 1-indexed.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_OWNERSHIP_HOLDERS_LISTList institutions and their holder IDs in a paginated directory. The directory takes no company identifier.

Input Parameters

number
Rows per page, up to 250. Defaults to 250; page for more.
number
Page number, 1-indexed.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_OWNERSHIP_INSIDER_HOLDERSCall 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

string
SEC Central Index Key. Use when a company has no ticker, or after a rename.
string
OpenFIGI identifier of the security. Licensed identifier.
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.
string
ISIN of the security. Licensed identifier.
string
CUSIP of the security. Licensed identifier.
string
Ticker symbol, for example MSFT. Only unique within an exchange, so pass exchange with it.
string
Exchange code for ticker, for example NASDAQ, or a MIC code for a non-US/CA listing.
number
Rows per page, up to 250. Defaults to 250; page for more.
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.
number
Page number, 1-indexed.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
boolean
Include holders marked inactive. Hidden by default; holders removed by an analyst override stay hidden either way.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_OWNERSHIP_INSIDER_TRANSACTIONSCall 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

string
SEC Central Index Key. Use when a company has no ticker, or after a rename.
string
OpenFIGI identifier of the security. Licensed identifier.
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.
string
ISIN of the security. Licensed identifier.
string
CUSIP of the security. Licensed identifier.
string
Ticker symbol, for example MSFT. Only unique within an exchange, so pass exchange with it.
string
Exchange code for ticker, for example NASDAQ, or a MIC code for a non-US/CA listing.
number
Rows per page, up to 250. Defaults to 250; page for more.
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.
number
Page number, 1-indexed.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
boolean
Include holders marked inactive. Hidden by default; holders removed by an analyst override stay hidden either way.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_OWNERSHIP_INSTITUTIONAL_HOLDERSCall 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

string
SEC Central Index Key. Use when a company has no ticker, or after a rename.
string
OpenFIGI identifier of the security. Licensed identifier.
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.
string
ISIN of the security. Licensed identifier.
number
Calendar year of the reported quarter. Defaults to the latest reported.
string
CUSIP of the security. Licensed identifier.
string
Ticker symbol, for example MSFT. Only unique within an exchange, so pass exchange with it.
number
Quarter, 1 to 4. Pass with year to read a historical position rather than the latest.
string
Exchange code for ticker, for example NASDAQ, or a MIC code for a non-US/CA listing.
number
Rows per page, up to 250. Defaults to 250; page for more.
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.
number
Page number, 1-indexed.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_PRICES_DAILYCall 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

string
SEC Central Index Key. Use when a company has no ticker, or after a rename.
string
OpenFIGI identifier of the security. Licensed identifier.
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.
string
ISIN of the security. Licensed identifier.
string
CUSIP of the security. Licensed identifier.
boolean
Return only the most recent bar, ignoring the date window.
string
Ticker symbol, for example MSFT. Only unique within an exchange, so pass exchange with it.
string
Inclusive end date, ISO 8601.
string
Exchange code for ticker, for example NASDAQ, or a MIC code for a non-US/CA listing.
string
Inclusive start date, ISO 8601.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_PRICES_INTRADAYCall 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

string
SEC Central Index Key. Use when a company has no ticker, or after a rename.
string
OpenFIGI identifier of the security. Licensed identifier.
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.
string
ISIN of the security. Licensed identifier.
string
CUSIP of the security. Licensed identifier.
string
Ticker symbol, for example MSFT. Only unique within an exchange, so pass exchange with it.
string
Inclusive end date, ISO 8601.
string
Exchange code for ticker, for example NASDAQ, or a MIC code for a non-US/CA listing.
string
Inclusive start date, ISO 8601.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_PRICES_SPLITSCall 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

string
SEC Central Index Key. Use when a company has no ticker, or after a rename.
string
OpenFIGI identifier of the security. Licensed identifier.
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.
string
ISIN of the security. Licensed identifier.
string
CUSIP of the security. Licensed identifier.
string
Ticker symbol, for example MSFT. Only unique within an exchange, so pass exchange with it.
string
Exchange code for ticker, for example NASDAQ, or a MIC code for a non-US/CA listing.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_RATIOS_DAILYCall 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

string
SEC Central Index Key. Use when a company has no ticker, or after a rename.
string
OpenFIGI identifier of the security. Licensed identifier.
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.
string
ISIN of the security. Licensed identifier.
string
CUSIP of the security. Licensed identifier.
string
Ticker symbol, for example MSFT. Only unique within an exchange, so pass exchange with it.
string
required
Which ratio to return a daily series for. Only ratios whose hasDailyData is true have one.
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.
string
Exchange code for ticker, for example NASDAQ, or a MIC code for a non-US/CA listing.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FISCAL_AI_RATIOS_SERIESCall 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

string
SEC Central Index Key. Use when a company has no ticker, or after a rename.
string
OpenFIGI identifier of the security. Licensed identifier.
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.
string
ISIN of the security. Licensed identifier.
string
CUSIP of the security. Licensed identifier.
string
Ticker symbol, for example MSFT. Only unique within an exchange, so pass exchange with it.
string
Restrict to one ratio by id. Omit for every supported ratio. Ids come from metrics/ratios-list.
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.
string
Exchange code for ticker, for example NASDAQ, or a MIC code for a non-US/CA listing.
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.
array
Comma-separated period filter: annual, quarterly, semi-annual, ltm, ytd, latest. Defaults to annual.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FULLENRICH_COMPANIES_LOOKUPResolve one company from its domain, LinkedIn company URL, or LinkedIn company ID. Returns firmographics, technologies, social profiles, and locations.

Input Parameters

string
Company domain, such as fullenrich.com.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
number
LinkedIn company ID.
string
LinkedIn company URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FULLENRICH_COMPANIES_MATCHUse 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

string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
required
Canonical LinkedIn company URL, such as https://www.linkedin.com/company/fullenrich. Matched exactly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FULLENRICH_COMPANIES_SEARCHFind 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

number
Records per page, up to 6. Each returned record costs 5 credits. Use pagination for more.
array
Company names. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
Company types, such as Public Company or Nonprofit. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
number
Records to skip. Use search_after beyond 10,000.
array
Company domains. Exact matching recommended. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
Keywords in company descriptions. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
Employee counts. Entries: { min?, max?, exclude? }; at least one inclusive bound.
array
Company industries. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
array
FullEnrich company IDs. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
Company specialties. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
string
Cursor from the previous response’s metadata.search_after. Keep the same filters.
array
Technologies used by the company. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
Founding years. Entries: { min?, max?, exclude? }; at least one inclusive bound.
array
Headquarters cities, regions, or countries. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
LinkedIn company IDs. Entries: { value: number, exclude?: boolean, exact_match?: boolean }.
array
LinkedIn company URLs. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FULLENRICH_CONTACTS_MOBILEFind 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

string
Employer domain, such as fullenrich.com. Either this or company_name identifies the company.
string
Family name.
string
Given name. With last_name and a company, an alternative to linkedin_url.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Employer name, when the domain is not known.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FULLENRICH_CONTACTS_PERSONAL_EMAILFind 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

string
Employer domain, such as fullenrich.com. Either this or company_name identifies the company.
string
Family name.
string
Given name. With last_name and a company, an alternative to linkedin_url.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Employer name, when the domain is not known.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FULLENRICH_CONTACTS_REVERSE_EMAILIdentify 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

string
required
The work or personal email address to identify.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FULLENRICH_CONTACTS_WORK_EMAILFind 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

string
Employer domain, such as fullenrich.com. Either this or company_name identifies the company.
string
Family name.
string
Given name. With last_name and a company, an alternative to linkedin_url.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Employer name, when the domain is not known.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FULLENRICH_PEOPLE_LOOKUPResolve 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

string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Full name. Combine with a company identifier.
string
Employer domain, such as fullenrich.com.
number
LinkedIn profile ID.
number
Employer LinkedIn ID.
string
LinkedIn profile URL.
string
Employer LinkedIn URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_FULLENRICH_PEOPLE_MATCHUse 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

string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
required
Canonical LinkedIn profile URL, such as https://www.linkedin.com/in/jane-doe. Matched exactly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_GET_AGENT_STATUSTool 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

string
required
Unique identifier (UUID) of the agent job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_GET_DEEP_RESEARCH_STATUSRetrieves 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_GET_THE_STATUS_OF_A_CRAWL_JOBRetrieves the current status, progress, and details of a web crawl job, using the job ID obtained when the crawl was initiated.

Input Parameters

string
required
Unique identifier (UUID) of the crawl job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_LIST_INTERACT_SESSIONSList standalone Firecrawl Interact browser sessions, optionally by status.

Input Parameters

string ("active" | "destroyed")
Supported Interact session status values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_LIST_MONITOR_CHECKSList recent check runs for a Firecrawl monitor.

Input Parameters

integer
Maximum number of checks to return, from 1 through 100.
integer
Number of checks to skip before returning results.
string ("queued" | "running" | "completed" | "failed" | "partial" | "skipped_overlap" | "skipped_no_credits")
Return only checks in the selected provider status.
string
required
UUID of the monitor whose check history should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_LLMS_TXT_GENERATEInitiates 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

string
required
The URL to generate LLMs.txt from. Must be a valid URI format.
integer
Maximum number of URLs to analyze when generating the LLMs.txt file. Must be between 1 and 100. Default is 10.
boolean
Include full text content in the response. When true, generates both llmstxt and llmsfulltxt. Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_LLMS_TXT_GETTool 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

string
required
Unique identifier (UUID) of the LLMs.txt generation job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_MAP_MULTIPLE_URLS_BASED_ON_OPTIONSMaps 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 callDiscount: 79

Input Parameters

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’). Do NOT pass code snippets, SDK examples, or anything other than a plain URL.
integer
Maximum number of links to return. Defaults to 5000. Maximum allowed is 100000.
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.
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.
integer
Timeout in milliseconds. No timeout is applied by default.
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’]).
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.
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.
boolean
If true, excludes URLs with query parameters from results. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_ORIANE_INSTAGRAM_POST_LOOKUPResolve 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

string
required
Canonical Instagram /p/ or /reel/ URL. Short links are unsupported.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_ORIANE_INSTAGRAM_POSTS_SEARCHSearch 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

string
Comma-separated post sort fields with optional :asc or :desc: viewsCount, likesCount, sharesCount, commentsCount, interactionsCount, engagementRatePerViews, engagementRatePerFollowers, profileFollowersCount, publishedAt, visualSimilarity, transcriptRelevance.
number
Maximum results, default 20.
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.
number
Result offset, default 0.
string
Text to match in the caption. Provide this or another search field; multiple fields must all match.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Anchor from the first visual search page, required for subsequent pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_ORIANE_INSTAGRAM_PROFILE_LOOKUPPass 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

string
required
Canonical Instagram profile URL.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_ORIANE_INSTAGRAM_PROFILES_SEARCHSearch 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

string
Text to match in the bio. Provide this or another search field; multiple fields must all match.
string
Comma-separated profile sort fields with optional :asc or :desc: followersCount, createdAt, updatedAt.
number
Maximum results, default 20.
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.
number
Result offset, default 0. Exact handle searches return at most one profile and require offset 0; paginate displayName or bio searches instead.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Text to match in the display name. Provide this or another search field; multiple fields must all match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_ORIANE_TIKTOK_POSTS_SEARCHSearch 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

string
Comma-separated post sort fields with optional :asc or :desc: viewsCount, likesCount, sharesCount, commentsCount, interactionsCount, engagementRatePerViews, engagementRatePerFollowers, profileFollowersCount, publishedAt, visualSimilarity, transcriptRelevance.
number
Maximum results, default 20.
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.
number
Result offset, default 0.
string
Text to match in the caption. Provide this or another search field; multiple fields must all match.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Anchor from the first visual search page, required for subsequent pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_ORIANE_TIKTOK_PROFILE_LOOKUPPass 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

string
required
Canonical TikTok profile URL.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_ORIANE_TIKTOK_PROFILES_SEARCHSearch 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

string
Text to match in the bio. Provide this or another search field; multiple fields must all match.
string
Comma-separated profile sort fields with optional :asc or :desc: followersCount, createdAt, updatedAt.
number
Maximum results, default 20.
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.
number
Result offset, default 0. Exact handle searches return at most one profile and require offset 0; paginate displayName or bio searches instead.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Text to match in the display name. Provide this or another search field; multiple fields must all match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_ORIANE_TIKTOK_VIDEO_LOOKUPResolve 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

string
required
Canonical TikTok /@handle/video/ URL. Short links are unsupported.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_ADVERTISING_COMPANYUse 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

string
required
Company slug (for example nvidia), domain (nvidia.com), or id.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_ADVERTISING_COMPANY_OVERVIEWUse for a company’s podcast advertising footprint in one call, across all its brands. For the show list use advertising/company/shows.

Input Parameters

string
required
Company slug (for example nvidia), domain (nvidia.com), or id.
string
Only episodes published on or after this ISO 8601 date or date-time.
string
Only episodes published before this ISO 8601 date or date-time. A bare date covers that whole UTC day.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_ADVERTISING_COMPANY_PLACEMENTSUse for the feed of a company’s actual ad reads, episode by episode, to read or audit them.

Input Parameters

string
required
Company slug (for example nvidia), domain (nvidia.com), or id.
number
Maximum records to return.
string
Only episodes published on or after this ISO 8601 date or date-time.
string
Only episodes published before this ISO 8601 date or date-time. A bare date covers that whole UTC day.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Only placements on one show.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Only placements attributed to this sponsor, keeping co-sponsors in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_ADVERTISING_COMPANY_PROSPECTSUse as a buy-side prospect list: where an advertiser could go next, with the shows it already buys as the reason.

Input Parameters

string
required
Company slug (for example nvidia), domain (nvidia.com), or id.
number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Pass via to attach, per recommendation, the company’s own shows that led to it.
string
Only shows in this ISO 639-1 language.
number
Only recommendations at or above this score, within the 200 strongest.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_ADVERTISING_COMPANY_SHOWSUse for where a company advertises, ranked by volume, with the reads to sample. Pages are at most 24 rows.

Input Parameters

string
required
Company slug (for example nvidia), domain (nvidia.com), or id.
number
Rows per page. This endpoint caps at 24.
string
Only episodes published on or after this ISO 8601 date or date-time.
string
Only episodes published before this ISO 8601 date or date-time. A bare date covers that whole UTC day.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Only one show.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Narrow rows to this sponsor identity while keeping the company constraint.
string
Only one publisher’s shows.
number
Previews per show when previews are included.
boolean
Include exhaustive show and network filter metadata; honoured only without a cursor.
string ("true" | "false")
Include recent ad segment previews per show.
string ("true" | "false")
Include company-wide sponsor totals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_ADVERTISING_CO_OCCURRENCEUse for who a sponsor shares ad breaks with: the advertisers that buy the same inventory.

Input Parameters

number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Only pairs involving this company, by id, domain or entity slug.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Only pairs involving this sponsor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_ADVERTISING_EPISODEUse for exactly who advertised in one episode, with the offer and where in the episode the read sits.

Input Parameters

string
required
Episode slug or id.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_ADVERTISING_PUBLISHERUse for how a network is monetised and who buys across it. For its shows ranked by ad volume use advertising/publisher/shows.

Input Parameters

string
required
Publisher slug (for example iheartpodcasts, bbc-radio-4) or id, as carried on a podcast record’s publisher.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_ADVERTISING_PUBLISHER_SHOWSUse for which of a network’s shows carry the advertising. For the same catalogue by popularity use podcasts/publisher/shows.

Input Parameters

string
required
Publisher slug (for example iheartpodcasts, bbc-radio-4) or id, as carried on a podcast record’s publisher.
number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_ADVERTISING_PUBLISHERS_LEADERBOARDUse for which networks carry the most advertising, or monetise their catalogue most densely.

Input Parameters

number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
number
Only publishers with at least this many shows that have run an ad.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_ADVERTISING_PUBLISHER_SPONSORSUse for who buys a network, and which of them buy it as a bundle: sort by podcast_coverage with a minimum.

Input Parameters

string
required
Publisher slug (for example iheartpodcasts, bbc-radio-4) or id, as carried on a podcast record’s publisher.
string ("ad_count" | "podcast_coverage" | "episode_reach")
ad_count for volume, podcast_coverage for network buyers, episode_reach for breadth.
number
Maximum records to return.
string
Sponsor name, case-insensitive partial match.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
number
Only sponsors on at least this many of the publisher’s shows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_ADVERTISING_SHOWUse for who sponsors a show and how heavily it is monetised. For the full per-sponsor list use advertising/show/sponsors.

Input Parameters

string
required
Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_ADVERTISING_SHOW_PROSPECTSUse as a prospecting list for a show selling its own inventory: who buys shows like mine and has not bought me.

Input Parameters

string
required
Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
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.
number
Only recommendations at or above this score; band is the recommended filter.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Only sponsors whose most recent ad across the related shows is on or after this date.
number
Drop the N most active advertisers corpus-wide, which every list already names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_ADVERTISING_SHOW_SPONSORSUse 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

string
required
Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
number
Maximum records to return.
string
Only episodes published on or after this ISO 8601 date or date-time.
string
Only episodes published before this ISO 8601 date or date-time. A bare date covers that whole UTC day.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Only sponsors linked to this company: a multi-brand advertiser’s footprint on one show.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_ADVERTISING_SPONSOR_PUBLISHERSUse to tell network buys from per-show buys: a sponsor at 60 to 100 percent coverage of several publishers is buying bundles.

Input Parameters

string
required
Sponsor id, or a company slug, domain, or id: a company reference aggregates across every sponsor linked to it.
number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_ADVERTISING_SPONSOR_SEGMENTSUse to read the actual ad reads for a sponsor, then podcasts/segment/transcript for the words of one.

Input Parameters

string
required
Sponsor id, or a company slug, domain, or id: a company reference aggregates across every sponsor linked to it.
number
Maximum records to return.
string
Only episodes published on or after this ISO 8601 date or date-time.
string
Only episodes published before this ISO 8601 date or date-time. A bare date covers that whole UTC day.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Only ads on one show, by slug, id or Apple collection id.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_ADVERTISING_SPONSOR_SHOWSUse for where an advertiser buys: the canonical footprint of one sponsor, or of a whole company across its brands.

Input Parameters

string
required
Sponsor id, or a company slug, domain, or id: a company reference aggregates across every sponsor linked to it.
number
Maximum records to return.
string
Only episodes published on or after this ISO 8601 date or date-time.
string
Only episodes published before this ISO 8601 date or date-time. A bare date covers that whole UTC day.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_ADVERTISING_TIMESERIESUse 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

string ("day" | "week" | "month")
Bucket width. Weeks start on Monday; all buckets are UTC-aligned.
string
Company id, domain or entity slug; aggregates every sponsor linked to it.
string
Only placements on one show.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Sponsor id. Exactly one of sponsor_id or company_id.
string
Only placements on one publisher’s shows.
string
Inclusive start of the range. Omit for all time.
string
End of the range; a bare date covers the whole day. Defaults to now.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_BIAS_PUBLISHERUse for a network’s political profile as a whole: how political its catalogue is and which way it leans.

Input Parameters

string
required
Publisher slug (for example iheartpodcasts, bbc-radio-4) or id, as carried on a podcast record’s publisher.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_BIAS_PUBLISHERS_BY_BUCKETUse for which publishers carry the most shows of one lean: the flip of a publisher’s own bias profile.

Input Parameters

string ("count" | "share")
count ranks by shows in the bucket; share by their fraction of the analysed catalogue.
number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
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.
number
Only publishers with at least this many shows in the bucket.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string ("US" | "UK" | "EU" | "CANADA" | "AUSTRALIA" | "INDIA" | "OTHER" | "UNKNOWN")
Restrict the corpus to one political framework before aggregating.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_BIAS_PUBLISHER_SHOWSUse to list a network’s shows by political lean, or only the ones in a bucket.

Input Parameters

string
required
Publisher slug (for example iheartpodcasts, bbc-radio-4) or id, as carried on a podcast record’s publisher.
array
Only these buckets, comma-separated to match any, for example LEFT,LEANS_LEFT.
string ("lean_score" | "evaluated_at" | "name")
lean_score on the -3 to +3 scale, evaluated_at by recency, or name.
number
Maximum records to return.
string ("asc" | "desc")
Sort direction.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string ("US" | "UK" | "EU" | "CANADA" | "AUSTRALIA" | "INDIA" | "OTHER" | "UNKNOWN")
Restrict the corpus to one political framework before aggregating.
string ("true" | "false")
Include shows rated NOT_POLITICAL. Set false for political shows only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_BIAS_PUBLISHERS_LEADERBOARDUse for which networks lean furthest left or right, are most political, or most ideologically diverse.

Input Parameters

number
Maximum records to return.
string
Only analyses evaluated on or after this RFC 3339 timestamp.
string
Only analyses evaluated before this RFC 3339 timestamp.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string ("US" | "UK" | "EU" | "CANADA" | "AUSTRALIA" | "INDIA" | "OTHER" | "UNKNOWN")
Restrict the corpus to one political framework before aggregating.
number
Only publishers with at least this many analysed shows.
number
Only publishers with at least this many political shows; applies to score and diversity metrics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_BIAS_SHOWUse 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

string
required
Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_CHARTS_CHARTUse 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

string ("rank" | "acceleration")
rank as published, or acceleration to reorder by each entry’s growth multiple, fastest first.
number
Ranked entries to return from rank 1 down.
string ("7d" | "24h")
Measurement window of the edition. Composite charts (all, all-entertainment, all-sports) publish 7d only.
array
Optional sections, comma-separated: timeseries for each entry’s daily history, driven_by for the entry whose coverage drives a derivative one.
string
required
Chart identifier from charts/list, for example all, tv-series, movies, video-games, guests.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_CHARTS_LISTUse 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

string ("7d" | "24h")
Measurement window of the edition. Composite charts (all, all-entertainment, all-sports) publish 7d only.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_COMPANIES_COMPETITORSUse for a company’s competitive set with the reason each one is on it, before comparing their podcast presence or advertising.

Input Parameters

string
required
Company slug (for example nvidia), domain (nvidia.com), or id.
number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_COMPANIES_PEOPLEUse to find executives and role holders at a company, or the marketing, brand and partnerships contacts a sponsorship conversation would go to.

Input Parameters

string
required
Company slug (for example nvidia), domain (nvidia.com), or id.
string ("marketing" | "brand" | "partnerships" | "media_advertising" | "communications" | "growth" | "executive" | "other")
Only people in this contact role class, the ones a sponsorship pitch would reach.
number
Maximum records to return.
string
Case-insensitive substring of the role title, for example chief or founder.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string ("true" | "false")
Only people currently in a role there. Set false to include past roles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_COMPANIES_PRODUCTSUse 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

string
required
Company slug (for example nvidia), domain (nvidia.com), or id.
array
Lifecycle statuses to include, comma-separated. Default active.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_COMPANIES_SEARCHUse 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

string
SEC CIKs, comma-separated.
string
Bulk get: comma-separated slugs, domains or ids, up to 100. Other filters and paging are ignored when set.
string
Wikidata QIDs, comma-separated.
number
Maximum records to return.
string
Company name, case-insensitive partial match.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Company domains, comma-separated.
string
Stock ticker symbols, comma-separated.
string
Knowledge-graph entity slugs or ids, comma-separated.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Only companies updated after this ISO 8601 date or date-time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_ENTITIES_GETResolve 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

string
required
Entity slug (sam-altman, apple) or id. A person slug also resolves, to that person’s linked entity.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_ENTITIES_LISTUse 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

string
Bulk get: comma-separated entity slugs or ids, up to 100. Other filters and paging are ignored when set; unresolved refs are omitted.
string
Only this entity category slug, from entities/types: person, company, movie, sports-team.
number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Only entities appearing in this show, by slug, id or Apple collection id.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_ENTITIES_LOOKUPUse 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

string ("person" | "company")
Restrict to people or companies.
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.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_ENTITIES_SEARCHUse 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

string ("person" | "company" | "knowledge_graph_entity")
Restrict to one kind. Omit to search people, companies and knowledge-graph entities together.
number
Maximum records to return.
string
required
A name, partial name, nickname, stock ticker, @handle or website domain: sam altman, coca cola, AAPL, @sama, apple.com.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_ENTITIES_TOPICUse 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

string
required
Topic id, ancestry slug (technology/artificial-intelligence) or path hash.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_ENTITIES_TOPICSUse 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

number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Only children of this topic, by id, ancestry slug or path hash. Omit for the top-level roots.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Only the topic with exactly this path hash.
string
Only descendants under this path prefix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_ENTITIES_TYPESUse to see what the type filter on entities/list can take. Skip it when listing without a filter.

Input Parameters

number
Maximum records to return. Omit for all of them.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PEOPLE_GUESTUse 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

string
required
Person slug (recommended), the person’s knowledge-graph entity slug, or the encoded person id.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PEOPLE_GUEST_APPEARANCESUse 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

string
required
Person slug (recommended), the person’s knowledge-graph entity slug, or the encoded person id.
number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Only appearances on episodes under this topic.
string
Only appearances on one show.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Only episodes published after this ISO 8601 date or date-time.
string
Only episodes published before this ISO 8601 date or date-time.
number
Only appearances with at least this much identified speaking time.
string ("SAFE" | "LIMITED" | "SENSITIVE" | "UNSAFE")
Only appearances on podcasts at or below this IAB Tech Lab brand-suitability tier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PEOPLE_GUEST_PITCH_LISTUse 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

string
required
Person slug (recommended), the person’s knowledge-graph entity slug, or the encoded person id.
number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Pass via to attach, per recommendation, the person’s own shows that led to it.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PEOPLE_GUESTSUse 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

string ("appearances" | "recency")
appearances (default) or recency.
number
Maximum records to return.
string
Case-insensitive substring of the guest’s display name.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Only guests with an appearance on an episode under this topic.
string
Only guests who have appeared on this show.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Only guests with an appearance published on or after this ISO 8601 date.
number
Only guests with at least this many lifetime appearances.
string ("SAFE" | "LIMITED" | "SENSITIVE" | "UNSAFE")
Only appearances on podcasts at or below this IAB Tech Lab brand-suitability tier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PEOPLE_GUEST_SHOWSUse for the set of shows behind a guest rather than the episodes: which shows book them and how often.

Input Parameters

string
required
Person slug (recommended), the person’s knowledge-graph entity slug, or the encoded person id.
number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PEOPLE_PROFILERetrieve a person’s profile by person slug, knowledge-graph entity slug, or encoded person ID, including available work history and profile links.

Input Parameters

string
required
Person slug (recommended), the person’s knowledge-graph entity slug, or the encoded person id.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PEOPLE_SHOW_GUESTSUse for who has been on a show and how often. For who it could book next use people/show-recommended-guests.

Input Parameters

string
required
Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PEOPLE_SHOW_RECOMMENDED_GUESTSUse as a booking pipeline for a show: guests its peers chose that it has not had yet.

Input Parameters

string
required
Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Pass via to attach, per recommended guest, the related shows that booked them.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_CLIPUse when a segment needs to be cited as a playable range rather than as text. For its words call podcasts/clip/transcript.

Input Parameters

string
required
Clip id, from a search match’s clips or a clip list.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_CLIPSUse 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

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.
number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Only clips whose primary speaker is this person, by person slug, entity slug or id.
string
Only clips from one episode.
string
Only clips from one show.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
number
Minimum engagement potential, 0 to 100; above 70 is a strong clip.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_CLIP_TRANSCRIPTUse to quote a clip verbatim with speaker labels, or export it as subtitles with format srt.

Input Parameters

string
required
Clip id.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_EPISODEUse 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

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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_EPISODE_CLIPSUse for the quotable moments of an episode as bounded, playable ranges with a kind and a speaker.

Input Parameters

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.
number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_EPISODE_ENTITIESUse 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

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.
number
Maximum records to return. Omit for all of them.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_EPISODE_SEGMENTSUse 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

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.
number
Maximum records to return. Omit for all of them.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_EPISODES_FEEDUse 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

number
Maximum records to return.
string
ISO 8601 start when no cursor is supplied. Omit both to start from now.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
array
Heavy relations to embed per episode, comma-separated: transcript, segments, clips, or all. Only valid when the milestone guarantees the data.
string ("discovered" | "transcribed" | "segmented" | "fully_ingested")
Deliver episodes once they reach this ingestion stage; ordered discovered, transcribed, segmented, fully_ingested.
string
Topics to follow, comma-separated slug paths (sports/football), ids or path hashes. A topic matches its descendants.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Shows to follow, comma-separated slugs or ids, at most 100.
number
Follow the most popular shows at or above this percentile, in (0, 1). The feed covers at most 100 shows in total.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_EPISODES_LISTUse 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

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.
number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
ISO 639-1 language code, for example en or fr. Matches the primary subtag, so fr covers fr-CA.
string
Episodes featuring this entity as a speaker or a mention, by slug (elon-musk, openai) or id.
string
Episodes where this person speaks, by person slug, entity slug or id. Works when the speaker has no knowledge-graph entity.
string
Episodes featuring this company, by slug, domain or id.
string
Restrict to one show, by slug, id or Apple collection id.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
number
Maximum length in seconds.
number
Minimum length in seconds.
boolean
Only episodes that reached the terminal ingestion milestone.
boolean
Only episodes with a completed transcript.
string
Only episodes published after this ISO 8601 date or date-time.
string
Only episodes published before this ISO 8601 date or date-time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_EPISODES_LOOKUPUse 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

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.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_EPISODE_SPEAKERSUse 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

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.
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.
number
Maximum records to return. Omit for all of them.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_EPISODES_SEARCHUse 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

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.
string ("relevance" | "recency")
relevance (default) or recency.
string ("INTRO" | "PERSONAL_BANTER" | "TOPIC_DISCUSSION" | "INTERVIEW" | "TRANSITION" | "AD" | "OUTRO")
Only segments of this type.
number
Maximum records to return.
string
Only segments from episodes published after this date.
string
Only segments from episodes published on or before this date. A bare date covers the whole day.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
number
Lines of surrounding dialogue around each matched line. Widen this instead of fetching the transcript.
string
ISO 639-1 language code, for example en or fr. Matches the primary subtag, so fr covers fr-CA.
string
Restrict to episodes featuring this entity, by slug or id. Ranking still comes from the search terms.
string
Restrict to episodes featuring this company, by slug, domain or id.
string
Restrict to one episode, by slug or id.
string
Restrict to one show, by slug, id or Apple collection id.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Restrict to episodes that mention any entity of this category slug (company, school, book). Not combinable with role.
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.
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_EPISODES_TIMESERIESUse 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

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.
string ("day" | "week" | "month")
Bucket width. Weeks start on Monday; all buckets are UTC-aligned.
string
ISO 639-1 language code, for example en or fr. Matches the primary subtag, so fr covers fr-CA.
string
Episodes featuring this entity as a speaker or a mention, by slug (elon-musk, openai) or id.
string
Episodes where this person speaks, by person slug, entity slug or id. Works when the speaker has no knowledge-graph entity.
string
Episodes featuring this company, by slug, domain or id.
string
Restrict to one show, by slug, id or Apple collection id.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
number
Maximum length in seconds.
number
Minimum length in seconds.
boolean
Only episodes that reached the terminal ingestion milestone.
boolean
Only episodes with a completed transcript.
string
Count episodes whose transcripts contain these terms (quoted phrases exact). Adds per-bucket mention_count. Not combinable with semantic_search.
string
Only episodes published after this ISO 8601 date or date-time.
string
Count episodes whose transcripts match this meaning, at the search endpoint’s threshold. Requires published_after. Not combinable with keyword_search.
string
Only episodes published before this ISO 8601 date or date-time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_EPISODE_TOPICSUse to classify an episode by subject area, or to pick up a topic_id for filtering shows and episodes.

Input Parameters

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.
number
Maximum records to return. Omit for all of them.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_LISTUse 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

string
Exact slug of one show.
string ("relevance" | "popularity")
relevance ranks by match quality (the default with q); popularity orders by global popularity percentile.
number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string ("true" | "false")
true for shows with detected advertising, false for ad-free shows with enough analysed episodes to say so.
string
ISO 639-1 language code, for example en or fr. Matches the primary subtag, so fr covers fr-CA.
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.
string ("true" | "false")
Whether episodes have discovered video versions.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
array
Detected production formats, comma-separated to match any: interview, panel, call_in, solo_narrated.
array
How often episodes feature a guest, comma-separated to match any: for example regular,always for interview shows, never for shows without guests.
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.
string ("active" | "dormant")
active has released an episode in the last 90 days; dormant has not.
number
Only shows at or above this global popularity percentile, in (0, 1].
number
Only shows publishing at most this many episodes a week.
number
Only shows publishing at least this many episodes a week over the trailing 90 days.
number
Only shows whose average episode runs at most this many minutes.
number
Only shows whose average episode runs at least this many minutes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_LOOKUPUse 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

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.
string
required
One or more platform-native identifiers, comma-separated, up to 100 per call.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_MENTIONSFind 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

string ("guest" | "host" | "panelist" | "correspondent" | "mention")
Constrain how the entity participates.
string ("recency" | "popularity" | "favorites")
recency (default), popularity of the parent show, or favorites.
number
Episodes per page; each episode’s full set of windows arrives in one page.
string
Only episodes published after this date.
string
Only episodes published before this date.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
ISO 639-1 language code, for example en or fr. Matches the primary subtag, so fr covers fr-CA.
string
Entity slug (sam-altman) or id. A person slug also resolves; a person without a linked entity falls back to name matching.
string
Company slug, domain or id; resolves to its linked entity or falls back to name matching.
string
Only mentions inside one episode.
string
Only mentions inside one show.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
boolean
Include mentions inside ad reads, which are excluded by default.
string
Only mentions on one publisher’s shows, by slug or id.
number
Surrounding dialogue lines around each mention.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_MENTIONS_TIMESERIESUse 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

string ("guest" | "host" | "panelist" | "correspondent" | "mention")
Constrain how the entity participates.
string ("day" | "week" | "month")
Bucket width. Weeks start on Monday; all buckets are UTC-aligned.
string
ISO 639-1 language code, for example en or fr. Matches the primary subtag, so fr covers fr-CA.
string
Entity slug or id.
string
Company slug, domain or id.
string
Only mentions inside one show.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
boolean
Count mentions inside ad reads too.
string
Only mentions on one publisher’s shows.
string
Only episodes published on or after this date. Omit for all time.
string
Only episodes published on or before this date. Defaults to now.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_PUBLISHERUse 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

string
required
Publisher slug (for example iheartpodcasts, bbc-radio-4) or id, as carried on a podcast record’s publisher.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_PUBLISHERSUse to find a network’s slug by name before asking about its shows, advertising, bias or suitability.

Input Parameters

string ("podcast_count" | "name")
podcast_count ranks by catalogue size (default); name is alphabetical.
number
Maximum records to return.
string
Case-insensitive substring of the publisher’s name or slug; an exact name match sorts first.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_PUBLISHER_SHOWSUse to walk a network’s catalogue by audience. For the same catalogue ranked by ad volume use advertising/publisher/shows.

Input Parameters

string
required
Publisher slug (for example iheartpodcasts, bbc-radio-4) or id, as carried on a podcast record’s publisher.
number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_SEARCHUse 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

string ("relevance" | "popularity")
relevance ranks by match quality (the default with q); popularity orders by global popularity percentile.
number
Maximum records to return.
string
required
Show name, forgiving of typos, missing words and qualifiers (offline jon favreau, equity techcrunch).
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string ("true" | "false")
true for shows with detected advertising, false for ad-free shows with enough analysed episodes to say so.
string
ISO 639-1 language code, for example en or fr. Matches the primary subtag, so fr covers fr-CA.
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.
string ("true" | "false")
Whether episodes have discovered video versions.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
array
Detected production formats, comma-separated to match any: interview, panel, call_in, solo_narrated.
array
How often episodes feature a guest, comma-separated to match any: for example regular,always for interview shows, never for shows without guests.
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.
string ("active" | "dormant")
active has released an episode in the last 90 days; dormant has not.
number
Only shows at or above this global popularity percentile, in (0, 1].
number
Only shows publishing at most this many episodes a week.
number
Only shows publishing at least this many episodes a week over the trailing 90 days.
number
Only shows whose average episode runs at most this many minutes.
number
Only shows whose average episode runs at least this many minutes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_SEGMENTUse 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

string
required
Segment id, from a search match or a segment list.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_SEGMENTSUse 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

string ("INTRO" | "PERSONAL_BANTER" | "TOPIC_DISCUSSION" | "INTERVIEW" | "TRANSITION" | "AD" | "OUTRO")
Only this segment type.
number
Maximum records to return.
string
Only episodes published on or after this ISO 8601 date or date-time.
string
Only episodes published before this ISO 8601 date or date-time. A bare date covers that whole UTC day.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Only segments of one episode, by slug or id.
string
Only segments from one show, by slug, id or Apple collection id.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_SEGMENT_TRANSCRIPTUse to read the words of one segment in full and in order, at the price of a segment rather than an episode.

Input Parameters

string
required
Segment id.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_SHOWUse 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

string
required
Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
array
Optional sections, comma-separated: related (five most related shows), recommended_guests (five bookable guests), recommended_sponsors (five prospective advertisers; premium-grade).
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
number
How many aggregated topics to return; 0 for none.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_SHOW_EPISODESUse 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

string
required
Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
number
Maximum records to return.
string
Only episodes whose title contains this text, case-insensitively. Titles only; to search what was said use podcasts/episodes/search with podcast_id.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Only episodes published after this ISO 8601 date or date-time.
string
Only episodes published before this ISO 8601 date or date-time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_SHOW_FORMATUse 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

string
required
Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_SHOW_MENTIONSUse 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

string
required
Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
string ("guest" | "host" | "panelist" | "correspondent" | "mention")
Constrain how the entity participates.
number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Entity slug (sam-altman, openai) or id.
string
Company slug, domain or id; resolves to its linked entity.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Only episodes published after this ISO 8601 date or date-time.
string
Only episodes published before this ISO 8601 date or date-time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_SHOW_RATINGSUse to read what listeners wrote about a show. For the averages and histogram use podcasts/show/ratings-summary.

Input Parameters

string
required
Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
number
Maximum records to return.
string
Lower bound on posted_at, ISO 8601.
string
Upper bound on posted_at, ISO 8601.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Only one platform locale, for example the Apple storefront us.
number
Lower bound on the star rating.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Only ratings from one platform, for example apple.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_SHOW_RATINGS_SUMMARYUse for a show’s average rating and count per storefront, plus the combined figure and what recent reviews say in aggregate.

Input Parameters

string
required
Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_TOPICSUse 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

number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_TRANSCRIPTUse 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

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.
number
Clip to lines ending by this offset in seconds.
number
Clip to lines starting at this offset in seconds.
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.
string
Only lines from this speaker: a full or partial name, case-insensitive, or an entity id or slug.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_TRANSCRIPT_MENTIONSUse 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

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.
number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Entity id or slug. Omit to return mentions of every entity in the episode.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
number
Dialogue lines of context on each side of every mention line; adjacent windows merge.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_PODCASTS_TRANSCRIPT_PREVIEWUse 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

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.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_RANKINGS_CATEGORIESUse to find the category_slug the chart capabilities take.

Input Parameters

number
Maximum records to return. Omit for all of them.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string ("apple" | "spotify")
Ranking source platform.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_RANKINGS_CHARTSUse 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

number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string ("apple" | "spotify")
Ranking source platform.
string
ISO 3166-1 alpha-2 country code, for example us, gb, jp. Case-insensitive.
number
Highest-numbered rank to include.
number
Lowest-numbered rank to include.
string
Chart variant within the source. Only top_podcasts exists today.
string
Only this show’s current chart appearances across the matching slots.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Category slug, for example comedy or business. Omit for the overall chart.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_RANKINGS_COUNTRIESUse to find the country codes the chart capabilities take.

Input Parameters

number
Maximum records to return. Omit for all of them.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string ("apple" | "spotify")
Ranking source platform.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_RANKINGS_HISTORYUse 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

number
Maximum records to return.
string
Lower bound on captured_at, ISO 8601.
string
Upper bound on captured_at, ISO 8601.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string ("apple" | "spotify")
Ranking source platform.
string
ISO 3166-1 alpha-2 country code, for example us, gb, jp. Case-insensitive.
string
Chart variant within the source. Only top_podcasts exists today.
string
Only one show within the slot.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Category slug, for example comedy or business. Omit for the overall chart.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_RANKINGS_MOVERSUse for what debuted, climbed, fell or dropped off a chart since yesterday or over a window.

Input Parameters

number
Maximum records to return.
string ("all" | "up" | "down" | "new" | "exit")
Which changes: up, down, new debuts, exits, or all.
string ("apple" | "spotify")
Ranking source platform.
string
ISO 3166-1 alpha-2 country code, for example us, gb, jp. Case-insensitive.
string
Chart variant within the source. Only top_podcasts exists today.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
number
Compare against the snapshot this many days ago.
string
Category slug, for example comedy or business. Omit for the overall chart.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_RANKINGS_SHOWUse for where a show charts today, everywhere it charts. For a one-number summary use rankings/show/summary.

Input Parameters

string
required
Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
number
Maximum records to return. Omit for all of them.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_RANKINGS_SHOW_HISTORYUse for a show’s chart trajectory over time.

Input Parameters

string
required
Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
number
Maximum records to return.
string
Lower bound on captured_at, ISO 8601.
string
Upper bound on captured_at, ISO 8601.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string ("apple" | "spotify")
Ranking source platform.
string
ISO 3166-1 alpha-2 country code, for example us, gb, jp. Case-insensitive.
string
Chart variant within the source. Only top_podcasts exists today.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Category slug, for example comedy or business. Omit for the overall chart.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_RANKINGS_SHOW_SUMMARYUse for how big a show is on the charts in one call: its best rank and how widely it charts.

Input Parameters

string
required
Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_RANKINGS_SOURCESUse to check which chart sources exist and how fresh the snapshot is.

Input Parameters

number
Maximum records to return. Omit for all of them.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_SUITABILITY_CATEGORY_PUBLISHERSUse 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

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.
number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
string ("most_exposed" | "least_exposed")
most_exposed ranks by exposure share descending; least_exposed inverts it.
string ("DOCUMENTARY" | "EDITORIAL" | "PROMOTIONAL" | "GLAMORIZING")
With category: only count exposure whose treatment equals this value.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string ("INCIDENTAL" | "OCCASIONAL" | "FREQUENT" | "PERVASIVE")
With category: only count exposure at or above this prevalence. INCIDENTAL is any non-NONE prevalence.
number
Exclude publishers with fewer analysed shows than this.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_SUITABILITY_GUESTUse for what kind of shows a guest tends to appear on, in brand-safety terms.

Input Parameters

string
required
Person slug (recommended), the person’s knowledge-graph entity slug, or the encoded person id.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_SUITABILITY_PUBLISHERUse for how brand-safe a network’s catalogue is as a whole and where its exposure sits.

Input Parameters

string
required
Publisher slug (for example iheartpodcasts, bbc-radio-4) or id, as carried on a podcast record’s publisher.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_SUITABILITY_PUBLISHER_SHOWSUse to build an inclusion or exclusion list inside one network: its shows by tier, or the ones exposed in a category.

Input Parameters

string
required
Publisher slug (for example iheartpodcasts, bbc-radio-4) or id, as carried on a podcast record’s publisher.
string ("risk_desc" | "risk_asc" | "recently_evaluated")
risk_desc puts the riskiest first, risk_asc the safest, recently_evaluated the newest assessment.
array
Only these tiers, comma-separated to match any, for example UNSAFE,SENSITIVE.
number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
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.
string ("DOCUMENTARY" | "EDITORIAL" | "PROMOTIONAL" | "GLAMORIZING")
With category: only count exposure whose treatment equals this value.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string ("INCIDENTAL" | "OCCASIONAL" | "FREQUENT" | "PERVASIVE")
With category: only count exposure at or above this prevalence. INCIDENTAL is any non-NONE prevalence.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_SUITABILITY_PUBLISHERS_LEADERBOARDUse for the safest or riskiest networks to buy, or the most broadly placeable.

Input Parameters

number
Maximum records to return.
string
Opaque cursor from a previous page. Omit for the first page; send the same filters with it.
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.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
number
Only publishers with at least this many analysed shows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PARTICLE_SUITABILITY_SHOWUse 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

string
required
Podcast slug (for example all-in), Particle id, or numeric Apple collection id. Take slugs from responses; a constructed slug returns 404.
array
Optional sections, comma-separated: trend for the comparison against the prior assessment, history for the list of prior assessments.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PEOPLE_DATA_LABS_COMPANY_ENRICHUse 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

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.
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.
string
State or region, one value. Never sufficient on its own.
string
Stock ticker.
string
Country, one value. Never sufficient on its own.
string
Social profile URL, for example linkedin.com/company/google.
string
Company domain. The most reliable single identifier.
string
City, one value. Never sufficient on its own.
string
Free-form location. Raises the likelihood of a name match; never sufficient on its own.
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.
boolean
Return titlecased values. Responses are lowercase otherwise, which matters when the output is shown to a person rather than matched on.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Postal code, one value. Never sufficient on its own.
string
Comma-separated schema fields to return, dot notation for subfields, a leading - to exclude instead, "" for none. Use it to reduce response size.
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.
string
Street address, one value. Never sufficient on its own.
boolean
Return matching inputs: top-level matched for enrichment, or matched_on within Identify candidates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_PEOPLE_DATA_LABS_COMPANY_SEARCHSearch 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

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.
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.
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.
boolean
Return titlecased values. Responses are lowercase otherwise, which matters when the output is shown to a person rather than matched on.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_QUEUE_GETTool to retrieve metrics about the team’s scrape queue. Use when you need to check queue status, job counts, or concurrency limits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_SCRAPEScrapes 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 scrapedDiscount: 79

Input Parameters

string
required
The fully qualified URL of the web page to scrape. Must start with ‘http://’ or ‘https://’ and be a valid web URL.
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.
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.
integer
Maximum time in milliseconds to wait for the scraping request to complete. Defaults to 30000.
integer
Time in milliseconds to wait for the page to load or for dynamic content to render before starting the scrape. Defaults to 0.
object
Location settings for the request
array
A list of HTML tags to specifically exclude from the output. Content within these tags will be removed.
array
A list of HTML tags to specifically include in the output. Content within these tags will be prioritized.
object
Options for JSON extraction
boolean
If true, attempts to extract only the main article content, excluding headers, footers, navigation bars, and ads. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_SEARCHSearches 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 resultsDiscount: 79

Input Parameters

string
required
The search query to execute. Can be provided as ‘query’ or ‘q’.
string
Language code for search results (e.g., ‘en’ for English, default ‘en’).
integer
Maximum number of search results to return (1-100, default 5).
string
Country code to tailor search results (e.g., ‘us’ for United States, default ‘us’).
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.
integer
Maximum time in milliseconds for search and scrape operations (1000-300000, default 60000).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_SEARCH_PEOPLE_APOLLOSearch 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

integer
Page of results, from 1.
string
Free text matched across the person and their company.
integer
Results per page, maximum 100.
string
Optional Firecrawl idempotency key. Reuse the same value when retrying an ambiguous timeout to avoid a second paid execution.
array
Job titles to match, for example “VP of Sales”. Several titles widen the net.
array
Locations to restrict to, for example “San Francisco, US”.
array
Company domains to restrict to, for example firecrawl.dev.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_SEARCH_PEOPLE_FULLENRICHSearch 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 personDiscount: 79

Input Parameters

integer
Records per page, up to 6. Each returned record costs 5 credits. Use pagination for more.
integer
Records to skip. Use search_after beyond 10,000.
array
FullEnrich person IDs. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
string
Optional Firecrawl idempotency key. Reuse the same value when retrying an ambiguous timeout to avoid a second paid execution.
array
Person names. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
string
Cursor from the previous response’s metadata.search_after. Keep the same filters.
array
Professional skills. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
Languages spoken. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
Cities, regions, or countries. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
Previous employer names. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
Current employer FullEnrich IDs. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
Universities attended. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
Previous employer domains. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
Previous job titles. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
Current employer names. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
Company types, such as Public Company or Nonprofit. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
Current employer domains. Exact matching recommended. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
Current job titles. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
Years at the current employer. Entries: { min?, max?, exclude? }; at least one inclusive bound.
array
Years in the current position. Entries: { min?, max?, exclude? }; at least one inclusive bound.
array
Current employer employee counts. Entries: { min?, max?, exclude? }; at least one inclusive bound.
array
Current employer industries. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
Current employer specialties. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
Current employer headquarters locations. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
Technologies used by the current employer. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
Current employer founding years. Entries: { min?, max?, exclude? }; at least one inclusive bound.
array
Current job functions. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
Current job subfunctions. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
LinkedIn profile IDs. Entries: { value: number, exclude?: boolean, exact_match?: boolean }.
array
Seniority levels, such as Founder, VP, or Manager. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
LinkedIn profile URLs. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
Current employer LinkedIn IDs. Entries: { value: number, exclude?: boolean, exact_match?: boolean }.
array
Current employer LinkedIn URLs. Entries: { value: string, exclude?: boolean, exact_match?: boolean }.
array
Days since the last job change. Entries: { min?, max?, exclude? }; at least one inclusive bound.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_SIMILARWEB_CHANNELS_SHAREUse for marketing channel shares for one complete month. Subscription availability applies. The Similarweb-only monthly credit allowance applies.

Input Parameters

boolean
Ascending sort when true.
string
Response field to sort by.
number
Maximum records in this page; Exchange bounds pages to 100.
string
required
Lowercase bare domain without www. or a URL path.
number
Number of records to skip.
string
Two-letter lowercase country code or ww.
string
required
Same month as start_date, as YYYY-MM.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
required
Requested month as YYYY-MM; initial contract supports one complete month.
string ("desktop" | "mobile_web" | "total")
Device scope.
string
Monthly observations.
boolean
Exclude subdomains when true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_SIMILARWEB_CHANNELS_TRAFFICUse for marketing channel traffic for one complete month. Subscription availability applies. The Similarweb-only monthly credit allowance applies.

Input Parameters

string
required
Lowercase bare domain without www. or a URL path.
string
Two-letter lowercase country code or ww.
string
required
Same month as start_date, as YYYY-MM.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
required
Requested month as YYYY-MM; initial contract supports one complete month.
string ("desktop" | "mobile_web" | "total")
Device scope.
string
Monthly observations.
boolean
Exclude subdomains when true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_SIMILARWEB_WEB_GEOGRAPHYUse for traffic geography for one complete month. Subscription availability applies. The Similarweb-only monthly credit allowance applies.

Input Parameters

boolean
Ascending sort when true.
string
Response field to sort by.
number
Maximum records in this page; Exchange bounds pages to 100.
string
required
Lowercase bare domain without www. or a URL path.
number
Page number, starting at 1 per the endpoint documentation.
string
required
Comma-separated metrics: visits, rank, share.
string
required
Same month as start_date, as YYYY-MM.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
required
Requested month as YYYY-MM; initial contract supports one complete month.
string ("desktop" | "mobile_web" | "total")
Device scope.
string
Monthly observations.
boolean
Exclude subdomains when true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_SIMILARWEB_WEB_INCOMING_REFERRALSList 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

boolean
Ascending sort when true.
string
Response field to sort by.
number
Maximum records in this page; Exchange bounds pages to 100.
string
required
Lowercase bare domain without www. or a URL path.
number
Number of records to skip.
string
Two-letter lowercase country code or ww.
string
required
Same month as start_date, as YYYY-MM.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
required
Requested month as YYYY-MM; initial contract supports one complete month.
string ("desktop" | "mobile_web" | "total")
Device scope.
string
Monthly observations.
boolean
Exclude subdomains when true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_SIMILARWEB_WEB_REFERRALSList 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

boolean
Ascending sort when true.
string
Response field to sort by.
number
Maximum records in this page; Exchange bounds pages to 100.
string
required
Lowercase bare domain without www. or a URL path.
number
Page number, starting at 1 per the endpoint documentation.
string
Two-letter lowercase country code or ww.
string
required
Same month as start_date, as YYYY-MM.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
required
Requested month as YYYY-MM; initial contract supports one complete month.
string ("desktop" | "mobile_web" | "total")
Device scope.
string
Monthly observations.
string
Incoming referral traffic.
boolean
Exclude subdomains when true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_SIMILARWEB_WEB_TRAFFICUse for traffic and engagement for one complete month. Subscription availability applies. The Similarweb-only monthly credit allowance applies.

Input Parameters

string
required
Lowercase bare domain without www. or a URL path.
string
Two-letter lowercase country code or ww.
string
required
Comma-separated metrics: visits, average_visit_duration, pages_per_visit, bounce_rate, unique_visitors.
string
required
Same month as start_date, as YYYY-MM.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
required
Requested month as YYYY-MM; initial contract supports one complete month.
string ("desktop" | "mobile_web" | "total")
Device scope.
string
Monthly observations.
boolean
Exclude subdomains when true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_SIMILARWEB_WEB_WEBSITE_REFERRALS_OUTGOING_REFERRALSList 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

boolean
Orders the results by ascending or descending
string
Selects a specific metric to order results by
number
Sets how many results to return.
string
required
Enter website of interest, without ‘www.’ or brackets {}
number
Defines the number of results to skip
string
Two-letter country code (e.g., ‘us’, ‘gb’, ‘ww’)
string
End date in ‘YYYY-MM’ or ‘YYYY-MM-DD’ format or relative keywords: latest, X_months_ago, X_days_ago
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string
Start date in ‘YYYY-MM’ or ‘YYYY-MM-DD’ format or relative keywords: latest, X_months_ago, X_days_ago
string ("desktop" | "mobile_web" | "total")
The device/platform the traffic is coming from
string ("daily" | "monthly")
Time granularity for the returned values
boolean
True’ will include only the main domain, ‘false’ will include subdomains. Default is ‘false’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_START_AGENTTool 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

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.
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.
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.
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_STOP_SCRAPE_INTERACTIONStop a scrape job’s interactive browser session, releasing browser resources and finalizing duration-based billing.

Input Parameters

string
required
UUID of the scrape job whose interactive browser session should be stopped.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_TOKEN_USAGE_GETTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_TOKEN_USAGE_GET_HISTORICALTool 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

boolean
When enabled, breaks down usage by individual API key. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_UPSPRING_ADS_BREAKDOWNUse 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

array
Only ads with this funnel id (OR across values). Ids from taxonomy/vertical’s dimensions.
array
Only ads with this persona id (OR across values). Ids from taxonomy/vertical’s dimensions.
string
One category id within a vertical, from taxonomy/verticals.
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.
array
Vertical id(s), for example beverages or skincare. Ids come from taxonomy/verticals.
array
Only ads with this archetype id (OR across values). Ids from taxonomy/vertical’s dimensions.
string ("true" | "false")
true for ads running now, false for stopped ones. Omit for both.
array
Only ads with this mechanism id (OR across values). Ids from taxonomy/vertical’s dimensions.
array
Only ads that use this claim type (an ad can carry several). Ids from taxonomy/vertical’s dimensions.
array
Only ads with this media type id (OR across values). Ids from taxonomy/vertical’s dimensions.
array
Only ads with this offer type id (OR across values). Ids from taxonomy/vertical’s dimensions.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string ("true" | "false")
true for ads whose landing page has store data (price, vendor), false for ads without. Omit for both.
array
Only ads with this positioning id (OR across values). Ids from taxonomy/vertical’s dimensions.
number
Only ads first seen in the last N days (1 to 365).
array
Only ads from these advertiser ids.
array
Only ads that use this evidence type (an ad can carry several). Ids from taxonomy/vertical’s dimensions.
array
Only ads with this hook polarity id (OR across values). Ids from taxonomy/vertical’s dimensions.
array
Only ads with this hook archetype id (OR across values). Ids from taxonomy/vertical’s dimensions.
number
Winners-only floor on Meta’s 1 to 5 delivery-strength indicator. Excludes ads without one.
array
Only ads that use this persuasion technique (an ad can carry several). Ids from taxonomy/vertical’s dimensions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_UPSPRING_ADS_BROWSEUse 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

number
Ads per page, 1 to 100 (1 to 50 with include=descriptors). Default 25.
string
meta.next_cursor from the previous page, verbatim. Send the same filters with it; a cursor replayed with changed filters is refused.
array
Only ads with this funnel id (OR across values). Ids from taxonomy/vertical’s dimensions.
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}.
array
Only ads with this persona id (OR across values). Ids from taxonomy/vertical’s dimensions.
string
One category id within a vertical, from taxonomy/verticals.
string ("random" | "recent" | "best")
random (a fresh sample each call), recent, or best (performance-signal ranked).
array
Vertical id(s), for example beverages or skincare. Ids come from taxonomy/verticals.
array
Only ads with this archetype id (OR across values). Ids from taxonomy/vertical’s dimensions.
string ("true" | "false")
true for ads running now, false for stopped ones. Omit for both.
array
Only ads with this mechanism id (OR across values). Ids from taxonomy/vertical’s dimensions.
array
Only ads that use this claim type (an ad can carry several). Ids from taxonomy/vertical’s dimensions.
array
Only ads with this media type id (OR across values). Ids from taxonomy/vertical’s dimensions.
array
Only ads with this offer type id (OR across values). Ids from taxonomy/vertical’s dimensions.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string ("true" | "false")
true for ads whose landing page has store data (price, vendor), false for ads without. Omit for both.
array
Only ads with this positioning id (OR across values). Ids from taxonomy/vertical’s dimensions.
number
Only ads first seen in the last N days (1 to 365).
array
Only ads from these advertiser ids.
array
Only ads that use this evidence type (an ad can carry several). Ids from taxonomy/vertical’s dimensions.
array
Only ads with this hook polarity id (OR across values). Ids from taxonomy/vertical’s dimensions.
array
Only ads with this hook archetype id (OR across values). Ids from taxonomy/vertical’s dimensions.
number
Winners-only floor on Meta’s 1 to 5 delivery-strength indicator. Excludes ads without one.
array
Only ads that use this persuasion technique (an ad can carry several). Ids from taxonomy/vertical’s dimensions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_UPSPRING_ADS_DETAILUse 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

string
required
Ad id from an ads/search, ads/browse or ads/similar row.
array
Comma-separated deep blocks: scenes, transcript, overlays, narrative, full (those four), media (asset URLs, not part of full).
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_UPSPRING_ADS_SEARCHUse 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

number
Ads per page, 1 to 100 (1 to 50 with include=descriptors). Default 25.
string
required
Free-text brief, for example prebiotic soda or greens powder daily drink. Hybrid semantic and keyword match.
string
meta.next_cursor from the previous page, verbatim. Send the same filters with it; a cursor replayed with changed filters is refused.
array
Only ads with this funnel id (OR across values). Ids from taxonomy/vertical’s dimensions.
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}.
array
Only ads with this persona id (OR across values). Ids from taxonomy/vertical’s dimensions.
string
One category id within a vertical, from taxonomy/verticals.
array
Vertical id(s), for example beverages or skincare. Ids come from taxonomy/verticals.
array
Only ads with this archetype id (OR across values). Ids from taxonomy/vertical’s dimensions.
string ("true" | "false")
true for ads running now, false for stopped ones. Omit for both.
array
Only ads with this mechanism id (OR across values). Ids from taxonomy/vertical’s dimensions.
array
Only ads that use this claim type (an ad can carry several). Ids from taxonomy/vertical’s dimensions.
array
Only ads with this media type id (OR across values). Ids from taxonomy/vertical’s dimensions.
array
Only ads with this offer type id (OR across values). Ids from taxonomy/vertical’s dimensions.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
string ("true" | "false")
true for ads whose landing page has store data (price, vendor), false for ads without. Omit for both.
array
Only ads with this positioning id (OR across values). Ids from taxonomy/vertical’s dimensions.
number
Only ads first seen in the last N days (1 to 365).
array
Only ads from these advertiser ids.
array
Only ads that use this evidence type (an ad can carry several). Ids from taxonomy/vertical’s dimensions.
array
Only ads with this hook polarity id (OR across values). Ids from taxonomy/vertical’s dimensions.
array
Only ads with this hook archetype id (OR across values). Ids from taxonomy/vertical’s dimensions.
number
Winners-only floor on Meta’s 1 to 5 delivery-strength indicator. Excludes ads without one.
array
Only ads that use this persuasion technique (an ad can carry several). Ids from taxonomy/vertical’s dimensions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_UPSPRING_ADS_SIMILARUse to find ads creatively like one ad, from the same brand and from its competitors.

Input Parameters

string
required
Ad id from an ads/search, ads/browse or ads/similar row.
string
descriptors adds synopsis and long_form per ad.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_UPSPRING_ADVERTISERS_BRIEFUse 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

string
required
Advertiser id from advertisers/search, advertisers/by-domain or an ad’s advertiser.id. It is the brand’s Facebook page id.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_UPSPRING_ADVERTISERS_BY_DOMAINUse 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

string ("true" | "false")
true (default) waits a few seconds for a brand Upspring has to fetch; false answers pending at once.
string
required
Company domain or URL, for example mudwtr.com; normalized to the root domain.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_UPSPRING_ADVERTISERS_COMPAREUse to put two brands’ ad strategies side by side: where they overlap, where they differ, and what each leaves open.

Input Parameters

string
required
Advertiser id from advertisers/search, advertisers/by-domain or an ad’s advertiser.id. It is the brand’s Facebook page id.
string
required
The second advertiser’s id.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_UPSPRING_ADVERTISERS_PEERSUse for brands like this one: same category, vertical, geography or size band. For creative similarity instead use advertisers/similar.

Input Parameters

string
required
Advertiser id from advertisers/search, advertisers/by-domain or an ad’s advertiser.id. It is the brand’s Facebook page id.
number
Advertisers to return, 1 to 25. Default 10.
array
Comma-separated facets to share with this advertiser: vertical, category, geo, spend_tier, traffic_tier, sales_tier. Default category,spend_tier.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_UPSPRING_ADVERTISERS_REQUESTUse 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

string
required
Advertiser id from advertisers/search, advertisers/by-domain or an ad’s advertiser.id. It is the brand’s Facebook page id.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_UPSPRING_ADVERTISERS_SEARCHUse 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

string
Primary geography, for example US.
string
Fuzzy brand name, typo and accent tolerant.
number
Advertisers per page, 1 to 50. Default 25.
string
meta.next_cursor from the previous page, verbatim. Send the same filters with it; a cursor replayed with changed filters is refused.
string
Website: full URL, bare domain, name without TLD or a partial term.
string
Facebook page URL or numeric page id (exact); a vanity URL falls back to a name match.
number
Only advertisers with at least this many active ads.
string
One category id within a vertical, from taxonomy/verticals.
array
Vertical id(s), for example beverages or skincare. Ids come from taxonomy/verticals.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.
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.
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_UPSPRING_ADVERTISERS_SIMILARUse for a brand’s closest competitors: advertisers going after the same audience with comparable creative strategies.

Input Parameters

string
required
Advertiser id from advertisers/search, advertisers/by-domain or an ad’s advertiser.id. It is the brand’s Facebook page id.
number
Advertisers to return, 1 to 25. Default 10.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_UPSPRING_TAXONOMY_VERTICALUse, free, before filtering ads by persona, hook or another dimension: lists the valid ids in one vertical.

Input Parameters

string
required
Vertical id from taxonomy/verticals, for example beverages.
string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRECRAWL_UPSPRING_TAXONOMY_VERTICALSUse first, free, to learn the vertical and category ids the ads and advertiser filters accept.

Input Parameters

string
Optional Firecrawl idempotency key. Reuse it when retrying an ambiguous timeout to avoid a second paid execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not