Documentation
Meta API

API to scrape meta from URLs

URL Meta provides a straight forward API to get meta of any given page on the internet. Following documentation covers the API. If you still have any questions, please reach out via chat or at team@urlmeta.org.

ℹ️

You'll need to register and get a free API key to access the API.

Auth

Follow the auth guide to add the required headers and your API key with requests.

Basics

KeyValueHelp
Endpointapi.urlmeta.org/metaShould always be accessed over https
api.urlmeta.org/ (deprecated)
MethodGET

Query Parameters

KeyValueHelp
urlThe URL to fetchrequired Along with scheme i.e: http or https

Example

To fetch the meta for https://backupdiary.com, we'll use:

https://api.urlmeta.org/meta?url=https%3A%2F%2Fbackupdiary.com

It is recommended to encode the url value. You can use encodeURIComponent in JavaScript and similar methods in other environments.

Response

The API will always return JSON response. Here's the response schema returned by the API.

{
  "result": {
    "status": "OK"
  },
  "meta": { ... }
}

meta key will contain all the meta parsed from the target page.

Here's an example response when https://backupdiary.com (opens in a new tab) is passed as url:

{
  "result": {
    "status": "OK"
  },
  "meta": {
    "site": {
      "name": "Backup Diary",
      "favicon": "https://backupdiary.com/icon.svg",
      "twitter": "https://twitter.com/@UseBackupDiary"
    },
    "image": "https://backupdiary.com/social-image.png",
    "title": "Backup Diary - leave a note for your loved ones",
    "description": "Store your important information, add recipients and then sign-in to your account once every 60 days. If you miss it, we'll send the information to your recipients."
  }
}

meta will only have the properties available on the given page. Make sure they are available in response before consuming them.