Overview
Metadata Extractor works by parsing the HTML content of a web page to extract the metadata. It returns the meta title, meta description, and more in a structured format.
Endpoint
One host, one path per API. The block below shows this call in four languages; every one of them is the same HTTP request. Making requests covers the timeouts, retries and parameter rules that apply to all of them. The SDKs wrap the same call in a typed client.
curl -X POST https://api.apiverve.com/v1/metadataextractor \
-H "x-api-key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"url": "https://apiverve.com"
}'const res = await fetch('https://api.apiverve.com/v1/metadataextractor', {
method: 'POST',
headers: {
'x-api-key': 'your_api_key_here',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"url": "https://apiverve.com"
}),
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const { data } = await res.json();
console.log(data);import requests
res = requests.post(
"https://api.apiverve.com/v1/metadataextractor",
headers={"x-api-key": "your_api_key_here"},
json={
"url": "https://apiverve.com"
},
timeout=15,
)
res.raise_for_status()
print(res.json()["data"])package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
body := strings.NewReader(`{
"url": "https://apiverve.com"
}`)
req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/metadataextractor", body)
req.Header.Set("Content-Type", "application/json")
req.Header.Set("x-api-key", "your_api_key_here")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}Replace your_api_key_here with the key from your dashboard. When the inputs arrive as a list rather than one at a time, batch requests run up to 200 of them through this same API in a single call.
Authentication
Send your key in the x-api-key header. That is the only auth step — there is no token exchange and no per-endpoint scope to configure. Authentication covers creating, rotating and revoking keys.
401 is the only auth verdict
A 401 means the key is missing, invalid or expired. A 403 means the key is valid but not permitted here — blocked by a key restriction or an IP allow-list. Running out of credits is a 429.
Parameters
Sent as JSON in the request body. Premium parameters are accepted on every plan but only take effect on plans that include them.
| Parameter | Type | Description |
|---|---|---|
urlRequired | string | The URL of the web page to extract metadata from url |
Response
Every API returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape. Response format covers the envelope, the other output formats and how premium fields are withheld.
{
"status": "ok",
"error": null,
"data": {
"requestUrl": "https://apiverve.com",
"url": "https://apiverve.com/",
"canonical": "",
"lang": "en",
"charset": "utf-8",
"title": "APIVerve — One key for 300+ production APIs",
"image": "",
"favicons": [
{
"rel": "icon",
"href": "/images/favicon.ico",
"sizes": "any"
},
{
"rel": "icon",
"type": "image/png",
"href": "/images/favicon.png"
},
{
"rel": "apple-touch-icon",
"href": "/images/apple-touch-icon.png"
}
],
"author": "",
"description": "Consistent schemas, predictable credit pricing, and an uptime SLA on every paid plan across 300+ production APIs. One key, one bill, zero glue code.",
"keywords": "",
"source": "",
"price": "",
"priceCurrency": "",
"availability": "",
"robots": "",
"jsonld": [],
"og:url": "https://apiverve.com",
"og:locale": "en_US",
"og:locale:alternate": "",
"og:title": "APIVerve — One key for 300+ production APIs",
"og:type": "website",
"og:description": "Consistent schemas, predictable credit pricing, and an uptime SLA on every paid plan across 300+ production APIs. One key, one bill, zero glue code.",
"og:determiner": "",
"og:site_name": "APIVerve",
"og:image": "https://apiverve.com/social-images/page-home.png",
"og:image:secure_url": "",
"og:image:type": "",
"og:image:width": "1200",
"og:image:height": "630",
"twitter:title": "APIVerve — One key for 300+ production APIs",
"twitter:description": "Consistent schemas, predictable credit pricing, and an uptime SLA on every paid plan across 300+ production APIs.",
"twitter:image": "https://apiverve.com/social-images/page-home.png",
"twitter:image:alt": "",
"twitter:card": "summary_large_image",
"twitter:site": "",
"twitter:site:id": "",
"twitter:url": "",
"twitter:account_id": "",
"twitter:creator": "",
"twitter:creator:id": "",
"twitter:player": "",
"twitter:player:width": "",
"twitter:player:height": "",
"twitter:player:stream": "",
"twitter:app:name:iphone": "",
"twitter:app:id:iphone": "",
"twitter:app:url:iphone": "",
"twitter:app:name:ipad": "",
"twitter:app:id:ipad": "",
"twitter:app:url:ipad": "",
"twitter:app:name:googleplay": "",
"twitter:app:id:googleplay": "",
"twitter:app:url:googleplay": "",
"headings": [
{
"level": "h1",
"text": "Every API your product needs, behind one key."
},
{
"level": "h2",
"text": "The boring parts of API integration, already solved."
},
{
"level": "h3",
"text": "One response envelope"
},
{
"level": "h3",
"text": "Flat credit pricing"
},
{
"level": "h3",
"text": "Backed by an uptime SLA"
},
{
"level": "h2",
"text": "Your first call takes two minutes."
},
{
"level": "h3",
"text": "Grab a key"
},
{
"level": "h3",
"text": "Call any endpoint"
},
{
"level": "h3",
"text": "Ship it"
},
{
"level": "h2",
"text": "Authenticate once. Point at anything."
},
{
"level": "h2",
"text": "Skip the integration work. Ship the feature."
},
{
"level": "h3",
"text": "User verification"
},
{
"level": "h3",
"text": "Commerce toolkit"
},
{
"level": "h3",
"text": "Data enrichment"
},
{
"level": "h3",
"text": "Docs & media"
},
{
"level": "h2",
"text": "Metrics from the last 24 hours."
},
{
"level": "h2",
"text": "Production APIs for the things you keep rebuilding."
},
{
"level": "h3",
"text": "Email Validator →"
},
{
"level": "h3",
"text": "IP Lookup →"
},
{
"level": "h3",
"text": "Weather →"
},
{
"level": "h3",
"text": "QR Code Generator →"
},
{
"level": "h3",
"text": "Currency Converter →"
},
{
"level": "h3",
"text": "Translator →"
},
{
"level": "h2",
"text": "450,000+ lookups, validations, and conversions a day, through one key."
},
{
"level": "h2",
"text": "Give your software a way to act on the world."
},
{
"level": "h3",
"text": "Scaling in production?"
},
{
"level": "h4",
"text": "Product"
},
{
"level": "h4",
"text": "Solutions"
},
{
"level": "h4",
"text": "Integrations"
},
{
"level": "h4",
"text": "Resources"
},
{
"level": "h4",
"text": "Compare"
},
{
"level": "h4",
"text": "SDKs"
},
{
"level": "h4",
"text": "Company"
},
{
"level": "h4",
"text": "Featured APIs"
},
{
"level": "h4",
"text": "More"
},
{
"level": "h4",
"text": "Legal"
},
{
"level": "h4",
"text": "Important disclaimer"
}
],
"imgTags": [
{
"src": "/images/favicon.png",
"alt": "",
"width": "26",
"height": "26"
},
{
"src": "/images/brands/brand01.png",
"alt": "Microsoft"
},
{
"src": "/images/brands/brand02.png",
"alt": "DuckDuckGo"
},
{
"src": "/images/brands/brand03.png",
"alt": "Topdanmark"
},
{
"src": "/images/brands/brand04.png",
"alt": "University of Maryland"
},
{
"src": "/images/brands/brand05.png",
"alt": "Postman"
},
{
"src": "/images/brands/brand06.png",
"alt": "RapidAPI"
},
{
"src": "/images/brands/brand07.png",
"alt": "Zapier"
},
{
"src": "/images/brands/brand08.svg",
"alt": "Deloitte"
},
{
"src": "/images/brands/brand01.png",
"alt": ""
},
{
"src": "/images/brands/brand02.png",
"alt": ""
},
{
"src": "/images/brands/brand03.png",
"alt": ""
},
{
"src": "/images/brands/brand04.png",
"alt": ""
},
{
"src": "/images/brands/brand05.png",
"alt": ""
},
{
"src": "/images/brands/brand06.png",
"alt": ""
},
{
"src": "/images/brands/brand07.png",
"alt": ""
},
{
"src": "/images/brands/brand08.svg",
"alt": ""
},
{
"src": "/images/brands/brand01.png",
"alt": ""
},
{
"src": "/images/brands/brand02.png",
"alt": ""
},
{
"src": "/images/brands/brand03.png",
"alt": ""
},
{
"src": "/images/brands/brand04.png",
"alt": ""
},
{
"src": "/images/brands/brand05.png",
"alt": ""
},
{
"src": "/images/brands/brand06.png",
"alt": ""
},
{
"src": "/images/brands/brand07.png",
"alt": ""
},
{
"src": "/images/brands/brand08.svg",
"alt": ""
},
{
"src": "/images/brands/brand01.png",
"alt": ""
},
{
"src": "/images/brands/brand02.png",
"alt": ""
},
{
"src": "/images/brands/brand03.png",
"alt": ""
},
{
"src": "/images/brands/brand04.png",
"alt": ""
},
{
"src": "/images/brands/brand05.png",
"alt": ""
},
{
"src": "/images/brands/brand06.png",
"alt": ""
},
{
"src": "/images/brands/brand07.png",
"alt": ""
},
{
"src": "/images/brands/brand08.svg",
"alt": ""
},
{
"src": "/images/brands/brand01.png",
"alt": ""
},
{
"src": "/images/brands/brand02.png",
"alt": ""
},
{
"src": "/images/brands/brand03.png",
"alt": ""
},
{
"src": "/images/brands/brand04.png",
"alt": ""
},
{
"src": "/images/brands/brand05.png",
"alt": ""
},
{
"src": "/images/brands/brand06.png",
"alt": ""
},
{
"src": "/images/brands/brand07.png",
"alt": ""
},
{
"src": "/images/brands/brand08.svg",
"alt": ""
},
{
"src": "/images/brands/brand01.png",
"alt": ""
},
{
"src": "/images/brands/brand02.png",
"alt": ""
},
{
"src": "/images/brands/brand03.png",
"alt": ""
},
{
"src": "/images/brands/brand04.png",
"alt": ""
},
{
"src": "/images/brands/brand05.png",
"alt": ""
},
{
"src": "/images/brands/brand06.png",
"alt": ""
},
{
"src": "/images/brands/brand07.png",
"alt": ""
},
{
"src": "/images/brands/brand08.svg",
"alt": ""
},
{
"src": "/images/favicon.png",
"alt": "",
"width": "24",
"height": "24"
}
],
"responseBody": "",
"viewport": "width=device-width, initial-scale=1, maximum-scale=1",
"theme-color": "#ffffff",
"application-name": "APIVerve",
"og:image:alt": "APIVerve — One key for 300+ production APIs"
}
}
Response fields
Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.
| Field | Type | Example | Description |
|---|---|---|---|
requestUrl | string | "https://apiverve.com" | Original URL submitted for metadata extraction |
url | string | "https://apiverve.com/" | Final resolved URL after redirects |
canonicalPremium | string | "" | Canonical URL from page meta tag |
lang | string | "en" | Page language code from HTML lang attribute |
charset | string | "utf-8" | Character encoding specified in meta tags |
title | string | "APIVerve — One key for 300+ production APIs" | Page title extracted from title tag |
imagePremium | string | "" | Primary image URL from meta tags |
faviconsPremium | array[3] | Array of favicon objects with URL references | |
relPremium | string | "icon" | Link relation of the icon (icon, apple-touch-icon, ...) |
hrefPremium | string | "/images/favicon.ico" | URL of the icon |
sizesPremium | string | "any" | Declared icon sizes |
author | string | "" | Page author extracted from meta tags |
description | string | "Consistent schemas, predictable credit pricing, and an uptime SLA on every paid plan across 300+ production APIs. One key, one bill, zero glue code." | Page description from meta description tag |
keywords | string | "" | Keywords extracted from meta keywords tag |
sourcePremium | string | "" | Page source or publication reference |
pricePremium | string | "" | Product price if available in schema |
priceCurrencyPremium | string | "" | Currency code for price field |
availabilityPremium | string | "" | Product availability status from schema |
robots | string | "" | Robots meta tag for search engine indexing |
jsonldPremium | array | [] | JSON-LD structured data schemas |
og:urlPremium | string | "https://apiverve.com" | Open Graph URL for social media sharing |
og:localePremium | string | "en_US" | Open Graph locale specification |
og:locale:alternatePremium | string | "" | Alternate locales the page is available in |
og:titlePremium | string | "APIVerve — One key for 300+ production APIs" | Open Graph title for social sharing |
og:typePremium | string | "website" | Open Graph content type category |
og:descriptionPremium | string | "Consistent schemas, predictable credit pricing, and an uptime SLA on every paid plan across 300+ production APIs. One key, one bill, zero glue code." | Open Graph description for social sharing |
og:determinerPremium | string | "" | Word that appears before the Open Graph title (a, an, the) |
og:site_namePremium | string | "APIVerve" | Open Graph site name for branding |
og:imagePremium | string | "https://apiverve.com/social-images/page-home.png" | Open Graph image for social media preview |
og:image:secure_urlPremium | string | "" | HTTPS URL of the Open Graph image |
og:image:typePremium | string | "" | MIME type of the Open Graph image |
og:image:widthPremium | string | "1200" | Width of the Open Graph image in pixels |
og:image:heightPremium | string | "630" | Height of the Open Graph image in pixels |
twitter:titlePremium | string | "APIVerve — One key for 300+ production APIs" | Twitter card title for X sharing |
twitter:descriptionPremium | string | "Consistent schemas, predictable credit pricing, and an uptime SLA on every paid plan across 300+ production APIs." | Twitter card description for sharing |
twitter:imagePremium | string | "https://apiverve.com/social-images/page-home.png" | Twitter card image for X preview |
twitter:image:altPremium | string | "" | Alt text for the Twitter card image |
twitter:cardPremium | string | "summary_large_image" | Twitter card type configuration |
twitter:sitePremium | string | "" | Twitter handle of the website |
twitter:site:idPremium | string | "" | Twitter user ID of the website |
twitter:urlPremium | string | "" | URL the Twitter card points to |
twitter:account_idPremium | string | "" | Twitter account ID for the site |
twitter:creatorPremium | string | "" | Twitter handle of the content creator |
twitter:creator:idPremium | string | "" | Twitter user ID of the content creator |
twitter:playerPremium | string | "" | URL of the Twitter player card iframe |
twitter:player:widthPremium | string | "" | Width of the Twitter player in pixels |
twitter:player:heightPremium | string | "" | Height of the Twitter player in pixels |
twitter:player:streamPremium | string | "" | URL of the raw media stream for the player card |
twitter:app:name:iphonePremium | string | "" | iPhone app name for the Twitter app card |
twitter:app:id:iphonePremium | string | "" | iPhone App Store ID for the Twitter app card |
twitter:app:url:iphonePremium | string | "" | iPhone deep link for the Twitter app card |
twitter:app:name:ipadPremium | string | "" | iPad app name for the Twitter app card |
twitter:app:id:ipadPremium | string | "" | iPad App Store ID for the Twitter app card |
twitter:app:url:ipadPremium | string | "" | iPad deep link for the Twitter app card |
twitter:app:name:googleplayPremium | string | "" | Google Play app name for the Twitter app card |
twitter:app:id:googleplayPremium | string | "" | Google Play app ID for the Twitter app card |
twitter:app:url:googleplayPremium | string | "" | Android deep link for the Twitter app card |
headingsPremium | array[37] | Array of heading elements with level and text | |
levelPremium | string | "h1" | |
textPremium | string | "Every API your product needs, behind one key." | |
imgTagsPremium | array[50] | Array of image tags with src and alt attributes | |
srcPremium | string | "/images/favicon.png" | |
altPremium | string | "" | |
widthPremium | string | "26" | |
heightPremium | string | "26" | |
responseBodyPremium | string | "" | Raw HTML response body content |
viewport | string | "width=device-width, initial-scale=1, maximum-scale=1" | Viewport meta tag for responsive design |
theme-colorPremium | string | "#ffffff" | Theme color meta tag for browser UI |
application-name | string | "APIVerve" | |
og:image:alt | string | "APIVerve — One key for 300+ production APIs" |
Errors
Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change. Error handling covers the full status list and which of them are worth retrying.
| Status | Meaning | What to do |
|---|---|---|
400 | Input was rejected | Read error; it names the parameter. |
401 | Key missing or invalid | Check the header name and the key value. |
403 | Key valid, but not permitted | A key restriction or IP allow-list; see key scoping. |
429 | Rate limited, or out of credits | Read error to tell them apart; see rate limits. |
Use cases
- Social Link Previews
- Chat applications fetch page title and meta description tags from shared links to display inline reading snippets in conversation feeds.
- Bookmark Library Archiving
- When archiving external resources, digital asset management platforms capture the page author, description, and keywords to catalog source references.
- Search Crawl Auditing
- Flag indexing barriers across client domains by evaluating robots tags, character encoding, and viewport settings extracted during scheduled crawls.
- Link Redirect Verification
- To detect outdated redirects, publishing platforms compare the original submitted URL against the resolved destination address and page title.
Other ways to use Metadata Extractor
Set up Metadata Extractor on APIVerve, or reach the same source a different way. Your APIVerve account and credits work on all of them — one key, one balance.
Give it to an AI agentConnect over MCP and your agent calls it as a native tool — Claude, Cursor, ChatGPT.VerveKit →Reference →
Google Sheets or ExcelA =VERVE() formula fills a column — no script, no export, recalculates in place.VerveSheets →Reference →
Ground an agent on itA cited, machine-checkable fact your model can't produce on its own.VerveContext →Reference →
Related
More in Data Processing: