URL

Retrieve data from a URL

Give a url and get structured metadata back. Add query parameters to take a screenshot, render a PDF, extract fields, or embed a single asset. Failures use a typed error object with code and message.

get/

Request

  • Base URL: https://api.microlink.io
  • URL: https://api.microlink.io/
  • Auth: one of:
    • none
    • API key in header x-api-key

Query parameters

adblockboolean

Improve performance and reduce response times by blocking non-essential advertisements, trackers, and cookie banners.

animationsboolean

Control CSS animations and transitions during website rendering. Ensures consistent snapshots by handling motion effects in the headless browser.

audioboolean

Detect and extract audio sources from any URL. It returns browser-friendly audio URLs along with metadata enabling integration of media content from platforms.

cacheKeystring

Take full control of cache identity to maximize hit rates and avoid redundant processing. Requires an API key (free plan included).

string
OR
string[]

Automate browser interactions by clicking specific DOM elements via CSS selectors. Use this parameter to trigger navigation, toggle UI components, or change page state.

colorSchemestring

Force the browser to render websites in light or dark mode using the prefers-color-scheme CSS media feature.

dataobject

Define custom data extraction rules using CSS selectors. Extract specific content like prices, reviews, or any structured data from any URL, through the API or the SDK.

devicestring

Emulate a wide range of mobile, tablet, and desktop devices by automatically setting the correct viewport, user agent, and screen resolution.

embedstring

Return a specific data field directly as the response body with appropriate content-type headers. Embed screenshots, PDFs, or extracted data directly in HTML, CSS, or Markdown.

filenamestring

Define a custom name for generated assets like screenshots or PDFs using the filename parameter. Requires an API key (free plan included).

filterstring

Reduce response bandwidth and optimize payload size by selecting specific data fields.

forceboolean

Bypass the Microlink CDN cache to fetch a fresh version of the target URL. Use the force parameter to invalidate existing cached copies and ensure the most up-to-date metadata.

functionstring

Execute custom JavaScript code inside a headless browser to perform advanced scraping or automation tasks. Gain full control over the page lifecycle with Puppeteer access.

headersobject

Configure custom HTTP headers to be sent with your requests to the target URL. This Pro feature allows for emulating specific browsers. Requires an API key (free plan included).

boolean
OR
object

The iframe parameter returns ready-to-use HTML and script tags for hundreds of providers.

boolean
OR
object

Analyze web performance and stack data with Microlink Insights. Extract identified technologies via Wappalyzer and detailed Lighthouse audit reports directly from any target URL.

boolean
OR
object

Generate comprehensive Google Lighthouse reports for any URL. Export web performance audits in JSON, HTML, or CSV formats using custom configurations via Microlink API.

insights.technologiesboolean

Identify the software stack behind any URL using Microlink technology detection. It returns a detailed list of frameworks, CDNs, and analytics tools with confidence scores.

javascriptboolean

Control whether JavaScript is executed within the headless browser for a target URL.

mediaTypestring

Switch between "screen" and "print" CSS media queries to control how a website renders for capture.

boolean
OR
object

Extract normalized metadata from any URL, including titles, descriptions, images, and logos.

string
OR
string[]

Inject JavaScript modules into a webpage during the rendering process.

paletteboolean

Extract dominant color palettes and accessibility-compliant color schemes from detected images.

pdf.formatstring

Customize the paper format for PDF generation from any URL. Supports standard sizes including A4, Letter, Legal, and Tabloid for high-quality.

pdf.heightstring

Set a custom paper height for your PDF generation using pixels, inches, or other CSS units. Fine-tune the dimensions of your website-to-PDF conversions.

boolean
OR
object

Generate high-quality PDFs from any website using Microlink headless browser infrastructure.

pdf.landscapeboolean

Set the paper orientation to landscape for your website-to-PDF conversions. Toggle between portrait and landscape modes to optimize the layout of generated PDF documents.

string
OR
object

Configure custom paper margins for your website-to-PDF conversions. Specify unified margins or individual top, bottom, left, and right values.

pdf.pageRangesstring

Define specific page ranges for your website-to-PDF conversion. Extract single pages or custom intervals like "1-5, 8, 11-13" from any URL using the Microlink API pageRanges parameter.

pdf.scalenumber

Adjust the zoom level of your website-to-PDF conversions using the scale parameter with Microlink API automated browser.

pdf.widthstring

Set a custom paper width for your PDF generation using pixels, inches, or other CSS units. Fine-tune the horizontal dimensions of your website-to-PDF conversions.

boolean
OR
object

Validate the accessibility of all URLs extracted in the response payload. The ping parameter verifies that links to images, videos, or audio are publicly reachable.

boolean
OR
string

Optimize how content is fetched from the target URL by choosing between a headless browser or a simple HTTP request.

string
OR
object

Bypass IP rate limits, CAPTCHAs, and regional restrictions using high-quality proxy rotation. Requires an API key (free plan included).

proxy.locationstring

Route the request through a proxy IP in a specific country to fetch region-specific content. Requires an API key (free plan included).

proxy.urlstring

Route every sub-request through your own HTTP proxy server. Requires an API key (free plan included).

retrynumber

Configure the number of exponential backoff retries to attempt if the underlying browser encounters an unexpected internal error.

boolean
OR
object

Record a website as a short video instead of a static image. Capture animations, transitions and live content as an H.264 MP4 with a single API call.

screenshot.codeSchemestring

Beautify HTML and JSON content with professional code syntax highlighting using the codeScheme parameter. Choose from popular Prism themes like Darcula or provide a custom CSS URL.

screenshot.elementstring

Capture a specific DOM element as a screenshot by providing a CSS selector. The Microlink API automatically waits for the element to be visible before rendering the image.

screenshot.fullPageboolean

Capture a high-resolution screenshot of the entire scrollable content of a website. Use the fullPage parameter to render the complete layout of a URL.

boolean
OR
object

Generate high-fidelity screenshots of any website with a single API call. Automatically handle headless browser infrastructure to extract visual data.

screenshot.omitBackgroundboolean

Generate transparent screenshots by omitting the default white background of the webpage.

screenshot.overlayobject

Create professional screenshot compositions with customizable browser overlays and backgrounds.

screenshot.qualitynumber

Control JPEG compression for website screenshots. Set quality between 0 and 100 to balance file size and visual fidelity.

screenshot.typestring

Choose between JPEG or PNG file formats for your website screenshots. Assets are automatically optimized and served in modern formats based on client device capabilities.

string
OR
string[]

Inject custom JavaScript into a webpage before it is rendered or captured.

scrollstring

Navigate to specific sections of a webpage by scrolling to a DOM element matching a CSS selector.

string
OR
number
OR
boolean

Optimize API performance by serving cached content while simultaneously refreshing it in the background. Requires an API key (free plan included).

string
OR
string[]

Inject custom CSS into a webpage before it is rendered or captured. The styles parameter supports both inline CSS rules and absolute URLs to external stylesheets.

string
OR
number

Define the maximum duration allowed for the API to process a request before timing out. The timeout parameter accepts values in milliseconds or human-readable formats.

string
OR
number

Define the cache expiration time for your requests to balance data freshness and response speed. The ttl parameter supports human-readable formats. Requires an API key (free plan included).

urlstring required

The primary address of the website you want to process. The url parameter is the core requirement for any Microlink API request, serving as the base for metadata extraction.

videoboolean

Detect and extract direct video source URLs from any website in a browser-friendly format.

viewportobject

Customize the browser visible area and device capabilities to control how a website is rendered.

waitForSelectorstring

Pause browser execution until a specific element is present in the DOM. The waitForSelector parameter ensures that dynamic content is fully rendered before extracting data.

string
OR
number

Force the headless browser to wait for a specific duration before capturing or extracting data from the target URL.

string
OR
string[]

Fine-tune when Microlink considers a page fully "loaded" by waiting for specific lifecycle events.

Response

The URL was resolved successfully.

status'success' required

Changes

No recorded changes to this operation across all 1 revision of this API.