Beta API

Extract API Documentation

Advanced content extraction with customizable fields and parsing options

Extract API - Beta

Extract comprehensive content, metadata, links, and images from web pages. Requires API key authentication. Contact us to get your beta API key!

Extract Endpoint

GET /extract?url={url}

Extract comprehensive content, metadata, links, and images from web pages. Perfect for content analysis, research, and data extraction.

Parameters:

url - The URL to extract content from (required)

Authentication:

API key required via X-API-Key: YOUR_API_KEY header

Extract Example

curl -H "X-API-Key: YOUR_API_KEY" \
  "https://api.ogfetch.com/extract?url=https://github.com"

Response Schema & Extracted Article

github.com

GitHub: Let's build from here

6 min read1,247 words

GitHub is where over 100 million developers shape the future of software, together. Contribute to the open source community, manage Git repositories, and review code like a pro.

GitHub is where over 100 million developers shape the future of software, together. Contribute to the open source community, manage Git repositories, and review code like a pro...

Extracted content rendered as an article preview, with link and image sidebars.

Response Schema

Extract Response Example

{
  "url": "https://github.com",
  "title": "GitHub: Let's build from here",
  "description": "GitHub is where over 100 million developers shape the future of software, together.",
  "excerpt": "GitHub is where over 100 million developers shape the future of software, together. Contribute to the open source community, manage Git repositories, and review code like a pro.",
  "content": "GitHub is where over 100 million developers shape the future of software, together. Contribute to the open source community, manage Git repositories, and review code like a pro...",
  "links": [
    {
      "text": "Sign up",
      "href": "https://github.com/signup",
      "type": "internal"
    }
  ],
  "images": [
    {
      "src": "https://github.githubassets.com/images/modules/site/social-cards/github-social.png",
      "alt": "GitHub Social Card",
      "width": 1200,
      "height": 630
    }
  ],
  "metadata": {
    "og:title": "GitHub: Let's build from here",
    "og:description": "GitHub is where over 100 million developers shape the future of software, together.",
    "twitter:card": "summary_large_image"
  },
  "read_time": 2,
  "word_count": 580,
  "cached": false,
  "extracted_at": "2024-01-15T10:30:00Z"
}

Field Descriptions

url: The requested URL

title: Page title

description: Meta description

excerpt: First 160 characters of content

content: Main page content (cleaned)

links: All links found on page with text and type

images: All images with src, alt, and dimensions

metadata: Open Graph and Twitter meta tags

read_time: Estimated reading time in minutes

word_count: Total word count