API Reference

Authentication

Pass your API key in the X-Api-Key request header. You can also pass it as the api_key query parameter.

X-Api-Key: ogf_your_key_here

GET /v1/fetch

Fetches a URL and returns all available metadata. Consumes one credit per successful response.

curl -G https://ogfetch.dev/v1/fetch \
  -H "X-Api-Key: ogf_your_key" \
  --data-urlencode "url=https://github.com"

Response schema

All fields are always present. Missing data is returned as null, not omitted. Image URLs and favicons are always resolved to absolute URLs.

{
  "url":         string,   // final URL after redirects
  "canonical":   string | null,
  "title":       string | null,
  "description": string | null,
  "favicon":     string | null,  // absolute URL
  "og": {
    "title":       string | null,
    "description": string | null,
    "image":       string | null,  // absolute URL
    "url":         string | null,
    "type":        string | null,
    "siteName":    string | null
  },
  "twitter": {
    "card":        string | null,
    "title":       string | null,
    "description": string | null,
    "image":       string | null,
    "creator":     string | null
  },
  "meta": {
    "author":      string | null,
    "keywords":    string | null,
    "robots":      string | null,
    "themeColor":  string | null
  },
  "wordCount":    number,
  "techStack":    string[],
  "statusCode":   number,  // HTTP status from target URL
  "responseTime": number,  // milliseconds
  "fetchedAt":    string   // ISO 8601
}

Tech stack detection

We detect frameworks and tools from HTML signatures and HTTP response headers. Detected values that may appear in techStack:

Error responses

Errors return a JSON body with error (human message) and code (machine-readable).