Back to Developers portal

oEmbed API

The oEmbed API is retired and should not be used anymore!

oEmbed is an open standard for embedding content into a website. You can use the URL of any Inoreader article to obtain the embed code for that article.

Further information about oEmbed can be found on the oEmbed homepage.

API Endpoint

You can use the API endpoint to request the embed code for an article from its URL.

https://www.inoreader.com/oembed/api

Request parameters:

  • url - (mandatory) Article URL from Inoreader, it must be urlencoded;
  • format - (optional) The desired format of the oEmbed response. Possible formats XML or JSON. JSON is the default one;
  • maxwidth - (optional) The maximum desired width of the embed.;
  • maxheight - (optional) The maximum desired height of the embed.

Example of Request:

https://www.inoreader.com/oembed/api/article?url=http%3A%2F%2Fwww.inoreader.com%2Farticle%2F3a9c6e7f31414b1c-how-to-prevent-spotify-from-wasting-disk-space&format=json

https://www.inoreader.com/oembed/api/article?url=http%3A%2F%2Fwww.inoreader.com%2Farticle%2F3a9c6e7f31414b1c-how-to-prevent-spotify-from-wasting-disk-space&format=json&maxwidth=400&maxheight=500

Example Responses:

XML response
<oembed>
    <type>rich</type>
    <version>1.0</version>
    <provider_name>Inoreader</provider_name>
    <provider_url>https://www.inoreader.com</provider_url>
    <author_name>Ars Technica</author_name>
    <title>John Wick Ch. 2: The righteous violence we so desperately need right now</title>
    <url>
        https://www.inoreader.com/article/3a9c6e7f3159059e-john-wick-ch-2-the-righteous-violence-we-so-desperately-need-right-now
    </url>
    <width>400</width>
    <height>500</height>
    <html>
        <iframe src="https://www.inoreader.com/oembed/article/3a9c6e7f3159059e-john-wick-ch-2-the-righteous-violence-we-so-desperately-need-right-now" scrolling="yes" frameborder="0" allowtransparency="true" style="position:absolute;overflow-x:hidden;border:none;max-width:1000px;max-height:1200px;display:block;width:100%;height:100%;"></iframe>
    </html>
</oembed>
JSON response
{
    "type": "rich",
    "version": "1.0",
    "provider_name": "Inoreader",
    "provider_url": "https://www.inoreader.com",
    "author_name": "Ars Technica",
    "title": "John Wick Ch. 2: The righteous violence we so desperately need right now",
    "url": "https://www.inoreader.com/article/3a9c6e7f3159059e-john-wick-ch-2-the-righteous-violence-we-so-desperately-need-right-now",
    "width": "1000",
    "height": "1200",
    "html": "<iframe src=\"https://www.inoreader.com/article/3a9c6e7f3159059e-john-wick-ch-2-the-righteous-violence-we-so-desperately-need-right-now\" scrolling=\"yes\" frameborder=\"0\" allowtransparency=\"true\" style=\"position:absolute;overflow-x:hidden;border:none;max-width:1000px;max-height:1200px;display:block;width:100%;height:100%;\"></iframe>"
}

Discovery

Inoreader supports the discovery of the oEmbed URL.
Each article page contains two link tags with the types 'application/json+oembed' and 'text/xml+oembed' containing the URLs for JSON and XML oEmbed responses.

Back to Developers portal