Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time
title
Endpoint

Microlink API is exposed from two endpoints:

  • free (api.microlink.io): The endpoint to be used for unauthenticated requests. It has daily rate limit.
  • pro (pro.microlink.io): The endpoint to be used for authenticated requests. It needs a previously register API key.

All you need to do for accessing any of these endpoints it to hit them using HTTP GET method, nothing else.

microlink https://github.io/microlinkhq&userAgent=googlebot

The endpoint accepts multiple query parameters. It doesn't matter if they are camel or snake case, both styles are supported.

microlink https://github.io/microlinkhq&user_agent=googlebot

If you are using Microlink Query Language, the endpoint is automatically determined in case you provide an API Key.

const mql = require('@microlink/mql')

const { status, data, response } = await mql(
  'https://github.io/microlinkhq', {
    apiKey: 'MyApiKey',
    userAgent: 'googlebot'
  }
)