Skip to main content
GET
/
web
/
scrape
/
markdown
JavaScript
import BrandDev from 'brand.dev';

const client = new BrandDev({
  apiKey: process.env['BRAND_DEV_API_KEY'], // This is the default and can be omitted
});

const response = await client.brand.webScrapeMd({ url: 'https://example.com' });

console.log(response.markdown);
{
  "success": true,
  "markdown": "<string>",
  "url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
url
string<uri>
required

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

​
includeLinks
boolean
default:true

Preserve hyperlinks in Markdown output

​
includeImages
boolean
default:false

Include image references in Markdown output

Response

Successful response

​
success
enum<boolean>
required

Indicates success

Available options:
true
​
markdown
string
required

Page content converted to GitHub Flavored Markdown

​
url
string
required

The URL that was scraped