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.
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": "https://apiverve.com",
"lang": "en",
"charset": "utf-8",
"title": "APIVerve - Fast, Scalable, and Reliable APIs",
"image": "",
"favicons": [
{
"rel": "icon",
"type": "image/x-icon",
"href": "/images/favicon.ico"
},
{
"rel": "icon",
"type": "image/png",
"href": "/images/favicon.png"
},
{
"rel": "apple-touch-icon",
"href": "/images/favicon.png"
}
],
"author": "APIVerve",
"description": "APIVerve offers fast, scalable, and reliable APIs for developers. Access data enrichment, validation, and integration services with enterprise-grade performance.",
"keywords": "API, developer tools, data enrichment, API integration, scalable APIs, reliable APIs",
"source": "",
"price": "",
"priceCurrency": "",
"availability": "",
"robots": "index, follow",
"jsonld": [
{
"@context": "https://schema.org",
"@type": "Organization",
"name": "APIVerve",
"url": "https://apiverve.com",
"logo": "https://apiverve.com/images/favicon.png",
"sameAs": [
"https://www.facebook.com/apiverve",
"https://www.twitter.com/apivervehq",
"https://www.linkedin.com/company/apiverve",
"https://github.com/apiverve",
"https://www.instagram.com/apiverve"
]
},
{
"@context": "https://schema.org",
"@type": "WebSite",
"url": "https://apiverve.com",
"potentialAction": {
"@type": "SearchAction",
"target": {
"@type": "EntryPoint",
"urlTemplate": "https://apiverve.com/marketplace?search={search_term_string}"
},
"query-input": "required name=search_term_string"
}
}
],
"og:url": "https://apiverve.com",
"og:locale": "",
"og:locale:alternate": "",
"og:title": "APIVerve - Fast, Scalable, and Reliable APIs",
"og:type": "website",
"og:description": "APIVerve offers fast, scalable, and reliable APIs for developers. Access data enrichment, validation, and integration services with enterprise-grade performance.",
"og:determiner": "",
"og:site_name": "APIVerve",
"og:image": "https://apiverve.com/images/posterImage.png",
"og:image:secure_url": "",
"og:image:type": "",
"og:image:width": "1200",
"og:image:height": "630",
"twitter:title": "APIVerve - Fast, Scalable, and Reliable APIs",
"twitter:description": "APIVerve offers fast, scalable, and reliable APIs for developers. Access data enrichment, validation, and integration services with enterprise-grade performance.",
"twitter:image": "https://apiverve.com/images/posterImage.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": "h4",
"text": "API Platform"
},
{
"level": "h5",
"text": "Core Platform"
},
{
"level": "h5",
"text": "Developer Tools"
},
{
"level": "h5",
"text": "Integrations"
},
{
"level": "h4",
"text": "Solutions"
},
{
"level": "h5",
"text": "By Industry"
},
{
"level": "h5",
"text": "By Use Case"
},
{
"level": "h4",
"text": "Resources"
},
{
"level": "h5",
"text": "Learn & Build"
},
{
"level": "h5",
"text": "Support & Community"
},
{
"level": "h5",
"text": "Trust & Transparency"
},
{
"level": "h1",
"text": "Fast, Scalable, and Reliable |"
},
{
"level": "h2",
"text": "Trusted by over 40,000 forward thinking developers"
},
{
"level": "h2",
"text": "Why Developers Choose APIVerve"
},
{
"level": "h3",
"text": "⚡ Unmatched Reliability"
},
{
"level": "h3",
"text": "🔑 True One-Key Simplicity"
},
{
"level": "h3",
"text": "🌐 GraphQL & Mocking"
},
{
"level": "h2",
"text": "Most Popular APIs"
},
{
"level": "h3",
"text": "Daily API Performance"
},
{
"level": "h2",
"text": "Trusted by Developers Worldwide"
},
{
"level": "h4",
"text": "Tomasz K."
},
{
"level": "h4",
"text": "Priya M."
},
{
"level": "h4",
"text": "Rafael S."
},
{
"level": "h2",
"text": "Native SDKs & Libraries"
},
{
"level": "h4",
"text": "JavaScript/TypeScript"
},
{
"level": "h4",
"text": "React"
},
{
"level": "h4",
"text": "Vue.js"
},
{
"level": "h4",
"text": "Angular"
},
{
"level": "h4",
"text": "Node.js"
},
{
"level": "h4",
"text": "Next.js"
},
{
"level": "h2",
"text": "Frequently Asked Questions"
},
{
"level": "h3",
"text": "How much usage is included with the Free Trial plan?"
},
{
"level": "h3",
"text": "How do I get an API Key?"
},
{
"level": "h3",
"text": "How does APIVerve use my data?"
},
{
"level": "h3",
"text": "Can I change my plan at any time?"
},
{
"level": "h3",
"text": "How do I know my plan usage?"
},
{
"level": "h3",
"text": "Can I cancel my plan anytime?"
},
{
"level": "h3",
"text": "Where can I find my invoices?"
},
{
"level": "h3",
"text": "What are your accepted payment methods?"
},
{
"level": "h3",
"text": "What happens when I go over the token limit for the month?"
},
{
"level": "h3",
"text": "What is a token?"
},
{
"level": "h3",
"text": "Do you offer student discounts?"
},
{
"level": "h2",
"text": "Ready to build something amazing?"
},
{
"level": "h3",
"text": "APIVerve"
},
{
"level": "h4",
"text": "Product"
},
{
"level": "h4",
"text": "Integrations"
},
{
"level": "h4",
"text": "Solutions"
},
{
"level": "h4",
"text": "Resources"
},
{
"level": "h4",
"text": "Compare"
},
{
"level": "h4",
"text": "SDKs"
},
{
"level": "h4",
"text": "Company"
},
{
"level": "h4",
"text": "Legal"
}
],
"imgTags": [
{
"src": "/images/favicon.png",
"alt": "APIVerve"
},
{
"src": "/images/wreath.svg",
"alt": "Award"
},
{
"src": "/images/brands/brand06.png",
"alt": "Postman"
},
{
"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": "Brand"
},
{
"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": "Brand"
},
{
"src": "/images/favicon.png",
"alt": "APIVerve"
}
],
"responseBody": "",
"viewport": "width=device-width, initial-scale=1,width=device-width, initial-scale=1",
"googlebot": "index, follow",
"theme-color": "#ffffff",
"application-name": "APIVerve",
"msapplication-TileColor": "#3b82f6",
"mobile-web-app-capable": "yes",
"apple-mobile-web-app-title": "APIVerve",
"apple-mobile-web-app-status-bar-style": "default",
"og:image:alt": "APIVerve - Fast, Scalable, and Reliable 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 | "https://apiverve.com" | 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 - Fast, Scalable, and Reliable 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" | |
typePremium | string | "image/x-icon" | |
hrefPremium | string | "/images/favicon.ico" | |
author | string | "APIVerve" | Page author extracted from meta tags |
description | string | "APIVerve offers fast, scalable, and reliable APIs for developers. Access data enrichment, validation, and integration services with enterprise-grade performance." | Page description from meta description tag |
keywords | string | "API, developer tools, data enrichment, API integration, scalable APIs, reliable APIs" | 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 | "index, follow" | Robots meta tag for search engine indexing |
jsonldPremium | array[2] | JSON-LD structured data schemas | |
@contextPremium | string | "https://schema.org" | |
@typePremium | string | "Organization" | |
namePremium | string | "APIVerve" | |
urlPremium | string | "https://apiverve.com" | Final resolved URL after redirects |
logoPremium | string | "https://apiverve.com/images/favicon.png" | |
sameAsPremium | array | [https://www.facebook.com/apiverve, ...] | |
og:urlPremium | string | "https://apiverve.com" | Open Graph URL for social media sharing |
og:localePremium | string | "" | Open Graph locale specification |
og:locale:alternate | string | "" | |
og:titlePremium | string | "APIVerve - Fast, Scalable, and Reliable APIs" | Open Graph title for social sharing |
og:typePremium | string | "website" | Open Graph content type category |
og:descriptionPremium | string | "APIVerve offers fast, scalable, and reliable APIs for developers. Access data enrichment, validation, and integration services with enterprise-grade performance." | Open Graph description for social sharing |
og:determiner | string | "" | |
og:site_namePremium | string | "APIVerve" | Open Graph site name for branding |
og:imagePremium | string | "https://apiverve.com/images/posterImage.png" | Open Graph image for social media preview |
og:image:secure_url | string | "" | |
og:image:type | string | "" | |
og:image:width | string | "1200" | |
og:image:height | string | "630" | |
twitter:titlePremium | string | "APIVerve - Fast, Scalable, and Reliable APIs" | Twitter card title for X sharing |
twitter:descriptionPremium | string | "APIVerve offers fast, scalable, and reliable APIs for developers. Access data enrichment, validation, and integration services with enterprise-grade performance." | Twitter card description for sharing |
twitter:imagePremium | string | "https://apiverve.com/images/posterImage.png" | Twitter card image for X preview |
twitter:image:alt | string | "" | |
twitter:cardPremium | string | "summary_large_image" | Twitter card type configuration |
twitter:site | string | "" | |
twitter:site:id | string | "" | |
twitter:url | string | "" | |
twitter:account_id | string | "" | |
twitter:creator | string | "" | |
twitter:creator:id | string | "" | |
twitter:player | string | "" | |
twitter:player:width | string | "" | |
twitter:player:height | string | "" | |
twitter:player:stream | string | "" | |
twitter:app:name:iphone | string | "" | |
twitter:app:id:iphone | string | "" | |
twitter:app:url:iphone | string | "" | |
twitter:app:name:ipad | string | "" | |
twitter:app:id:ipad | string | "" | |
twitter:app:url:ipad | string | "" | |
twitter:app:name:googleplay | string | "" | |
twitter:app:id:googleplay | string | "" | |
twitter:app:url:googleplay | string | "" | |
headingsPremium | array[52] | Array of heading elements with level and text | |
levelPremium | string | "h4" | |
textPremium | string | "API Platform" | |
imgTagsPremium | array[20] | Array of image tags with src and alt attributes | |
srcPremium | string | "/images/favicon.png" | |
altPremium | string | "APIVerve" | |
responseBodyPremium | string | "" | Raw HTML response body content |
viewport | string | "width=device-width, initial-scale=1,width=device-width, initial-scale=1" | Viewport meta tag for responsive design |
googlebot | string | "index, follow" | Googlebot specific crawling directives |
theme-colorPremium | string | "#ffffff" | Theme color meta tag for browser UI |
application-name | string | "APIVerve" | |
msapplication-TileColor | string | "#3b82f6" | |
mobile-web-app-capable | string | "yes" | |
apple-mobile-web-app-title | string | "APIVerve" | |
apple-mobile-web-app-status-bar-style | string | "default" | |
og:image:alt | string | "APIVerve - Fast, Scalable, and Reliable 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
- SEO Analysis
- Use the Metadata Extractor API to extract metadata for SEO analysis. Use the data to optimize content, improve search engine rankings, and increase website traffic
- Data Mining
- Conduct data mining by using the Metadata Extractor API to extract metadata. Use the data to extract data, collect information, and analyze trends
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.
Related
More in Data Processing: