# firecrawl OpenAPI overview

> Below is an overview of the firecrawl openapi in simple language. This API contains 23 endpoints.

For more detailed information of an endpoint, visit https://oapis.org/summary/firecrawl/[idOrRoute]

Firecrawl API v1.0.0 - https://api.firecrawl.dev
API for interacting with Firecrawl services to perform web scraping and crawling tasks.

## Billing

- [getCreditUsage](https://oapis.org/openapi/firecrawl/getCreditUsage): GET https://api.firecrawl.dev/team/credit-usage - Get remaining credits for the authenticated team
- [getTokenUsage](https://oapis.org/openapi/firecrawl/getTokenUsage): GET https://api.firecrawl.dev/team/token-usage - Get remaining tokens for the authenticated team (Extract only)

## Crawling

- [getCrawlStatus](https://oapis.org/openapi/firecrawl/getCrawlStatus): GET https://api.firecrawl.dev/crawl/{id} - Get the status of a crawl job
- [cancelCrawl](https://oapis.org/openapi/firecrawl/cancelCrawl): DELETE https://api.firecrawl.dev/crawl/{id} - Cancel a crawl job
- [getCrawlErrors](https://oapis.org/openapi/firecrawl/getCrawlErrors): GET https://api.firecrawl.dev/crawl/{id}/errors - Get the errors of a crawl job
- [crawlUrls](https://oapis.org/openapi/firecrawl/crawlUrls): POST https://api.firecrawl.dev/crawl - Crawl multiple URLs based on options
- [getActiveCrawls](https://oapis.org/openapi/firecrawl/getActiveCrawls): GET https://api.firecrawl.dev/crawl/active - Get all active crawls for the authenticated team

## Extraction

- [extractData](https://oapis.org/openapi/firecrawl/extractData): POST https://api.firecrawl.dev/extract - Extract structured data from pages using LLMs
- [getExtractStatus](https://oapis.org/openapi/firecrawl/getExtractStatus): GET https://api.firecrawl.dev/extract/{id} - Get the status of an extract job

## Feedback

- [submitEndpointFeedback](https://oapis.org/openapi/firecrawl/submitEndpointFeedback): POST https://api.firecrawl.dev/feedback - Submit feedback for a v2 job
- [submitSearchFeedback](https://oapis.org/openapi/firecrawl/submitSearchFeedback): POST https://api.firecrawl.dev/search/{jobId}/feedback - Submit feedback for a search job

## LLMs.txt

- [generateLLMsTxt](https://oapis.org/openapi/firecrawl/generateLLMsTxt): POST https://api.firecrawl.dev/llmstxt - Generate LLMs.txt for a website
- [getLLMsTxtStatus](https://oapis.org/openapi/firecrawl/getLLMsTxtStatus): GET https://api.firecrawl.dev/llmstxt/{id} - Get the status and results of an LLMs.txt generation job

## Mapping

- [mapUrls](https://oapis.org/openapi/firecrawl/mapUrls): POST https://api.firecrawl.dev/map - Map multiple URLs based on options

## Research

- [startDeepResearch](https://oapis.org/openapi/firecrawl/startDeepResearch): POST https://api.firecrawl.dev/deep-research - Start a deep research operation on a query
- [getDeepResearchStatus](https://oapis.org/openapi/firecrawl/getDeepResearchStatus): GET https://api.firecrawl.dev/deep-research/{id} - Get the status and results of a deep research operation

## Scraping

- [scrapeAndExtractFromUrl](https://oapis.org/openapi/firecrawl/scrapeAndExtractFromUrl): POST https://api.firecrawl.dev/scrape - Scrape a single URL and optionally extract information using an LLM
- [scrapeAndExtractFromUrls](https://oapis.org/openapi/firecrawl/scrapeAndExtractFromUrls): POST https://api.firecrawl.dev/batch/scrape - Scrape multiple URLs and optionally extract information using an LLM
- [getBatchScrapeStatus](https://oapis.org/openapi/firecrawl/getBatchScrapeStatus): GET https://api.firecrawl.dev/batch/scrape/{id} - Get the status of a batch scrape job
- [cancelBatchScrape](https://oapis.org/openapi/firecrawl/cancelBatchScrape): DELETE https://api.firecrawl.dev/batch/scrape/{id} - Cancel a batch scrape job
- [getBatchScrapeErrors](https://oapis.org/openapi/firecrawl/getBatchScrapeErrors): GET https://api.firecrawl.dev/batch/scrape/{id}/errors - Get the errors of a batch scrape job

## Search

- [searchAndScrape](https://oapis.org/openapi/firecrawl/searchAndScrape): POST https://api.firecrawl.dev/search - Search and optionally scrape search results
- [submitSearchFeedback](https://oapis.org/openapi/firecrawl/submitSearchFeedback): POST https://api.firecrawl.dev/search/{jobId}/feedback - Submit feedback for a search job