Short Code Generator API
Overview
To use Short Code Generator, you need an API key. You can get one by creating a free account and visiting your dashboard.
GET Endpoint
https://api.apiverve.com/v1/shortcodegeneratorExample
How to call the Short Code Generator API in different programming languages.
curl -X GET \
"https://api.apiverve.com/v1/shortcodegenerator?count=5&length=8&charset=alphanumeric" \
-H "X-API-Key: your_api_key_here"const response = await fetch('https://api.apiverve.com/v1/shortcodegenerator?count=5&length=8&charset=alphanumeric', {
method: 'GET',
headers: {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
});
const data = await response.json();
console.log(data);import requests
headers = {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
response = requests.get('https://api.apiverve.com/v1/shortcodegenerator?count=5&length=8&charset=alphanumeric', headers=headers)
data = response.json()
print(data)package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/shortcodegenerator?count=5&length=8&charset=alphanumeric", nil)
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": {
"codes": [
"bgiFznFh",
"jr84hHsG",
"Q77qABwn",
"gvMjXxXs",
"WDPJzCsi"
],
"count": 5,
"length": 8,
"charset": "alphanumeric",
"url_safe": true
}
}Authentication
The Short Code Generator 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 Short Code Generator API directly in your browser with live requests and responses.
Parameters
The following parameters are available for the Short Code Generator API:
Generate Short Code
| Parameter | Type | Required | Description | Default | Example |
|---|---|---|---|---|---|
count | integer | optional | Number of codes to generate Range: 1 - 100 | ||
length | integer | optional | Length of each code Range: 4 - 32 | ||
charset | string | optional | Character set Supported values: alphanumericalphanumerichexbase58 |
Response
The Short Code Generator 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>
<codes>
<code>bgiFznFh</code>
<code>jr84hHsG</code>
<code>Q77qABwn</code>
<code>gvMjXxXs</code>
<code>WDPJzCsi</code>
</codes>
<count>5</count>
<length>8</length>
<charset>alphanumeric</charset>
<url_safe>true</url_safe>
</data>
</response>
status: ok
error: null
data:
codes:
- bgiFznFh
- jr84hHsG
- Q77qABwn
- gvMjXxXs
- WDPJzCsi
count: 5
length: 8
charset: alphanumeric
url_safe: true
| key | value |
|---|---|
| codes | [bgiFznFh,jr84hHsG,Q77qABwn,gvMjXxXs,WDPJzCsi] |
| count | 5 |
| length | 8 |
| charset | alphanumeric |
| url_safe | true |
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 |
|---|---|---|---|
codes | array | - | |
count | number | - | |
length | number | - | |
charset | string | - | |
url_safe | boolean | - |
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 Short Code Generator through GraphQL to combine it with other API calls in a single request. Query only the short code generator 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 {
shortcodegenerator(
input: {
count: 5
length: 8
charset: "alphanumeric"
}
) {
codes
count
length
charset
url_safe
}
}Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.
CORS Support
The Short Code Generator 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
Short Code Generator 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 Short Code Generator 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 Short Code Generator
Official Short Code Generator packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →
No-Code Integrations
Short Code Generator 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 Short Code Generator?
How many credits does Short Code Generator cost?
Each successful Short Code Generator 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 short code generator lookups.
Can I use Short Code Generator in production?
The free plan is for testing and development only. For production use of Short Code Generator, 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 Short Code Generator from a browser?
What happens if I exceed my Short Code Generator credit limit?
When you reach your monthly credit limit, Short Code Generator 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.








