## Table of Contents - [What your function receives](#what-your-function-receives) - [Click, wait, and navigate](#click-wait-and-navigate) - [Combine with other parameters](#combine-with-other-parameters) - [CLI Microlink API example](#cli-microlink-api-example) - [cURL Microlink API example](#curl-microlink-api-example) - [JavaScript Microlink API example](#javascript-microlink-api-example) - [Python Microlink API example](#python-microlink-api-example) - [Ruby Microlink API example](#ruby-microlink-api-example) - [PHP Microlink API example](#php-microlink-api-example) - [Golang Microlink API example](#golang-microlink-api-example) - [See also](#see-also) --- [API](https://microlink.io/docs/api/getting-started/overview) [GUIDES](https://microlink.io/docs/guides) [MQL](https://microlink.io/docs/mql/getting-started/overview) [SDK](https://microlink.io/docs/sdk/getting-started/overview) [CARDS](https://microlink.io/docs/cards/getting-started/overview) API GUIDES MQL SDK CARDS Getting Started [Overview](https://microlink.io/docs/guides) [What is Microlink](https://microlink.io/docs/guides/what-is-microlink) [Screenshot](https://microlink.io/docs/guides/screenshot) [Customizing output](https://microlink.io/docs/guides/screenshot/customizing-output) [Browser settings](https://microlink.io/docs/guides/screenshot/browser-settings) [Page interaction](https://microlink.io/docs/guides/screenshot/page-interaction) [Delivery and embedding](https://microlink.io/docs/guides/screenshot/embedding) [Caching and performance](https://microlink.io/docs/guides/screenshot/caching-and-performance) [Private pages](https://microlink.io/docs/guides/screenshot/private-pages) [Troubleshooting](https://microlink.io/docs/guides/screenshot/troubleshooting) [Data extraction](https://microlink.io/docs/guides/data-extraction) [Defining rules](https://microlink.io/docs/guides/data-extraction/defining-rules) [Page preparation](https://microlink.io/docs/guides/data-extraction/page-preparation) [Delivery and response shaping](https://microlink.io/docs/guides/data-extraction/delivery-and-response) [Caching and performance](https://microlink.io/docs/guides/data-extraction/caching-and-performance) [Private pages](https://microlink.io/docs/guides/data-extraction/private-pages) [Troubleshooting](https://microlink.io/docs/guides/data-extraction/troubleshooting) [Embed](https://microlink.io/docs/guides/embed) [SDK](https://microlink.io/docs/guides/embed/sdk) [Iframe parameter](https://microlink.io/docs/guides/embed/iframe) [Custom HTML/CSS](https://microlink.io/docs/guides/embed/metadata-api) [Custom previews with AI](https://microlink.io/docs/guides/embed/custom-previews-with-ai) [Caching and performance](https://microlink.io/docs/guides/embed/caching-and-performance) [Private pages and proxy](https://microlink.io/docs/guides/embed/private-pages-and-proxy) [Troubleshooting](https://microlink.io/docs/guides/embed/troubleshooting) [Markdown](https://microlink.io/docs/guides/markdown) [Choosing scope](https://microlink.io/docs/guides/markdown/choosing-scope) [Delivery and response shaping](https://microlink.io/docs/guides/markdown/delivery-and-response) [Function](https://microlink.io/docs/guides/function) [Writing functions](https://microlink.io/docs/guides/function/writing-functions) [Browser interaction](https://microlink.io/docs/guides/function/browser-interaction) [Profiling and performance](https://microlink.io/docs/guides/function/profiling-and-performance) [Troubleshooting](https://microlink.io/docs/guides/function/troubleshooting) [PDF](https://microlink.io/docs/guides/pdf) [Page size and layout](https://microlink.io/docs/guides/pdf/page-size-and-layout) [Page preparation](https://microlink.io/docs/guides/pdf/page-preparation) [Delivery and embedding](https://microlink.io/docs/guides/pdf/embedding) [Caching and performance](https://microlink.io/docs/guides/pdf/caching-and-performance) [Private pages](https://microlink.io/docs/guides/pdf/private-pages) [Troubleshooting](https://microlink.io/docs/guides/pdf/troubleshooting) [Metadata](https://microlink.io/docs/guides/metadata) [Choosing fields](https://microlink.io/docs/guides/metadata/choosing-fields) [Extending results](https://microlink.io/docs/guides/metadata/extending-results) [Delivery and response shaping](https://microlink.io/docs/guides/metadata/delivery-and-response) [Page preparation](https://microlink.io/docs/guides/metadata/page-preparation) [Caching and performance](https://microlink.io/docs/guides/metadata/caching-and-performance) [Private pages](https://microlink.io/docs/guides/metadata/private-pages) [Troubleshooting](https://microlink.io/docs/guides/metadata/troubleshooting) [Insights](https://microlink.io/docs/guides/insights) [Technology detection](https://microlink.io/docs/guides/insights/technology-detection) [Lighthouse reports](https://microlink.io/docs/guides/insights/lighthouse-reports) [Caching and performance](https://microlink.io/docs/guides/insights/caching-and-performance) [Troubleshooting](https://microlink.io/docs/guides/insights/troubleshooting) [Common patterns](https://microlink.io/docs/guides/common/caching) [Caching patterns](https://microlink.io/docs/guides/common/caching) [Private pages](https://microlink.io/docs/guides/common/private-pages) [Proxy](https://microlink.io/docs/guides/common/proxy) [Troubleshooting](https://microlink.io/docs/guides/common/troubleshooting) [Production patterns](https://microlink.io/docs/guides/common/production-patterns) API GUIDES MQL SDK CARDS Getting Started [Overview](https://microlink.io/docs/guides) [What is Microlink](https://microlink.io/docs/guides/what-is-microlink) [Screenshot](https://microlink.io/docs/guides/screenshot) [Customizing output](https://microlink.io/docs/guides/screenshot/customizing-output) [Browser settings](https://microlink.io/docs/guides/screenshot/browser-settings) [Page interaction](https://microlink.io/docs/guides/screenshot/page-interaction) [Delivery and embedding](https://microlink.io/docs/guides/screenshot/embedding) [Caching and performance](https://microlink.io/docs/guides/screenshot/caching-and-performance) [Private pages](https://microlink.io/docs/guides/screenshot/private-pages) [Troubleshooting](https://microlink.io/docs/guides/screenshot/troubleshooting) [Data extraction](https://microlink.io/docs/guides/data-extraction) [Defining rules](https://microlink.io/docs/guides/data-extraction/defining-rules) [Page preparation](https://microlink.io/docs/guides/data-extraction/page-preparation) [Delivery and response shaping](https://microlink.io/docs/guides/data-extraction/delivery-and-response) [Caching and performance](https://microlink.io/docs/guides/data-extraction/caching-and-performance) [Private pages](https://microlink.io/docs/guides/data-extraction/private-pages) [Troubleshooting](https://microlink.io/docs/guides/data-extraction/troubleshooting) [Embed](https://microlink.io/docs/guides/embed) [SDK](https://microlink.io/docs/guides/embed/sdk) [Iframe parameter](https://microlink.io/docs/guides/embed/iframe) [Custom HTML/CSS](https://microlink.io/docs/guides/embed/metadata-api) [Custom previews with AI](https://microlink.io/docs/guides/embed/custom-previews-with-ai) [Caching and performance](https://microlink.io/docs/guides/embed/caching-and-performance) [Private pages and proxy](https://microlink.io/docs/guides/embed/private-pages-and-proxy) [Troubleshooting](https://microlink.io/docs/guides/embed/troubleshooting) [Markdown](https://microlink.io/docs/guides/markdown) [Choosing scope](https://microlink.io/docs/guides/markdown/choosing-scope) [Delivery and response shaping](https://microlink.io/docs/guides/markdown/delivery-and-response) [Function](https://microlink.io/docs/guides/function) [Writing functions](https://microlink.io/docs/guides/function/writing-functions) [Browser interaction](https://microlink.io/docs/guides/function/browser-interaction) [Profiling and performance](https://microlink.io/docs/guides/function/profiling-and-performance) [Troubleshooting](https://microlink.io/docs/guides/function/troubleshooting) [PDF](https://microlink.io/docs/guides/pdf) [Page size and layout](https://microlink.io/docs/guides/pdf/page-size-and-layout) [Page preparation](https://microlink.io/docs/guides/pdf/page-preparation) [Delivery and embedding](https://microlink.io/docs/guides/pdf/embedding) [Caching and performance](https://microlink.io/docs/guides/pdf/caching-and-performance) [Private pages](https://microlink.io/docs/guides/pdf/private-pages) [Troubleshooting](https://microlink.io/docs/guides/pdf/troubleshooting) [Metadata](https://microlink.io/docs/guides/metadata) [Choosing fields](https://microlink.io/docs/guides/metadata/choosing-fields) [Extending results](https://microlink.io/docs/guides/metadata/extending-results) [Delivery and response shaping](https://microlink.io/docs/guides/metadata/delivery-and-response) [Page preparation](https://microlink.io/docs/guides/metadata/page-preparation) [Caching and performance](https://microlink.io/docs/guides/metadata/caching-and-performance) [Private pages](https://microlink.io/docs/guides/metadata/private-pages) [Troubleshooting](https://microlink.io/docs/guides/metadata/troubleshooting) [Insights](https://microlink.io/docs/guides/insights) [Technology detection](https://microlink.io/docs/guides/insights/technology-detection) [Lighthouse reports](https://microlink.io/docs/guides/insights/lighthouse-reports) [Caching and performance](https://microlink.io/docs/guides/insights/caching-and-performance) [Troubleshooting](https://microlink.io/docs/guides/insights/troubleshooting) [Common patterns](https://microlink.io/docs/guides/common/caching) [Caching patterns](https://microlink.io/docs/guides/common/caching) [Private pages](https://microlink.io/docs/guides/common/private-pages) [Proxy](https://microlink.io/docs/guides/common/proxy) [Troubleshooting](https://microlink.io/docs/guides/common/troubleshooting) [Production patterns](https://microlink.io/docs/guides/common/production-patterns) [Copy for LLM](https://microlink.io/docs/guides/function/browser-interaction.md "Copy content for LLM") \| [View as Markdown](https://microlink.io/docs/guides/function/browser-interaction.md "View content as Markdown") Microlink functions can interact with a browser. When your function references `page`, you get the full [Puppeteer Page](https://pptr.dev/api/puppeteer.page) object: ```js const microlink = require('@microlink/function') const scrape = ({ page }) => page.$eval('h1', el => el.textContent.trim()) const fn = microlink(scrape) const result = await fn('https://example.com') console.log(result.value) // 'Example Domain' ``` Start with the high-level helpers before reaching for lower-level APIs: - [page.title](https://pptr.dev/api/puppeteer.page.title): Get the document title. - [page.\$eval](https://pptr.dev/api/puppeteer.page._eval): Run a function on the first matching element. - [page.\$\$eval](https://pptr.dev/api/puppeteer.page.__eval): Run a function on all matching elements. - [page.url](https://pptr.dev/api/puppeteer.page.url): Get the current URL. - [page.content](https://pptr.dev/api/puppeteer.page.content): Get the full page HTML. Any [Puppeteer Page method](https://pptr.dev/api/puppeteer.page) is available. ## What your function receives | Property | Type | Description | | ------------------- | ------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `page` | [Page✓](https://pptr.dev/api/puppeteer.page) | Full Puppeteer access for clicks, waits, evaluation, and navigation. When the function references `page`, Microlink navigates to the URL in a browser before calling your function | | `response` | [HTTPResponse✓](https://pptr.dev/api/puppeteer.httpresponse) | The response returned by the implicit navigation. Only available when the function uses `page` | | `headers` | `object` | The request headers used to fetch the target URL | | any extra parameter | depends on what you pass | Custom inputs forwarded from the request | ## Click, wait, and navigate Puppeteer helpers let you interact with the page before extracting data: ```js const microlink = require('@microlink/function') const scrapeAfterClick = ({ page }) => page .click('button.load-more') .then(() => page.waitForSelector('.results')) .then(() => page.$$eval('.results li', items => items.map(el => el.textContent.trim()) ) ) const fn = microlink(scrapeAfterClick) const result = await fn('https://example.com') ``` Replace fixed waits like `page.waitForTimeout(3000)` with [page.waitForSelector](https://pptr.dev/api/puppeteer.page.waitforselector) or [page.waitForNavigation](https://pptr.dev/api/puppeteer.page.waitfornavigation) whenever possible — they are faster and more reliable. ## Combine with other parameters Because [function](https://microlink.io/docs/api/parameters/function) is just another Microlink parameter, you can prepare the page before your function runs using [scripts](https://microlink.io/docs/api/parameters/scripts), [modules](https://microlink.io/docs/api/parameters/modules), [click](https://microlink.io/docs/api/parameters/click), or [waitForSelector](https://microlink.io/docs/api/parameters/wait-for-selector): The following examples show how to use the Microlink API with CLI, cURL, JavaScript, Python, Ruby, PHP & Golang, targeting 'https://microlink.io' URL with 'function', 'scripts' & 'meta' API parameters: ### CLI Microlink API example ```bash microlink https://microlink.io&function='({ page }) => page.evaluate("jQuery.fn.jquery")'&scripts=https://code.jquery.com/jquery-3.5.0.min.js ``` ### cURL Microlink API example ```bash curl -G "https://api.microlink.io" \ -d "url=https://microlink.io" \ -d "function=(%7B%20page%20%7D)%20%3D%3E%20page.evaluate(%22jQuery.fn.jquery%22)" \ -d "scripts=https://code.jquery.com/jquery-3.5.0.min.js" \ -d "meta=false" ``` ### JavaScript Microlink API example ```javascript import mql from '@microlink/mql' const { data } = await mql('https://microlink.io', { function: '({ page }) => page.evaluate("jQuery.fn.jquery")', scripts: [ "https://code.jquery.com/jquery-3.5.0.min.js" ], meta: false }) ``` ### Python Microlink API example ```python import requests url = "https://api.microlink.io/" querystring = { "url": "https://microlink.io", "function": '''({ page }) => page.evaluate("jQuery.fn.jquery")''', "scripts": "https://code.jquery.com/jquery-3.5.0.min.js", "meta": "false" } response = requests.get(url, params=querystring) print(response.json()) ``` ### Ruby Microlink API example ```ruby require 'uri' require 'net/http' base_url = "https://api.microlink.io/" params = { url: "https://microlink.io", function: '({ page }) => page.evaluate("jQuery.fn.jquery")', scripts: "https://code.jquery.com/jquery-3.5.0.min.js", meta: "false" } 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 "https://microlink.io", "function" => '({ page }) => page.evaluate("jQuery.fn.jquery")', "scripts" => "https://code.jquery.com/jquery-3.5.0.min.js", "meta" => "false" ]; $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) } fn := `({ page }) => page.evaluate("jQuery.fn.jquery")` q := u.Query() q.Set("url", "https://microlink.io") q.Set("function", fn) q.Set("scripts", "https://code.jquery.com/jquery-3.5.0.min.js") q.Set("meta", "false") 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)) } ``` ```javascript import mql from '@microlink/mql' const { data } = await mql('https://microlink.io', { function: '({ page }) => page.evaluate("jQuery.fn.jquery")', scripts: [ "https://code.jquery.com/jquery-3.5.0.min.js" ], meta: false }) ``` The `scripts` parameter injects jQuery before the function runs, making it available inside `page.evaluate`. ## See also - [Writing functions](https://microlink.io/docs/guides/function/writing-functions) — return values, custom parameters, and npm packages. - [Profiling and performance](https://microlink.io/docs/guides/function/profiling-and-performance) — understand where time is spent and how to optimize. - [Function reference](https://microlink.io/docs/api/parameters/function) — response shape, plan limits, and compression. Last updated on May 24, 2026 [Edit on GitHub](https://github.com/microlinkhq/www/blob/master/src/content/docs/guides/function/browser-interaction.md)