Introduction

Link Preview is a easy to use REST API to fetch webpage OGP meta data and generate a preview of webpage content.

Usage scenario

• 🌅 Social Media App
• 📱 Messaging App
• 📧Email Communication

Features

• Parse basic OGP data eg. title, description, image etc
• Parse extensive OGP data

How to use?

Parse basic OGP

const axios = require('axios');

const options = {
  method: 'GET',
  url: '<LINK_PREVIEW_SERVER>/min',
  params: {
    url: 'https://www.youtube.com/watch?v=ybJ_R08SogU',
  }
};

try {
	const response = await axios.request(options);
	console.log(response.data);
} catch (error) {
	console.error(error);
}

{
  "url": "https://www.youtube.com/watch?v=Q-uy0FS6RwU",
  "canonical_url": "https://www.youtube.com/watch?v=Q-uy0FS6RwU",
  "title": "Go Class: 15 Networking with HTTP - YouTube",
  "description": "In this segment I introduce Go's support for HTTP clients and servers and give a little preview of Go's support for object-oriented programming.Slides at: ht...",
  "cover": "https://i.ytimg.com/vi/Q-uy0FS6RwU/maxresdefault.jpg",
  "sitename": "YouTube",
  "images": null,
  "icons": [
    "https://www.youtube.com/s/desktop/ff71ea81/img/favicon.ico",
    "https://www.youtube.com/s/desktop/ff71ea81/img/favicon_32x32.png",
    "https://www.youtube.com/s/desktop/ff71ea81/img/favicon_48x48.png",
    "https://www.youtube.com/s/desktop/ff71ea81/img/favicon_96x96.png",
    "https://www.youtube.com/s/desktop/ff71ea81/img/favicon_144x144.png"
  ]
}

Parse Extensive OGP

const axios = require('axios');

const options = {
  method: 'GET',
  url: '<LINK_PREVIEW_SERVER>',
  params: {
    url: 'https://www.youtube.com/watch?v=ybJ_R08SogU',
  }
};

try {
	const response = await axios.request(options);
	console.log(response.data);
} catch (error) {
	console.error(error);
}

{
  "ogp": {
    "og:url": [
      "https://www.youtube.com/watch?v=hlWiI4xVXKY"
    ],
    "og:type": [
      "video.other"
    ],
    "og:image": [
      "https://i.ytimg.com/vi/hlWiI4xVXKY/maxresdefault.jpg"
    ],
    "og:title": [
      "Beautiful Relaxing Music • Peaceful Piano Music & Guitar Music | Sunny Mornings by Peder B. Helland"
    ],
    "fb:app_id": [
      "87741124305"
    ],
    "al:ios:url": [
      "vnd.youtube://www.youtube.com/watch?v=hlWiI4xVXKY&feature=applinks"
    ],
    "al:web:url": [
      "http://www.youtube.com/watch?v=hlWiI4xVXKY&feature=applinks"
    ],
    "og:site_name": [
      "YouTube"
    ],
    "og:video:tag": [
      "calm",
      "calm music",
      "calming",
      "calming music",
      "cello",
      "dormir",
      "détendre",
      "guitar",
      "insomnia",
      "meditar",
      "meditation",
      "meditation music",
      "peaceful",
      "peaceful music",
      "peder b. helland",
      "peter b. helland",
      "piano",
      "piano music",
      "relajarse",
      "relax",
      "relaxante",
      "relaxation",
      "relaxing",
      "relaxing music",
      "sleep",
      "sleep music",
      "sleeping",
      "sleeping music",
      "smoothing relaxation",
      "soothing",
      "soothing music",
      "soothing relaxation",
      "study music"
    ],
    "og:video:url": [
      "https://www.youtube.com/embed/hlWiI4xVXKY"
    ],
    "og:video:type": [
      "text/html"
    ],
    "al:android:url": [
      "vnd.youtube://www.youtube.com/watch?v=hlWiI4xVXKY&feature=applinks"
    ],
    "og:description": [
      "Beautiful relaxing music by Peder B. Helland. Enjoy peaceful piano music and guitar music (\"Sunny Mornings\") with birds singing in the background. Stream or ..."
    ],
    "og:image:width": [
      "1280"
    ],
    "og:video:width": [
      "1280"
    ],
    "al:ios:app_name": [
      "YouTube"
    ],
    "og:image:height": [
      "720"
    ],
    "og:video:height": [
      "720"
    ],
    "al:android:package": [
      "com.google.android.youtube"
    ],
    "al:android:app_name": [
      "YouTube"
    ],
    "al:ios:app_store_id": [
      "544007664"
    ],
    "og:video:secure_url": [
      "https://www.youtube.com/embed/hlWiI4xVXKY"
    ]
  },
  "seo": {
    "title": [
      "Beautiful Relaxing Music • Peaceful Piano Music & Guitar Music | Sunny Mornings by Peder B. Helland"
    ],
    "keywords": [
      "calm, calm music, calming, calming music, cello, dormir, détendre, guitar, insomnia, meditar, meditation, meditation music, peaceful, peaceful music, peder b. helland, peter b. helland, piano, piano music, relajarse, relax, relaxante, relaxation, relaxing, relaxing music, sleep, sleep music, sleeping, sleeping music, smoothing relaxation, soothing, soothing music, soothing relaxation, study music"
    ],
    "description": [
      "Beautiful relaxing music by Peder B. Helland. Enjoy peaceful piano music and guitar music (\"Sunny Mornings\") with birds singing in the background. Stream or ..."
    ],
    "theme-color": [
      "rgba(255, 255, 255, 0.98)"
    ],
    "twitter:url": [
      "https://www.youtube.com/watch?v=hlWiI4xVXKY"
    ],
    "twitter:card": [
      "player"
    ],
    "twitter:site": [
      "@youtube"
    ],
    "twitter:image": [
      "https://i.ytimg.com/vi/hlWiI4xVXKY/maxresdefault.jpg"
    ],
    "twitter:title": [
      "Beautiful Relaxing Music • Peaceful Piano Music & Guitar Music | Sunny Mornings by Peder B. Helland"
    ],
    "twitter:player": [
      "https://www.youtube.com/embed/hlWiI4xVXKY"
    ],
    "twitter:app:id:ipad": [
      "544007664"
    ],
    "twitter:description": [
      "Beautiful relaxing music by Peder B. Helland. Enjoy peaceful piano music and guitar music (\"Sunny Mornings\") with birds singing in the background. Stream or ..."
    ],
    "twitter:app:url:ipad": [
      "vnd.youtube://www.youtube.com/watch?v=hlWiI4xVXKY&feature=applinks"
    ],
    "twitter:player:width": [
      "1280"
    ],
    "twitter:app:id:iphone": [
      "544007664"
    ],
    "twitter:app:name:ipad": [
      "YouTube"
    ],
    "twitter:player:height": [
      "720"
    ],
    "twitter:app:url:iphone": [
      "vnd.youtube://www.youtube.com/watch?v=hlWiI4xVXKY&feature=applinks"
    ],
    "twitter:app:name:iphone": [
      "YouTube"
    ],
    "twitter:app:id:googleplay": [
      "com.google.android.youtube"
    ],
    "twitter:app:url:googleplay": [
      "https://www.youtube.com/watch?v=hlWiI4xVXKY"
    ],
    "twitter:app:name:googleplay": [
      "YouTube"
    ]
  },
  "title": "Beautiful Relaxing Music • Peaceful Piano Music & Guitar Music | Sunny Mornings by Peder B. Helland - YouTube",
  "canonical_url": "https://www.youtube.com/watch?v=hlWiI4xVXKY"
}