POST
/
api
/
v2
/
google
/
images
curl --request POST \
  --url https://piloterr.com/api/v2/google/images \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{
  "query": "<string>",
  "gl": "<string>",
  "hl": "<string>",
  "page": 123
}'
{
    "images": [
        {
            "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/7/73/Lion_waiting_in_Namibia.jpg/1200px-Lion_waiting_in_Namibia.jpg",
            "link": "https://en.wikipedia.org/wiki/Lion",
            "title": "Lion - Wikipedia",
            "domain": "en.wikipedia.org",
            "source": "Wikipedia",
            "position": 1,
            "image_width": 1200,
            "image_height": 900
        },
        {
            "url": "https://cdn.britannica.com/30/150930-120-D3D93F1E/lion-Namibia.jpg",
            "link": "https://www.britannica.com/animal/lion",
            "title": "Lion | Characteristics, Habitat ...",
            "domain": "www.britannica.com",
            "source": "Britannica",
            "position": 2,
            "image_width": 900,
            "image_height": 675
        },
        {
            "url": "https://c02.purpledshub.com/uploads/sites/62/2019/10/Federico_Veronesi_Lions-cover-image-e359a4e.jpg",
            "link": "https://www.discoverwildlife.com/animal-facts/mammals/facts-about-lions",
            "title": "Lion guide: species facts and where ...",
            "domain": "www.discoverwildlife.com",
            "source": "BBC Wildlife Magazine",
            "position": 3,
            "image_width": 3710,
            "image_height": 4000
        },
        ...
    ],
    "search_parameters": {
        "q": "lion",
        "gl": "us",
        "hl": "en",
        "page": 1,
        "engine": "google"
    }
}
​
x-api-key
string
required

This parameter specifies the private key you’ll need for Piloterr access.

​
Body

​
Search Query

​
query
string
required

Parameter defines the query you want to search.

​
Localization

​
gl
string

Parameter defines the country to use for the Google images. It’s a two-letter country code. (e.g., us for the United States, uk for United Kingdom, or fr for France). Head to the Google countries page for a full list of supported Google countries.

​
hl
string

Parameter defines the language to use for the Google images. It’s a two-letter language code. (e.g., en for English, es for Spanish, or fr for French). Head to the Google languages page for a full list of supported Google languages.

​
Pagination

Images are fetched by batch of 100 images per search. To fech additional images, you need to perform the same search again, incrementing the page parameter for each page of results you want to retrieve.

​
page
integer

Parameter defines the result offset. It skips the given number of results. It’s used for pagination.

​
Response

​
Google Images
object
{
    "images": [
        {
            "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/7/73/Lion_waiting_in_Namibia.jpg/1200px-Lion_waiting_in_Namibia.jpg",
            "link": "https://en.wikipedia.org/wiki/Lion",
            "title": "Lion - Wikipedia",
            "domain": "en.wikipedia.org",
            "source": "Wikipedia",
            "position": 1,
            "image_width": 1200,
            "image_height": 900
        },
        {
            "url": "https://cdn.britannica.com/30/150930-120-D3D93F1E/lion-Namibia.jpg",
            "link": "https://www.britannica.com/animal/lion",
            "title": "Lion | Characteristics, Habitat ...",
            "domain": "www.britannica.com",
            "source": "Britannica",
            "position": 2,
            "image_width": 900,
            "image_height": 675
        },
        {
            "url": "https://c02.purpledshub.com/uploads/sites/62/2019/10/Federico_Veronesi_Lions-cover-image-e359a4e.jpg",
            "link": "https://www.discoverwildlife.com/animal-facts/mammals/facts-about-lions",
            "title": "Lion guide: species facts and where ...",
            "domain": "www.discoverwildlife.com",
            "source": "BBC Wildlife Magazine",
            "position": 3,
            "image_width": 3710,
            "image_height": 4000
        },
        ...
    ],
    "search_parameters": {
        "q": "lion",
        "gl": "us",
        "hl": "en",
        "page": 1,
        "engine": "google"
    }
}

Was this page helpful?