URL Unshortener API
Overview
To use URL Unshortener, 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/urlunshortenerExample
How to call the URL Unshortener API in different programming languages.
curl -X POST \
"https://api.apiverve.com/v1/urlunshortener" \
-H "X-API-Key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"url": "https://bit.ly/3k3j4"
}'const response = await fetch('https://api.apiverve.com/v1/urlunshortener', {
method: 'POST',
headers: {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
},
body: JSON.stringify({
"url": "https://bit.ly/3k3j4"
})
});
const data = await response.json();
console.log(data);import requests
headers = {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
payload = {
"url": "https://bit.ly/3k3j4"
}
response = requests.post('https://api.apiverve.com/v1/urlunshortener', 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{}{
"url": "https://bit.ly/3k3j4"
}
jsonPayload, _ := json.Marshal(payload)
req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/urlunshortener", 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": {
"source": "https://bit.ly/3k3j4",
"destination": "http://www.allclimbing.com/archive/2009/09/climbing-video-alex-puccio-on-trice-v12/",
"unshortened": true,
"reason": null
}
}Authentication
The URL Unshortener 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 Unshortener API directly in your browser with live requests and responses.
Parameters
The following parameters are available for the URL Unshortener API:
Unshorten Shortened URL
| Parameter | Type | Required | Description | Default | Example |
|---|---|---|---|---|---|
url | string | required | The shortened URL to unshorten Format: url (e.g., https://bit.ly/3k3j4) | - |
Response
The URL Unshortener 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>
<source>https://bit.ly/3k3j4</source>
<destination>http://www.allclimbing.com/archive/2009/09/climbing-video-alex-puccio-on-trice-v12/</destination>
<unshortened>true</unshortened>
<reason xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</data>
</response>
status: ok
error: null
data:
source: https://bit.ly/3k3j4
destination: >-
http://www.allclimbing.com/archive/2009/09/climbing-video-alex-puccio-on-trice-v12/
unshortened: true
reason: null
| key | value |
|---|---|
| source | https://bit.ly/3k3j4 |
| destination | http://www.allclimbing.com/archive/2009/09/climbing-video-alex-puccio-on-trice-v12/ |
| unshortened | true |
| reason |
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 |
|---|---|---|---|
source | string | The shortened URL that was provided as input | |
destination | string | The original unshortened URL destination | |
unshortened | boolean | Whether the URL was successfully unshortened | |
reason | object | Reason for failure if unshortened is false |
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 URL Unshortener through GraphQL to combine it with other API calls in a single request. Query only the url unshortener 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 {
urlunshortener(
input: {
url: "https://bit.ly/3k3j4"
}
) {
source
destination
unshortened
reason
}
}Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.
CORS Support
The URL Unshortener 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
URL Unshortener 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 URL Unshortener 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 URL Unshortener
Official URL Unshortener packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →
No-Code Integrations
URL Unshortener 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 URL Unshortener?
How many credits does URL Unshortener cost?
Each successful URL Unshortener 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 unshortener lookups.
Can I use URL Unshortener in production?
The free plan is for testing and development only. For production use of URL Unshortener, 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 Unshortener from a browser?
What happens if I exceed my URL Unshortener credit limit?
When you reach your monthly credit limit, URL Unshortener 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.








