# Lens

Our `google_lens` source enables you to extract results from the Google Lens feature while performing an image search.

{% hint style="info" %}
Explore output [**data dictionary**](#data-dictionary) for each Lens SERP feature, offering a brief description, screenshot, parsed JSON code snippet, and a table defining each parsed field. Navigate through the details using the right-side navigation or scrolling down the page.
{% endhint %}

## Request samples

The API sends a request to the Google Lens feature to retrieve structured data related to the content of an image.

{% tabs %}
{% tab title="cURL" %}

```shell
curl 'https://realtime.oxylabs.io/v1/queries' \
--user 'USERNAME:PASSWORD' \
-H 'Content-Type: application/json' \
-d '{
        "source": "google_lens",
        "query": "https://www.beginningboutique.com.au/cdn/shop/files/Flossie-Pink-Maxi-Sleeveless-Dress_750x.jpg",
        "parse": "true"
    }'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests
from pprint import pprint

# Structure payload.
payload = {
    'source': 'google_lens',
    'query': 'https://www.beginningboutique.com.au/cdn/shop/files/Flossie-Pink-Maxi-Sleeveless-Dress_750x.jpg',
    'parse': 'true'
}

# Get response.
response = requests.request(
    'POST',
    'https://realtime.oxylabs.io/v1/queries',
    auth=('USERNAME', 'PASSWORD'),
    json=payload,
)

# Print prettified response to stdout.
pprint(response.json())

```

{% endtab %}

{% tab title="Node.js" %}

```javascript
const https = require("https");

const username = "USERNAME";
const password = "PASSWORD";
const body = {
    source: "google_lens",
    query: "https://www.beginningboutique.com.au/cdn/shop/files/Flossie-Pink-Maxi-Sleeveless-Dress_750x.jpg",
    parse: true,
};

const options = {
    hostname: "realtime.oxylabs.io",
    path: "/v1/queries",
    method: "POST",
    headers: {
        "Content-Type": "application/json",
        Authorization:
            "Basic " + Buffer.from(`${username}:${password}`).toString("base64"),
    },
};

const request = https.request(options, (response) => {
    let data = "";

    response.on("data", (chunk) => {
        data += chunk;
    });

    response.on("end", () => {
        const responseData = JSON.parse(data);
        console.log(JSON.stringify(responseData, null, 2));
    });
});

request.on("error", (error) => {
    console.error("Error:", error);
});

request.write(JSON.stringify(body));
request.end();
```

{% endtab %}

{% tab title="HTTP" %}

```http
https://realtime.oxylabs.io/v1/queries?source=google_lens&query=https%3A%2F%2Fwww.beginningboutique.com.au%2Fcdn%2Fshop%2Ffiles%2FFlossie-Pink-Maxi-Sleeveless-Dress_750x.jpg&parse=true&access_token=12345abcde
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php

$params = array(
    'source' => 'google_lens',
    'query' => 'https://www.beginningboutique.com.au/cdn/shop/files/Flossie-Pink-Maxi-Sleeveless-Dress_750x.jpg',
    'parse' => true
);

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://realtime.oxylabs.io/v1/queries");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params));
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_USERPWD, "USERNAME" . ":" . "PASSWORD");


$headers = array();
$headers[] = "Content-Type: application/json";
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
echo $result;

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);
```

{% endtab %}

{% tab title="Golang" %}

```go
package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"io/ioutil"
	"net/http"
)

func main() {
	const Username = "USERNAME"
	const Password = "PASSWORD"

	payload := map[string]interface{}{
		"source": "google_lens",
		"query":  "https://www.beginningboutique.com.au/cdn/shop/files/Flossie-Pink-Maxi-Sleeveless-Dress_750x.jpg",
		"parse":  true,
	}

	jsonValue, _ := json.Marshal(payload)

	client := &http.Client{}
	request, _ := http.NewRequest("POST",
		"https://realtime.oxylabs.io/v1/queries",
		bytes.NewBuffer(jsonValue),
	)

	request.SetBasicAuth(Username, Password)
	response, _ := client.Do(request)

	responseText, _ := ioutil.ReadAll(response.Body)
	fmt.Println(string(responseText))
}
```

{% endtab %}

{% tab title="C#" %}

```csharp
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Json;
using System.Threading.Tasks;

namespace OxyApi
{
    class Program
    {
        static async Task Main()
        {
            const string Username = "USERNAME";
            const string Password = "PASSWORD";

            var parameters = new {
                source = "google_lens",
                query = "https://www.beginningboutique.com.au/cdn/shop/files/Flossie-Pink-Maxi-Sleeveless-Dress_750x.jpg",
                parse = true
            };

            var client = new HttpClient();

            Uri baseUri = new Uri("https://realtime.oxylabs.io");
            client.BaseAddress = baseUri;

            var requestMessage = new HttpRequestMessage(HttpMethod.Post, "/v1/queries");
            requestMessage.Content = JsonContent.Create(parameters);

            var authenticationString = $"{Username}:{Password}";
            var base64EncodedAuthenticationString = Convert.ToBase64String(System.Text.ASCIIEncoding.UTF8.GetBytes(authenticationString));
            requestMessage.Headers.Add("Authorization", "Basic " + base64EncodedAuthenticationString);

            var response = await client.SendAsync(requestMessage);
            var contents = await response.Content.ReadAsStringAsync();

            Console.WriteLine(contents);
        }
    }
}
```

{% endtab %}

{% tab title="Java" %}

```java
package org.example;

import okhttp3.*;
import org.json.JSONObject;
import java.util.concurrent.TimeUnit;

public class Main implements Runnable {
    private static final String AUTHORIZATION_HEADER = "Authorization";
    public static final String USERNAME = "USERNAME";
    public static final String PASSWORD = "PASSWORD";

    public void run() {
        JSONObject jsonObject = new JSONObject();
        jsonObject.put("source", "google_lens");
        jsonObject.put("query", "https://www.beginningboutique.com.au/cdn/shop/files/Flossie-Pink-Maxi-Sleeveless-Dress_750x.jpg");
        jsonObject.put("parse", true);

        Authenticator authenticator = (route, response) -> {
            String credential = Credentials.basic(USERNAME, PASSWORD);
            return response
                    .request()
                    .newBuilder()
                    .header(AUTHORIZATION_HEADER, credential)
                    .build();
        };

        var client = new OkHttpClient.Builder()
                .authenticator(authenticator)
                .readTimeout(180, TimeUnit.SECONDS)
                .build();

        var mediaType = MediaType.parse("application/json; charset=utf-8");
        var body = RequestBody.create(jsonObject.toString(), mediaType);
        var request = new Request.Builder()
                .url("https://realtime.oxylabs.io/v1/queries")
                .post(body)
                .build();

        try (var response = client.newCall(request).execute()) {
            if (response.body() != null) {
                try (var responseBody = response.body()) {
                    System.out.println(responseBody.string());
                }
            }
        } catch (Exception exception) {
            System.out.println("Error: " + exception.getMessage());
        }

        System.exit(0);
    }

    public static void main(String[] args) {
        new Thread(new Main()).start();
    }
}
```

{% endtab %}

{% tab title="JSON" %}

```json
{
    "source": "google_lens", 
    "query": "https://www.beginningboutique.com.au/cdn/shop/files/Flossie-Pink-Maxi-Sleeveless-Dress_750x.jpg",
    "parse": "true"
}
```

{% endtab %}
{% endtabs %}

We use synchronous [**Realtime**](/scraping-solutions/web-scraper-api/integration-methods/realtime.md) integration method in our examples. If you would like to use [**Proxy Endpoint**](/scraping-solutions/web-scraper-api/integration-methods/proxy-endpoint.md) or asynchronous [**Push-Pull**](/scraping-solutions/web-scraper-api/integration-methods/push-pull.md) integration, refer to the [**integration methods**](/scraping-solutions/web-scraper-api/integration-methods.md) section.

## Request parameter values

### Generic

Basic setup and customization options for scraping Google Lens results.

<table><thead><tr><th width="222">Parameter</th><th width="350.3333333333333">Description</th><th>Default Value</th></tr></thead><tbody><tr><td><mark style="background-color:green;"><strong>source</strong></mark></td><td>Sets the scraper.</td><td><code>google_lens</code></td></tr><tr><td><mark style="background-color:green;"><strong>query</strong></mark></td><td>The URL of the image to be searched for.</td><td>-</td></tr><tr><td><code>render</code></td><td>Enables JavaScript rendering when set to <code>html</code>. <a href="/pages/7sSik87DtvlBOq67ENnO"><strong>More info</strong></a><strong>.</strong></td><td>-</td></tr><tr><td><code>parse</code></td><td>Returns parsed data when set to <code>true</code>. Explore output <a href="#output-data-dictionary"><strong>data dictionary</strong></a>.</td><td><code>false</code></td></tr><tr><td><code>callback_url</code></td><td>URL to your callback endpoint. <a href="/pages/DijMC0XcEbNczNgRaHIV#callback"><strong>More info</strong></a>.</td><td>-</td></tr><tr><td><code>user_agent_type</code></td><td>Device type and browser. The full list can be found <a href="/pages/rrKXR4LNzotP94phU1YL"><strong>here</strong></a>.</td><td><code>desktop</code></td></tr></tbody></table>

&#x20;   \- mandatory parameter

### Localization

Adapt search results to specific geographical locations and languages.

<table><thead><tr><th width="222">Parameter</th><th width="350.3333333333333">Description</th><th>Default Value</th></tr></thead><tbody><tr><td><code>geo_location</code></td><td>The geographical location that the result should be adapted for. Using this parameter correctly is extremely important to get the right data. For more information, read about our suggested <code>geo_location</code> parameter structures <a href="/pages/MzPAMWq8tFiQFjuZRyEM#google"><strong>here</strong></a><strong>.</strong></td><td>-</td></tr><tr><td><code>locale</code></td><td><code>Accept-Language</code> header value which changes your Google search page web interface language. <a href="/pages/rAkVD7OwCRtmZreOVBiG#locale-1"><strong>More info</strong></a>.</td><td>-</td></tr></tbody></table>

## Structured data

```json
{
    "results": [
        {
            "content": {
                "results": {
                    "organic": [
                        {
                            "pos": 1,
                            "url": "https://www.pinterest.com/shopping/free-people-pink-maxi-dress/903333914404/",
                            "title": "Free People Pink Maxi Dress - Shop on Pinterest",
                            "domain": "Pinterest",
                            "pos_overall": 1,
                            "url_thumbnail": "https://encrypted-tbn2.gstatic.com/images?q=tbn:ANd9GcR5hGHj6ima-cDFEYeMNi-7ngOomqkHz_1Joc4_DVA5gDTprXGJ"
                        },
                        ...
                        {
                            "pos": 59,
                            "url": "https://www.jjshouse.com/Sheath-Column-One-Shoulder-Floor-Length-Chiffon-Junior-Bridesmaid-Dress-With-Ruffle-Lace-Beading-009119572-g119572",
                            "title": "Sheath/Column One-Shoulder Floor-Length Chiffon Junior Bridesmaid Dress With Ruffle Lace Beading",
                            "domain": "JJsHouse.com",
                            "pos_overall": 59,
                            "url_thumbnail": "https://encrypted-tbn2.gstatic.com/images?q=tbn:ANd9GcR8evuMBA8z7Aa8mcYh97Y2hbpB3YIEV0ZSs2gkpYIyF3pmyj_X"
                        }
                    ],
                    "total_results_count": 59
                },
                "parse_status_code": 12000
            },
            "created_at": "2024-03-13 15:07:42",
            "updated_at": "2024-03-13 15:07:45",
            "page": 1,
            "url": "https://lens.google.com/uploadbyurl?url=https://www.beginningboutique.com.au/cdn/shop/files/Flossie-Pink-Maxi-Sleeveless-Dress_750x.jpg&uule=w+CAIQICINdW5pdGVkIHN0YXRlcw&gl=us&hl=en",
            "job_id": "7173696230097183745",
            "status_code": 200,
            "parser_type": ""
        }
    ],
}
```

## Output data dictionary

#### **JSON structure**

This table outlines the key elements of a Google Lens search result. The table below presents a detailed list of each SERP feature we parse, along with its description and data type. The table also includes some metadata.

<table><thead><tr><th width="264.3333333333333">Key</th><th width="319">Description</th><th>Type</th></tr></thead><tbody><tr><td><code>results</code></td><td>A dictionary containing the results of the search.</td><td>array</td></tr><tr><td><code>results.organic</code></td><td>A list of unpaid image results with their respective details.</td><td>array</td></tr><tr><td><code>total_results_count</code></td><td>The total number of results found for the image URL.</td><td>integer</td></tr><tr><td><code>parse_status_code</code></td><td>The status code of the parsing job. You can see the parser status codes described <a href="https://github.com/oxylabs/gitbook-public-english/blob/master/scraping-solutions/web-scraper-api/targets/google/broken-reference/README.md"><strong>here</strong></a>.</td><td>integer</td></tr><tr><td><code>created_at</code></td><td>The timestamp when the scraping job was created.</td><td>timestamp</td></tr><tr><td><code>updated_at</code></td><td>The timestamp when the scraping job was finished.</td><td>timestamp</td></tr><tr><td><code>page</code></td><td>Page number relative to the Google SERP pagination.</td><td>integer</td></tr><tr><td><code>job_id</code></td><td>The ID of the job associated with the scraping job.</td><td>string</td></tr><tr><td><code>status_code</code></td><td>The status code of the scraping job. You can see the scraper status codes described <a href="https://github.com/oxylabs/gitbook-public-english/blob/master/scraping-solutions/web-scraper-api/targets/google/broken-reference/README.md"><strong>here</strong></a>.</td><td>integer</td></tr></tbody></table>

### Organic

Google Lens accounts multiple factors to deliver the most relevant and useful information to users based on the content of the image user uploads.

<figure><img src="/files/97Q4OHSjxcK61gTBgB73" alt=""><figcaption></figcaption></figure>

```json
...
{
    "pos": 1,
    "url": "https://www.pinterest.com/shopping/free-people-pink-maxi-dress/903333914404/",
    "title": "Free People Pink Maxi Dress - Shop on Pinterest",
    "domain": "Pinterest",
    "pos_overall": 1,
    "url_thumbnail": "https://encrypted-tbn2.gstatic.com/images?q=tbn:ANd9GcR5hGHj6ima-cDFEYeMNi-7ngOomqkHz_1Joc4_DVA5gDTprXGJ"
},
...
```

<table><thead><tr><th width="241">Key (results.organic)</th><th width="363">Description</th><th>Type</th></tr></thead><tbody><tr><td><code>pos</code></td><td>An indicator denoting the position of a given item among all Google Lens results.</td><td>integer</td></tr><tr><td><code>url</code></td><td>The URL of the Google Lens result.</td><td>string</td></tr><tr><td><code>title</code></td><td>The title of the result.</td><td>string</td></tr><tr><td><code>domain</code></td><td>The source of the Google Lens result.</td><td>string</td></tr><tr><td><code>pos_overall</code></td><td>The position index of the Google Lens result within the SERP.</td><td>integer</td></tr><tr><td><code>url_thumbnail</code></td><td>The base64-encoded thumbnail images of the Google Lens result.</td><td>string</td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.oxylabs.io/scraping-solutions/web-scraper-api/targets/google/lens.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.