# iframe

Type:

\<boolean\> \| \<object\>

\
Default: false

It enables embedded detection over the target [url](https://microlink.io/docs/api/parameters/url).

When is present, a new `iframe` data field will be returned when is possible. Any URL that implements [](https://oembed.com/)

oEmbed

specification is supported.

The following examples show how to use the Microlink API with CLI, cURL, JavaScript, Python, Ruby, PHP & Golang, targeting 'https://www.youtube.com/watch?v=9P6rdqiybaw' URL with 'iframe' API parameter:

### CLI Microlink API example

```
microlink https://www.youtube.com/watch?v=9P6rdqiybaw&iframe
```

### cURL Microlink API example

```
curl -G "https://api.microlink.io" \
  -d "url=https://www.youtube.com/watch?v=9P6rdqiybaw" \
  -d "iframe=true"
```

### JavaScript Microlink API example

```
import mql from '@microlink/mql'

const { data } = await mql('https://www.youtube.com/watch?v=9P6rdqiybaw', {
  iframe: true
})
```

### Python Microlink API example

```
import requests

url = "https://api.microlink.io/"

querystring = {
    "url": "https://www.youtube.com/watch?v=9P6rdqiybaw",
    "iframe": "true"
}

response = requests.get(url, params=querystring)

print(response.json())
```

### Ruby Microlink API example

```
require 'uri'
require 'net/http'

base_url = "https://api.microlink.io/"

params = {
  url: "https://www.youtube.com/watch?v=9P6rdqiybaw",
  iframe: "true"
}

uri = URI(base_url)
uri.query = URI.encode_www_form(params)

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
response = http.request(request)

puts response.body
```

### PHP Microlink API example

```
<?php

$baseUrl = "https://api.microlink.io/";

$params = [
    "url" => "https://www.youtube.com/watch?v=9P6rdqiybaw",
    "iframe" => "true"
];

$query = http_build_query($params);
$url = $baseUrl . '?' . $query;

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET"
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #: " . $err;
} else {
    echo $response;
}
```

### Golang Microlink API example

```
package main

import (
    "fmt"
    "net/http"
    "net/url"
    "io"
)

func main() {
    baseURL := "https://api.microlink.io"

    u, err := url.Parse(baseURL)
    if err != nil {
        panic(err)
    }
    q := u.Query()
    q.Set("url", "https://www.youtube.com/watch?v=9P6rdqiybaw")
    q.Set("iframe", "true")
    u.RawQuery = q.Encode()

    req, err := http.NewRequest("GET", u.String(), nil)
    if err != nil {
        panic(err)
    }

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }

    fmt.Println(string(body))
}
```

    import mql from '@microlink/mql'

    const { data } = await mql('https://www.youtube.com/watch?v=9P6rdqiybaw', {
      iframe: true
    })

Click to run the code and see the API response

If the discovery has been done successfully, the `iframe` field will be now present into the response:

    {
      "iframe": {
        "html": "<blockquote class=\"twitter-tweet\"><p lang=\"en\" dir=\"ltr\">our new shiny website has landed <a href=\"https://t.co/KIrhYYcTRx\">https://t.co/KIrhYYcTRx</a> <a href=\"https://t.co/cM0se2UoIg\">pic.twitter.com/cM0se2UoIg</a></p>&mdash; microlink.io (@microlinkhq) <a href=\"https://twitter.com/microlinkhq/status/1032664633960800257?ref_src=twsrc%5Etfw\">August 23, 2018</a></blockquote>\n<script async src=\"https://platform.twitter.com/widgets.js\" charset=\"utf-8\"></script>\n",
        "scripts": [
          {
            "async": true,
            "src": "https://platform.twitter.com/widgets.js",
            "charset": "utf-8"
          }
        ]
      }
    }

The \`iframe\` field has \`scripts\` and \`html\` subfields.

Additionally, you can supply any consumer query parameter supported by [](https://oembed.com/)

specification

, like `maxWidth` or `maxHeight`:

The following examples show how to use the Microlink API with CLI, cURL, JavaScript, Python, Ruby, PHP & Golang, targeting 'https://www.youtube.com/watch?v=9P6rdqiybaw' URL with 'iframe' API parameter:

### CLI Microlink API example

```
microlink https://www.youtube.com/watch?v=9P6rdqiybaw&iframe.maxWidth=350
```

### cURL Microlink API example

```
curl -G "https://api.microlink.io" \
  -d "url=https://www.youtube.com/watch?v=9P6rdqiybaw" \
  -d "iframe.maxWidth=350"
```

### JavaScript Microlink API example

```
import mql from '@microlink/mql'

const { data } = await mql('https://www.youtube.com/watch?v=9P6rdqiybaw', {
  iframe: {
    maxWidth: 350
  }
})
```

### Python Microlink API example

```
import requests

url = "https://api.microlink.io/"

querystring = {
    "url": "https://www.youtube.com/watch?v=9P6rdqiybaw",
    "iframe.maxWidth": "350"
}

response = requests.get(url, params=querystring)

print(response.json())
```

### Ruby Microlink API example

```
require 'uri'
require 'net/http'

base_url = "https://api.microlink.io/"

params = {
  url: "https://www.youtube.com/watch?v=9P6rdqiybaw",
  iframe.maxWidth: "350"
}

uri = URI(base_url)
uri.query = URI.encode_www_form(params)

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
response = http.request(request)

puts response.body
```

### PHP Microlink API example

```
<?php

$baseUrl = "https://api.microlink.io/";

$params = [
    "url" => "https://www.youtube.com/watch?v=9P6rdqiybaw",
    "iframe.maxWidth" => "350"
];

$query = http_build_query($params);
$url = $baseUrl . '?' . $query;

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET"
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #: " . $err;
} else {
    echo $response;
}
```

### Golang Microlink API example

```
package main

import (
    "fmt"
    "net/http"
    "net/url"
    "io"
)

func main() {
    baseURL := "https://api.microlink.io"

    u, err := url.Parse(baseURL)
    if err != nil {
        panic(err)
    }
    q := u.Query()
    q.Set("url", "https://www.youtube.com/watch?v=9P6rdqiybaw")
    q.Set("iframe.maxWidth", "350")
    u.RawQuery = q.Encode()

    req, err := http.NewRequest("GET", u.String(), nil)
    if err != nil {
        panic(err)
    }

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }

    fmt.Println(string(body))
}
```

    import mql from '@microlink/mql'

    const { data } = await mql('https://www.youtube.com/watch?v=9P6rdqiybaw', {
      iframe: {
        maxWidth: 350
      }
    })

Click to run the code and see the API response

Keep in mind the support for this query parameters depend on every provider implementation.

## [Providers supported](https://microlink.io/docs/api/parameters/iframe#providers-supported)

Most of the most popular sites over the Internet supports oEmbed protocol.

A non exhaustive list of supported providers are:

- [](https://www.23hq.com/)


  23HQ


- [](https://abraia.me/)


  Abraia


- [](https://embed.acast.com/)


  Acast


- [](https://secure.actblue.com/)


  ActBlue


- [](https://adilo.bigcommand.com/)


  Adilo


- [](https://www.afreecatv.com/)


  afreecaTV


- [](https://altium.com/)


  Altium LLC


- [](https://www.altrulabs.com/)


  Altru


- [](https://live.amcharts.com/)


  amCharts Live Editor


- [](https://amtraker.com/)


  Amtraker


- [](https://www.animatron.com/)


  Animatron


- [](https://animoto.com/)


  Animoto


- [](https://storymaps.arcgis.com/)


  ArcGIS StoryMaps


- [](https://app.archivos.digital/)


  Archivos


- [](https://assemblrworld.com/)


  AssemblrWorld


- [](https://audio.com/)


  audio.com


- [](https://audioboom.com/)


  Audioboom


- [](https://audioclip.naver.com/)


  AudioClip


- [](https://audiomack.com/)


  Audiomack


- [](https://audiomeans.fr/)


  Audiomeans


- [](https://www.avocode.com/)


  Avocode


- [](https://backtracks.fm/)


  Backtracks


- [](https://balsamiq.cloud/)


  Balsamiq Cloud


- [](https://beams.fm/)


  Beams.fm


- [](https://www.beautiful.ai/)


  Beautiful.AI


- [](https://www.behance.net/)


  Behance


- [](https://blackfire.io/)


  Blackfire.io


- [](https://blogcast.host/)


  Blogcast


- [](https://www.bookingmood.com/)


  Bookingmood


- [](https://boxofficebuz.com/)


  Box Office Buz


- [](https://www.bumper.com/)


  Bumper


- [](https://buttondown.email/)


  Buttondown


- [](https://cmc.byzart.eu/)


  Byzart Project


- [](https://cacoo.com/)


  Cacoo


- [](https://www.canva.com/)


  Canva


- [](https://img.catbo.at/)


  CatBoat


- [](https://www.ceros.com/)


  Ceros


- [](https://www.chartblocks.com/)


  ChartBlocks


- [](https://www.chirbit.com/)


  chirbit.com


-
- [](https://www.circuitlab.com/)


  CircuitLab


- [](https://www.clipland.com/)


  Clipland


- [](https://clyp.it/)


  Clyp


- [](https://ilovecoco.video/)


  CoCo Corp


- [](https://www.codehs.com/)


  CodeHS


- [](https://codepen.io/)


  CodePen


- [](https://codepoints.net/)


  Codepoints


- [](https://codesandbox.io/)


  CodeSandbox


- [](https://www.collegehumor.com/)


  CollegeHumor


- [](https://commaful.com/)


  Commaful


- [](https://coub.com/)


  Coub


- [](https://crowdranking.com/)


  Crowd Ranking


- [](https://crumb.sh/)


  Crumb.sh


- [](https://cueup.io/)


  Cueup DJ Booking


- [](https://curated.co/)


  Curated


- [](https://customerdb.com/)


  CustomerDB


- [](https://www.dadan.io/)


  dadan


- [](https://www.dailymotion.com/)


  Dailymotion


- [](https://www.datawrapper.de/)


  Datawrapper


- [](https://www.deseret.com/)


  Deseret News


- [](https://www.deviantart.com/)


  Deviantart.com


- [](https://www.ultimedia.com/)


  Digiteka


- [](https://www.docdroid.net/)


  DocDroid


- [](https://docswell.com/)


  Docswell


- [](https://dotsub.com/)


  Dotsub


- [](https://dreambroker.com/)


  Dream Broker


- [](https://d.tube/)


  DTube


- [](https://echoeshq.com/)


  EchoesHQ


- [](https://www.edumedia-sciences.com/)


  eduMedia


- [](https://egliseinfo.catholique.fr/)


  EgliseInfo


- [](https://embedery.com/)


  Embedery


- [](https://www.ethfiddle.com/)


  Ethfiddle


- [](https://eventlive.pro/)


  EventLive


- [](https://everviz.com/)


  everviz


- [](https://ex.co/)


  Ex.Co


- [](https://eyrie.io/)


  Eyrie


- [](https://www.facebook.com/)


  Facebook


- [](https://faithlifetv.com/)


  Faithlife TV


- [](https://fireworktv.com/)


  Firework


-
- [](https://flat.io/)


  Flat


- [](https://www.flickr.com/)


  Flickr


- [](https://flourish.studio/)


  Flourish


- [](https://flows.flowhub.org/)


  FlowHubOrg


- [](https://fooday.app/)


  Fooday


- [](https://www.foxsports.com.au/)


  FOX SPORTS Australia


- [](https://framebuzz.com/)


  FrameBuzz


- [](https://www.framer.com/)


  Framer


- [](https://www.geograph.org.uk/)


  Geograph Britain and Ireland


- [](https://geo-en.hlipp.de/)


  Geograph Germany


- [](https://www.gettyimages.com/)


  Getty Images


- [](https://www.gifnote.com/)


  Gifnote


-
- [](https://gloria.tv/)


  GloriaTV


- [](https://www.gmetri.com/)


  GMetri


- [](https://www.gong.io/)


  Gong


- [](https://grain.com/)


  Grain


- [](https://gtchannel.com/)


  GT Channel


- [](https://www.gumlet.com/)


  Gumlet


- [](https://gyazo.com/)


  Gyazo


-
- [](https://hearthis.at/)


  hearthis.at


- [](https://heyzine.com/)


  Heyzine


- [](https://www.hihaho.com/)


  hihaho


- [](https://hippovideo.io/)


  HippoVideo


- [](https://homey.app/)


  Homey


- [](https://huffduffer.com/)


  HuffDuffer


- [](https://www.hulu.com/)


  Hulu


- [](https://idomoo.com/)


  Idomoo


- [](https://www.ifixit.com/)


  iFixit


-
- [](https://www.iheart.com/)


  iHeartRadio


- [](https://imenupro.com/)


  iMenuPro


- [](https://player.indacolive.com/)


  Indaco


- [](https://infogram.com/)


  Infogram


- [](https://infoveave.net/)


  Infoveave


- [](https://www.injurymap.com/)


  Injurymap


- [](https://www.inoreader.com/)


  Inoreader


- [](https://inphood.com/)


  inphood


- [](https://instagram.com/)


  Instagram


- [](https://www.insticator.com/)


  Insticator Inc


- [](https://issuu.com/)


  Issuu


- [](https://play.itemis.io/)


  itemis CREATE


- [](https://jovian.com/)


  Jovian


- [](https://tv.kakao.com/)


  KakaoTv


- [](https://www.kickstarter.com/)


  Kickstarter


- [](https://www.kidoju.com/)


  Kidoju


- [](https://kirim.email/)


  Kirim.Email


- [](https://kit.co/)


  Kit


- [](https://www.kitchenbowl.com/)


  Kitchenbowl


- [](https://kmdr.sh/)


  kmdr


- [](https://jdr.knacki.info/)


  Knacki


- [](https://knowledgepad.co/)


  Knowledge Pad


- [](https://kooapp.com/)


  Kooapp


- [](https://kurozora.app/)


  Kurozora


- [](https://learningapps.org/)


  LearningApps.org


- [](https://umotion-test.univ-lemans.fr/)


  LeMans.Pod


- [](https://pod.univ-lille.fr/)


  Lille.Pod


- [](https://place.line.me/)


  Line Place


- [](https://livestream.com/)


  Livestream


- [](https://lottiefiles.com/)


  LottieFiles


- [](https://ludus.one/)


  Ludus


- [](https://latd.com/)


  Lumiere


- [](https://mathembed.com/)


  MathEmbed


- [](https://matterport.com/)


  Matterport


- [](https://me.me/)


  me.me


- [](https://mdstrm.com/)


  Mediastream


- [](https://medienarchiv.zhdk.ch/)


  Medienarchiv der Künste - Zürcher Hochschule der Künste


- [](https://mermaid.ink/)


  Mermaid Ink


- [](https://stream.microsoft.com/)


  Microsoft Stream


- [](https://www.minervaknows.com/)


  Minerva


- [](https://miro.com/)


  Miro


- [](https://mixcloud.com/)


  MixCloud


- [](https://mixpanel.com/)


  Mixpanel


- [](https://www.mobypicture.com/)


  Moby Picture


- [](https://musicboxmaniacs.com/)


  Music Box Maniacs


- [](https://namchey.com/)


  Namchey


- [](https://www.nanoo.tv/)


  nanoo.tv


- [](https://www.nb.no/)


  Nasjonalbiblioteket


- [](https://naturalatlas.com/)


  Natural Atlas


- [](https://ndla.no/)


  NDLA - Norwegian Digital Learning Arena


- [](https://www.nfb.ca/)


  nfb.ca


- [](https://observablehq.com/)


  Observable


- [](https://www.odds.com.au/)


  Odds.com.au


- [](https://odesli.co/)


  Odesli (formerly Songlink)


- [](https://odysee.com/)


  Odysee


- [](https://official.fm/)


  Official FM


- [](https://omniscope.me/)


  Omniscope


- [](https://omnystudio.com/)


  Omny Studio


- [](https://orbitvu.co/)


  Orbitvu


- [](https://origits.com/)


  Origits


- [](https://outplayed.tv/)


  Outplayed.tv


- [](https://overflow.io/)


  Overflow


-
- [](https://padlet.com/)


  Padlet


- [](https://pandavideo.com/)


  Panda Video


- [](https://www.pastery.net/)


  Pastery


- [](https://piggy.to/)


  Piggy


- [](https://builder.pikasso.xyz/)


  Pikasso


- [](https://www.pingvp.com/)


  PingVP


- [](https://www.pinpoll.com/products/tools)


  Pinpoll


- [](https://www.pinterest.com/)


  Pinterest


- [](https://www.pitchhub.com/)


  PitchHub


- [](https://www.pixdor.com/)


  Pixdor


- [](https://plusdocs.com/)


  Plusdocs


- [](https://podbean.com/)


  Podbean


- [](https://polldaddy.com/)


  Poll Daddy


- [](https://portfolium.com/)


  Portfolium


- [](https://prezi.com/)


  Prezi Video


- [](https://qtpi.gg/)


  QTpi


- [](https://www.quiz.biz/)


  Quiz.biz


- [](https://www.quizz.biz/)


  Quizz.biz


- [](https://radiopublic.com/)


  RadioPublic


- [](https://raindrop.io/)


  Raindrop


- [](https://www.rcvis.com/)


  rcvis


- [](https://reddit.com/)


  Reddit


- [](https://www.releasewire.com/)


  ReleaseWire


- [](https://replit.com/)


  Replit


- [](https://www.reverbnation.com/)


  ReverbNation


- [](https://roomshare.jp/)


  Roomshare


- [](https://roosterteeth.com/)


  RoosterTeeth


- [](https://rumble.com/)


  Rumble


- [](https://octopus.saooti.com/)


  Saooti


- [](https://videos.sapo.pt/)


  Sapo Videos


- [](https://www.screen9.com/)


  Screen9


- [](https://www.screencast.com/)


  Screencast.com


- [](https://www.screenr.com/)


  Screenr


- [](https://scribblemaps.com/)


  ScribbleMaps


- [](https://www.scribd.com/)


  Scribd


- [](https://www.sendtonews.com/)


  SendtoNews


- [](https://shoudio.com/)


  Shoudio


- [](https://getshow.io/)


  Show by Animaker


- [](https://showtheway.io/)


  Show the Way, actionable location info


- [](https://simplecast.com/)


  Simplecast


- [](https://onsizzle.com/)


  Sizzle


- [](https://sketchfab.com/)


  Sketchfab


- [](https://www.slideshare.net/)


  SlideShare


- [](https://smashnotes.com/)


  SmashNotes


- [](https://smeme.com/)


  Smeme


- [](https://www.smrthi.com/)


  Smrthi


- [](https://www.smugmug.com/)


  SmugMug


- [](https://www.socialexplorer.com/)


  SocialExplorer


- [](https://soundcloud.com/)


  SoundCloud


- [](https://speakerdeck.com/)


  SpeakerDeck


- [](https://spotify.com/)


  Spotify


- [](https://spotlightr.com/)


  Spotlightr


- [](https://www.spreaker.com/)


  Spreaker


- [](https://sproutvideo.com/)


  SproutVideo


- [](https://purl.stanford.edu/)


  Stanford Digital Repository


- [](https://streamable.com/)


  Streamable


- [](https://www.streamio.com/)


  Streamio


- [](https://subscribi.io/)


  Subscribi


- [](https://www.sudomemo.net/)


  Sudomemo


- [](https://www.sutori.com/)


  Sutori


- [](https://sway.office.com/)


  Sway Office


- [](https://www.sway.com/)


  Sway


- [](https://www.synthesia.io/)


  Synthesia


-
- [](https://www.nytimes.com/)


  The New York Times


- [](https://theysaidso.com/)


  They Said So


- [](https://www.tickcounter.com/)


  TickCounter


- [](https://www.tiktok.com/)


  TikTok


- [](https://tonicaudio.com/)


  Tonic Audio


- [](https://www.toornament.com/)


  Toornament


- [](https://www.topy.se/)


  Topy


- [](https://totango.com/)


  Totango


- [](https://trinityaudio.ai/)


  Trinity Audio


- [](https://www.tumblr.com/)


  Tumblr


- [](https://www.tuxx.be/)


  Tuxx


- [](https://tvcf.co.kr/)


  tvcf


- [](https://twinmotion.unrealengine.com/)


  Twinmotion


- [](https://typecast.ai/)


  TypeCast


- [](https://typlog.com/)


  Typlog


- [](https://uapod.univ-antilles.fr/)


  UAPod


- [](https://map.cam.ac.uk/)


  University of Cambridge Map


- [](https://mediatheque.univ-paris1.fr/)


  UnivParis1.Pod


- [](https://pod.u-pec.fr/)


  Upec.Pod


- [](https://www.ustream.tv/)


  Ustream


- [](https://www.ustudio.com/)


  uStudio, Inc.


- [](https://veer.tv/)


  VeeR VR


- [](https://veer.tv/)


  VeeR VR


-
- [](https://videfit.com/)


  Videfit


- [](https://vidmount.com/)


  VidMount


- [](https://vidyard.com/)


  Vidyard


- [](https://vimeo.com/)


  Vimeo


- [](https://www.viostream.com/)


  Viostream


- [](https://www.viously.com/)


  Viously


- [](https://vizydrop.com/)


  Vizydrop


- [](https://vlipsy.com/)


  Vlipsy


-
- [](https://www.vouchfor.com/)


  Vouch


- [](https://voxsnap.com/)


  VoxSnap


- [](https://wave.video/)


  Wave.video


- [](https://www.wecandeo.com/)


  wecandeo


- [](https://www.whimsical.com/)


  Whimsical


- [](https://wistia.com/)


  Wistia, Inc.


- [](https://www.wizer.me/)


  wizer.me


- [](https://wokwi.com/)


  Wokwi


- [](https://www.wolframcloud.com/)


  Wolfram Cloud


- [](https://wordpress.com/)


  WordPress.com


-
- [](https://www.youtube.com/)


  YouTube


-
- [](https://zeplin.io/)


  Zeplin


- [](https://app.zingsoft.com/)


  ZingSoft


- [](https://www.znipe.tv/)


  ZnipeTV


- [](https://zoomable.ca/)


  Zoomable