Skip to content

screenshot › element

Type: <string>
It captures the DOM element matching the given for the screenshot over the target url.

The following examples show how to use the Microlink API with CLI, cURL, JavaScript, Python, Ruby, PHP & Golang, targeting 'https://codepen.io/fossheim/full/oNjxrZa' URL with 'screenshot' API parameter:

CLI Microlink API example

microlink https://codepen.io/fossheim/full/oNjxrZa&screenshot.element=#result-iframe-wrap

cURL Microlink API example

curl -G "https://api.microlink.io" \
  -d "url=https://codepen.io/fossheim/full/oNjxrZa" \
  -d "screenshot.element=#result-iframe-wrap"

JavaScript Microlink API example

import mql from '@microlink/mql'

const { data } = await mql('https://codepen.io/fossheim/full/oNjxrZa', {
  screenshot: {
    element: "#result-iframe-wrap"
  }
})

Python Microlink API example

import requests

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

querystring = {
    "url": "https://codepen.io/fossheim/full/oNjxrZa",
    "screenshot.element": "#result-iframe-wrap"
}

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://codepen.io/fossheim/full/oNjxrZa",
  screenshot.element: "#result-iframe-wrap"
}

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://codepen.io/fossheim/full/oNjxrZa",
    "screenshot.element" => "#result-iframe-wrap"
];

$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://codepen.io/fossheim/full/oNjxrZa")
    q.Set("screenshot.element", "#result-iframe-wrap")
    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))
}
It will wait for the element to appear in the page and to be visible.