Markdown Link Extractor API
Overview
To use Markdown Link Extractor, 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/markdownlinkextractorExample
How to call the Markdown Link Extractor API in different programming languages.
curl -X POST \
"https://api.apiverve.com/v1/markdownlinkextractor" \
-H "X-API-Key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"markdown": "# Sample Document\n\nCheck out [this link](https://example.com) and [another one](https://test.com).\n\n\n\nVisit <https://autolink.com> or just https://bare-url.com\n\n[Reference link][ref1]\n\n[ref1]: https://reference.com"
}'const response = await fetch('https://api.apiverve.com/v1/markdownlinkextractor', {
method: 'POST',
headers: {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
},
body: JSON.stringify({
"markdown": "# Sample Document\n\nCheck out [this link](https://example.com) and [another one](https://test.com).\n\n\n\nVisit <https://autolink.com> or just https://bare-url.com\n\n[Reference link][ref1]\n\n[ref1]: https://reference.com"
})
});
const data = await response.json();
console.log(data);import requests
headers = {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
payload = {
"markdown": "# Sample Document\n\nCheck out [this link](https://example.com) and [another one](https://test.com).\n\n\n\nVisit <https://autolink.com> or just https://bare-url.com\n\n[Reference link][ref1]\n\n[ref1]: https://reference.com"
}
response = requests.post('https://api.apiverve.com/v1/markdownlinkextractor', headers=headers, json=payload)
data = response.json()
print(data)package main
import (
"fmt"
"io"
"net/http"
"bytes"
"encoding/json"
)
func main() {
payload := map[string]interface{}{
"markdown": "# Sample Document
Check out [this link](https://example.com) and [another one](https://test.com).

Visit <https://autolink.com> or just https://bare-url.com
[Reference link][ref1]
[ref1]: https://reference.com"
}
jsonPayload, _ := json.Marshal(payload)
req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/markdownlinkextractor", bytes.NewBuffer(jsonPayload))
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))
}{
"status": "ok",
"error": null,
"data": {
"totalLinks": 6,
"links": [
{
"text": "this link",
"url": "https://example.com",
"type": "inline"
},
{
"text": "another one",
"url": "https://test.com",
"type": "inline"
},
{
"text": "Image",
"url": "https://example.com/image.png",
"type": "inline"
},
{
"text": "Reference link",
"url": "https://reference.com",
"type": "reference",
"reference": "ref1"
},
{
"text": "https://autolink.com",
"url": "https://autolink.com",
"type": "autolink"
},
{
"text": "https://bare-url.com",
"url": "https://bare-url.com",
"type": "bare"
}
],
"categories": {
"internal": {
"count": 0,
"links": []
},
"external": {
"count": 6,
"links": [
{
"text": "this link",
"url": "https://example.com",
"type": "inline"
},
{
"text": "another one",
"url": "https://test.com",
"type": "inline"
},
{
"text": "Image",
"url": "https://example.com/image.png",
"type": "inline"
},
{
"text": "Reference link",
"url": "https://reference.com",
"type": "reference",
"reference": "ref1"
},
{
"text": "https://autolink.com",
"url": "https://autolink.com",
"type": "autolink"
},
{
"text": "https://bare-url.com",
"url": "https://bare-url.com",
"type": "bare"
}
]
},
"email": {
"count": 0,
"links": []
},
"other": {
"count": 0,
"links": []
}
},
"markdownLength": 253
}
}Authentication
The Markdown Link Extractor 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 Markdown Link Extractor API directly in your browser with live requests and responses.
Parameters
The following parameters are available for the Markdown Link Extractor API:
Extract Links from Markdown
| Parameter | Type | Required | Description | Default | Example |
|---|---|---|---|---|---|
markdown | string | required | Markdown text to parse (max 100,000 characters) | - |
Response
The Markdown Link Extractor API returns responses in JSON, XML, YAML, and CSV formats. The JSON response is shown in the Example section above; alternative formats below.
Other Response Formats
<?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>
<totalLinks>6</totalLinks>
<links>
<link>
<text>this link</text>
<url>https://example.com</url>
<type>inline</type>
</link>
<link>
<text>another one</text>
<url>https://test.com</url>
<type>inline</type>
</link>
<link>
<text>Image</text>
<url>https://example.com/image.png</url>
<type>inline</type>
</link>
<link>
<text>Reference link</text>
<url>https://reference.com</url>
<type>reference</type>
<reference>ref1</reference>
</link>
<link>
<text>https://autolink.com</text>
<url>https://autolink.com</url>
<type>autolink</type>
</link>
<link>
<text>https://bare-url.com</text>
<url>https://bare-url.com</url>
<type>bare</type>
</link>
</links>
<categories>
<internal>
<count>0</count>
<links>
</links>
</internal>
<external>
<count>6</count>
<links>
<link>
<text>this link</text>
<url>https://example.com</url>
<type>inline</type>
</link>
<link>
<text>another one</text>
<url>https://test.com</url>
<type>inline</type>
</link>
<link>
<text>Image</text>
<url>https://example.com/image.png</url>
<type>inline</type>
</link>
<link>
<text>Reference link</text>
<url>https://reference.com</url>
<type>reference</type>
<reference>ref1</reference>
</link>
<link>
<text>https://autolink.com</text>
<url>https://autolink.com</url>
<type>autolink</type>
</link>
<link>
<text>https://bare-url.com</text>
<url>https://bare-url.com</url>
<type>bare</type>
</link>
</links>
</external>
<email>
<count>0</count>
<links>
</links>
</email>
<other>
<count>0</count>
<links>
</links>
</other>
</categories>
<markdownLength>253</markdownLength>
</data>
</response>
status: ok
error: null
data:
totalLinks: 6
links:
- text: this link
url: https://example.com
type: inline
- text: another one
url: https://test.com
type: inline
- text: Image
url: https://example.com/image.png
type: inline
- text: Reference link
url: https://reference.com
type: reference
reference: ref1
- text: https://autolink.com
url: https://autolink.com
type: autolink
- text: https://bare-url.com
url: https://bare-url.com
type: bare
categories:
internal:
count: 0
links: []
external:
count: 6
links:
- text: this link
url: https://example.com
type: inline
- text: another one
url: https://test.com
type: inline
- text: Image
url: https://example.com/image.png
type: inline
- text: Reference link
url: https://reference.com
type: reference
reference: ref1
- text: https://autolink.com
url: https://autolink.com
type: autolink
- text: https://bare-url.com
url: https://bare-url.com
type: bare
email:
count: 0
links: []
other:
count: 0
links: []
markdownLength: 253
| key | value |
|---|---|
| totalLinks | 6 |
| links | [{text:this link,url:https://example.com,type:inline},{text:another one,url:https://test.com,type:inline},{text:Image,url:https://example.com/image.png,type:inline},{text:Reference link,url:https://reference.com,type:reference,reference:ref1},{text:https://autolink.com,url:https://autolink.com,type:autolink},{text:https://bare-url.com,url:https://bare-url.com,type:bare}] |
| categories | {internal:{count:0,links:[]},external:{count:6,links:[{text:this link,url:https://example.com,type:inline},{text:another one,url:https://test.com,type:inline},{text:Image,url:https://example.com/image.png,type:inline},{text:Reference link,url:https://reference.com,type:reference,reference:ref1},{text:https://autolink.com,url:https://autolink.com,type:autolink},{text:https://bare-url.com,url:https://bare-url.com,type:bare}]},email:{count:0,links:[]},other:{count:0,links:[]}} |
| markdownLength | 253 |
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 |
|---|---|---|---|
totalLinks | number | - | |
| [ ] Array items: | array[6] | - | |
â”” text | string | - | |
â”” url | string | - | |
â”” type | string | - | |
categories | object | - | |
â”” internal | object | - | |
â”” count | number | - | |
â”” links | array | - | |
â”” external | object | - | |
â”” count | number | - | |
| [ ] Array items: | array[6] | - | |
â”” text | string | - | |
â”” url | string | - | |
â”” type | string | - | |
â”” email | object | - | |
â”” count | number | - | |
â”” links | array | - | |
â”” other | object | - | |
â”” count | number | - |
Headers
Only X-API-Key is required. Optional headers include Accept for response format negotiation (JSON, XML, or YAML), User-Agent, and X-Request-ID for request tracing. See all request headers →
GraphQL AccessALPHA
Access Markdown Link Extractor through GraphQL to combine it with other API calls in a single request. Query only the markdown link extractor 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 {
markdownlinkextractor(
input: {
markdown: "# Sample Document
Check out [this link](https://example.com) and [another one](https://test.com).

Visit <https://autolink.com> or just https://bare-url.com
[Reference link][ref1]
[ref1]: https://reference.com"
}
) {
totalLinks
links
categories {
internal {
count
links
}
external {
count
links
}
email {
count
links
}
other {
count
links
}
}
markdownLength
}
}Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.
CORS Support
The Markdown Link Extractor API accepts cross-origin requests from any origin, so it can be called directly from browser-based applications without a proxy. See CORS support →
Rate Limiting
Markdown Link Extractor requests are throttled per minute on the Free plan and unthrottled on paid plans. Exceeding the limit returns 429 Too Many Requests; rate-limit usage is reported in the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers. See per-plan limits and best practices →
Error Codes
The Markdown Link Extractor API uses standard HTTP status codes — 200 on success, 400 for invalid parameters, 401 for missing or invalid keys, 403 for insufficient credits, 429 for rate-limit exhaustion, and 500/503 for server-side issues. Each error response includes an X-Request-ID header you can quote when contacting support. See full error handling guide →
SDKs for Markdown Link Extractor
Official Markdown Link Extractor packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →
No-Code Integrations
Markdown Link Extractor works with Zapier, Make, Pipedream, n8n, and Power Automate using the same API key. See setup guides →
Frequently Asked Questions
How do I get an API key for Markdown Link Extractor?
How many credits does Markdown Link Extractor cost?
Each successful Markdown Link Extractor 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 markdown link extractor lookups.
Can I use Markdown Link Extractor in production?
The free plan is for testing and development only. For production use of Markdown Link Extractor, 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 Markdown Link Extractor from a browser?
What happens if I exceed my Markdown Link Extractor credit limit?
When you reach your monthly credit limit, Markdown Link Extractor 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.








