POST/fetch

Fetch

The /fetch endpoint allows you to fetch a single webpage from a given URL.

Linkup·$0.01 per call

Example code

// Using @orth/sdk - The simplest way to call APIs
// Install: npm install @orth/sdk
import Orthogonal from "@orth/sdk";

const orthogonal = new Orthogonal({
  apiKey: process.env.ORTHOGONAL_API_KEY,
});

const output = await orthogonal.run({
  api: "linkup",
  path: "/fetch",
  body: {
    "url": "example"
  }
});

console.log(output);

Body parameters

urlrequired

string

The URL of the webpage you want to fetch.

renderJs

boolean

Defines whether the API should render the JavaScript of the webpage.

includeRawHtml

boolean

Defines whether the API should include the raw HTML of the webpage in its response.

extractImages

boolean

Defines whether the API should extract the images from the webpage in its response.

Response

markdown

string

Clean markdown version of the webpage content.

favicon

string

URL of the website favicon.

rawContent

string

Raw page content. Present only when includeRawContent is true.

contentType

string

The type of rawContent (e.g. html). Present only when rawContent is returned.

rawHtml

string

Deprecated. Raw HTML version of the webpage. Use includeRawContent instead.

images

array

List of images extracted from the webpage. Present only when extractImages is true.

images[].url

string

URL of the extracted image.

images[].alt

string

Alt text of the extracted image.

data

object

Structured data extracted from the webpage. Present only when schema is provided in the request. Fields with no grounded value are omitted.