README.md

Turn Google results into structured, code-ready data. Powered by microlink.io

Highlights

• 10 Google verticals in one API
  Google Search
  Google News
  Google Images
  Google Videos
  Google Places
  Google Maps
  Google Shopping
  Google Scholar
  Google Patents
  Google Autocomplete
  

• Normalized data
  Prices { symbol, amount }
  Ratings { score, total, reviews }
  Coordinates { latitude, longitude }
  Images { url, width, height }
  

• Built for developers and LLMs
  Any result with a url exposes .html() to fetch the page HTML on demand.
  Just call .next() to fetch the next page.
  Parallelized requests (~1s latency).
  Type-specific inference included.
  

Install

npm install @microlink/google

Quick start

Your first query

The only prerequisite to initialize @microlink/google is to have Microlink API key:

const google = require('@microlink/google')({
  apiKey: process.env.MICROLINK_API_KEY
})

Make your first query:

const page = await google('Lotus Elise S2')

console.log(page.results)
// [
//   {
//     title: 'Lotus Elise - Wikipedia',
//     url: 'https://en.wikipedia.org/wiki/Lotus_Elise',
//     description: 'The Lotus Elise is a two-seat, rear-wheel-drive...'
//   }
// ]

Use Google search operators to refine queries:

const page = await google('Lotus Elise S2 filetype:pdf')

Localize results using location or filter by time with period:

await google('recetas de pasta', {
  location: 'es',
  period: 'week'
})

Get HTML markup

Any result containing a url exposes a lazy .html() method:

const { results } = await google('node.js frameworks')

for (const result of results) {
  const html = await result.html()
  console.log(html)
}

Pagination

Pages chain naturally:

const page1 = await google('node.js frameworks')
const page2 = await page1.next()
const page3 = await page2.next()

You can also iterate:

let page = await google('node.js frameworks')

while (page) {
  for (const result of page.results) {
    console.log(result.title)
  }

  page = await page.next()
}

Google products

Type	Product	Example
search	Google Search	google('Lotus Elise S2')
news	Google News	google('artificial intelligence', { type: 'news' })
images	Google Images	google('northern lights', { type: 'images' })
videos	Google Videos	google('cooking tutorial', { type: 'videos' })
places	Google Places	google('coffee shops denver', { type: 'places' })
maps	Google Maps	google('apple store new york', { type: 'maps' })
shopping	Google Shopping	google('macbook pro', { type: 'shopping' })
scholar	Google Scholar	google('transformer architecture', { type: 'scholar' })
patents	Google Patents	google('touchscreen gestures apple', { type: 'patents' })
autocomplete	Google Autocomplete	google('how to', { type: 'autocomplete' })

Google Search

Web results with knowledge graph, related questions, and related searches.

const page = await google('Lotus Elise S2')

page.results[0]

page.knowledgeGraph
page.peopleAlsoAsk
page.relatedSearches

Google News

Recent articles with publisher, date, and thumbnail.

const page = await google('artificial intelligence', { type: 'news' })

Google Images

Full-resolution image URLs with dimensions.

const page = await google('northern lights', { type: 'images' })

Google Videos

Video metadata with duration in milliseconds.

const page = await google('cooking tutorial', { type: 'videos' })

Google Places

Local business listings with coordinates and contact info.

const page = await google('coffee shops denver', { type: 'places' })

Google Maps

Detailed place data with ratings, hours, and pricing.

const page = await google('apple store new york', { type: 'maps' })

Google Shopping

Product listings with parsed prices and structured ratings.

const page = await google('macbook pro', { type: 'shopping' })

Google Scholar

Academic papers with citation counts and PDF links.

const page = await google('transformer architecture', { type: 'scholar' })

Google Patents

Patent filings with ISO 8601 dates and metadata.

const page = await google('touchscreen gestures apple', { type: 'patents' })

Google Autocomplete

Search suggestions as you type.

const page = await google('how to', { type: 'autocomplete' })

API

google(query, options?)

query

Required Type: string

The search query. Supports Google search operators.

await google('annual report filetype:pdf')
await google('security updates site:github.com')
await google('"machine learning" site:arxiv.org')

options

type

Type: string
Default: 'search'
Values: 'search' | 'news' | 'images' | 'videos' | 'places' | 'maps' | 'shopping' | 'scholar' | 'patents' | 'autocomplete'

Selects which Google product to query.

await google('artificial intelligence', { type: 'news' })

location

Type: string
Default: 'us'
Values: Location

Controls result geolocation using a country code (ISO 3166-1 alpha-2). This influences ranking, language, and local intent.

await google('recetas de pasta', { location: 'es' })

period

Type: string
Default: undefined
Values: 'hour' | 'day' | 'week' | 'month' | 'year'

Limits results to a recent time window. Useful for news monitoring and freshness-sensitive queries.

await google('tech news', { period: 'week' })

License

@microlink/google © Microlink, released under the MIT License.
Authored and maintained by Kiko Beats with help from contributors.

microlink.io · GitHub microlinkhq · X @microlinkhq