Error Codes

Microlink API considers an unexpected situation any request performed on which status is different from 'success'.
When this happens, the response payload includes some useful information in order to determine the root cause of the problem:
  • id: The unique identifier associated with the request.
  • code: The error code that represents the final request state.
  • message: A brief explanantion about why the error happened.
  • more: A link pointing this documentation.
  • report: A link for reporting the problem directly to us.

EAUTH

Message
Authentication failed. Make sure you are attaching your API key as x-api-key header.
Solution
Ensure your API key we send you via email and it's attached as x-api-key against pro.microlink.io endpoint.

EBRWSRTIMEOUT

Message
The URL provided reached the maximum browser navigation time allowed.
Solution
Any request has a maximum timeout of 28s associated, meaning that any request needs to be resolved before that umbral.
Additionally, some API parameters (such as insights, pdf, prerender or screenshot) have a browser navigation associated. During it, the target URL is resolved from the perspective of a browser.
The maximum time associated with a browser navigation is 23s, considering the browser hangs if navigation isn't resolved after this time.
In order to avoid this error, browser navigation time need to be done below the threshold.

ECNRCY

Message
Requests against free.microlink.io are limited to 1 concurrent requests.
Solution
The free endpoint has some soft limitations in order to prevent abusive usage.
You need to upgrade your plan in order to don't have these restrictions.

EFATAL

Message
Resolves the target URL failed.
Solution
This is the generic error used when it wasn't possible to determine the root cause of the problem.
If you are experimenting with this error, please contact us, reporting the request id to make it possible to reproduce the original request.

EHEADERS

Message
You need a pro plan for using headers.
Solution
In order to use headers query parameter, you need to upgrade your free plan.

EINVALURL

Message
The target URL is considered not valid.
Solution
Ensure the url provided has protocol, hostname and follows standard.

EINVALURLCLIENT

Message
The target URL is considered not valid.
Solution
Ensure the url provided has protocol, hostname and follows standard.

EMAXREDIRECTS

Message
The target URL reached the maximum number of redirect after 10 times.
Solution
Ensure the url provided reaches the destination URL in less than 10 hops.

EPRO

Message
The request has x-api-key header present and it has been performed against api.microlink.io endpoint.
Solution
In order to authenticate your requests, you need to perform them against pro.microlink.io endpoint.

EPROXY

Message
You need a pro plan for using proxy.
Solution
In order to use proxy query parameter, you need to upgrade your free plan.

ERATE

Message
Your daily rate limit has been reached. You need to wait or extend your plan.
Solution
You need to extend your rate limit quota or wait until you're quota reset.

ETIMEOUT

Message
The request reached maximum timeout.
Solution
Any request has a maximum timeout of 28s associated, meaning that any request needs to be resolved before that umbral.

ETTL

Message
You need a pro plan for using ttl.
Solution
In order to use ttl query parameter, you need to upgrade your free plan.

ETTLRANGE

Message
The ttl range is invalid.
Solution
The ttl value should be a value between 1m to 31d range.

Error Codes

Microlink API considers an unexpected situation any request performed on which status is different from 'success'.
When this happens, the response payload includes some useful information in order to determine the root cause of the problem:
  • id: The unique identifier associated with the request.
  • code: The error code that represents the final request state.
  • message: A brief explanantion about why the error happened.
  • more: A link pointing this documentation.
  • report: A link for reporting the problem directly to us.

EAUTH

Message
Authentication failed. Make sure you are attaching your API key as x-api-key header.
Solution
Ensure your API key we send you via email and it's attached as x-api-key against pro.microlink.io endpoint.

EBRWSRTIMEOUT

Message
The URL provided reached the maximum browser navigation time allowed.
Solution
Any request has a maximum timeout of 28s associated, meaning that any request needs to be resolved before that umbral.
Additionally, some API parameters (such as insights, pdf, prerender or screenshot) have a browser navigation associated. During it, the target URL is resolved from the perspective of a browser.
The maximum time associated with a browser navigation is 23s, considering the browser hangs if navigation isn't resolved after this time.
In order to avoid this error, browser navigation time need to be done below the threshold.

ECNRCY

Message
Requests against free.microlink.io are limited to 1 concurrent requests.
Solution
The free endpoint has some soft limitations in order to prevent abusive usage.
You need to upgrade your plan in order to don't have these restrictions.

EFATAL

Message
Resolves the target URL failed.
Solution
This is the generic error used when it wasn't possible to determine the root cause of the problem.
If you are experimenting with this error, please contact us, reporting the request id to make it possible to reproduce the original request.

EHEADERS

Message
You need a pro plan for using headers.
Solution
In order to use headers query parameter, you need to upgrade your free plan.

EINVALURL

Message
The target URL is considered not valid.
Solution
Ensure the url provided has protocol, hostname and follows standard.

EINVALURLCLIENT

Message
The target URL is considered not valid.
Solution
Ensure the url provided has protocol, hostname and follows standard.

EMAXREDIRECTS

Message
The target URL reached the maximum number of redirect after 10 times.
Solution
Ensure the url provided reaches the destination URL in less than 10 hops.

EPRO

Message
The request has x-api-key header present and it has been performed against api.microlink.io endpoint.
Solution
In order to authenticate your requests, you need to perform them against pro.microlink.io endpoint.

EPROXY

Message
You need a pro plan for using proxy.
Solution
In order to use proxy query parameter, you need to upgrade your free plan.

ERATE

Message
Your daily rate limit has been reached. You need to wait or extend your plan.
Solution
You need to extend your rate limit quota or wait until you're quota reset.

ETIMEOUT

Message
The request reached maximum timeout.
Solution
Any request has a maximum timeout of 28s associated, meaning that any request needs to be resolved before that umbral.

ETTL

Message
You need a pro plan for using ttl.
Solution
In order to use ttl query parameter, you need to upgrade your free plan.

ETTLRANGE

Message
The ttl range is invalid.
Solution
The ttl value should be a value between 1m to 31d range.