npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

iframely

v2.3.0

Published

oEmbed/2 gateway endpoint. Get embed data for various http links through one self-hosted API

Downloads

44,392

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

ittecoitteco

Keywords

oembedembedopen graphogtwitter cards

Readme

Iframely API for Responsive Web Embeds and URL Meta

This is the self-hosted version of Iframely's APIs and HTML parsers.

Iframely takes your URL and returns its metadata. If supported on the URL, we'll add HTML of rich media embeds. Think layers, posts, slideshows, surveys, infographics, maps and more.

This package includes specific domain parsers for most popular publishers. YouTube, Facebook, Instagram, Twitter, SoundCloud, Google Maps, TED, Twitch and many more. See /plugins/domains folder. In addition, we cover many domains by whitelisting media through the generic publishing protocols: oEmbed, Open Graph, Twitter Cards and microformats. For the rest of URLs, you'll include have metadata and thumbnail images from those protocols. Use it to create your own URL previews.

Iframely's whitelist file is fetched from our central database. The changes are synced automatically to your instance by default. But you replace that with your own whitelist file. There should be over 1500 domains covered by the central whitelist.

Breaking changes in version 2.0.0

The minimum version of the Node required for Iframely starting from version 2.0.0 is Node 14. Please see migration steps from earlier versions.

API endpoints

To make use of the data, you need to connect to APIs over HTTP. There are two endpoints available. One in oEmbed and one in Iframely API format. The oEmbed endpoint is just an adapter from Iframely to oEmbed spec.

Iframely format mimics the <head> section of the page. It has meta field for data and links array for media.

Both endpoints accept &url= input and provide JSON response. Below are some open responses from our cloud API, so you can see the format:

You can use Iframely can as Node.js library. That's how we use it in the cloud. However, documentation on it is lacking.

Not included as compared to Cloud API

Hosted cloud APIs can optionally return Iframely.com-powered iFrame renders in the html field. iFrames deliver all hosted widgets such as cards for URL previews, GIF support, player events, AMP, and others. Our per-URL customization, predictive sizing mechanism for JavaScript-based embeds to minimize the layout shift, lazy-loading, type-based media whitelist and the number of other configurations are only available in the cloud.

This open-source version provides the web parsers only. Iframely cloud use data from those parsers as-is in production. Though the format of API endpoints between the cloud and self-hosted version should match, there might be minor discrepancies.

Finally, there's a number of domain plugins not included in self-hosted version. We seem to have stopped adding new publishers to the open-source. It looks like many of our later providers need quicker turnaround time for updates and fixes. You can extend the self-hosted version with private plugins too.

Get started:

To get started with the APIs:

Contribute

We put our best effort to maintain Iframely and all its domain parsers. Please, feel free to reach us on Twitter or to submit an issue if you have any suggestions. Our support email is support at iframely.com

Fork and pull-request, if you'd like to add more plugins and/or contribute fixes or improvements. By doing so, you make your work available under the same MIT license.

Please submit your PR against develop branch. This is where everything gets merged before we release it into master.

License & Authors

MIT License. (c) 2012-2022 Itteco Software Corp. Nazar Leush, Ivan Paramonau and the contributors.