One request. Any URL.
Microlink API
The headless browser cloud. We run the fleet. You get the output.
- No API key required to start
- 25 requests per day free
- Cached across 340+ edge locations
Paste this into your agent.
Install the Microlink skill. Run `npx -y skills add microlinkhq/skills/microlink`. It is the entry point for every Microlink product. Then use Microlink when I need a screenshot, PDF, markdown, or scrape from any URL.
One skill. It covers every Microlink product.
The following examples show how to use the Microlink API with CLI, cURL, JavaScript, Python, Ruby, PHP & Golang, targeting 'https://github.com/' URL:
CLI Microlink API example
microlink https://github.com/cURL Microlink API example
curl -G "https://api.microlink.io" \
-d "url=https://github.com/"JavaScript Microlink API example
import createClient from 'microlink.io'
const microlink = createClient()
const data = await microlink.metadata('https://github.com/')Python Microlink API example
import requests
url = "https://api.microlink.io/"
querystring = {
"url": "https://github.com/"
}
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://github.com/"
}
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.bodyPHP Microlink API example
<?php
$baseUrl = "https://api.microlink.io/";
$params = [
"url" => "https://github.com/"
];
$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://github.com/")
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))
}One endpoint, production-ready speed.
2.8
secs
Screenshot P95
2.0
secs
Metadata P95
99.9
%
SLA on paid plans
Call the API. No key needed.
The free endpoint is a GET. Pass a URL, read JSON. Add a key later when you need Search, more quota, a proxy, or a custom cache TTL.
Pick any URL
A public page is enough. The API detects when a page needs a headless browser, so client-rendered sites work as well as static HTML.https://github.comHit api.microlink.io
GET api.microlink.io with a url. Metadata comes back by default.?url=https://github.comAsk for what you need
&screenshot=true &data.markdown.attr=markdown
https://api.microlink.ioEverything you can build with the API
Every product runs on the same endpoint. Open one to see what it does and how to use it.
How every request actually runs
Isolation, adblock, automation, and the edge cache run on every plan. Cards marked PRO need an API key. Open a primitive to see when to use it.
Antibot Detection
PRO
Know exactly who blocked your request and why, across 30+ antibot and CAPTCHA providers.
Browser Automation
Click, scroll, wait, type, set device and more. Shape the page before you capture it.
Adblock & Cookie Banners
Ads and trackers blocked, cookie banners dismissed automatically. On by default, on every plan.
Browser Functions
Run JavaScript with Puppeteer and npm packages. No infrastructure, no servers.
Configurable Caching
PRO
Cache responses for 1 minute to 31 days. Cache hits are free and ultra fast.
Custom HTTP Headers
PRO
Forward cookies, tokens and any header to the target page. Keep secrets out of the URL.
Proxy Resolution
PRO
Automatically bypass Cloudflare, DataDome, Akamai and more. We handle the hard part.
Request Isolation
One ephemeral browser per call. SSRF blocked before navigation.
Web Scraping
Extract structured JSON from any webpage using CSS selectors. URL → JSON in one request.
Use it from code, a terminal, or an agent
The endpoint is HTTP. These are the wrappers when you do not want to compose the query string by hand.
Start free, scale when ready
No signup, no API key, no credit card. 25 requests/day on the free plan. Pro is the same API with more quota and production controls.
Free
Try the API in seconds. No card.
$0/month
25 requests per day
Pro
For production workloads.
$49/month
≈ $1.07 per 1,000 requests
46,000 requests / month
- Everything in Free
- Automatic proxy resolution
- Configurable TTL
- Custom HTTP headers
- Custom cache key
- Priority email support
Cancel anytime · No setup fees
Business & Enterprise
Bought the way companies buy.
- Everything in Pro, plus:
- Card or invoice, PO number, net 30
- NDA, DPA & service agreement
- Vendor assessments on request
- Same named contact
- Annual billing, 10% discount
Enterprise adds
Enterprise API controls, contracts, and support
Business is the Pro API, bought the way your company buys. Enterprise is the same API on hardware that serves only you.
Dedicated environment
Your own API endpoint and browser pool on Enterprise. No shared capacity, no noisy neighbors.99.9% uptime SLA
On every paid plan. Enterprise adds service credits and no rate limits, so traffic spikes are served, not throttled.Your storage and CDN
On Enterprise, your own asset store with no TTL cap and your own CDN across 340+ Cloudflare edge nodes.
Built on open source,
trusted by developers
The Microlink API runs on open source you can read, fork, and run yourself: metascraper for metadata, browserless for the headless browser, and mql, the HTTP client behind the SDK.
Frequently asked questions
The questions that come up the first time you call the endpoint.
What is the Microlink API?
A REST API that turns any URL into structured data. Call api.microlink.io on the free plan, or pro.microlink.io with an API key.
Metadata is returned by default. Add query parameters for screenshots, PDFs, markdown, embeds, or a browser function.
Do I need an API key?
Not to start. The free plan is 25 requests per day with no key and no credit card.
What can I get from one request?
Normalized metadata by default: title, description, image, logo, and more.
The same request can also return a screenshot, PDF, markdown, HTML, iframe embed, or the return value of a browser function. See combining workflows.
When you only need one of those, add meta=false to skip metadata, which is usually the biggest speedup. More in production patterns.
What does a response look like?
JSON with a status field: success, fail for a problem with the request, or error for a server-side issue. The payload lives in data.
Failed requests add a code such as EINVALURL or ERATE and a human-readable message. See the response format and error codes.
Can I use the API URL directly as an image or file?
Yes. Add embed with the field you want, such as embed=screenshot.url, and the API answers with that asset instead of JSON.
The request URL then works as an img src, an og:image, or a PDF download link. Keep API keys out of those URLs. See embedding screenshots.
How is this different from running Puppeteer myself?
You do not run browsers, proxies, caches, or a fleet.
Pages that need rendering run in an isolated browser, Pro adds a residential proxy when a site blocks you, and responses are cached at the edge. Cache hits are free.
When is Microlink not the right fit?
When you need to crawl thousands of pages by following links, drive a live browser session interactively, or fetch static HTML that needs no rendering.
A crawler, a local Puppeteer or Playwright instance, or a plain HTTP client fits those better. See when something else is better.
How does caching work?
Every response is cached for 24 hours by default, and the x-cache-status header tells you whether it was a MISS or a HIT. Cache hits are free and fast. Add force to skip the cache.
On Pro, ttl sets anything from 1 minute to 31 days and staleTtl serves the cached copy while a fresh one is fetched. See the caching guide.
What happens when a site blocks the request?
On the free plan, a site behind antibot protection returns the EPROXYNEEDED error.
On Pro, Microlink names the antibot or CAPTCHA provider that blocked you and retries the same request through a residential proxy automatically. See the proxy guide.
What is included on the free plan?
25 requests per day on every product except Search, no credit card.
How do I know how much quota is left?
All requests return x-rate-limit-limit, x-rate-limit-remaining, and x-rate-limit-reset. The free endpoint reports the daily window. Pro reports your plan quota, resets at the start of the next month in UTC, and can lag the live counter by a few minutes. Past the limit you get HTTP 429 with the ERATE code.
There is no throttling, so parallel requests are fine within your quota. On Pro you are notified at 80% of your plan, and requests pause at 100% with no overage fees. See handling rate limits.
How do I authenticate?
Send your Pro token as the x-api-key request header to pro.microlink.io.
Do not put the key in frontend code. Use a proxy that allowlists your domains, as shown in authentication.
Where is the documentation?
The API reference lives in the docs.
Guides cover workflows, starting with what Microlink is and how a request works. The SDK has its own docs, and the OpenAPI spec is machine-readable.
Do you offer an enterprise API?
Yes. Business is Pro with invoicing, net 30, NDA, DPA, and a named contact.
Enterprise is a dedicated environment with your own endpoint, browser pool, storage, and CDN. Every paid plan has a 99.9% uptime SLA, and only Enterprise backs it with service credits. See Business & Enterprise.
Start now
Hit the endpoint with any URL. 25Â requests/day, no account, no card.
No login needed
25 reqs/day free
No credit card