Url Preview 💻

Url preview is an free API providing metadata, jsonld from any webpage. You can also get data to preview url like on facebook, linkedind or twitter.

Usage 👩‍💻

You only have to do some http request to the api : https://urlpreview.vercel.app/api/v1

GET /preview

Request

Example : https://urlpreview.vercel.app/api/v1/preview?url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DdQw4w9WgXcQ

Parameters Value
url Url to scrap

To avoid any problem, don't forget to url encode the value you pass to the url parameter !

Response

Response body:

{
  "title": "Rick Astley - Never Gonna Give You Up (Video)",
  "description": "Rick Astley's official music video for “Never Gonna Give You Up” Listen to Rick Astley: https://RickAstley.lnk.to/_listenYD Subscribe to the official Rick As...",
  "image": "https://i.ytimg.com/vi/dQw4w9WgXcQ/maxresdefault.jpg",
  "domain": "www.youtube.com"
}

GET /metadata

Request

Example : https://urlpreview.vercel.app/api/v1/metadata?url=https%3A%2F%2Fwww.theverge.com%2F2017%2F11%2F16%2F16667366%2Ftesla-semi-truck-announced-price-release-date-electric-self-driving&suObject=true

Parameters Value
url Url to scrap
subObject Getting object response

To avoid any problem, don't forget to url encode the value you pass to the url parameter !

Response

Response body:

{
  "charset": "utf-8",
  "Content-Type": "text/html; charset=UTF-8",
  "X-UA-Compatible": "IE=edge",
  "viewport": "width=device-width, initial-scale=1, shrink-to-fit=no",
  "apple-mobile-web-app-title": "Verge",
  "article": {
    "publisher": "http://www.facebook.com/verge",
    "author": "http://facebook.com/zacestrada",
    "published_time": "2017-11-16T23:47:07-05:00",
    "modified_time": "2017-11-16T23:47:07-05:00"
  },
  "author": "Zac Estrada",
  "style-tools": "https://www.theverge.com/style/community/372/d321565222175dac2dea8810c0bb0352/tools.css",
  "google-site-verification": "IucFf_TKtbFFH8_YeFyEteQIwYPdANM1R46_U9DpAr4",
  "msvalidate": {
    "01": "D385D0326A3AE144205C298DB34B4E94"
  },
  "ahrefs-site-verification": "1e57a609922037a3fbdc1c22efd7334113f174f15608f37e1b8538a7b4ce64c3",
  "description": "500 miles of range and more aerodynamic than a supercar",
  "og": {
    "description": "500 miles of range and more aerodynamic than a supercar",
    "image": "https://cdn.vox-cdn.com/thumbor/iDt70XEkiWUnA-NhWSnRio8HoHg=/0x75:3840x2085/fit-in/1200x630/cdn.vox-cdn.com/uploads/chorus_asset/file/9699573/Semi_Front_Profile.jpg",
    "site_name": "The Verge",
    "title": "This is the Tesla Semi truck",
    "type": "article",
    "url": "https://www.theverge.com/2017/11/16/16667366/tesla-semi-truck-announced-price-release-date-electric-self-driving"
  },
  "fb": {
    "app_id": "549923288395304"
  },
  "twitter": {
    "card": "summary_large_image",
    "url": "https://www.theverge.com/2017/11/16/16667366/tesla-semi-truck-announced-price-release-date-electric-self-driving",
    "title": "This is the Tesla Semi truck",
    "description": "500 miles of range and more aerodynamic than a supercar",
    "image": "https://cdn.vox-cdn.com/thumbor/n32q2zYeYLQGqoLhoZyQij0iFfw=/0x120:3840x2040/fit-in/1200x600/cdn.vox-cdn.com/uploads/chorus_asset/file/9699573/Semi_Front_Profile.jpg",
    "site": "verge"
  },
  "sailthru": {
    "title": "This is the Tesla Semi truck",
    "tags": "general,the-verge,front-page,tech,transportation,cars,tesla,autonomous-cars",
    "description": "500 miles of range and more aerodynamic than a supercar",
    "date": "2017-11-16T23:47:07-05:00",
    "image": {
      "full": "https://cdn.vox-cdn.com/thumbor/FA1FPlEkmMBEWgC3trfRatP7H0w=/0x0:3840x2160/1600x900/cdn.vox-cdn.com/uploads/chorus_image/image/57642013/Semi_Front_Profile.0.jpg",
      "thumb": "https://cdn.vox-cdn.com/thumbor/-E2SunSVupc9hq6MfQ3PjuXXgzo=/840x0:3000x2160/200x200/cdn.vox-cdn.com/uploads/chorus_image/image/57642013/Semi_Front_Profile.0.jpg"
    }
  },
  "msapplication-TileImage": "https://cdn.vox-cdn.com/uploads/chorus_asset/file/7396113/221a67c8-a10f-11e6-8fae-983107008690.0.png",
  "msapplication-TileColor": "#393092",
  "theme-color": "",
  "outbrainsection": "autonomous-cars"
}

GET /jsonld

Request

Example : https://urlpreview.vercel.app/api/v1/jsonld?url=https%3A%2F%2Fwww.theverge.com%2F2017%2F11%2F16%2F16667366%2Ftesla-semi-truck-announced-price-release-date-electric-self-driving

Parameters Value
url Url to scrap

To avoid any problem, don't forget to url encode the value you pass to the url parameter !

Response

Response body:

[
  {
    "@context": "http://schema.org",
    "@type": "NewsArticle",
    "mainEntityOfPage": "https://www.theverge.com/2017/11/16/16667366/tesla-semi-truck-announced-price-release-date-electric-self-driving",
    "url": "https://www.theverge.com/2017/11/16/16667366/tesla-semi-truck-announced-price-release-date-electric-self-driving",
    "headline": "This is the Tesla Semi truck",
    "description": "500 miles of range and more aerodynamic than a supercar",
    "speakable": {
      "@type": "SpeakableSpecification",
      "xpath": [
        "/html/head/title",
        "/html/head/meta[@name='description']/@content"
      ]
    },
    "datePublished": "2017-11-16T23:47:07-05:00",
    "dateModified": "2017-11-16T23:47:07-05:00",
    "author": [
      {
        "@type": "Person",
        "name": "Zac Estrada"
      }
    ],
    "publisher": {
      "@type": "Organization",
      "name": "The Verge",
      "logo": {
        "@type": "ImageObject",
        "url": "https://cdn.vox-cdn.com/uploads/chorus_asset/file/13668586/google_amp.0.png",
        "width": 600,
        "height": 60
      }
    },
    "articleSection": "Front Page",
    "keywords": [
      "Front Page",
      "Tech",
      "Transportation",
      "Cars",
      "Tesla",
      "Autonomous Cars"
    ],
    "about": {
      "@type": "Event",
      "name": "Tesla Semi Truck Event 2017",
      "startDate": "2017-11-17T04:00:00+00:00",
      "location": {
        "@type": "Place",
        "name": "Tesla Motors factory",
        "address": "Hawthorne, California, USA"
      }
    },
    "image": [
      {
        "@type": "ImageObject",
        "url": "https://cdn.vox-cdn.com/thumbor/k8ssXKPAuRwxa1pKew982ZMgv0o=/1400x1400/filters:format(jpeg)/cdn.vox-cdn.com/uploads/chorus_asset/file/9699573/Semi_Front_Profile.jpg",
        "width": 1400,
        "height": 1400
      },
      {
        "@type": "ImageObject",
        "url": "https://cdn.vox-cdn.com/thumbor/l6nkV8CkJIdUrJIzHFWUFc1zLRM=/1400x1050/filters:format(jpeg)/cdn.vox-cdn.com/uploads/chorus_asset/file/9699573/Semi_Front_Profile.jpg",
        "width": 1400,
        "height": 1050
      },
      {
        "@type": "ImageObject",
        "url": "https://cdn.vox-cdn.com/thumbor/5Sqo6J73lBi1hwzEiKCQy6FLx3I=/1400x788/filters:format(jpeg)/cdn.vox-cdn.com/uploads/chorus_asset/file/9699573/Semi_Front_Profile.jpg",
        "width": 1400,
        "height": 788
      }
    ],
    "thumbnailUrl": "https://cdn.vox-cdn.com/thumbor/k8ssXKPAuRwxa1pKew982ZMgv0o=/1400x1400/filters:format(jpeg)/cdn.vox-cdn.com/uploads/chorus_asset/file/9699573/Semi_Front_Profile.jpg"
  }
]

License 🧾

Released under the MIT License.

Maintained by Marc-Etienne Dartus.