Overview
Provides both encoded and unencoded query strings with full URL formatting, perfect for API integration and dynamic URL generation.
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/querystringbuilder \
-H "x-api-key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"params": {
"name": "John Doe",
"age": 30,
"city": "New York",
"interests": [
"coding",
"music",
"travel"
]
},
"encode": true
}'const res = await fetch('https://api.apiverve.com/v1/querystringbuilder', {
method: 'POST',
headers: {
'x-api-key': 'your_api_key_here',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"params": {
"name": "John Doe",
"age": 30,
"city": "New York",
"interests": [
"coding",
"music",
"travel"
]
},
"encode": true
}),
});
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/querystringbuilder",
headers={"x-api-key": "your_api_key_here"},
json={
"params": {
"name": "John Doe",
"age": 30,
"city": "New York",
"interests": [
"coding",
"music",
"travel"
]
},
"encode": True
},
timeout=15,
)
res.raise_for_status()
print(res.json()["data"])package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
body := strings.NewReader(`{
"params": {
"name": "John Doe",
"age": 30,
"city": "New York",
"interests": [
"coding",
"music",
"travel"
]
},
"encode": true
}`)
req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/querystringbuilder", 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.
A 401 means the key is missing, invalid or expired. A 403 means the key is valid but not permitted here — blocked by a key restriction or an IP allow-list. Running out of credits is a 429.
Parameters
Sent as JSON in the request body. Premium parameters are accepted on every plan but only take effect on plans that include them.
| Parameter | Type | Description |
|---|---|---|
paramsRequired | object | JSON object of parameters |
encodeOptional | boolean | URL encode parameter values default true · url |
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": {
"queryString": "name=John%20Doe&age=30&city=New%20York&interests=coding&interests=music&interests=travel",
"fullURL": "?name=John%20Doe&age=30&city=New%20York&interests=coding&interests=music&interests=travel",
"encoded": true,
"paramCount": 4
}
}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.
| Field | Type | Example | Description |
|---|---|---|---|
queryString | string | "name=John%20Doe&age=30&city=New%20York&interests=coding&interests=music&interests=travel" | Formatted query string with encoded parameter key-value pairs |
fullURL | string | "?name=John%20Doe&age=30&city=New%20York&interests=coding&interests=music&interests=travel" | Complete query string with leading question mark for URLs |
encoded | boolean | true | Indicates whether URL encoding was applied to parameters |
paramCount | number | 4 | Total count of unique parameters in the query string |
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.
| Status | Meaning | What to do |
|---|---|---|
400 | Input was rejected | Read error; it names the parameter. |
401 | Key missing or invalid | Check the header name and the key value. |
403 | Key valid, but not permitted | A key restriction or IP allow-list; see key scoping. |
429 | Rate limited, or out of credits | Read error to tell them apart; see rate limits. |
Use cases
- API Integration
- Build query strings for API requests from parameter objects
- URL Generation
- Generate dynamic URLs with properly encoded query parameters
- Form Processing
- Convert form data to URL query strings for GET requests
- Link Building
- Create shareable links with query parameters from structured data
Other ways to use Query String Builder
Set up Query String Builder 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: