# Scrapfly Documentation

## Table of Contents

### Dashboard

- [Intro](https://scrapfly.io/docs)
- [Project](https://scrapfly.io/docs/project)
- [Account](https://scrapfly.io/docs/account)
- [Workspace & Team](https://scrapfly.io/docs/workspace-and-team)
- [Billing](https://scrapfly.io/docs/billing)

### Products

#### MCP Server

- [Getting Started](https://scrapfly.io/docs/mcp/getting-started)
- [Tools & API Spec](https://scrapfly.io/docs/mcp/tools)
- [Authentication](https://scrapfly.io/docs/mcp/authentication)
- [Examples & Use Cases](https://scrapfly.io/docs/mcp/examples)
- [FAQ](https://scrapfly.io/docs/mcp/faq)
##### Integrations

- [Overview](https://scrapfly.io/docs/mcp/integrations)
- [Claude Desktop](https://scrapfly.io/docs/mcp/integrations/claude-desktop)
- [Claude Code](https://scrapfly.io/docs/mcp/integrations/claude-code)
- [ChatGPT](https://scrapfly.io/docs/mcp/integrations/chatgpt)
- [Cursor](https://scrapfly.io/docs/mcp/integrations/cursor)
- [Cline](https://scrapfly.io/docs/mcp/integrations/cline)
- [Windsurf](https://scrapfly.io/docs/mcp/integrations/windsurf)
- [Zed](https://scrapfly.io/docs/mcp/integrations/zed)
- [Roo Code](https://scrapfly.io/docs/mcp/integrations/roo-code)
- [VS Code](https://scrapfly.io/docs/mcp/integrations/vscode)
- [LangChain](https://scrapfly.io/docs/mcp/integrations/langchain)
- [LlamaIndex](https://scrapfly.io/docs/mcp/integrations/llamaindex)
- [CrewAI](https://scrapfly.io/docs/mcp/integrations/crewai)
- [OpenAI](https://scrapfly.io/docs/mcp/integrations/openai)
- [n8n](https://scrapfly.io/docs/mcp/integrations/n8n)
- [Make](https://scrapfly.io/docs/mcp/integrations/make)
- [Zapier](https://scrapfly.io/docs/mcp/integrations/zapier)
- [Vapi AI](https://scrapfly.io/docs/mcp/integrations/vapi)
- [Agent Builder](https://scrapfly.io/docs/mcp/integrations/agent-builder)
- [Custom Client](https://scrapfly.io/docs/mcp/integrations/custom-client)


#### Web Scraping API

- [Getting Started](https://scrapfly.io/docs/scrape-api/getting-started)
- [API Specification]()
- [Monitoring](https://scrapfly.io/docs/monitoring)
- [Customize Request](https://scrapfly.io/docs/scrape-api/custom)
- [Debug](https://scrapfly.io/docs/scrape-api/debug)
- [Anti Scraping Protection](https://scrapfly.io/docs/scrape-api/anti-scraping-protection)
- [Proxy](https://scrapfly.io/docs/scrape-api/proxy)
- [Proxy Mode](https://scrapfly.io/docs/scrape-api/proxy-mode)
- [Proxy Mode - Screaming Frog](https://scrapfly.io/docs/scrape-api/proxy-mode/screaming-frog)
- [Proxy Mode - Apify](https://scrapfly.io/docs/scrape-api/proxy-mode/apify)
- [(Auto) Data Extraction](https://scrapfly.io/docs/scrape-api/extraction)
- [Javascript Rendering](https://scrapfly.io/docs/scrape-api/javascript-rendering)
- [Javascript Scenario](https://scrapfly.io/docs/scrape-api/javascript-scenario)
- [SSL](https://scrapfly.io/docs/scrape-api/ssl)
- [DNS](https://scrapfly.io/docs/scrape-api/dns)
- [Cache](https://scrapfly.io/docs/scrape-api/cache)
- [Session](https://scrapfly.io/docs/scrape-api/session)
- [Webhook](https://scrapfly.io/docs/scrape-api/webhook)
- [Screenshot](https://scrapfly.io/docs/scrape-api/screenshot)
- [Errors](https://scrapfly.io/docs/scrape-api/errors)
- [Timeout](https://scrapfly.io/docs/scrape-api/understand-timeout)
- [Throttling](https://scrapfly.io/docs/throttling)
- [Troubleshoot](https://scrapfly.io/docs/scrape-api/troubleshoot)
- [Billing](https://scrapfly.io/docs/scrape-api/billing)
- [FAQ](https://scrapfly.io/docs/scrape-api/faq)

#### Crawler API

- [Getting Started](https://scrapfly.io/docs/crawler-api/getting-started)
- [API Specification]()
- [Retrieving Results](https://scrapfly.io/docs/crawler-api/results)
- [WARC Format](https://scrapfly.io/docs/crawler-api/warc-format)
- [Data Extraction](https://scrapfly.io/docs/crawler-api/extraction-rules)
- [Webhook](https://scrapfly.io/docs/crawler-api/webhook)
- [Billing](https://scrapfly.io/docs/crawler-api/billing)
- [Errors](https://scrapfly.io/docs/crawler-api/errors)
- [Troubleshoot](https://scrapfly.io/docs/crawler-api/troubleshoot)
- [FAQ](https://scrapfly.io/docs/crawler-api/faq)

#### Screenshot API

- [Getting Started](https://scrapfly.io/docs/screenshot-api/getting-started)
- [API Specification]()
- [Accessibility Testing](https://scrapfly.io/docs/screenshot-api/accessibility)
- [Webhook](https://scrapfly.io/docs/screenshot-api/webhook)
- [Billing](https://scrapfly.io/docs/screenshot-api/billing)
- [Errors](https://scrapfly.io/docs/screenshot-api/errors)

#### Extraction API

- [Getting Started](https://scrapfly.io/docs/extraction-api/getting-started)
- [API Specification]()
- [Rules Template](https://scrapfly.io/docs/extraction-api/rules-and-template)
- [LLM Extraction](https://scrapfly.io/docs/extraction-api/llm-prompt)
- [AI Auto Extraction](https://scrapfly.io/docs/extraction-api/automatic-ai)
- [Webhook](https://scrapfly.io/docs/extraction-api/webhook)
- [Billing](https://scrapfly.io/docs/extraction-api/billing)
- [Errors](https://scrapfly.io/docs/extraction-api/errors)
- [FAQ](https://scrapfly.io/docs/extraction-api/faq)

#### Proxy Saver

- [Getting Started](https://scrapfly.io/docs/proxy-saver/getting-started)
- [Fingerprints](https://scrapfly.io/docs/proxy-saver/fingerprints)
- [Optimizations](https://scrapfly.io/docs/proxy-saver/optimizations)
- [SSL Certificates](https://scrapfly.io/docs/proxy-saver/certificates)
- [Protocols](https://scrapfly.io/docs/proxy-saver/protocols)
- [Pacfile](https://scrapfly.io/docs/proxy-saver/pacfile)
- [Secure Credentials](https://scrapfly.io/docs/proxy-saver/security)
- [Billing](https://scrapfly.io/docs/proxy-saver/billing)

#### Cloud Browser API

- [Getting Started](https://scrapfly.io/docs/cloud-browser-api/getting-started)
- [Proxy & Geo-Targeting](https://scrapfly.io/docs/cloud-browser-api/proxy)
- [Unblock API](https://scrapfly.io/docs/cloud-browser-api/unblock)
- [File Downloads](https://scrapfly.io/docs/cloud-browser-api/file-downloads)
- [Session Resume](https://scrapfly.io/docs/cloud-browser-api/session-resume)
- [Human-in-the-Loop](https://scrapfly.io/docs/cloud-browser-api/human-in-the-loop)
- [Debug Mode](https://scrapfly.io/docs/cloud-browser-api/debug-mode)
- [Bring Your Own Proxy](https://scrapfly.io/docs/cloud-browser-api/bring-your-own-proxy)
- [Browser Extensions](https://scrapfly.io/docs/cloud-browser-api/extensions)
##### Integrations

- [Puppeteer](https://scrapfly.io/docs/cloud-browser-api/puppeteer)
- [Playwright](https://scrapfly.io/docs/cloud-browser-api/playwright)
- [Selenium](https://scrapfly.io/docs/cloud-browser-api/selenium)
- [Vercel Agent Browser](https://scrapfly.io/docs/cloud-browser-api/agent-browser)
- [Browser Use](https://scrapfly.io/docs/cloud-browser-api/browser-use)
- [Stagehand](https://scrapfly.io/docs/cloud-browser-api/stagehand)

- [Billing](https://scrapfly.io/docs/cloud-browser-api/billing)
- [Errors](https://scrapfly.io/docs/cloud-browser-api/errors)


### Tools

- [Antibot Detector](https://scrapfly.io/docs/tools/antibot-detector)

### SDK

- [Golang](https://scrapfly.io/docs/sdk/golang)
- [Python](https://scrapfly.io/docs/sdk/python)
- [TypeScript](https://scrapfly.io/docs/sdk/typescript)
- [Scrapy](https://scrapfly.io/docs/sdk/scrapy)

### Integrations

- [Getting Started](https://scrapfly.io/docs/integration/getting-started)
- [LangChain](https://scrapfly.io/docs/integration/langchain)
- [LlamaIndex](https://scrapfly.io/docs/integration/llamaindex)
- [CrewAI](https://scrapfly.io/docs/integration/crewai)
- [Zapier](https://scrapfly.io/docs/integration/zapier)
- [Make](https://scrapfly.io/docs/integration/make)
- [n8n](https://scrapfly.io/docs/integration/n8n)

### Academy

- [Overview](https://scrapfly.io/academy)
- [Web Scraping Overview](https://scrapfly.io/academy/scraping-overview)
- [Tools](https://scrapfly.io/academy/tools-overview)
- [Reverse Engineering](https://scrapfly.io/academy/reverse-engineering)
- [Static Scraping](https://scrapfly.io/academy/static-scraping)
- [HTML Parsing](https://scrapfly.io/academy/html-parsing)
- [Dynamic Scraping](https://scrapfly.io/academy/dynamic-scraping)
- [Hidden API Scraping](https://scrapfly.io/academy/hidden-api-scraping)
- [Headless Browsers](https://scrapfly.io/academy/headless-browsers)
- [Hidden Web Data](https://scrapfly.io/academy/hidden-web-data)
- [JSON Parsing](https://scrapfly.io/academy/json-parsing)
- [Data Processing](https://scrapfly.io/academy/data-processing)
- [Scaling](https://scrapfly.io/academy/scaling)
- [Walkthrough Summary](https://scrapfly.io/academy/walkthrough-summary)
- [Scraper Blocking](https://scrapfly.io/academy/scraper-blocking)
- [Proxies](https://scrapfly.io/academy/proxies)

---

# Stock Extraction Schema

> This model has been tailored based on customer feedback and usage. If you need a specific model and enough generalist, you can contact us on the support link below. If some fields are missing, you can also contact us to add them. 
>  
>  [Contact us](https://scrapfly.io/docs/support)

##### Stock  object

 

- **symbol**  string The stock ticker symbol.
- **companyName**  string The name of the company.
- **currency**  \[string, null\] COMPUTE: Currency code in ISO3 format (e.g., USD, EUR, GBP). Derive from currency symbol if code not found ($ -> USD, € -> EUR, £ -> GBP).
- **pricing**  \[object, null\] 
    - **currentPrice**  \[object, null\] The current price of the stock.
        
        
        - **original**  \[string, null\] The raw unparsed current price.
        - **amount**  \[number, null\] The numeric value of the current price.
    - **change**  \[object, null\] The change in stock price.
        
        
        - **original**  \[string, null\] The raw unparsed price change.
        - **amount**  \[number, null\] The numeric value of the price change.
    - **changePercentage**  \[number, null\] The percentage change in stock price.
    - **previousClose**  \[object, null\] The previous closing price of the stock.
        
        
        - **original**  \[string, null\] The raw unparsed previous closing price.
        - **amount**  \[number, null\] The numeric value of the previous closing price.
    - **open**  \[object, null\] The opening price of the stock.
        
        
        - **original**  \[string, null\] The raw unparsed opening price.
        - **amount**  \[number, null\] The numeric value of the opening price.
    - **dayLow**  \[object, null\] The lowest price of the stock during the trading day.
        
        
        - **original**  \[string, null\] The raw unparsed lowest price during the trading day.
        - **amount**  \[number, null\] The numeric value of the lowest price during the trading day.
    - **dayHigh**  \[object, null\] The highest price of the stock during the trading day.
        
        
        - **original**  \[string, null\] The raw unparsed highest price during the trading day.
        - **amount**  \[number, null\] The numeric value of the highest price during the trading day.
    - **volume**  \[number, null\] The trading volume of the stock.
    - **averageVolume**  \[number, null\] The average trading volume of the stock.
    - **marketCap**  \[object, null\] The market capitalization of the company.
        
        
        - **original**  \[string, null\] The raw unparsed market capitalization.
        - **amount**  \[number, null\] The numeric value of the market capitalization.
    - **peRatio**  \[number, null\] The price-to-earnings ratio of the stock.
    - **dividendYield**  \[number, null\] The dividend yield of the stock.
    - **exDividendDate**  \[string, null\] The ex-dividend date of the stock.
- **keyStatistics**  \[object, null\] 
    - **yearToDateReturn**  \[object, null\] The year to date return of the stock.
        
        
        - **original**  \[string, null\] The raw unparsed of the year to date return.
        - **amount**  \[number, null\] The numeric value of the year to date return.
    - **1YearReturn**  \[object, null\] The 1 year return of the stock.
        
        
        - **original**  \[string, null\] The raw unparsed of the year to date return.
        - **amount**  \[number, null\] The numeric value of the year to date return.
    - **3YearReturn**  \[object, null\] The 3 year return of the stock.
        
        
        - **original**  \[string, null\] The raw unparsed of the year to date return.
        - **amount**  \[number, null\] The numeric value of the year to date return.
    - **5YearReturn**  \[object, null\] The 5 year return of the stock.
        
        
        - **original**  \[string, null\] The raw unparsed of the year to date return.
        - **amount**  \[number, null\] The numeric value of the year to date return.
    - **52WeekLow**  \[object, null\] The 52-week low price of the stock.
        
        
        - **original**  \[string, null\] The raw unparsed 52-week low price.
        - **amount**  \[number, null\] The numeric value of the 52-week low price.
    - **52WeekHigh**  \[object, null\] The 52-week high price of the stock.
        
        
        - **original**  \[string, null\] The raw unparsed 52-week high price.
        - **amount**  \[number, null\] The numeric value of the 52-week high price.
    - **earningsPerShare**  \[object, null\] The earnings per share of the stock.
        
        
        - **original**  \[string, null\] The raw unparsed earnings per share.
        - **amount**  \[number, null\] The numeric value of the earnings per share.
    - **beta**  \[number, null\] The beta value of the stock.
    - **nextEarningsDate**  \[string, null\] The next earnings date of the stock.
- **news**  \[array, null\] A list of news articles related to the stock.
    
    ###### Items  object
    
    
    - **headline**  string The headline of the news article.
    - **source**  string The source of the news article.
    - **publishDate**  string The publication date of the news article.
    - **link**  string The URL link to the news article. Copy the exact URL as found in the document. Never construct or guess URLs.
- **competitors**  \[array, null\] A list of competitor stocks.
    
    ###### Items  object
    
    
    - **symbol**  string The stock ticker symbol of the competitor.
    - **companyName**  string The name of the competitor company.
    - **price**  object The current price of the competitor's stock.
        
        
        - **original**  \[string, null\] The raw unparsed price of the competitor's stock.
        - **amount**  \[number, null\] The numeric value of the competitor's stock price.
    - **change**  object The change in the competitor's stock price.
        
        
        - **original**  \[string, null\] The raw unparsed price change.
        - **amount**  \[number, null\] The numeric value of the price change.
    - **changePercentage**  number The percentage change in the competitor's stock price.
- **analystRatings**  \[object, null\] Analyst ratings for the stock.
    
    
    - **buy**  \[number, null\] The number of buy ratings.
    - **hold**  \[number, null\] The number of hold ratings.
    - **sell**  \[number, null\] The number of sell ratings.
    - **consensus**  \[string, null\] The consensus rating (e.g., Strong Buy, Buy, Hold, Underperform, Sell).
- **financials**  \[object, null\] Financial statistics of the company.
    
    
    - **totalRevenue**  \[object, null\] The total revenue of the company.
        
        
        - **original**  \[string, null\] The raw unparsed total revenue.
        - **amount**  \[number, null\] The numeric value of the total revenue.
    - **netIncome**  \[object, null\] The net income of the company.
        
        
        - **original**  \[string, null\] The raw unparsed net income.
        - **amount**  \[number, null\] The numeric value of the net income.
    - **earningsPerShare**  \[object, null\] The earnings per share of the company.
        
        
        - **original**  \[string, null\] The raw unparsed earnings per share.
        - **amount**  \[number, null\] The numeric value of the earnings per share.
    - **revenueGrowth**  \[number, null\] The revenue growth rate of the company.
    - **grossMargin**  \[number, null\] The gross margin of the company.
    - **ebitda**  \[object, null\] The earnings before interest, taxes, depreciation, and amortization.
        
        
        - **original**  \[string, null\] The raw unparsed earnings before interest, taxes, depreciation, and amortization.
        - **amount**  \[number, null\] The numeric value of the earnings before interest, taxes, depreciation, and amortization.
    - **netProfitMargin**  \[number, null\] The net profit margin of the company.
    - **freeCashFlow**  \[object, null\] The free cash flow of the company.
        
        
        - **original**  \[string, null\] The raw unparsed free cash flow.
        - **amount**  \[number, null\] The numeric value of the free cash flow.
    - **totalDebt**  \[object, null\] The total debt of the company.
        
        
        - **original**  \[string, null\] The raw unparsed total debt.
        - **amount**  \[number, null\] The numeric value of the total debt.
- **link**  \[string, null\] A link to the detailed stock page. Copy the exact URL as found in the document. Never construct or guess URLs.