Authentication

To authenticate with the Autom API, add the header x-api-key to your request.

You can find your API key on your dashboard.

Request

• The host is autom.dev

• All requests should be made with HTTPS

• All of our endpoints accept the POST method

You are required to add the header Content-Type: application/json

curl -X POST \
 -H "Content-Type: application/json" \
 -H "x-api-key: your_api_key" \
 -d '{
    "query": "home",
    "page": 1,
    "gl": "us",
    "hl": "en",
    "google_domains": "google.com"
}' \
 "https://autom.dev/api/v1/google/search"

Response

• All the response will be in the JSON format.

• Each response will always contain an error property: false if the request was successful, true otherwise

• Response codes: see error handling page for more information.

Example of a successful response

{
    "search_parameters": {
        "q": "home",
        "google_domain": "google.com",
        "page": 1,
        "gl": "us",
        "hl": "en",
        "engine": "google"
    },
    "organic_results": [
        {
            "position": 1,
            "title": "The Home Depot",
            "link": "https://www.homedepot.com/",
            "domain": "www.homedepot.com",
            "displayed_link": "https://www.homedepot.com",
            "snippet_matched": [
                "home"
            ],
            "snippet": "Shop online for all your home improvement needs: appliances, bathroom decorating ideas, kitchen remodeling, patio furniture, power tools, bbq grills, ..."
        },
        {
            "position": 2,
            "title": "At Home is The Home & Holiday Superstore",
            "link": "https://www.athome.com/",
            "domain": "www.athome.com",
            "displayed_link": "https://www.athome.com",
            "snippet_matched": [],
            "snippet": null
        },
        {
            "position": 3,
            "title": "Home (2015)",
            "link": "https://www.imdb.com/title/tt2224026/",
            "domain": "www.imdb.com",
            "displayed_link": "https://www.imdb.com › title",
            "snippet_matched": [],
            "snippet": null
        },
        {
            "position": 4,
            "title": "Google Home: Smart home automation from Google",
            "link": "https://home.google.com/welcome/",
            "domain": "home.google.com",
            "displayed_link": "https://home.google.com › ...",
            "snippet_matched": [
                "home"
            ],
            "snippet": "From smart lights to smart locks, Google Home unites devices and services from Google and your favorite brands to build a personalized smart home to help ..."
        },
        {
            "position": 5,
            "title": "Home Definition & Meaning",
            "link": "https://www.dictionary.com/browse/home",
            "domain": "www.dictionary.com",
            "displayed_link": "https://www.dictionary.com › browse",
            "snippet_matched": [],
            "snippet": "a house, apartment, or other shelter that is the usual residence of a person, family, or household. the place in which one's domestic affections are centered."
        },
        {
            "position": 6,
            "title": "Home Official Trailer #1 (2015) - YouTube",
            "link": "https://www.youtube.com/watch?v=MyqZf8LiWvM",
            "domain": "www.youtube.com",
            "displayed_link": "https://www.youtube.com › watch",
            "snippet_matched": [],
            "snippet": null
        }
    ]
}