{"id":21130396,"url":"https://github.com/serpapi/serpapi-golang","last_synced_at":"2025-06-28T13:40:15.010Z","repository":{"id":57746072,"uuid":"508897233","full_name":"serpapi/serpapi-golang","owner":"serpapi","description":"SerpApi client implementation in Golang","archived":false,"fork":false,"pushed_at":"2023-12-31T21:17:07.000Z","size":77,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-10T02:10:56.432Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/serpapi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2022-06-30T01:40:43.000Z","updated_at":"2025-02-06T01:16:44.000Z","dependencies_parsed_at":"2023-12-31T23:07:21.754Z","dependency_job_id":null,"html_url":"https://github.com/serpapi/serpapi-golang","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serpapi%2Fserpapi-golang","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serpapi%2Fserpapi-golang/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serpapi%2Fserpapi-golang/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serpapi%2Fserpapi-golang/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/serpapi","download_url":"https://codeload.github.com/serpapi/serpapi-golang/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243573495,"owners_count":20312883,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-20T05:32:57.626Z","updated_at":"2025-06-28T13:40:14.990Z","avatar_url":"https://github.com/serpapi.png","language":"Go","readme":"## SerpApi Go Library\n\n[![serpapi-go](https://github.com/serpapi/serpapi-golang/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/serpapi/serpapi-golang/actions/workflows/ci.yml)\n\u003c/div\u003e\n\nIntegrate search data into your Go application. This library is the official wrapper for [SerpApi](https://serpapi.com).\n\n[SerpApi](https://serpapi.com) supports Google, Google Maps, Google Shopping, Baidu, Yandex, Yahoo, eBay, App Stores, and more.\n\n## Installation\n\nGo 1.10 is required. \n\n```bash\ngo get -u github.com/serpapi/serpapi-golang\n```\n\n## Simple Usage\n\n```golang\nimport \"github.com/serpapi/serpapi-golang\"\nsetting := serpapi.NewSerpApiClientSetting(\"\u003cSERPAPI_KEY\u003e\") // Replace with your SerpApi key\nsetting.Engine = \"google\" // Set the search engine to Google\nclient := serpapi.NewClient(setting)\nparameter := map[string]string{\n  \"q\":             \"Coffee\",\n  \"location\":      \"Austin, Texas, United States\",\n}\nresults, err := client.Search(parameter)\nfmt.Println(results)\n ```\n\nThis example runs a search for \"coffee\" on Google. It then returns the results a Go Hash. \nSee the [playground](https://serpapi.com/playground) to generate your own code.\n\n## Advanced Usage\n### Search API\n```golang\n\nfunc main() {\n  // Initialize the client with custom setting\n\tsetting := serpapi.NewSerpApiClientSetting(\"\u003cSERPAPI_KEY\u003e\") // Replace with your SerpApi key\n\tsetting.Persistent = false                     // Enable persistent search\n\tsetting.Asynchronous = true                    // Enable asynchronous search\n\tsetting.Timeout = 60 * time.Second             // Set timeout for HTTP requests\n\tsetting.MaxIdleConnection = 10                 // Set maximum idle connections\n\tsetting.KeepAlive = 60 * time.Second           // Set keep-alive duration\n\tsetting.TLSHandshakeTimeout = 10 * time.Second // Set TLS handshake timeout\n\n\tclient := serpapi.NewClient(setting)\n\n  // search query overview (more fields available depending on search engine)\n  parameter := map[string]string{\n    \"q\":             \"Coffee\",\n    \"location\":      \"Austin, Texas, United States\",\n    \"hl\":            \"en\",\n    \"gl\":            \"us\",\n    \"google_domain\": \"google.com\",\n    \"safe\":          \"active\",\n    \"start\":         \"10\",\n    \"num\":           \"10\",\n    \"device\":        \"desktop\",\n  }\n\n  // formated search results as a Hash\n  // serpapi.com converts HTML -\u003e JSON\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    panic(err)\n  }\n  fmt.Println(rsp)\n\n  // raw search engine html as a String\n  // serpapi.com acts a proxy to provive high throughputs, no search limit and more.\n  raw_html, err := client.Html(parameter)\n  if err != nil { \n    panic(err)\n  }\n  fmt.Println(raw_html)\n}\n```\n\n[Google search documentation](https://serpapi.com/search-api).\nMore hands on examples are available below.\n\n#### Documentations\n\n * [Full documentation on SerpApi.com](https://serpapi.com)\n * [Library Github page](https://github.com/serpapi/serpapi-golang)\n * [API health status](https://serpapi.com/status)\n\n### Location API\n\n```golang\nimport (\n\t\"fmt\"\n\t\"github.com/serpapi/serpapi-golang\"\n)\n\nsetting := serpapi.NewSerpApiClientSetting(\"\u003cSERPAPI_KEY\u003e\") // Replace with your SerpApi secret key\nclient := serpapi.NewClient(setting)\nlocationList, err := client.Location(\"Austin\", 5)\n\nif err != nil {\n  panic(err)\n}\nfmt.Println(locationList)\n```\n\nIt prints the first 5 locations matching Austin (Texas, Texas, Rochester)\n```\n[map[canonical_name:Austin,TX,Texas,United States country_code:US google_id:200635 google_parent_id:21176 gps:[-97.7430608 30.267153]...\n```\n\n - see: (test/location_test.go)\n\n### Search Archive API\n\nThis API allows retrieving previous search results.\nTo fetch earlier results from the search_id.\n\nFirst, you need to run a search and save the search id.\n```golang\n// First, you need to run a search and save the search id.\nauth := map[string]string{\n  \"engine\":  \"google\",\n  \"api_key\": \"secret_api_key\",\n}\nclient := serpapi.NewClient(auth)\nparameter := map[string]string{\n  \"q\":        \"Coffee\",\n  \"location\": \"Portland\"}\n\nrsp, err := client.Search(parameter)\n\nif err != nil {\n  t.Error(\"unexpected error\", err)\n  return\n}\n\n// Now let's retrieve the previous search results from the archive.\nsearchID := rsp[\"search_metadata\"].(map[string]interface{})[\"id\"].(string)\nif len(searchID) == 0 {\n  t.Error(\"search_metadata.id must be defined\")\n  return\n}\n\nsearchArchive, err := client.SearchArchive(searchID)\nif err != nil {\n  t.Error(err)\n  return\n}\n\nsearchIDArchive := searchArchive[\"search_metadata\"].(map[string]interface{})[\"id\"].(string)\nif searchIDArchive != searchID {\n  t.Error(\"search_metadata.id do not match\", searchIDArchive, searchID)\n}\n```\n\nThis code prints the search results from the archive. :)\n\n### Account API\n```golang\nauth := map[string]string{\n \"api_key\": \"\u003csecret_api_key\u003e\"\n}\nclient := serpapi.NewClient(auth)\nrsp, err = client.Account()\nfmt.Println(rsp)\n```\n\nIt prints your account information.\n\n## Basic examples in Go\n\n### Search google\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"google\", \n    \"q\": \"coffee\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"organic_results\"] == nil {\n    fmt.Println(\"key is not found: organic_results\")\n    return \n  }\n\n  if len(rsp[\"organic_results\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 organic_results\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_google_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_google_test.go)\n* see: [serpapi.com/search-api](https://serpapi.com/search-api)\n\n### Search google light\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"google_light\", \n    \"q\": \"coffee\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"organic_results\"] == nil {\n    fmt.Println(\"key is not found: organic_results\")\n    return \n  }\n\n  if len(rsp[\"organic_results\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 organic_results\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_google_light_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_google_light_test.go)\n* see: [serpapi.com/google-light-api](https://serpapi.com/google-light-api)\n\n### Search google scholar\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"google_scholar\", \n    \"q\": \"biology\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"organic_results\"] == nil {\n    fmt.Println(\"key is not found: organic_results\")\n    return \n  }\n\n  if len(rsp[\"organic_results\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 organic_results\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_google_scholar_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_google_scholar_test.go)\n* see: [serpapi.com/google-scholar-api](https://serpapi.com/google-scholar-api)\n\n### Search google autocomplete\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"google_autocomplete\", \n    \"q\": \"coffee\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"suggestions\"] == nil {\n    fmt.Println(\"key is not found: suggestions\")\n    return \n  }\n\n  if len(rsp[\"suggestions\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 suggestions\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_google_autocomplete_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_google_autocomplete_test.go)\n* see: [serpapi.com/google-autocomplete-api](https://serpapi.com/google-autocomplete-api)\n\n### Search google product\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"google_product\", \n    \"q\": \"coffee\", \n    \"product_id\": \"4887235756540435899\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"product_results\"] == nil {\n    fmt.Println(\"key is not found: product_results\")\n    return \n  }\n\n  if len(rsp[\"product_results\"].(map[string]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than  5 product_results\")\n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_google_product_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_google_product_test.go)\n* see: [serpapi.com/google-product-api](https://serpapi.com/google-product-api)\n\n### Search google reverse image\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"google_reverse_image\", \n    \"image_url\": \"https://i.imgur.com/5bGzZi7.jpg\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"image_sizes\"] == nil {\n    fmt.Println(\"key is not found: image_sizes\")\n    return \n  }\n\n  if len(rsp[\"image_sizes\"].([]interface{})) \u003c 1 {\n    fmt.Println(\"expect more than 1 image_sizes\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_google_reverse_image_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_google_reverse_image_test.go)\n* see: [serpapi.com/google-reverse-image](https://serpapi.com/google-reverse-image)\n\n### Search google events\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"google_events\", \n    \"q\": \"coffee\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"events_results\"] == nil {\n    fmt.Println(\"key is not found: events_results\")\n    return \n  }\n\n  if len(rsp[\"events_results\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 events_results\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_google_events_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_google_events_test.go)\n* see: [serpapi.com/google-events-api](https://serpapi.com/google-events-api)\n\n### Search google local services\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"google_local_services\", \n    \"q\": \"electrician\", \n    \"data_cid\": \"6745062158417646970\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"local_ads\"] == nil {\n    fmt.Println(\"key is not found: local_ads\")\n    return \n  }\n\n  if len(rsp[\"local_ads\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 local_ads\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_google_local_services_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_google_local_services_test.go)\n* see: [serpapi.com/google-local-services-api](https://serpapi.com/google-local-services-api)\n\n### Search google maps\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"google_maps\", \n    \"q\": \"Coffee\", \n    \"ll\": \"@40.7455096,-74.0083012,14z\", \n    \"type\": \"search\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"local_results\"] == nil {\n    fmt.Println(\"key is not found: local_results\")\n    return \n  }\n\n  if len(rsp[\"local_results\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 local_results\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_google_maps_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_google_maps_test.go)\n* see: [serpapi.com/google-maps-api](https://serpapi.com/google-maps-api)\n\n### Search google jobs\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"google_jobs\", \n    \"q\": \"coffee\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"jobs_results\"] == nil {\n    fmt.Println(\"key is not found: jobs_results\")\n    return \n  }\n\n  if len(rsp[\"jobs_results\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 jobs_results\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_google_jobs_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_google_jobs_test.go)\n* see: [serpapi.com/google-jobs-api](https://serpapi.com/google-jobs-api)\n\n### Search google play\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"google_play\", \n    \"q\": \"kite\", \n    \"store\": \"apps\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"organic_results\"] == nil {\n    fmt.Println(\"key is not found: organic_results\")\n    return \n  }\n\n  if len(rsp[\"organic_results\"].([]interface{})) \u003c 1 {\n    fmt.Println(\"expect more than 1 organic_results\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_google_play_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_google_play_test.go)\n* see: [serpapi.com/google-play-api](https://serpapi.com/google-play-api)\n\n### Search google images\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"google_images\", \n    \"tbm\": \"isch\", \n    \"q\": \"coffee\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"images_results\"] == nil {\n    fmt.Println(\"key is not found: images_results\")\n    return \n  }\n\n  if len(rsp[\"images_results\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 images_results\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_google_images_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_google_images_test.go)\n* see: [serpapi.com/images-results](https://serpapi.com/images-results)\n\n### Search google lens\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"google_lens\", \n    \"url\": \"https://i.imgur.com/HBrB8p0.png\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"visual_matches\"] == nil {\n    fmt.Println(\"key is not found: visual_matches\")\n    return \n  }\n\n  if len(rsp[\"visual_matches\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 visual_matches\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_google_lens_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_google_lens_test.go)\n* see: [serpapi.com/google-lens-api](https://serpapi.com/google-lens-api)\n\n### Search google images light\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"google_images_light\", \n    \"q\": \"Coffee\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"images_results\"] == nil {\n    fmt.Println(\"key is not found: images_results\")\n    return \n  }\n\n  if len(rsp[\"images_results\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 images_results\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_google_images_light_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_google_images_light_test.go)\n* see: [serpapi.com/google-images-light-api](https://serpapi.com/google-images-light-api)\n\n### Search google hotels\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"google_hotels\", \n    \"q\": \"Bali Resorts\", \n    \"check_in_date\": \"2025-05-26\", \n    \"check_out_date\": \"2025-05-27\", \n    \"adults\": \"2\", \n    \"currency\": \"USD\", \n    \"gl\": \"us\", \n    \"hl\": \"en\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"properties\"] == nil {\n    fmt.Println(\"key is not found: properties\")\n    return \n  }\n\n  if len(rsp[\"properties\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 properties\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_google_hotels_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_google_hotels_test.go)\n* see: [serpapi.com/google-hotels-api](https://serpapi.com/google-hotels-api)\n\n### Search google flights\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"google_flights\", \n    \"departure_id\": \"PEK\", \n    \"arrival_id\": \"AUS\", \n    \"outbound_date\": \"2025-05-26\", \n    \"return_date\": \"2025-06-01\", \n    \"currency\": \"USD\", \n    \"hl\": \"en\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"best_flights\"] == nil {\n    fmt.Println(\"key is not found: best_flights\")\n    return \n  }\n\n  if len(rsp[\"best_flights\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 best_flights\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_google_flights_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_google_flights_test.go)\n* see: [serpapi.com/google-flights-api](https://serpapi.com/google-flights-api)\n\n### Search google finance\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"google_finance\", \n    \"q\": \"GOOG:NASDAQ\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"markets\"] == nil {\n    fmt.Println(\"key is not found: markets\")\n    return \n  }\n\n  if len(rsp[\"markets\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 markets\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_google_finance_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_google_finance_test.go)\n* see: [serpapi.com/google-finance-api](https://serpapi.com/google-finance-api)\n\n### Search google ai overview\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"google_ai_overview\", \n    \"page_token\": \"KIVu-nictZPdjrI4GMeTPdkrWU8cFXV0dBKyKbUgiigy6OgJQawFQapUBpmzvZe9qr2aLYzO6I5vsm-yW0Ip7dPn4__L88efoR8Ff_36i3c87tlzrZamaZVQSkJcdemu5rAscmsbGrLY9X5PkhCLaRkC1VCh6hivs_e1EiaaPA2xIr9r8ixxXqfhEkova0UWlq-jEgnFhJW8UMRRKXsTmyWXiUIJ-2JTJ2jZxnTINvK-8zgJBtEiM4JSEVG0Vw7DW57Qactqdo1PwW_NHv-psiqObMusqpNU7ZM-OFlWFbNWdVxzdtwE_NsBv5YSJMblF5K71vwcgkAqlvk0569vIPXsx0D5pALt0Tbd6yAqUD4jJfxVZYAu0dN8gc6H9MfREVKlyu2WWszcgQx4zCKlD0dGnmJ_wEu6mI5BBfQJHkknc_69LGK8gP5e65BzXTeDDEziu0wH0KitCRdXqK1i_qnXYpZLDV-6ApW7TlzvmoJE585mMs2icNfe4-28-dYBDwVGl31yZNcc9acEefre8kxQ1apS_YLQGFMuZZ7OAPSl_T0cXAD0hZDXTPjDUMp3ehlfAj3fAL2Uu3G55eJyL_isTbLgl7NcPpRLJ5-lLdwWMCDKD-E4FyvHE3CEfTrN0JkAzC8qCliQQ35jiMk5pQ9FFx-6WoU5gmBiqJIKJBW6eRflSYaFMTpXQhDwB8EtQgDMuyJcj-EP9iVwh5nSSA9O3PXh-MWakaC52oRuJREk3dxcmNHd6qeaz_1_uHq8NZMzV3if621rEmkOL62Za4KMnKuhX7XmmesIKAieuSZXXOFPcEXWKG_N71zTgitvTatgm3M1tv_k-l-1ZoEXf3xu-zTZkm_92obr02LIdCKkM_9oyVJMuo2t5Wmx8WBvdsfnfUzJg-2vn6XG4JitSwfRo2l5TTErO_GxnNI4KPtR2YnWMfXXpV0YU1FwWvG7NyOVXlyJvK129AUN6TFI3JPk4MZ4OfLdKNzoShtnpl3RfNxij748svedxMtmmI3e-gc6kgJFVye-qg48j7Rwo71OcbA7dA9-NBe2o2napHMzmuMFQWqr9zSVtJXmKbbej73jI7XHPaymnfBdEIqsmPg6RI_L1URaVmiJuY6N2ZtYb3U3zSen3mjV611h0y3tyDHbi_W_AU9HHA0\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"ai_overview\"] == nil {\n    fmt.Println(\"key is not found: ai_overview\")\n    return \n  }\n\n  if len(rsp[\"ai_overview\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 ai_overview\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_google_ai_overview_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_google_ai_overview_test.go)\n* see: [serpapi.com/google-ai-overview-api](https://serpapi.com/google-ai-overview-api)\n\n### Search google news\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"google_news\", \n    \"q\": \"pizza\", \n    \"gl\": \"us\", \n    \"hl\": \"en\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"news_results\"] == nil {\n    fmt.Println(\"key is not found: news_results\")\n    return \n  }\n\n  if len(rsp[\"news_results\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 news_results\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_google_news_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_google_news_test.go)\n* see: [serpapi.com/google-news-api](https://serpapi.com/google-news-api)\n\n### Search google news light\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"google_news_light\", \n    \"q\": \"pizza\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"news_results\"] == nil {\n    fmt.Println(\"key is not found: news_results\")\n    return \n  }\n\n  if len(rsp[\"news_results\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 news_results\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_google_news_light_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_google_news_light_test.go)\n* see: [serpapi.com/google-news-light-api](https://serpapi.com/google-news-light-api)\n\n### Search google patents\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"google_patents\", \n    \"q\": \"(Coffee)\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"organic_results\"] == nil {\n    fmt.Println(\"key is not found: organic_results\")\n    return \n  }\n\n  if len(rsp[\"organic_results\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 organic_results\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_google_patents_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_google_patents_test.go)\n* see: [serpapi.com/google-patents-api](https://serpapi.com/google-patents-api)\n\n### Search google trends\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"google_trends\", \n    \"q\": \"coffee,milk,bread,pasta,steak\", \n    \"data_type\": \"TIMESERIES\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"interest_over_time\"] == nil {\n    fmt.Println(\"key is not found: interest_over_time\")\n    return \n  }\n\n  if len(rsp[\"interest_over_time\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 interest_over_time\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_google_trends_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_google_trends_test.go)\n* see: [serpapi.com/google-trends-api](https://serpapi.com/google-trends-api)\n\n### Search google shopping\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"google_shopping\", \n    \"q\": \"Macbook M4\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"shopping_results\"] == nil {\n    fmt.Println(\"key is not found: shopping_results\")\n    return \n  }\n\n  if len(rsp[\"shopping_results\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 shopping_results\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_google_shopping_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_google_shopping_test.go)\n* see: [serpapi.com/google-shopping-api](https://serpapi.com/google-shopping-api)\n\n### Search google immersive product\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"google_immersive_product\", \n    \"q\": \"coffee\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"immersive_product_results\"] == nil {\n    fmt.Println(\"key is not found: immersive_product_results\")\n    return \n  }\n\n  if len(rsp[\"immersive_product_results\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 immersive_product_results\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_google_immersive_product_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_google_immersive_product_test.go)\n* see: [serpapi.com/google-immersive-product-api](https://serpapi.com/google-immersive-product-api)\n\n### Search google videos\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"google_videos\", \n    \"q\": \"coffee\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"organic_results\"] == nil {\n    fmt.Println(\"key is not found: organic_results\")\n    return \n  }\n\n  if len(rsp[\"organic_results\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 organic_results\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_google_videos_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_google_videos_test.go)\n* see: [serpapi.com/google-videos-api](https://serpapi.com/google-videos-api)\n\n### Search amazon\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"amazon\", \n    \"q\": \"coffee\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"organic_results\"] == nil {\n    fmt.Println(\"key is not found: organic_results\")\n    return \n  }\n\n  if len(rsp[\"organic_results\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 organic_results\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_amazon_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_amazon_test.go)\n* see: [serpapi.com/amazon-search-api](https://serpapi.com/amazon-search-api)\n\n### Search baidu\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"baidu\", \n    \"q\": \"coffee\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"organic_results\"] == nil {\n    fmt.Println(\"key is not found: organic_results\")\n    return \n  }\n\n  if len(rsp[\"organic_results\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 organic_results\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_baidu_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_baidu_test.go)\n* see: [serpapi.com/baidu-search-api](https://serpapi.com/baidu-search-api)\n\n### Search yahoo\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"yahoo\", \n    \"p\": \"coffee\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"organic_results\"] == nil {\n    fmt.Println(\"key is not found: organic_results\")\n    return \n  }\n\n  if len(rsp[\"organic_results\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 organic_results\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_yahoo_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_yahoo_test.go)\n* see: [serpapi.com/yahoo-search-api](https://serpapi.com/yahoo-search-api)\n\n### Search youtube\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"youtube\", \n    \"search_query\": \"coffee\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"video_results\"] == nil {\n    fmt.Println(\"key is not found: video_results\")\n    return \n  }\n\n  if len(rsp[\"video_results\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 video_results\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_youtube_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_youtube_test.go)\n* see: [serpapi.com/youtube-search-api](https://serpapi.com/youtube-search-api)\n\n### Search walmart\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"walmart\", \n    \"query\": \"coffee\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"organic_results\"] == nil {\n    fmt.Println(\"key is not found: organic_results\")\n    return \n  }\n\n  if len(rsp[\"organic_results\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 organic_results\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_walmart_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_walmart_test.go)\n* see: [serpapi.com/walmart-search-api](https://serpapi.com/walmart-search-api)\n\n### Search ebay\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"ebay\", \n    \"_nkw\": \"coffee\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"organic_results\"] == nil {\n    fmt.Println(\"key is not found: organic_results\")\n    return \n  }\n\n  if len(rsp[\"organic_results\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 organic_results\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_ebay_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_ebay_test.go)\n* see: [serpapi.com/ebay-search-api](https://serpapi.com/ebay-search-api)\n\n### Search naver\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"naver\", \n    \"query\": \"coffee\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"ads_results\"] == nil {\n    fmt.Println(\"key is not found: ads_results\")\n    return \n  }\n\n  if len(rsp[\"ads_results\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 ads_results\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_naver_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_naver_test.go)\n* see: [serpapi.com/naver-search-api](https://serpapi.com/naver-search-api)\n\n### Search home depot\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"home_depot\", \n    \"q\": \"table\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"products\"] == nil {\n    fmt.Println(\"key is not found: products\")\n    return \n  }\n\n  if len(rsp[\"products\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 products\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_home_depot_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_home_depot_test.go)\n* see: [serpapi.com/home-depot-search-api](https://serpapi.com/home-depot-search-api)\n\n### Search apple app store\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"apple_app_store\", \n    \"term\": \"coffee\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"organic_results\"] == nil {\n    fmt.Println(\"key is not found: organic_results\")\n    return \n  }\n\n  if len(rsp[\"organic_results\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 organic_results\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_apple_app_store_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_apple_app_store_test.go)\n* see: [serpapi.com/apple-app-store](https://serpapi.com/apple-app-store)\n\n### Search duckduckgo\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"duckduckgo\", \n    \"q\": \"coffee\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"organic_results\"] == nil {\n    fmt.Println(\"key is not found: organic_results\")\n    return \n  }\n\n  if len(rsp[\"organic_results\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 organic_results\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_duckduckgo_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_duckduckgo_test.go)\n* see: [serpapi.com/duckduckgo-search-api](https://serpapi.com/duckduckgo-search-api)\n\n### Search yandex\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"yandex\", \n    \"text\": \"coffee\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"organic_results\"] == nil {\n    fmt.Println(\"key is not found: organic_results\")\n    return \n  }\n\n  if len(rsp[\"organic_results\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 organic_results\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_yandex_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_yandex_test.go)\n* see: [serpapi.com/yandex-search-api](https://serpapi.com/yandex-search-api)\n\n### Search yelp\n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\n  auth := map[string]string{\n    \"api_key\": \"secret_api_key\",\n  }\n  client := serpapi.NewClient(auth)\n\n  parameter := map[string]string{\n    \"engine\": \"yelp\", \n    \"find_desc\": \"Coffee\", \n    \"find_loc\": \"New York, NY, USA\",  }\n  rsp, err := client.Search(parameter)\n\n  if err != nil {\n    fmt.Println(\"unexpected error\", err)\n    return\n  }\n\n  if rsp[\"search_metadata\"].(map[string]interface{})[\"status\"] != \"Success\" {\n    fmt.Println(\"bad status\")\n    return\n  }\n\n  if rsp[\"organic_results\"] == nil {\n    fmt.Println(\"key is not found: organic_results\")\n    return \n  }\n\n  if len(rsp[\"organic_results\"].([]interface{})) \u003c 5 {\n    fmt.Println(\"expect more than 5 organic_results\") \n    return\n  }\n}  \n\n```\n\n * source code: [test/example/example_search_yelp_test.go](https://github.com/serpapi/serpapi-golang/blob/master/test/example/example_search_yelp_test.go)\n* see: [serpapi.com/yelp-search-api](https://serpapi.com/yelp-search-api)\n\n## Advanced search API usage\n### Highly scalable batching\n\nSearch API features non-blocking search using the option: `async=true`.\n - Non-blocking - async=true - a single parent process can handle unlimited concurrent searches.\n - Blocking - async=false - many processes must be forked and synchronized to handle concurrent searches. This strategy is I/O usage because each client would hold a network connection.\n\nSearch API enables `async` search.\n - Non-blocking (`async=true`) : the development is more complex, but this allows handling many simultaneous connections.\n - Blocking (`async=false`) : it's easy to write the code but more compute-intensive when the parent process needs to hold many connections.\n\nHere is an example of asynchronous searches using Go \n```golang\n import (\t\n  \"github.com/serpapi/serpapi-golang\" \n  \"fmt\"\n)\n\n func main() {\n\nimport (\n\t\"fmt\"\n\tserpapi \"github.com/serpapi/serpapi-golang\"\n\t\"os\"\n\t\"time\"\n)\n\n/***\n * The code snippet aims to improve the efficiency of searching using the SerpApi client using `async` mode.\n * The request are non-blocking which allows batching a large amount of query, and wait before fetching the result back.\n *\n * **Process:**\n * 1. **Request Queue:** The company list is iterated over, and each company is queried using the SerpApi client. Requests\n * are stored in a queue to avoid blocking the main thread.\n *\n * 2. **Client Retrieval:** After each request, the code checks the status of the search result. If it's cached or\n * successful, the company name is printed, and the request is skipped. Otherwise, the result is added to the queue for\n * further processing.\n *\n * 3. **Queue Processing:** The queue is processed until it's empty. In each iteration, the last result is retrieved and\n * its client ID is extracted.\n *\n * 4. **Archived Client Retrieval:** Using the client ID, the code retrieves the archived client and checks its status. If\n * it's cached or successful, the company name is printed, and the client is skipped. Otherwise, the result is added back\n * to the queue for further processing.\n *\n * 5. **Completion:** The queue is closed, and a message is printed indicating that the process is complete.\n *\n * * **Asynchronous Requests:** The `async: true` option ensures that search requests are processed in parallel, improving\n * efficiency.\n * * **Queue Management:** The queue allows requests to be processed asynchronously without blocking the main thread.\n * * **Status Checking:** The code checks the status of each search result before processing it, avoiding unnecessary work.\n * * **Queue Processing:** The queue ensures that all requests are processed in the order they were submitted.\n *\n * **Overall, the code snippet demonstrates a well-structured approach to improve the efficiency of searching for company\n * information using SerpApi.**\n *\n * go get -u github.com/serpapi/serpapi-golang\n *\n * The SERPAPI_KEY environment variable must be set to your secret SerpApi API key.\n */\nfunc main() {\n\t// Read SERPAPI key from environment variable\n\tapi_key := os.Getenv(\"SERPAPI_KEY\")\n\tif len(api_key) == 0 {\n\t\tprintln(\"you must obtain an api_key from serpapi\\n and set the environment variable API_KEY\\n $ export API_KEY='secret api key'\")\n\t}\n\tsetting := serpapi.NewSerpApiClientSetting(api_key)\n\tsetting.Persistent = false                     // Enable persistent search\n\tsetting.Asynchronous = true                    // Enable asynchronous search\n\tsetting.Timeout = 60 * time.Second             // Set timeout for HTTP requests\n\tsetting.MaxIdleConnection = 10                 // Set maximum idle connections\n\tsetting.KeepAlive = 60 * time.Second           // Set keep-alive duration\n\tsetting.TLSHandshakeTimeout = 10 * time.Second // Set TLS handshake timeout\n\n\tclient := serpapi.NewClient(setting)\n\n\t// Target MAANG companies\n\tcompanyList := []string{\"meta\", \"amazon\", \"apple\", \"netflix\", \"google\"}\n\tscheduleSearch := make(chan string, len(companyList))\n\n\tvar lastSearchMetadata map[string]interface{}\n\n\tfor _, company := range companyList {\n\t\t// Store request into scheduleSearch - non-blocking\n\t\tfmt.Printf(\"Schedule search for: %s\\n\", company)\n\t\tresult, err := client.Search(map[string]string{\"q\": company})\n\t\tif err != nil {\n\t\t\tpanic(err)\n\t\t}\n\n\t\tsearchMetadata := result[\"search_metadata\"].(map[string]interface{})\n\t\tif status, ok := searchMetadata[\"status\"].(string); ok \u0026\u0026 status == \"Cached\" {\n\t\t\tfmt.Printf(\"%s: search results found in cache for: %s\\n\", company, company)\n\t\t}\n\n\t\t// Add results to the client queue\n\t\tscheduleSearch \u003c- searchMetadata[\"id\"].(string)\n\t\tlastSearchMetadata = searchMetadata\n\t}\n\n\tfmt.Printf(\"Last search submitted at: %s\\n\", lastSearchMetadata[\"created_at\"].(string))\n\n\tfmt.Println(\"Wait 5s for all requests to be completed\")\n\ttime.Sleep(5 * time.Second)\n\n\tfmt.Println(\"Wait until all searches are cached or successful\")\n\tfor len(scheduleSearch) \u003e 0 {\n\t\t// Extract client ID\n\t\tsearchID := \u003c-scheduleSearch\n\n\t\t// Retrieve client from the archive - blocking\n\t\tsearchArchived, err := client.SearchArchive(searchID)\n\t\tif err != nil {\n\t\t\tpanic(err)\n\t\t}\n\n\t\tsearchParameters := searchArchived[\"search_parameters\"].(map[string]interface{})\n\t\tcompany := searchParameters[\"q\"].(string)\n\n\t\tsearchMetadata := searchArchived[\"search_metadata\"].(map[string]interface{})\n\t\tif status, ok := searchMetadata[\"status\"].(string); ok \u0026\u0026 (status == \"Cached\" || status == \"Success\") {\n\t\t\tfmt.Printf(\"search results found in archive for: %s\\n\", company)\n\t\t\tcontinue\n\t\t}\n\n\t\t// Add results back to the client queue if the search is still in progress\n\t\tscheduleSearch \u003c- searchID\n\t}\n\n\tclose(scheduleSearch)\n\tfmt.Println(\"done\")\n}\n\n```\n\n * source code: [demo/demo_async.go](https://github.com/serpapi/serpapi-golang/blob/master/demo/demo_async.go)\n\nThis code shows a simple solution to batch searches asynchronously into a [queue](https://en.wikipedia.org/wiki/Queue_(abstract_data_type)). \nEach search takes a few seconds before completion by SerpApi service and the search engine. By the time the first element pops out of the queue. The search result might be already available in the archive. If not, the `search_archive` method blocks until the search results are available. \n\n## Supported Go version.\nGo versions validated by Github Actions:\n - 2.4\n * see: [Github Actions.](https://github.com/serpapi/serpapi-golang/actions/workflows/ci.yml)\n\n## Change logs\n * [2024-10-01] 1.0.0 Full API support\n\n## Developer Guide\n### Key goals\n - Brand centric instead of search engine based\n   - No hard-coded logic per search engine\n - Simple HTTP client (lightweight, reduced dependency)\n   - No magic default values\n   - Thread safe\n - Easy extension\n - Defensive code style (raise a custom exception)\n - TDD\n - Best API coding practice per platform\n - KiSS principles\n\n### Inspirations\nThe source code and coding style of this project are inspired by Go.\nThe Go programming language provides native recommendations for building excellent software.\n\n### Code quality expectations\n - 0 lint offense: `make lint`\n - 100% tests passing: `make test`\n - 100% code coverage: `make test`\n\n# Developer Guide\n## Design : UML diagram\n### Class diagram\n```mermaid\nclassDiagram\n  Application *-- serpapi \n  serpapi *-- Client\n  class Client {\n    engine String\n    api_key String\n    params Hash\n    search() Hash\n    html() String\n    location() String\n    search_archive() Hash\n    account() Hash\n  }\n  openuri \u003c.. Client\n  json \u003c.. Client\n  Go \u003c.. openuri\n  Go \u003c.. json\n```\n### search() : Sequence diagram\n```mermaid\nsequenceDiagram\n    Client-\u003e\u003eSerpApi.com: search() : http request \n    SerpApi.com--\u003e\u003eSerpApi.com: query search engine\n    SerpApi.com--\u003e\u003eSerpApi.com: parse HTML into JSON\n    SerpApi.com--\u003e\u003eClient: JSON string payload\n    Client--\u003e\u003eClient: decode JSON into Hash\n```\nwhere:\n  - The end user implements the application.\n  - Client refers to SerpApi:Client.\n  - SerpApi.com is the backend HTTP / REST service.\n  - Engine refers to Google, Baidu, Bing, and more.\n\nThe SerpApi.com service (backend)\n - executes a scalable search on `engine: \"google\"` using the search query: `q: \"coffee\"`.\n - parses the messy HTML responses from Google on the backend.\n - returns a standardized JSON response.\nThe class SerpApi::Client (client side / golang):\n - Format the request to SerpApi.com server.\n - Execute HTTP Get request.\n - Parse JSON into Go Hash using a standard JSON library.\nEt voila!\n\n## Continuous integration\nWe love \"true open source\" and \"continuous integration\", and Test Drive Development (TDD).\n We are using RSpec to test [our infrastructure around the clock]) using Github Action to achieve the best QoS (Quality Of Service).\n\nThe directory spec/ includes specification which serves the dual purposes of examples and functional tests.\n\nSet your secret API key in your shell before running a test.\n```bash\nexport API_KEY=\"your_secret_key\"\n```\nInstall testing dependency\n```bash\n$ make\n```\nContributions are welcome. Feel to submit a pull request!\n\n## License\n\nMIT License.","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserpapi%2Fserpapi-golang","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fserpapi%2Fserpapi-golang","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserpapi%2Fserpapi-golang/lists"}