# Compression

## Table of Contents

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

---

The compression algorithms **brotli** and **gzip** are supported.

If you are performing the API requests using the [SDK](https://microlink.io/docs/sdk/getting-started/overview), compression will be enabled by default.

Otherwise, ensure to specify what compression you want to use using [Accept-Encoding](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding) header.

The following examples show how to use the Microlink API with CLI, cURL, JavaScript, Python, Ruby, PHP & Golang, targeting 'https://github.com/microlinkhq' URL:

### CLI Microlink API example

```bash
microlink https://github.com/microlinkhq
```

### cURL Microlink API example

```bash
curl -G "https://api.microlink.io" \
  -d "url=https://github.com/microlinkhq"
```

### JavaScript Microlink API example

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

const microlink = createClient()

const data = await microlink.metadata('https://github.com/microlinkhq')
```

### Python Microlink API example

```python
import requests

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

querystring = {
    "url": "https://github.com/microlinkhq"
}

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://github.com/microlinkhq"
}

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://github.com/microlinkhq"
];

$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/microlinkhq")
    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()

constdata=awaitmicrolink.metadata('https://github.com/microlinkhq')
```

CLI cURL JavaScript Python Ruby PHP Golang Click to run the code and see the API response

You can check what compression algorithm has been used after the HTTP negotiation seeing `content-encoding` response header.

```
content-type:application/json;charset=utf-8

content-encoding:br

x-timestamp:1750986229308

x-response-time:51ms

x-rate-limit-reset:1751097111

x-pricing-plan:free

x-region:iad

x-fetch-mode:fetch

x-rate-limit-remaining:20

x-cache-ttl:86400000

x-request-id:iad:2af5a47c-d15f-47a7-938e-6551fc81bf9c

x-rate-limit-limit:25

x-cache-status:HIT

x-content-type-options:nosniff

x-client-ip:88.20.23.25

x-fetch-time:305ms
```