Query String Builder API

POST

Documentation Start for free →

Convert any JSON object into a fully formatted URL query string.

Query String Builder converts JSON objects into properly formatted URL query strings with optional encoding.

Try it — live request, no key required

Request

POSTapi.apiverve.com/v1/querystringbuilder

Body

paramsstring

Verification

Format

No key required to try it. Get a key to use it in your app.

Example

{
  "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
  }
}

About the Query String Builder API

Provides both encoded and unencoded query strings with full URL formatting, perfect for API integration and dynamic URL generation.

What people use it for

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

Ways to call it

One endpoint, many ways in — REST with JSON, XML, YAML and CSV, plus GraphQL and an MCP interface for AI agents.

JSON: Default REST response
XML: Markup format
YAML: Human-readable
CSV: Tabular export
GraphQL: Query language
MCP: For AI agents

View all integrations →

Other ways to use Query String Builder

Same data, same APIVerve account, same credit balance — one key works on all of them.

Give it to an AI agentConnect over MCP and your agent calls it as a native tool — Claude, Cursor, ChatGPT.on VerveKit

Questions.

Common questions about the Query String Builder API.

Read the docs →

How many query strings does the Free plan cover?

The Free plan gives you 200 credits each month, covering 100 query string generations at 2 credits per call. For larger workloads, the Starter plan provides 200,000 credits for up to 100,000 conversions a month, which works out to about $0.30 per 1,000 calls.

Can I generate query strings with and without URL encoding?

Yes. You can toggle the encode parameter to control whether parameter values are URL-encoded. The response also confirms whether encoding was applied through the encoded boolean field.

Does the output include the leading question mark ready for URL attachment?

Yes. Every successful request returns fullURL, which includes the leading question mark, as well as queryString, which contains only the formatted key-value pairs without the prefix.

What input format does the API require for parameters?

The API requires a standard JSON object passed to the params field. Each key-value pair in that object is mapped directly into a query parameter pair.

Does the response report how many parameters were processed?

Yes. The response includes a paramCount field showing the total count of unique parameters converted into the query string.

Request parameters — POST /v1/querystringbuilder

Sent as JSON in the request body. Premium parameters are accepted on every plan but only take effect on plans that include them. Anything not listed here is dropped rather than passed through.

Required

Parameter	Type	Example	Description
`params`Required	object	`{"name":"John","age":30}`	JSON object of parameters

Optional

Parameter	Type	Example	Description
`encode`Optional	boolean	`true`	URL encode parameter values default true · url

Example request

curl -X POST "https://api.apiverve.com/v1/querystringbuilder" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"params":{"name":"John Doe","age":30,"city":"New York","interests":["coding","music","travel"]},"encode":true}'

Authentication

Send your key in the x-api-key header. That is the only auth step — no token exchange, and no per-endpoint scope to configure.

Header	When	Value
`x-api-key`Required	Every request	Your API key. Header names are case-insensitive, so `X-API-Key` is the same header.
`Authorization`Alternate	Instead of the above	`Bearer <key>` — for clients that only expose bearer auth. Resolves to the same account and the same billing.
`content-type`Required	POST body	`application/json`

401 is the only auth verdict

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.

Response — POST /v1/querystringbuilder

Every APIVerve endpoint returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape.

Sample response

{
  "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

Response headers

Every response carries your balance, so your own code always knows where it stands without polling anything. All four are exposed to browsers through CORS.

Header	What it carries
`x-api-remaining-credits`	Credits left in the current cycle
`x-api-credits-used`	Credits spent in the current cycle
`x-api-max-credits`	The allowance for the cycle
`x-api-version`	Version of the endpoint that answered

Errors

Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change.

Status	Meaning	What to do
`400`	Input was rejected	Read `error`; it names the parameter that has to change.
`401`	Key missing or invalid	Check the header name and the key value.
`403`	Key valid, but not permitted here	A key restriction or an IP allow-list — never a bad key.
`429`	Rate limited, or out of credits	Read `error` to tell them apart, then back off or top up.

What a call costs — 2 credits per call

Credits are shared across every APIVerve API — one balance, one key, one bill. Failed requests never count against it, so a rejected input costs nothing.

Plan	Per month	Credits	Query String Builder calls	Per 1,000 calls
Free	Free	200	100	Free
Starter	$29.99	200,000	100,000	$0.30
Pro	$99.99	1,000,000	500,000	$0.20
Mega	$299.99	4,000,000	2,000,000	$0.15

Calls are what the credits buy at this API's rate — spend them here, on any of the other APIs, or across both. Nothing is reserved per endpoint.

Compare all pricing tiers →

Call it from cURL — POST /v1/querystringbuilder

No SDK to install — this is a plain HTTPS call to /v1/querystringbuilder with your key in the x-api-key header. Swap in a real key and it runs as-is.

cURL

1
2

curl "https://api.apiverve.com/v1/querystringbuilder" \
  -H "x-api-key: YOUR_API_KEY"

Resources

GitHubapiverve/querystringbuilder-apiSource, issues and the examples this page is built from.ReferenceQuery String Builder API docsEvery parameter, every response field, and the errors.ParametersWhat this call acceptsRequired and optional inputs, with example values.

Also published for

@apiverve/querystringbuildernpm APIVerve.API.QueryStringBuilderNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from Node.js — POST /v1/querystringbuilder

Install the Node.js SDK, then call the Query String Builder API with your key. The client wraps the same HTTPS request, so anything it returns is what the endpoint returns.

Install — npm

npm install @apiverve/querystringbuilder

Node.js

const res = await fetch("https://api.apiverve.com/v1/querystringbuilder", {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const { data } = await res.json();
console.log(data);

Resources

npm@apiverve/querystringbuilderThe published Node.js client, versioned and signed.GitHubapiverve/querystringbuilder-apiSource, issues and the examples this page is built from.ReferenceQuery String Builder API docsEvery parameter, every response field, and the errors.ParametersWhat this call acceptsRequired and optional inputs, with example values.

Also published for

APIVerve.API.QueryStringBuilderNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from Python — POST /v1/querystringbuilder

No SDK to install — this is a plain HTTPS call to /v1/querystringbuilder with your key in the x-api-key header. Swap in a real key and it runs as-is.

Python

import requests

res = requests.get(
    "https://api.apiverve.com/v1/querystringbuilder",
    headers={"x-api-key": "YOUR_API_KEY"},
)
print(res.json()["data"])

Resources

Also published for

@apiverve/querystringbuildernpm APIVerve.API.QueryStringBuilderNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from C# / .NET — POST /v1/querystringbuilder

Install the C# / .NET SDK, then call the Query String Builder API with your key. The client wraps the same HTTPS request, so anything it returns is what the endpoint returns.

Install — NuGet

dotnet add package APIVerve.API.QueryStringBuilder

C# / .NET

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY");

var json = await client.GetStringAsync("https://api.apiverve.com/v1/querystringbuilder");
Console.WriteLine(json);

Resources

NuGetAPIVerve.API.QueryStringBuilderThe published C# / .NET client, versioned and signed.GitHubapiverve/querystringbuilder-apiSource, issues and the examples this page is built from.ReferenceQuery String Builder API docsEvery parameter, every response field, and the errors.ParametersWhat this call acceptsRequired and optional inputs, with example values.

Also published for

@apiverve/querystringbuildernpm

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from Go — POST /v1/querystringbuilder

No SDK to install — this is a plain HTTPS call to /v1/querystringbuilder with your key in the x-api-key header. Swap in a real key and it runs as-is.

req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/querystringbuilder", nil)
req.Header.Set("x-api-key", "YOUR_API_KEY")

res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))

Resources

Also published for

@apiverve/querystringbuildernpm APIVerve.API.QueryStringBuilderNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from PHP — POST /v1/querystringbuilder

No SDK to install — this is a plain HTTPS call to /v1/querystringbuilder with your key in the x-api-key header. Swap in a real key and it runs as-is.

PHP

$ch = curl_init("https://api.apiverve.com/v1/querystringbuilder");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ["x-api-key: YOUR_API_KEY"]);

$response = curl_exec($ch);
echo $response;

Resources

Also published for

@apiverve/querystringbuildernpm APIVerve.API.QueryStringBuilderNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from Ruby — POST /v1/querystringbuilder

No SDK to install — this is a plain HTTPS call to /v1/querystringbuilder with your key in the x-api-key header. Swap in a real key and it runs as-is.

Ruby

require "net/http"

uri = URI("https://api.apiverve.com/v1/querystringbuilder")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "YOUR_API_KEY"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

Resources

Also published for

@apiverve/querystringbuildernpm APIVerve.API.QueryStringBuilderNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Data Conversion

View all 33 →

All articles →

Extract Clean Content from Any WebpageTurn messy web pages into clean Markdown. Perfect for content migration, archiving, AI training data, and building read-later tools.Read

Generate PDFs from HTML with an APIConvert HTML to PDF programmatically. Tutorial covering invoices, reports, receipts, and certificates with code examples.Read

Automating Visual Testing With ScreenshotsCatch visual bugs before users do. Here's how to add screenshot-based testing to your workflow.Read

Query String Builder API

Try it — live request, no key required

About the Query String Builder API

What people use it for

Ways to call it

Other ways to use Query String Builder

Questions.

Request parameters — POST /v1/querystringbuilder

Required

Optional

Authentication

Response — POST /v1/querystringbuilder

Response fields

Response headers

Errors

What a call costs — 2 credits per call

Call it from cURL — POST /v1/querystringbuilder

Resources

Also published for

Call it from Node.js — POST /v1/querystringbuilder

Resources

Also published for

Call it from Python — POST /v1/querystringbuilder

Resources

Also published for

Call it from C# / .NET — POST /v1/querystringbuilder

Resources

Also published for

Call it from Go — POST /v1/querystringbuilder

Resources

Also published for

Call it from PHP — POST /v1/querystringbuilder

Resources

Also published for

Call it from Ruby — POST /v1/querystringbuilder

Resources

Also published for

Zero-code embed — one snippet, no backend

Changelog — Query String Builder API

Data Conversion

Related articles

Ready to build with Query String Builder? Start with 200 free credits — one key unlocks all 300+ APIs.

Explore the catalog