Short Code Generator API

GET

Produce random alphanumeric codes for vouchers, invites, and links.

Short Code Generator creates custom alphanumeric short codes for vouchers, referral tokens, and redirect slugs. Specify a length, batch count, and character set like numeric, hex, or Base58 to receive an array of random strings.

Try it — live request, no key required

Request

GETapi.apiverve.com/v1/shortcodegenerator

Verification

Format

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

Example

{
  "status": "ok",
  "error": null,
  "data": {
    "codes": [
      "bgiFznFh",
      "jr84hHsG",
      "Q77qABwn",
      "gvMjXxXs",
      "WDPJzCsi"
    ],
    "count": 5,
    "length": 8,
    "charset": "alphanumeric",
    "url_safe": true
  }
}

About the Short Code Generator API

Short Code Generator works by randomly selecting characters from the specified character set to create codes of the desired length. Supports URL-safe character sets and excludes ambiguous characters in Base58 mode.

What people use it for

URL Shortening: Generate short codes for URL shortening services and link tracking
Voucher Systems: Create unique voucher and coupon codes for e-commerce and promotions
Temporary Access: Generate temporary access codes and one-time passwords for authentication
Referral Programs: Create short referral codes for marketing and referral tracking systems

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 Short Code Generator

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 Google Sheets or ExcelA =VERVE() formula fills a column — no script, no export, recalculates in place.on VerveSheets

Questions.

Common questions about the Short Code Generator API.

Read the docs →

How many code generation requests does the Free plan cover?

The Free plan covers 100 requests per month at 2 credits per call. For higher volumes, the Starter plan covers 100,000 requests monthly, which works out to about $0.30 per 1,000 calls.

Which character sets can I use for generating codes?

You can select from alphanumeric, alphabetic, numeric, hexadecimal, or Base58 character sets. You can also specify the exact character length for the generated codes.

Can I generate codes that exclude visually ambiguous characters?

Yes. Using the Base58 character set automatically excludes easily confused characters such as uppercase I, lowercase l, and the number 0. This makes codes easier for users to read and type manually.

Can I generate a batch of codes in a single request?

Yes. Pass the count parameter to generate multiple codes at once. The API returns an array containing all generated codes along with the requested count, length, and charset.

Are the generated codes safe to use in website URLs?

Yes. The supported character sets produce standard alphanumeric characters that are URL-safe, making them suitable for URL shorteners and redirect paths.

Request parameters — GET /v1/shortcodegenerator

Sent in the query string. 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.

Optional

Parameter	Type	Example	Description
`count`Optional	integer	`5`	Number of codes to generate default 1 · range 1-100
`length`Optional	integer	`8`	Length of each code default 8 · range 4-32
`charset`Optional	string	`alphanumeric`	Character set `alphanumericalphanumerichexbase58` default alphanumeric

Example request

1
2

curl "https://api.apiverve.com/v1/shortcodegenerator?count=5&length=8&charset=alphanumeric" \
  -H "x-api-key: YOUR_API_KEY"

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.

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 — GET /v1/shortcodegenerator

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": {
    "codes": [
      "bgiFznFh",
      "jr84hHsG",
      "Q77qABwn",
      "gvMjXxXs",
      "WDPJzCsi"
    ],
    "count": 5,
    "length": 8,
    "charset": "alphanumeric",
    "url_safe": true
  }
}

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
`codes`	array	`[bgiFznFh, ...]`	Array of generated short codes
`count`	number	`5`	Number of codes generated
`length`	number	`8`	Length of each generated code
`charset`	string	`"alphanumeric"`	Character set used for generation
`url_safe`	boolean	`true`	Whether the generated codes are safe to use in a URL without encoding

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	Short Code Generator 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 — GET /v1/shortcodegenerator

No SDK to install — this is a plain HTTPS call to /v1/shortcodegenerator 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/shortcodegenerator" \
  -H "x-api-key: YOUR_API_KEY"

Resources

GitHubapiverve/shortcodegenerator-apiSource, issues and the examples this page is built from.ReferenceShort Code Generator API docsEvery parameter, every response field, and the errors.ParametersWhat this call acceptsRequired and optional inputs, with example values.

Also published for

@apiverve/shortcodegeneratornpm APIVerve.API.ShortCodeGeneratorNuGet

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

Call it from Node.js — GET /v1/shortcodegenerator

Install the Node.js SDK, then call the Short Code Generator 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/shortcodegenerator

Node.js

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

Resources

npm@apiverve/shortcodegeneratorThe published Node.js client, versioned and signed.GitHubapiverve/shortcodegenerator-apiSource, issues and the examples this page is built from.ReferenceShort Code Generator API docsEvery parameter, every response field, and the errors.ParametersWhat this call acceptsRequired and optional inputs, with example values.

Also published for

APIVerve.API.ShortCodeGeneratorNuGet

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

Call it from Python — GET /v1/shortcodegenerator

No SDK to install — this is a plain HTTPS call to /v1/shortcodegenerator 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/shortcodegenerator",
    headers={"x-api-key": "YOUR_API_KEY"},
)
print(res.json()["data"])

Resources

Also published for

@apiverve/shortcodegeneratornpm APIVerve.API.ShortCodeGeneratorNuGet

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

Call it from C# / .NET — GET /v1/shortcodegenerator

Install the C# / .NET SDK, then call the Short Code Generator 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.ShortCodeGenerator

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/shortcodegenerator");
Console.WriteLine(json);

Resources

NuGetAPIVerve.API.ShortCodeGeneratorThe published C# / .NET client, versioned and signed.GitHubapiverve/shortcodegenerator-apiSource, issues and the examples this page is built from.ReferenceShort Code Generator API docsEvery parameter, every response field, and the errors.ParametersWhat this call acceptsRequired and optional inputs, with example values.

Also published for

@apiverve/shortcodegeneratornpm

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

Call it from Go — GET /v1/shortcodegenerator

No SDK to install — this is a plain HTTPS call to /v1/shortcodegenerator 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/shortcodegenerator", 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/shortcodegeneratornpm APIVerve.API.ShortCodeGeneratorNuGet

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

Call it from PHP — GET /v1/shortcodegenerator

No SDK to install — this is a plain HTTPS call to /v1/shortcodegenerator 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/shortcodegenerator");
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/shortcodegeneratornpm APIVerve.API.ShortCodeGeneratorNuGet

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

Call it from Ruby — GET /v1/shortcodegenerator

No SDK to install — this is a plain HTTPS call to /v1/shortcodegenerator 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/shortcodegenerator")
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/shortcodegeneratornpm APIVerve.API.ShortCodeGeneratorNuGet

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

Data Generation

View all 32 →

All articles →

Generate Barcodes for Inventory and ShippingCreate Code 128 and Code 39 barcodes programmatically. Tutorial for inventory systems, shipping labels, and asset tracking.Read

Add Secure Password Generation to Your AppGenerate cryptographically secure passwords via API. Tutorial with code examples for signup flows, admin panels, and password managers.Read

QR Codes Are Back (And This Time It's Different)Remember when QR codes were a punchline? Now they're everywhere. Here's why this time it stuck.Read

Short Code Generator API

Try it — live request, no key required

About the Short Code Generator API

What people use it for

Ways to call it

Other ways to use Short Code Generator

Questions.

Request parameters — GET /v1/shortcodegenerator

Optional

Authentication

Response — GET /v1/shortcodegenerator

Response fields

Response headers

Errors

What a call costs — 2 credits per call

Call it from cURL — GET /v1/shortcodegenerator

Resources

Also published for

Call it from Node.js — GET /v1/shortcodegenerator

Resources

Also published for

Call it from Python — GET /v1/shortcodegenerator

Resources

Also published for

Call it from C# / .NET — GET /v1/shortcodegenerator

Resources

Also published for

Call it from Go — GET /v1/shortcodegenerator

Resources

Also published for

Call it from PHP — GET /v1/shortcodegenerator

Resources

Also published for

Call it from Ruby — GET /v1/shortcodegenerator

Resources

Also published for

Zero-code embed — one snippet, no backend

Changelog — Short Code Generator API

Data Generation

Related articles

Ready to build with Short Code Generator? Start with 200 free credits — one key unlocks all 300+ APIs.

Explore the catalog