> ## Documentation Index > Fetch the complete documentation index at: https://firecrawl.web3doc.top/llms.txt > Use this file to discover all available pages before exploring further. # 抓取 ## OpenAPI ````yaml v1-openapi POST /scrape openapi: 3.0.0 info: title: Firecrawl API version: v1 description: >- API for interacting with Firecrawl services to perform web scraping and crawling tasks. contact: name: Firecrawl Support url: https://firecrawl.dev/support email: support@firecrawl.dev servers: - url: https://api.firecrawl.dev/v1 security: - bearerAuth: [] paths: /scrape: post: tags: - Scraping summary: Scrape a single URL and optionally extract information using an LLM operationId: scrapeAndExtractFromUrl requestBody: required: true content: application/json: schema: allOf: - type: object properties: url: type: string format: uri description: The URL to scrape required: - url - $ref: '#/components/schemas/ScrapeOptions' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ScrapeResponse' '402': description: Payment required content: application/json: schema: type: object properties: error: type: string example: Payment required to access this resource. '429': description: Too many requests content: application/json: schema: type: object properties: error: type: string example: >- Request rate limit exceeded. Please wait and try again later. '500': description: Server error content: application/json: schema: type: object properties: error: type: string example: An unexpected error occurred on the server. security: - bearerAuth: [] components: schemas: ScrapeOptions: type: object properties: formats: type: array items: type: string enum: - markdown - html - rawHtml - links - screenshot - screenshot@fullPage - json description: Formats to include in the output. default: - markdown onlyMainContent: type: boolean description: >- Only return the main content of the page excluding headers, navs, footers, etc. default: true includeTags: type: array items: type: string description: Tags to include in the output. excludeTags: type: array items: type: string description: Tags to exclude from the output. headers: type: object description: >- Headers to send with the request. Can be used to send cookies, user-agent, etc. waitFor: type: integer description: >- Specify a delay in milliseconds before fetching the content, allowing the page sufficient time to load. default: 0 mobile: type: boolean description: >- Set to true if you want to emulate scraping from a mobile device. Useful for testing responsive pages and taking mobile screenshots. default: false skipTlsVerification: type: boolean description: Skip TLS certificate verification when making requests default: false timeout: type: integer description: Timeout in milliseconds for the request default: 30000 jsonOptions: type: object description: Extract object properties: schema: type: object description: The schema to use for the extraction (Optional) systemPrompt: type: string description: The system prompt to use for the extraction (Optional) prompt: type: string description: The prompt to use for the extraction without a schema (Optional) actions: type: array description: Actions to perform on the page before grabbing the content items: oneOf: - type: object title: Wait properties: type: type: string enum: - wait description: Wait for a specified amount of milliseconds milliseconds: type: integer minimum: 1 description: Number of milliseconds to wait selector: type: string description: Query selector to find the element by example: '#my-element' required: - type - type: object title: Screenshot properties: type: type: string enum: - screenshot description: >- Take a screenshot. The links will be in the response's `actions.screenshots` array. fullPage: type: boolean description: Should the screenshot be full-page or viewport sized? default: false required: - type - type: object title: Click properties: type: type: string enum: - click description: Click on an element selector: type: string description: Query selector to find the element by example: '#load-more-button' required: - type - selector - type: object title: Write text properties: type: type: string enum: - write description: >- Write text into an input field, text area, or contenteditable element. Note: You must first focus the element using a 'click' action before writing. The text will be typed character by character to simulate keyboard input. text: type: string description: Text to type example: Hello, world! required: - type - text - type: object title: Press a key description: >- Press a key on the page. See https://asawicki.info/nosense/doc/devices/keyboard/key_codes.html for key codes. properties: type: type: string enum: - press description: Press a key on the page key: type: string description: Key to press example: Enter required: - type - key - type: object title: Scroll properties: type: type: string enum: - scroll description: Scroll the page or a specific element direction: type: string enum: - up - down description: Direction to scroll default: down selector: type: string description: Query selector for the element to scroll example: '#my-element' required: - type - type: object title: Scrape properties: type: type: string enum: - scrape description: >- Scrape the current page content, returns the url and the html. required: - type - type: object title: Execute JavaScript properties: type: type: string enum: - executeJavascript description: Execute JavaScript code on the page script: type: string description: JavaScript code to execute example: document.querySelector('.button').click(); required: - type - script location: type: object description: >- Location settings for the request. When specified, this will use an appropriate proxy if available and emulate the corresponding language and timezone settings. Defaults to 'US' if not specified. properties: country: type: string description: ISO 3166-1 alpha-2 country code (e.g., 'US', 'AU', 'DE', 'JP') pattern: ^[A-Z]{2}$ default: US languages: type: array description: >- Preferred languages and locales for the request in order of priority. Defaults to the language of the specified location. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language items: type: string example: en-US removeBase64Images: type: boolean description: >- Removes all base 64 images from the output, which may be overwhelmingly long. The image's alt text remains in the output, but the URL is replaced with a placeholder. blockAds: type: boolean description: Enables ad-blocking and cookie popup blocking. default: true proxy: type: string enum: - basic - stealth description: >- Specifies the type of proxy to use. - **basic**: Proxies for scraping sites with none to basic anti-bot solutions. Fast and usually works. - **stealth**: Stealth proxies for scraping sites with advanced anti-bot solutions. Slower, but more reliable on certain sites. If you do not specify a proxy, Firecrawl will automatically attempt to determine which one you need based on the target site. ScrapeResponse: type: object properties: success: type: boolean data: type: object properties: markdown: type: string html: type: string nullable: true description: HTML version of the content on page if `html` is in `formats` rawHtml: type: string nullable: true description: Raw HTML content of the page if `rawHtml` is in `formats` screenshot: type: string nullable: true description: Screenshot of the page if `screenshot` is in `formats` links: type: array items: type: string description: List of links on the page if `links` is in `formats` actions: type: object nullable: true description: >- Results of the actions specified in the `actions` parameter. Only present if the `actions` parameter was provided in the request properties: screenshots: type: array description: >- Screenshot URLs, in the same order as the screenshot actions provided. items: type: string format: url metadata: type: object properties: title: type: string description: type: string language: type: string nullable: true sourceURL: type: string format: uri ' ': type: string statusCode: type: integer description: The status code of the page error: type: string nullable: true description: The error message of the page llm_extraction: type: object description: >- Displayed when using LLM Extraction. Extracted data from the page following the schema defined. nullable: true warning: type: string nullable: true description: >- Can be displayed when using LLM Extraction. Warning message will let you know any issues with the extraction. securitySchemes: bearerAuth: type: http scheme: bearer ````