colorScheme

Type: <string>
Default: 'no-preference'

Sets prefers-color-scheme CSS media feature, indicating user preference to use 'light' or 'dark' color theme over the target url.

The following examples show how to use the Microlink API with CLI, cURL, JavaScript, Python, Ruby, PHP & Golang, targeting 'https://googlechromelabs.github.io/dark-mode-toggle/demo' URL with 'screenshot' & 'colorScheme' API parameters:

CLI Microlink API example

microlink https://googlechromelabs.github.io/dark-mode-toggle/demo&screenshot&colorScheme=dark

cURL Microlink API example

curl -G "https://api.microlink.io" \
  -d "url=https://googlechromelabs.github.io/dark-mode-toggle/demo" \
  -d "screenshot=true" \
  -d "colorScheme=dark"

JavaScript Microlink API example

import createClient from 'microlink.io'

const microlink = createClient()

const data = await microlink.screenshot('https://googlechromelabs.github.io/dark-mode-toggle/demo', {
  colorScheme: "dark"
})

Python Microlink API example

import requests

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

querystring = {
    "url": "https://googlechromelabs.github.io/dark-mode-toggle/demo",
    "screenshot": "true",
    "colorScheme": "dark"
}

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://googlechromelabs.github.io/dark-mode-toggle/demo",
  screenshot: "true",
  colorScheme: "dark"
}

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://googlechromelabs.github.io/dark-mode-toggle/demo",
    "screenshot" => "true",
    "colorScheme" => "dark"
];

$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://googlechromelabs.github.io/dark-mode-toggle/demo")
    q.Set("screenshot", "true")
    q.Set("colorScheme", "dark")
    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 createClient from 'microlink.io'

const microlink = createClient()

const data = await microlink.screenshot('https://googlechromelabs.github.io/dark-mode-toggle/demo', {
  colorScheme: "dark"
})