GET/web/scrape/markdown

Scrape URL and convert to Markdown

Scrapes the given URL, converts the HTML content to Markdown, and returns the result.

Context.dev·$0.03 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: "context-dev",
  path: "/web/scrape/markdown",
  query: {
    "url": "example"
  }
});

console.log(output);

Query parameters

urlrequired

string

Full URL to scrape and convert to markdown (must include http:// or https:// protocol)

includeLinks

boolean

Preserve hyperlinks in Markdown output

includeImages

boolean

Include image references in Markdown output

shortenBase64Images

boolean

Shorten base64-encoded image data in the Markdown output

useMainContentOnly

boolean

Extract only the main content of the page, excluding headers, footers, sidebars, and navigation

Response

url

string

success

boolean

markdown

string

metadata.image

string

metadata.title

string

metadata.jsonLd.0.@type

string

metadata.jsonLd.0.title

string

metadata.jsonLd.0.@content

string

metadata.jsonLd.0.industry

string

metadata.jsonLd.0.baseSalary

null

metadata.jsonLd.0.datePosted

string

metadata.jsonLd.0.description

null

metadata.jsonLd.0.jobBenefits

string

metadata.jsonLd.0.jobLocation.geo.@type

string

metadata.jsonLd.0.jobLocation.@type

string

metadata.jsonLd.0.jobLocation.address.@type

string

metadata.jsonLd.0.jobLocation.address.addressRegion

string

metadata.jsonLd.0.jobLocation.address.streetAddress

string

metadata.jsonLd.0.jobLocation.address.addressCountry

string

metadata.jsonLd.0.jobLocation.@content

string

metadata.jsonLd.0.validThrough

string

metadata.jsonLd.0.employmentType

string

metadata.jsonLd.0.employerOverview

null

metadata.jsonLd.0.responsibilities

null

metadata.jsonLd.0.hiringOrganization

string

metadata.jsonLd.0.experienceRequirements

null

metadata.robots

string

metadata.favicon

string

metadata.twitter.card

string

metadata.finalUrl

string

metadata.language

string

metadata.siteName

string

metadata.openGraph.url

string

metadata.openGraph.type

string

metadata.openGraph.image

string

metadata.openGraph.title

string

metadata.openGraph.locale

string

metadata.openGraph.siteName

string

metadata.openGraph.description

string

metadata.sourceUrl

string

metadata.description

string

metadata.canonicalUrl

string

metadata.additionalMeta.baggage

string

metadata.additionalMeta.charset

string

metadata.additionalMeta.viewport

string

metadata.additionalMeta.fb:app_id

string

metadata.additionalMeta.theme-color.0

string

metadata.additionalMeta.sentry-trace

string

metadata.additionalMeta.google-play-app

string

metadata.additionalMeta.apple-itunes-app

string

metadata.additionalMeta.format-detection

string

key_metadata.credits_consumed

number

key_metadata.credits_remaining

number