viewport

Type: <object>

It sets browser visible area settings and device capabilities over the target url.

The following examples show how to use the Microlink API with CLI, cURL, JavaScript, Python, Ruby, PHP & Golang, targeting 'https://en.wikipedia.org/wiki/Bob_Dylan' URL with 'screenshot' & 'viewport' API parameters:

CLI Microlink API example

microlink https://en.wikipedia.org/wiki/Bob_Dylan&screenshot&viewport.width=640&viewport.height=400&viewport.deviceScaleFactor=2&viewport.isMobile

cURL Microlink API example

curl -G "https://api.microlink.io" \
  -d "url=https://en.wikipedia.org/wiki/Bob_Dylan" \
  -d "screenshot=true" \
  -d "viewport.width=640" \
  -d "viewport.height=400" \
  -d "viewport.deviceScaleFactor=2" \
  -d "viewport.isMobile=true"

JavaScript Microlink API example

import mql from '@microlink/mql'

const { data } = await mql('https://en.wikipedia.org/wiki/Bob_Dylan', {
  screenshot: true,
  viewport: {
    width: 640,
    height: 400,
    deviceScaleFactor: 2,
    isMobile: true
  }
})

Python Microlink API example

import requests

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

querystring = {
    "url": "https://en.wikipedia.org/wiki/Bob_Dylan",
    "screenshot": "true",
    "viewport.width": "640",
    "viewport.height": "400",
    "viewport.deviceScaleFactor": "2",
    "viewport.isMobile": "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://en.wikipedia.org/wiki/Bob_Dylan",
  screenshot: "true",
  viewport.width: "640",
  viewport.height: "400",
  viewport.deviceScaleFactor: "2",
  viewport.isMobile: "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://en.wikipedia.org/wiki/Bob_Dylan",
    "screenshot" => "true",
    "viewport.width" => "640",
    "viewport.height" => "400",
    "viewport.deviceScaleFactor" => "2",
    "viewport.isMobile" => "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://en.wikipedia.org/wiki/Bob_Dylan")
    q.Set("screenshot", "true")
    q.Set("viewport.width", "640")
    q.Set("viewport.height", "400")
    q.Set("viewport.deviceScaleFactor", "2")
    q.Set("viewport.isMobile", "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://en.wikipedia.org/wiki/Bob_Dylan', {
  screenshot: true,
  viewport: {
    width: 640,
    height: 400,
    deviceScaleFactor: 2,
    isMobile: true
  }
})

Establishing a custom viewport.

The default viewport values are provided by the default device. The viewport should be defined by:

width <number>: The page width in pixels
height <number>: The page height in pixels.
deviceScaleFactor <number>: Specify device scale factor.
isMobile <boolean>: Whether the meta viewport tag is taken into account.
hasTouch <boolean>: Specifies if viewport supports touch events.
isLandscape <boolean>: Specifies if viewport is in landscape mode.

If you just provide an incomplete set of viewport values, they will be merged with the default values: