URL Encoder/Decoder API
Overview
To use URL Encoder/Decoder, 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/urlencodeExample
How to call the URL Encoder/Decoder API in different programming languages.
curl -X POST \
"https://api.apiverve.com/v1/urlencode" \
-H "X-API-Key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"text": "Hello World & Goodbye",
"action": "encode"
}'const response = await fetch('https://api.apiverve.com/v1/urlencode', {
method: 'POST',
headers: {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
},
body: JSON.stringify({
"text": "Hello World & Goodbye",
"action": "encode"
})
});
const data = await response.json();
console.log(data);import requests
headers = {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
payload = {
"text": "Hello World & Goodbye",
"action": "encode"
}
response = requests.post('https://api.apiverve.com/v1/urlencode', 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{}{
"text": "Hello World & Goodbye",
"action": "encode"
}
jsonPayload, _ := json.Marshal(payload)
req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/urlencode", 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": {
"action": "encode",
"original": "Hello World & Goodbye",
"encoded": "Hello%20World%20%26%20Goodbye",
"length": 29
}
}Authentication
The URL Encoder/Decoder 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 Encoder/Decoder API directly in your browser with live requests and responses.
Parameters
The URL Encoder/Decoder API supports multiple query options. Use one of the following:
Option 1: URL Encode
| Parameter | Type | Required | Description | Default | Example |
|---|---|---|---|---|---|
text | string | required | The text to encode | - | |
action | string | optional | The action to perform Supported values: encodedecode |
Option 2: URL Decode
| Parameter | Type | Required | Description | Default | Example |
|---|---|---|---|---|---|
text | string | required | The URL-encoded string to decode | - | |
action | string | optional | The action to perform Supported values: encodedecode |
Response
The URL Encoder/Decoder 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>
<action>encode</action>
<original>Hello World & Goodbye</original>
<encoded>Hello%20World%20%26%20Goodbye</encoded>
<length>29</length>
</data>
</response>
status: ok
error: null
data:
action: encode
original: Hello World & Goodbye
encoded: Hello%20World%20%26%20Goodbye
length: 29
| key | value |
|---|---|
| action | encode |
| original | Hello World & Goodbye |
| encoded | Hello%20World%20%26%20Goodbye |
| length | 29 |
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 |
|---|---|---|---|
action | string | The encoding or decoding action that was performed | |
original | string | The original text input before encoding or decoding | |
encoded | string | The resulting encoded or decoded text output | |
lengthPremium | number | The total character length of the encoded or decoded output |
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 Encoder/Decoder through GraphQL to combine it with other API calls in a single request. Query only the url encoder/decoder 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 {
urlencode(
input: {
text: "Hello World & Goodbye"
action: "encode"
}
) {
action
original
encoded
length
}
}Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.
CORS Support
The URL Encoder/Decoder 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 Encoder/Decoder 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 Encoder/Decoder 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 Encoder/Decoder
Official URL Encoder/Decoder packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →
No-Code Integrations
URL Encoder/Decoder 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 Encoder/Decoder?
How many credits does URL Encoder/Decoder cost?
Each successful URL Encoder/Decoder 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 encoder/decoder lookups.
Can I use URL Encoder/Decoder in production?
The free plan is for testing and development only. For production use of URL Encoder/Decoder, 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 Encoder/Decoder from a browser?
What happens if I exceed my URL Encoder/Decoder credit limit?
When you reach your monthly credit limit, URL Encoder/Decoder 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.








