URL to Markdown API
URL to Markdown is a powerful tool for converting any webpage into clean, readable Markdown format. It preserves the document structure including headings, links, lists, and images.
The URL to Markdown API provides reliable and fast access to url to markdown data through a simple REST interface. Built for developers who need consistent, high-quality results with minimal setup time.
To use URL to Markdown, you need an API key. You can get one by creating a free account and visiting your dashboard.
POST Endpoint
https://api.apiverve.com/v1/urltomarkdownCode Examples
Here are examples of how to call the URL to Markdown API in different programming languages:
curl -X POST \
"https://api.apiverve.com/v1/urltomarkdown" \
-H "X-API-Key: your_api_key_here"const response = await fetch('https://api.apiverve.com/v1/urltomarkdown', {
method: 'POST',
headers: {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
});
const data = await response.json();
console.log(data);import requests
headers = {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
response = requests.post('https://api.apiverve.com/v1/urltomarkdown', headers=headers)
data = response.json()
print(data)const https = require('https');
const url = require('url');
const options = {
method: 'POST',
headers: {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
};
const req = https.request('https://api.apiverve.com/v1/urltomarkdown', options, (res) => {
let data = '';
res.on('data', (chunk) => data += chunk);
res.on('end', () => console.log(JSON.parse(data)));
});
req.end();<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apiverve.com/v1/urltomarkdown');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'X-API-Key: your_api_key_here',
'Content-Type: application/json'
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/urltomarkdown", nil)
req.Header.Set("X-API-Key", "your_api_key_here")
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require 'net/http'
require 'json'
uri = URI('https://api.apiverve.com/v1/urltomarkdown')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['X-API-Key'] = 'your_api_key_here'
request['Content-Type'] = 'application/json'
response = http.request(request)
puts JSON.pretty_generate(JSON.parse(response.body))using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
class Program
{
static async Task Main(string[] args)
{
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-API-Key", "your_api_key_here");
var response = await client.GetAsync("https://api.apiverve.com/v1/urltomarkdown");
response.EnsureSuccessStatusCode();
var responseBody = await response.Content.ReadAsStringAsync();
Console.WriteLine(responseBody);
}
}Authentication
The URL to Markdown API requires authentication via API key. Include your API key in the request header:
X-API-Key: your_api_key_hereInteractive API Playground
Test the URL to Markdown API directly in your browser with live requests and responses.
Parameters
The following parameters are available for the URL to Markdown API:
Convert URL to Markdown
| Parameter | Type | Required | Description | Default | Example |
|---|---|---|---|---|---|
url | string | required | The URL of the webpage to convert to Markdown Format: url (e.g., https://www.example.com/article) | - | |
includeImagesPremium | boolean | optional | Whether to include image references in the Markdown output | - | |
includeLinksPremium | boolean | optional | Whether to include hyperlinks in the Markdown output | - |
Response
The URL to Markdown API returns responses in JSON, XML, YAML, and CSV formats:
Example Responses
{
"status": "ok",
"error": null,
"data": {
"url": "https://example.com/blog/getting-started",
"title": "Getting Started Guide",
"markdown": "# Getting Started Guide\n\nWelcome to our platform. This guide will help you get up and running quickly.\n\n## Prerequisites\n\nBefore you begin, make sure you have:\n\n- A registered account\n- API credentials\n- Node.js 18 or higher\n\n## Installation\n\nInstall the package using npm:\n\n```\nnpm install example-sdk\n```\n\n## Quick Start\n\nHere's a simple example to get you started:\n\n1. Import the SDK\n2. Initialize with your API key\n3. Make your first request\n\n## Next Steps\n\nCheck out our [documentation](https://example.com/docs) for more details.\n\n",
"wordCount": 87,
"imageCount": 1,
"linkCount": 1
}
}<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>ok</status>
<error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<data>
<url>https://example.com/blog/getting-started</url>
<title>Getting Started Guide</title>
<markdown># Getting Started Guide
Welcome to our platform. This guide will help you get up and running quickly.
## Prerequisites
Before you begin, make sure you have:
- A registered account
- API credentials
- Node.js 18 or higher
## Installation
Install the package using npm:
```
npm install example-sdk
```
## Quick Start
Here's a simple example to get you started:
1. Import the SDK
2. Initialize with your API key
3. Make your first request
## Next Steps
Check out our [documentation](https://example.com/docs) for more details.
</markdown>
<wordCount>87</wordCount>
<imageCount>1</imageCount>
<linkCount>1</linkCount>
</data>
</response>
status: ok
error: null
data:
url: https://example.com/blog/getting-started
title: Getting Started Guide
markdown: >-
# Getting Started Guide
Welcome to our platform. This guide will help you get up and running
quickly.
## Prerequisites
Before you begin, make sure you have:
- A registered account
- API credentials
- Node.js 18 or higher
## Installation
Install the package using npm:
```
npm install example-sdk
```
## Quick Start
Here's a simple example to get you started:
1. Import the SDK
2. Initialize with your API key
3. Make your first request
## Next Steps
Check out our [documentation](https://example.com/docs) for more details.

wordCount: 87
imageCount: 1
linkCount: 1
| key | value |
|---|---|
| url | https://example.com/blog/getting-started |
| title | Getting Started Guide |
| markdown | # Getting Started Guide |
| Welcome to our platform. This guide will help you get up and running quickly. | |
| ## Prerequisites | |
| Before you begin | make sure you have: |
| - A registered account | |
| - API credentials | |
| - Node.js 18 or higher | |
| ## Installation | |
| Install the package using npm: | |
| ``` | |
| npm install example-sdk | |
| ``` | |
| ## Quick Start | |
| Here's a simple example to get you started: | |
| 1. Import the SDK | |
| 2. Initialize with your API key | |
| 3. Make your first request | |
| ## Next Steps | |
| Check out our [documentation](https://example.com/docs) for more details. | |
|  | |
| wordCount | 87 |
| imageCount | 1 |
| linkCount | 1 |
Response Structure
All API responses follow a consistent structure with the following fields:
| Field | Type | Description | Example |
|---|---|---|---|
status | string | Indicates whether the request was successful ("ok") or failed ("error") | ok |
error | string | null | Contains error message if status is "error", otherwise null | null |
data | object | null | Contains the API response data if successful, otherwise null | {...} |
Learn more about response formats →
Response Data Fields
When the request is successful, the data object contains the following fields:
| Field | Type | Sample Value | Description |
|---|---|---|---|
url | string | The original URL that was converted | |
title | string | Page title extracted from the webpage | |
markdown | string | The converted Markdown content | |
wordCount | number | Number of words in the extracted content | |
imageCount | number | Number of images found in the content | |
linkCount | number | Number of links found in the content |
Headers
Required and optional headers for URL to Markdown API requests:
| Header Name | Required | Example Value | Description |
|---|---|---|---|
X-API-Key | required | your_api_key_here | Your APIVerve API key. Found in your dashboard under API Keys. |
Accept | optional | application/json | Specify response format: application/json (default), application/xml, or application/yaml |
User-Agent | optional | MyApp/1.0 | Identifies your application for analytics and debugging purposes |
X-Request-ID | optional | req_123456789 | Custom request identifier for tracking and debugging requests |
Cache-Control | optional | no-cache | Control caching behavior for the request and response |
GraphQL AccessALPHA
Access URL to Markdown through GraphQL to combine it with other API calls in a single request. Query only the url to markdown data you need with precise field selection, and orchestrate complex data fetching workflows.
Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.
POST https://api.apiverve.com/v1/graphqlquery {
urltomarkdown {
url
title
markdown
wordCount
imageCount
linkCount
}
}Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.
CORS Support
The URL to Markdown API supports Cross-Origin Resource Sharing (CORS) with wildcard configuration, allowing you to call URL to Markdown directly from browser-based applications without proxy servers.
| CORS Header | Value | Description |
|---|---|---|
Access-Control-Allow-Origin | * | Accepts requests from any origin |
Access-Control-Allow-Methods | * | Accepts any HTTP method |
Access-Control-Allow-Headers | * | Accepts any request headers |
Browser Usage: You can call URL to Markdown directly from JavaScript running in the browser without encountering CORS errors. No proxy server or additional configuration needed.
Rate Limiting
URL to Markdown API requests are subject to rate limiting based on your subscription plan. These limits ensure fair usage and maintain service quality for all URL to Markdown users.
| Plan | Rate Limit | Description |
|---|---|---|
| Free | 5 requests/min | Hard rate limit enforced - exceeding will return 429 errors |
| Starter | No Limit | Production ready - standard traffic priority |
| Pro | No Limit | Production ready - preferred traffic priority |
| Mega | No Limit | Production ready - highest traffic priority |
Learn more about rate limiting →
Rate Limit Headers
When rate limits apply, each URL to Markdown response includes headers to help you track your usage:
| Header | Description |
|---|---|
X-RateLimit-Limit | Maximum number of requests allowed per time window |
X-RateLimit-Remaining | Number of requests remaining in the current window |
X-RateLimit-Reset | Unix timestamp when the rate limit window resets |
Handling Rate Limits
Free Plan: When you exceed your rate limit, URL to Markdown returns a 429 Too Many Requests status code. Your application should implement appropriate backoff logic to handle this gracefully.
Paid Plans: No rate limiting or throttling applied. All paid plans (Starter, Pro, Mega) are production-ready.
Best Practices for URL to Markdown:
- Monitor the rate limit headers to track your URL to Markdown usage (Free plan only)
- Cache url to markdown responses where appropriate to reduce API calls
- Upgrade to Pro or Mega for guaranteed no-throttle URL to Markdown performance
Note: URL to Markdown rate limits are separate from credit consumption. You may have credits remaining but still hit rate limits when using URL to Markdown on Free tier.
Error Codes
The URL to Markdown API uses standard HTTP status codes to indicate success or failure:
| Code | Message | Description | Solution |
|---|---|---|---|
200 | OK | Request successful, data returned | No action needed - request was successful |
400 | Bad Request | Invalid request parameters or malformed request | Check required parameters and ensure values match expected formats |
401 | Unauthorized | Missing or invalid API key | Include x-api-key header with valid API key from dashboard |
403 | Forbidden | API key lacks permission or insufficient credits | Check credit balance in dashboard or upgrade plan |
429 | Too Many Requests | Rate limit exceeded (Free: 5 req/min) | Implement request throttling or upgrade to paid plan |
500 | Internal Server Error | Server error occurred | Retry request after a few seconds, contact support if persists |
503 | Service Unavailable | API temporarily unavailable | Wait and retry, check status page for maintenance updates |
Learn more about error handling →
Need help? Contact support with your X-Request-ID for assistance.
Integrate URL to Markdown with SDKs
Get started quickly with official URL to Markdown SDKs for your preferred language. Each library handles authentication, request formatting, and error handling automatically.
Available for Node.js, Python, C#/.NET, and Android/Java. All SDKs are open source and regularly updated.
Integrate URL to Markdown with No-Code API Tools
Connect the URL to Markdown API to your favorite automation platform without writing code. Build workflows that leverage url to markdown data across thousands of apps.





All platforms use your same API key to access URL to Markdown. Visit our integrations hub for step-by-step setup guides.
Frequently Asked Questions
How do I get an API key for URL to Markdown?
How many credits does URL to Markdown cost?
Each successful URL to Markdown API call consumes credits based on plan tier. Check the pricing section above for the exact credit cost. Failed requests and errors don't consume credits, so you only pay for successful url to markdown lookups.
Can I use URL to Markdown in production?
The free plan is for testing and development only. For production use of URL to Markdown, upgrade to a paid plan (Starter, Pro, or Mega) which includes commercial use rights, no attribution requirements, and guaranteed uptime SLAs. All paid plans are production-ready.
Can I use URL to Markdown from a browser?
What happens if I exceed my URL to Markdown credit limit?
When you reach your monthly credit limit, URL to Markdown API requests will return an error until you upgrade your plan or wait for the next billing cycle. You'll receive notifications at 80% and 95% usage to give you time to upgrade if needed.



