# Function: Browser interaction

## 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)

---

Microlink functions can interact with a browser.

`page` is a [Puppeteer Page](https://pptr.dev/api/puppeteer.page) for the URL you asked for:

```js
importcreateClientfrom'microlink.io'

constmicrolink=createClient()

constscrape=({page})=>page.$eval('h1',el=>el.textContent.trim())

constresult=awaitmicrolink.function('https://example.com',scrape)

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 URL the page settled on.
- [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.

Two methods extend `page`:

- [page.extract](https://microlink.io/docs/api/parameters/function#pageextract): the same rules as [data](https://microlink.io/docs/api/parameters/data).
- [page.metadata](https://microlink.io/docs/api/parameters/function#pagemetadata): the same normalized metadata as [meta](https://microlink.io/docs/api/parameters/meta).

## What your function receives

| Property            | Type                                                          | Description                                                                                                                                                                                                                             |
| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url`               | `string`                                                      | The URL you asked for, not the one a redirect settles on. Available without a browser. `page.url()` is the settled one                                                                                                                  |
| `page`              | [Page ✓](https://pptr.dev/api/puppeteer.page)                 | The Puppeteer Page for that URL. The page API is supported. [page.extract](https://microlink.io/docs/api/parameters/function#pageextract) and [page.metadata](https://microlink.io/docs/api/parameters/function#pagemetadata) extend it |
| `response`          | [HTTPResponse ✓](https://pptr.dev/api/puppeteer.httpresponse) | The response from the implicit [page.goto ✓](https://pptr.dev/api/puppeteer.page.goto) . Only available when the function loads the page in a browser                                                                                   |
| `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
constscrapeAfterClick=({page})=>

page

.click('button.load-more')

.then(()=>page.waitForSelector('.results'))

.then(()=>

page.$$eval('.results li',items=>

items.map(el=>el.textContent.trim())

)

)

constresult=awaitmicrolink.function('https://example.com',scrapeAfterClick)
```

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/waitForSelector). In the SDK they travel as the third argument of `run`:

```js
const{value}=awaitmicrolink.function(

'https://microlink.io',

({page})=>page.evaluate('jQuery.fn.jquery'),

{scripts:'https://code.jquery.com/jquery-3.5.0.min.js'}

)
```

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' 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"
```

### JavaScript Microlink API example

```javascript
import createClient from 'microlink.io'

const microlink = createClient()

const { value } = await microlink.function(
  'https://microlink.io',
  ({ page }) => page.evaluate("jQuery.fn.jquery"),
  {
    scripts: [
      "https://code.jquery.com/jquery-3.5.0.min.js"
    ]
  }
)
```

### 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"
}

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"
}

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
<?php

$baseUrl = "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"
];

$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")
    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
importcreateClientfrom'microlink.io'

constmicrolink=createClient()

const{value}=awaitmicrolink.function(

'https://microlink.io',

({page})=>page.evaluate("jQuery.fn.jquery"),

{

scripts:[

"https://code.jquery.com/jquery-3.5.0.min.js"

]

}

)
```

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.