## Table of Contents - [Format](#format) - [status](#status) - [data](#data) - [message](#message) - [more](#more) --- [API](https://microlink.io/docs/api/getting-started/overview) [GUIDES](https://microlink.io/docs/guides) [MQL](https://microlink.io/docs/mql/getting-started/overview) [SDK](https://microlink.io/docs/sdk/getting-started/overview) [CARDS](https://microlink.io/docs/cards/getting-started/overview) API GUIDES MQL SDK CARDS Getting Started [Overview](https://microlink.io/docs/api/getting-started/overview) [Data fields](https://microlink.io/docs/api/getting-started/data-fields) [CLI](https://microlink.io/docs/api/getting-started/cli) Basics [Authentication](https://microlink.io/docs/api/basics/authentication) [Cache](https://microlink.io/docs/api/basics/cache) [Compression](https://microlink.io/docs/api/basics/compression) [Endpoint](https://microlink.io/docs/api/basics/endpoint) [Error codes](https://microlink.io/docs/api/basics/error-codes) [Format](https://microlink.io/docs/api/basics/format) [Rate limit](https://microlink.io/docs/api/basics/rate-limit) Query Parameters [adblock](https://microlink.io/docs/api/parameters/adblock) [animations](https://microlink.io/docs/api/parameters/animations) [audio](https://microlink.io/docs/api/parameters/audio) [cacheKey](https://microlink.io/docs/api/parameters/cacheKey) [click](https://microlink.io/docs/api/parameters/click) [colorScheme](https://microlink.io/docs/api/parameters/colorScheme) [data](https://microlink.io/docs/api/parameters/data) [device](https://microlink.io/docs/api/parameters/device) [embed](https://microlink.io/docs/api/parameters/embed) [filename](https://microlink.io/docs/api/parameters/filename) [filter](https://microlink.io/docs/api/parameters/filter) [force](https://microlink.io/docs/api/parameters/force) [function](https://microlink.io/docs/api/parameters/function) [headers](https://microlink.io/docs/api/parameters/headers) [iframe](https://microlink.io/docs/api/parameters/iframe) [insights](https://microlink.io/docs/api/parameters/insights) [lighthouse](https://microlink.io/docs/api/parameters/insights/lighthouse) [technologies](https://microlink.io/docs/api/parameters/insights/technologies) [javascript](https://microlink.io/docs/api/parameters/javascript) [mediaType](https://microlink.io/docs/api/parameters/mediaType) [meta](https://microlink.io/docs/api/parameters/meta) [modules](https://microlink.io/docs/api/parameters/modules) [palette](https://microlink.io/docs/api/parameters/palette) [pdf](https://microlink.io/docs/api/parameters/pdf) [format](https://microlink.io/docs/api/parameters/pdf/format) [height](https://microlink.io/docs/api/parameters/pdf/height) [landscape](https://microlink.io/docs/api/parameters/pdf/landscape) [margin](https://microlink.io/docs/api/parameters/pdf/margin) [pageRanges](https://microlink.io/docs/api/parameters/pdf/pageRanges) [scale](https://microlink.io/docs/api/parameters/pdf/scale) [width](https://microlink.io/docs/api/parameters/pdf/width) [ping](https://microlink.io/docs/api/parameters/ping) [prerender](https://microlink.io/docs/api/parameters/prerender) [proxy](https://microlink.io/docs/api/parameters/proxy) [retry](https://microlink.io/docs/api/parameters/retry) [screenshot](https://microlink.io/docs/api/parameters/screenshot) [codeScheme](https://microlink.io/docs/api/parameters/screenshot/codeScheme) [element](https://microlink.io/docs/api/parameters/screenshot/element) [fullPage](https://microlink.io/docs/api/parameters/screenshot/fullPage) [overlay](https://microlink.io/docs/api/parameters/screenshot/overlay) [omitBackground](https://microlink.io/docs/api/parameters/screenshot/omitBackground) [type](https://microlink.io/docs/api/parameters/screenshot/type) [scripts](https://microlink.io/docs/api/parameters/scripts) [scroll](https://microlink.io/docs/api/parameters/scroll) [styles](https://microlink.io/docs/api/parameters/styles) [staleTtl](https://microlink.io/docs/api/parameters/staleTtl) [timeout](https://microlink.io/docs/api/parameters/timeout) [ttl](https://microlink.io/docs/api/parameters/ttl) [url](https://microlink.io/docs/api/parameters/url) [video](https://microlink.io/docs/api/parameters/video) [viewport](https://microlink.io/docs/api/parameters/viewport) [waitForSelector](https://microlink.io/docs/api/parameters/waitForSelector) [waitForTimeout](https://microlink.io/docs/api/parameters/waitForTimeout) [waitUntil](https://microlink.io/docs/api/parameters/waitUntil) API GUIDES MQL SDK CARDS Getting Started [Overview](https://microlink.io/docs/api/getting-started/overview) [Data fields](https://microlink.io/docs/api/getting-started/data-fields) [CLI](https://microlink.io/docs/api/getting-started/cli) Basics [Authentication](https://microlink.io/docs/api/basics/authentication) [Cache](https://microlink.io/docs/api/basics/cache) [Compression](https://microlink.io/docs/api/basics/compression) [Endpoint](https://microlink.io/docs/api/basics/endpoint) [Error codes](https://microlink.io/docs/api/basics/error-codes) [Format](https://microlink.io/docs/api/basics/format) [Rate limit](https://microlink.io/docs/api/basics/rate-limit) Query Parameters [adblock](https://microlink.io/docs/api/parameters/adblock) [animations](https://microlink.io/docs/api/parameters/animations) [audio](https://microlink.io/docs/api/parameters/audio) [cacheKey](https://microlink.io/docs/api/parameters/cacheKey) [click](https://microlink.io/docs/api/parameters/click) [colorScheme](https://microlink.io/docs/api/parameters/colorScheme) [data](https://microlink.io/docs/api/parameters/data) [device](https://microlink.io/docs/api/parameters/device) [embed](https://microlink.io/docs/api/parameters/embed) [filename](https://microlink.io/docs/api/parameters/filename) [filter](https://microlink.io/docs/api/parameters/filter) [force](https://microlink.io/docs/api/parameters/force) [function](https://microlink.io/docs/api/parameters/function) [headers](https://microlink.io/docs/api/parameters/headers) [iframe](https://microlink.io/docs/api/parameters/iframe) [insights](https://microlink.io/docs/api/parameters/insights) [lighthouse](https://microlink.io/docs/api/parameters/insights/lighthouse) [technologies](https://microlink.io/docs/api/parameters/insights/technologies) [javascript](https://microlink.io/docs/api/parameters/javascript) [mediaType](https://microlink.io/docs/api/parameters/mediaType) [meta](https://microlink.io/docs/api/parameters/meta) [modules](https://microlink.io/docs/api/parameters/modules) [palette](https://microlink.io/docs/api/parameters/palette) [pdf](https://microlink.io/docs/api/parameters/pdf) [format](https://microlink.io/docs/api/parameters/pdf/format) [height](https://microlink.io/docs/api/parameters/pdf/height) [landscape](https://microlink.io/docs/api/parameters/pdf/landscape) [margin](https://microlink.io/docs/api/parameters/pdf/margin) [pageRanges](https://microlink.io/docs/api/parameters/pdf/pageRanges) [scale](https://microlink.io/docs/api/parameters/pdf/scale) [width](https://microlink.io/docs/api/parameters/pdf/width) [ping](https://microlink.io/docs/api/parameters/ping) [prerender](https://microlink.io/docs/api/parameters/prerender) [proxy](https://microlink.io/docs/api/parameters/proxy) [retry](https://microlink.io/docs/api/parameters/retry) [screenshot](https://microlink.io/docs/api/parameters/screenshot) [codeScheme](https://microlink.io/docs/api/parameters/screenshot/codeScheme) [element](https://microlink.io/docs/api/parameters/screenshot/element) [fullPage](https://microlink.io/docs/api/parameters/screenshot/fullPage) [overlay](https://microlink.io/docs/api/parameters/screenshot/overlay) [omitBackground](https://microlink.io/docs/api/parameters/screenshot/omitBackground) [type](https://microlink.io/docs/api/parameters/screenshot/type) [scripts](https://microlink.io/docs/api/parameters/scripts) [scroll](https://microlink.io/docs/api/parameters/scroll) [styles](https://microlink.io/docs/api/parameters/styles) [staleTtl](https://microlink.io/docs/api/parameters/staleTtl) [timeout](https://microlink.io/docs/api/parameters/timeout) [ttl](https://microlink.io/docs/api/parameters/ttl) [url](https://microlink.io/docs/api/parameters/url) [video](https://microlink.io/docs/api/parameters/video) [viewport](https://microlink.io/docs/api/parameters/viewport) [waitForSelector](https://microlink.io/docs/api/parameters/waitForSelector) [waitForTimeout](https://microlink.io/docs/api/parameters/waitForTimeout) [waitUntil](https://microlink.io/docs/api/parameters/waitUntil) ## Format [Copy for LLM](https://microlink.io/docs/api/basics/format.md "Copy content for LLM") \| [View as Markdown](https://microlink.io/docs/api/basics/format.md "View content as Markdown") All the responses are served as **JSON**. The response format is based on [JSend](https://labs.omniti.com/labs/jsend) specification. That means every API response have the following fields: ## status Type: \ The status associated with the response. The value can be: - 'success': The request was resolved successfully. Associated with Type: 2xx HTTP status code. - 'fail': The request failed. Probably a missing or wrong value for a parameter. Associated with 4xx\` HTTP status code. - 'error': Uh oh. Something unexpected happened. Associated with 5xx HTTP status code. A simple rule here is, if the request was resolved successfully, then the 'success' status will be associated. In other case check for 'fail' or 'error'. ## data Type: \ The API response payload. ## message *Optional*\ Type: \ An human readable extra information, such as an error message or explanation. ## more *Optional*\ Type: \ An additional link pointing to external resource for reading more about `message`. Last updated on January 10, 2026 [Edit on GitHub](https://github.com/microlinkhq/www/blob/master/src/content/docs/api/basics/format.md)