Lens

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

Query parameters

Parameter	Description	Default Value
source	Data source. More info.	google_lens
query	The URL of the image to be searched for.	-
locale	Accept-Language header value which changes your Google search page web interface language. More info.	-
geo_location	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 geo_location parameter structures here.	-
user_agent_type	Device type and browser. You can find the full list here.	desktop
parse	true will return structured data.	-
render	Enables JavaScript rendering. More info.	-
callback_url	URL to your callback endpoint.	-

- required parameter

Code examples

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

JSON

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

cURL

curl --user "user:pass1" 'https://realtime.oxylabs.io/v1/queries' -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"}'

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=('user', 'pass1'),
    json=payload,
)

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

PHP

<?php

$params = [
    '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, "user" . ":" . "pass1");

$headers = [];
$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);
?>

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

The example above uses the Realtime integration method. If you would like to use some other integration method in your query (e.g. Push-Pull or Proxy Endpoint), refer to the integration methods section.

Structured data

{
    "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": ""
        }
    ],
}

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.

Key	Description	Type
results	A dictionary containing the results of the search.	array
results.organic	A list of unpaid image results with their respective details.	array
total_results_count	The total number of results found for the image URL.	integer
parse_status_code	The status code of the parsing job. You can see the parser status codes described here.	integer
created_at	The timestamp when the scraping job was created.	timestamp
updated_at	The timestamp when the scraping job was finished.	timestamp
page	Page number relative to the Google SERP pagination.	integer
job_id	The ID of the job associated with the scraping job.	string
status_code	The status code of the scraping job. You can see the scraper status codes described here.	integer

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.

...
{
    "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"
},
...

Key (results.organic)	Description	Type
pos	An indicator denoting the position of a given item among all Google Lens results.	integer
url	The URL of the Google Lens result.	string
title	The title of the result.	string
domain	The source of the Google Lens result.	string
pos_overall	An indication of the position of the Google Lens result within the SERP.	integer
url_thumbnail	The base64-encoded thumbnail images of the Google Lens result.	string