# microlink.io

> Markdown mirror of DialtoneApp's public top-site detail page for `microlink.io`.

URL: https://dialtoneapp.com/top-sites/microlink.io/index.md
Canonical HTML: https://dialtoneapp.com/top-sites/microlink.io

## Summary

- Domain: `microlink.io`
- Website: https://microlink.io
- Description: ai readable | score 30 | purchase read only
- Label: ai_readable
- Payment surface: Not available
- Purchase boundary: read_only
- Control boundary: unknown
- Rank: 468706

## robots

~~~text
User-agent: *
Allow: /
Sitemap: https://microlink.io/sitemap-index.xml
~~~

## llms

~~~text
# Microlink.io API Context for LLMs

Project: Microlink
Description: Turn any website into data. APIs for link previews, screenshots, PDF generation, and scraping.

## API Documentation
https://microlink.io/docs/api/getting-started/overview.md
https://microlink.io/docs/api/getting-started/data-fields.md
https://microlink.io/docs/api/getting-started/cli.md
https://microlink.io/docs/api/basics/authentication.md
https://microlink.io/docs/api/basics/cache.md
https://microlink.io/docs/api/basics/compression.md
https://microlink.io/docs/api/basics/endpoint.md
https://microlink.io/docs/api/basics/error-codes.md
https://microlink.io/docs/api/basics/format.md
https://microlink.io/docs/api/basics/rate-limit.md
https://microlink.io/docs/api/parameters/adblock.md
https://microlink.io/docs/api/parameters/animations.md
https://microlink.io/docs/api/parameters/audio.md
https://microlink.io/docs/api/parameters/click.md
https://microlink.io/docs/api/parameters/colorScheme.md
https://microlink.io/docs/api/parameters/data.md
https://microlink.io/docs/api/parameters/device.md
https://microlink.io/docs/api/parameters/embed.md
https://microlink.io/docs/api/parameters/filename.md
https://microlink.io/docs/api/parameters/filter.md
https://microlink.io/docs/api/parameters/force.md
https://microlink.io/docs/api/parameters/function.md
https://microlink.io/docs/api/parameters/headers.md
https://microlink.io/docs/api/parameters/iframe.md
https://microlink.io/docs/api/parameters/insights.md
https://microlink.io/docs/api/parameters/insights/lighthouse.md
https://microlink.io/docs/api/parameters/insights/technologies.md
https://microlink.io/docs/api/parameters/javascript.md
https://microlink.io/docs/api/parameters/mediaType.md
https://microlink.io/docs/api/parameters/meta.md
https://microlink.io/docs/api/parameters/modules.md
https://microlink.io/docs/api/parameters/palette.md
https://microlink.io/docs/api/parameters/pdf/format.md
https://microlink.io/docs/api/parameters/pdf/height.md
https://microlink.io/docs/api/parameters/pdf.md
https://microlink.io/docs/api/parameters/pdf/landscape.md
https://microlink.io/docs/api/parameters/pdf/margin.md
https://microlink.io/docs/api/parameters/pdf/pageRanges.md
https://microlink.io/docs/api/parameters/pdf/scale.md
https://microlink.io/docs/api/parameters/pdf/width.md
https://microlink.io/docs/api/parameters/ping.md
https://microlink.io/docs/api/parameters/prerender.md
https://microlink.io/docs/api/parameters/proxy.md
https://microlink.io/docs/api/parameters/retry.md
https://microlink.io/docs/api/parameters/screenshot/codeScheme.md
https://microlink.io/docs/api/parameters/screenshot/element.md
https://microlink.io/docs/api/parameters/screenshot/fullPage.md
https://microlink.io/docs/api/parameters/screenshot.md
https://microlink.io/docs/api/parameters/screenshot/omitBackground.md
https://microlink.io/docs/api/parameters/screenshot/overlay.md
https://microlink.io/docs/api/parameters/screenshot/type.md
https://microlink.io/docs/api/parameters/scripts.md
https://microlink.io/docs/api/parameters/scroll.md
https://microlink.io/docs/api/parameters/staleTtl.md
https://microlink.io/docs/api/parameters/styles.md
https://microlink.io/docs/api/parameters/timeout.md
https://microlink.io/docs/api/parameters/ttl.md
https://microlink.io/docs/api/parameters/url.md
https://microlink.io/docs/api/parameters/video.md
https://microlink.io/docs/api/parameters/viewport.md
https://microlink.io/docs/api/parameters/waitForSelector.md
https://microlink.io/docs/api/parameters/waitForTimeout.md
https://microlink.io/docs/api/parameters/waitUntil.md

## Cards Documentation
https://microlink.io/docs/cards/getting-started/editor.md
https://microlink.io/docs/cards/getting-started/embed.md
https://microlink.io/docs/cards/getting-started/overview.md
https://microlink.io/docs/cards/getting-started/presets.md
https://microlink.io/docs/cards/getting-started/query-variables.md
https://microlink.io/docs/cards/others/authentication.md
https://microlink.io/docs/cards/others/encoding.md
https://microlink.io/docs/cards/others/pricing.md

## MQL Documentation
https://microlink.io/docs/mql/getting-started/api.md
https://microlink.io/docs/mql/getting-started/installation.md
https://microlink.io/docs/mql/getting-started/overview.md
https://microlink.io/docs/mql/getting-started/usage.md
https://microlink.io/docs/mql/data/attr.md
https://microlink.io/docs/mql/data/evaluate.md
https://microlink.io/docs/mql/data/selector.md
https://microlink.io/docs/mql/data/selectorAll.md
https://microlink.io/docs/mql/data/type.md
https://microlink.io/docs/mql/rules/basic.md
https://microlink.io/docs/mql/rules/fallbacks.md
https://microlink.io/docs/mql/rules/nested.md

## Guides Documentation
https://microlink.io/docs/guides/index.md
https://microlink.io/docs/guides/what-is-microlink.md
https://microlink.io/docs/guides/function/index.md
https://microlink.io/docs/guides/screenshot/index.md
https://microlink.io/docs/guides/screenshot/browser-settings.md
https://microlink.io/docs/guides/screenshot/customizing-output.md
https://microlink.io/docs/guides/screenshot/embedding.md
https://microlink.io/docs/guides/screenshot/page-interaction.md
https://microlink.io/docs/guides/screenshot/private-pages.md
https://microlink.io/docs/guides/screenshot/caching-and-performance.md
https://microlink.io/docs/guides/screenshot/troubleshooting.md
https://microlink.io/docs/guides/pdf/index.md
https://microlink.io/docs/guides/pdf/embedding.md
https://microlink.io/docs/guides/pdf/page-preparation.md
https://microlink.io/docs/guides/pdf/page-size-and-layout.md
https://microlink.io/docs/guides/pdf/private-pages.md
https://microlink.io/docs/guides/pdf/caching-and-performance.md
https://microlink.io/docs/guides/pdf/troubleshooting.md
https://microlink.io/docs/guides/metadata/index.md
https://microlink.io/docs/guides/metadata/choosing-fields.md
https://microlink.io/docs/guides/metadata/delivery-and-response.md
https://microlink.io/docs/guides/metadata/extending-results.md
https://microlink.io/docs/guides/metadata/page-preparation.md
https://microlink.io/docs/guides/metadata/private-pages.md
https://microlink.io/docs/guides/metadata/caching-and-performance.md
https://microlink.io/docs/guides/metadata/troubleshooting.md
https://microlink.io/docs/guides/markdown/index.md
https://microlink.io/docs/guides/markdown/choosing-scope.md
https://microlink.io/docs/guides/markdown/delivery-and-response.md
https://microlink.io/docs/guides/data-extraction/index.md
https://microlink.io/docs/guides/data-extraction/defining-rules.md
https://microlink.io/docs/guides/data-extraction/delivery-and-response.md
https://microlink.io/docs/guides/data-extraction/page-preparation.md
https://microlink.io/docs/guides/data-extraction/private-pages.md
https://microlink.io/docs/guides/data-extraction/caching-and-performance.md
https://microlink.io/docs/guides/data-extraction/troubleshooting.md
https://microlink.io/docs/guides/insights/index.md
https://microlink.io/docs/guides/insights/caching-and-performance.md
https://microlink.io/docs/guides/insights/lighthouse-reports.md
https://microlink.io/docs/guides/insights/technology-detection.md
https://microlink.io/docs/guides/insights/troubleshooting.md
https://microlink.io/docs/guides/common/caching.md
https://microlink.io/docs/guides/common/private-pages.md
https://microlink.io/docs/guides/common/production-patterns.md
https://microlink.io/docs/guides/common/troubleshooting.md

## SDK Documentation
https://microlink.io/docs/sdk/getting-started/overview.md
https://microlink.io/docs/sdk/getting-started/polyfills.md
https://microlink.io/docs/sdk/getting-started/styling.md
https://microlink.io/docs/sdk/integrations/jekyll.md
https://microlink.io/docs/sdk/integrations/react.md
https://microlink.io/docs/sdk/integrations/vanilla.md
https://microlink.io/docs/sdk/integrations/vue.md
https://microlink.io/docs/sdk/parameters/api-key.md
https://microlink.io/docs/sdk/parameters/contrast.md
https://microlink.io/docs/sdk/parameters/direction.md
https://microlink.io/docs/sdk/parameters/fetch-data.md
https://microlink.io/docs/sdk/parameters/lazy.md
https://microlink.io/docs/sdk/parameters/media-ref.md
https://microlink.io/docs/sdk/parameters/media/auto-play.md
https://microlink.io/docs/sdk/parameters/media/controls.md
https://microlink.io/docs/sdk/parameters/media.md
https://microlink.io/docs/sdk/parameters/media/loop.md
https://microlink.io/docs/sdk/parameters/media/muted.md
https://microlink.io/docs/sdk/parameters/set-data.md
https://microlink.io/docs/sdk/parameters/size.md
https://microlink.io/docs/sdk/parameters/url.md
~~~

## llms-full

~~~text
# Microlink API Simplified Documentation

## 1. Overview
Microlink is a "browser-as-a-service" API. It turns any website URL into structured data, automating browser actions like scraping, taking screenshots, and generating PDFs.

**Core Value:**
- Input: A URL (and optional parameters).
- Output: Structured JSON containing metadata, media, screenshot URLs, or scraped content.

## 2. API Connection
- **Base Endpoint:** `GET https://api.microlink.io`
- **Authentication:**
  - **Free:** No key required (limited concurrency).
  - **Pro:** Send `x-api-key` header.
- **Client Libraries:**
  - Node.js: `@microlink/mql` (Recommended)
  - Other: cURL, Python, Ruby, PHP, Golang, Vanilla JS (fetch).

## 3. Request Parameters
All parameters are passed as query strings (REST) or options objects (Node.js SDK).

### Core Parameters
- `url` (Required): The target URL to process (must be encoded).
- `meta` (Boolean, default `true`): Extracts Open Graph/JSON-LD metadata.
- `prerender` (String): Set to `'auto'` to render client-side apps (React/Vue/SPA) before scraping.
- `ttl` (Number): Cache duration in milliseconds.

### Visual Actions
- `screenshot` (Boolean | Object):
  - `true`: Returns a screenshot URL.
  - `fullPage`: Capture entire height.
  - `overlay.browser`: `'dark'` | `'light'` (Wraps image in a browser frame).
- `pdf` (Boolean | Object):
  - `true`: Returns a PDF URL.
  - `format`: `'A4'`, `'Letter'`, etc.

### Intelligent Extraction
- `palette` (Boolean): Detect predominant colors from the main image.
- `embed` (String): Returns embeddable HTML for supported providers (YouTube, Spotify, etc.).
- `iframe` (Boolean): Returns specific oEmbed/iframe data.

### Custom Scraping (`data`)
Pass a `data` object to scrape specific DOM elements using CSS selectors.
- Syntax: `data.<field_name>.<property>=<value>`
- Example: Extract a price.
  - `data.price.selector` = `.product-price`
  - `data.price.attr` = `text`

## 4. Response Schema
The API returns a JSON object with a `status` and `data` object.

### Standard Metadata Fields (returned by default)
When `meta=true`, the following fields are normalized and returned:
- `author`: Human-readable author name.
- `date`: ISO 8601 publication date.
- `description`: Publisher's description.
- `title`: Article/Page title.
- `publisher`: Publisher brand name (e.g., "The New York Times").
- `lang`: ISO 639-1 language code (e.g., `en`).
- `url`: The final canonical URL (after redirects).

### Media Fields (Image/Video/Logo/Screenshot)
When a field contains media (like `image`, `logo`, `video`, or `screenshot`), it returns an object with context:
- `url`: The direct link to the asset.
- `type`: File extension (png, jpg, mp4).
- `size`: File size in bytes.
- `size_pretty`: Human-readable size (e.g., "4.12 kB").
- `width` / `height`: Dimensions in pixels.
- `duration`: (Video/Audio only) Duration in seconds.

### HTTP Context
- `statusCode`: HTTP status of the target URL.
- `headers`: HTTP headers of the target URL.
- `redirects`: Array of redirects followed (status code + url).

## 5. Examples

### JSON Response Example
```json
{
  "status": "success",
  "data": {
    "title": "Microlink.io",
    "description": "Turn websites into data...",
    "lang": "en",
    "image": {
      "url": "https://cdn.microlink.io/...",
      "type": "png",
      "size": 4118,
      "width": 280,
      "height": 280
    },
    "screenshot": {
      "url": "https://cdn.microlink.io/shot/...",
      "width": 1280,
      "height": 800
    }
  }
}
```

### Node.js Example with @microlink/mql

```javascript
const mql = require('@microlink/mql')

const { status, data } = await mql('https://github.com/microlinkhq', {
  screenshot: { overlay: { browser: 'dark' } },
  pdf: false,
  prerender: 'auto'
})

console.log(data.screenshot.url)
```

### Python Example

```python
import requests

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

querystring = {
    "url": "https://www.netflix.com/title/80057281",
    "screenshot": "true"
}

response = requests.get(url, params=querystring)

print(response.json())
```
~~~