getOgExtract
Extract targeted content from any URL using HTML tag names or custom CSS selectors. Supports JavaScript rendering for dynamic pages.
Instructions
Extract specific content from any URL via the OpenGraph.io API (v3). Two modes — choose based on what you need:
Mode 1 — Tag-based (html_elements): pass an array of HTML tag names, e.g. ['h1','h2','p','a']. The API collects all matching elements and joins their text into a single concatenatedText string. Best for bulk content extraction where you want all headings, paragraphs, or links as one block of text.
Mode 2 — Selector-based (selectors): pass a CSS selector map where each key is your chosen label and each value is a CSS selector, e.g. { "title": "article h1", "price": ".price-box .price", "sku": "#product-sku" }. The API returns a data object keyed by those labels — ideal for structured scraping of specific named fields.
Response shape by mode:
html_elementsonly →{ concatenatedText }selectorsonly →{ data, concatenatedText }Both provided →
{ data, concatenatedText }
For JS-heavy / SPA pages set full_render: true to guarantee JavaScript execution before extraction. Use wait_for_selector when content loads asynchronously.
Pick the right tool: getOgData → Open Graph tags, social preview metadata (title, description, image, favicon) getOgMarkdown → Clean readable text / article prose — ideal for feeding into an LLM getOgScrapeData → Raw HTML — use when you need to do your own parsing or link extraction getOgExtract → Targeted elements by tag (html_elements) or named CSS selectors (selectors) getOgScreenshot → Visual capture of a page as an image getOgQuery → Natural-language question answered from page content (100–200 credits/request)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | URL of the webpage to extract content from. | |
| retry | No | Automatically retry failed requests. Defaults to true on v3. | |
| cache_ok | No | Use cached results. Set to false to bypass cache. Defaults to true. | |
| selectors | No | CSS selector map for structured extraction. Keys are output labels; values are CSS selectors. Example: { "article_title": "article h1", "price": ".price-box .price", "description": "#product-description p" }. When provided, returns a structured `data` object keyed by label instead of a raw element list. Can be combined with html_elements. | |
| use_proxy | No | Route the request through a standard proxy. | |
| auto_proxy | No | Automatically escalate to a proxy if the direct request fails. Defaults to true on v3. | |
| accept_lang | No | Accept-Language header for the outbound request. Defaults to 'auto'. | |
| ai_sanitize | No | Scan the fetched content for prompt-injection attempts. | |
| auto_render | No | Automatically detect and switch to headless rendering for SPA pages. Defaults to true on v3. | |
| full_render | No | Fully render the page with JavaScript before extracting. Useful for SPAs. | |
| max_retries | No | Maximum number of retry attempts (1–4). Defaults to 4. | |
| use_premium | No | Route the request through a premium proxy. | |
| use_superior | No | Route the request through a superior-tier proxy. | |
| html_elements | No | List of HTML tag names to extract (e.g. ['h1', 'h2', 'a', 'img', 'p']). Defaults to ['title','h1','h2','h3','h4','h5','p'] when neither html_elements nor selectors is provided. | |
| max_cache_age | No | Maximum cache age in milliseconds. Defaults to 432000000 (5 days). | |
| proxy_country | No | Two-letter ISO country code for geo-targeted proxy exit node. | |
| load_more_wait | No | Milliseconds to wait after each load_more click (0–5000). Defaults to 1500. | |
| retry_escalate | No | Escalate proxy tier on each retry attempt. Defaults to true. | |
| ai_sanitize_mode | No | 'sanitize' cleans the content, 'warn' returns a safety report, 'block' returns HTTP 422. | |
| load_more_clicks | No | Number of times to click the load_more_selector (1–10). Defaults to 3. | |
| load_more_scroll | No | Scroll between load_more clicks. Defaults to true. | |
| scroll_to_bottom | No | Scroll to the bottom of the page before extracting. Useful for lazy-loaded content. | |
| wait_for_selector | No | CSS selector to wait for before extracting. | |
| load_more_selector | No | CSS selector for a 'load more' button to click before extracting. | |
| load_more_item_selector | No | CSS selector to watch for new items when using load_more_selector. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | ||
| data | No | Structured object keyed by your selector labels. Only present when the selectors param was used. | |
| concatenatedText | No | All matched element text joined into one string. Present in both html_elements and selectors modes. |