URL Encoder/Decoder

Overview

URL Encoder/Decoder works by converting special characters and spaces into percent-encoded format (%XX) for safe URL transmission or decoding percent-encoded strings back to original text. Essential for query parameters and URL construction.

Endpoint

One host, one path per API. The block below shows this call in four languages; every one of them is the same HTTP request. Making requests covers the timeouts, retries and parameter rules that apply to all of them. The SDKs wrap the same call in a typed client.

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 res = 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"
}),
});

if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);

const { data } = await res.json();
console.log(data);

import requests

res = requests.post(
    "https://api.apiverve.com/v1/urlencode",
    headers={"x-api-key": "your_api_key_here"},
    json={
    "text": "Hello World & Goodbye",
    "action": "encode"
},
    timeout=15,
)
res.raise_for_status()

print(res.json()["data"])

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{
  "text": "Hello World & Goodbye",
  "action": "encode"
}`)
	req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/urlencode", body)
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("x-api-key", "your_api_key_here")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

Replace your_api_key_here with the key from your dashboard. When the inputs arrive as a list rather than one at a time, batch requests run up to 200 of them through this same API in a single call.

Authentication

Send your key in the x-api-key header. That is the only auth step — there is no token exchange and no per-endpoint scope to configure. Authentication covers creating, rotating and revoking keys.

Parameters

Sent as JSON in the request body. Premium parameters are accepted on every plan but only take effect on plans that include them.

Response

Every API returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape. Response format covers the envelope, the other output formats and how premium fields are withheld.

{
  "status": "ok",
  "error": null,
  "data": {
    "action": "encode",
    "original": "Hello World & Goodbye",
    "encoded": "Hello%20World%20%26%20Goodbye",
    "length": 29
  }
}

Response fields

Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.

Errors

Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change. Error handling covers the full status list and which of them are worth retrying.

Use cases

API Requests

Encode query parameters and URL components before making API requests to ensure proper formatting

Link Generation

Generate properly encoded URLs for links, redirects, and sharing with special characters or spaces

Form Handling

Encode form data for URL submission or decode URL-encoded form data received from submissions

Search Queries

Encode search terms and filters for URL-based search functionality and bookmarkable search results

Other ways to use URL Encoder/Decoder

Set up URL Encoder/Decoder on APIVerve, or reach the same source a different way. Your APIVerve account and credits work on all of them — one key, one balance.

Related

More in Data Conversion: