Overview
Provides token expiration tracking and remaining time information, compatible with Google Authenticator and other TOTP applications.
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/totpgenerator \
-H "x-api-key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"secret": "JBSWY3DPEHPK3PXP",
"digits": 6,
"period": 30
}'const res = await fetch('https://api.apiverve.com/v1/totpgenerator', {
method: 'POST',
headers: {
'x-api-key': 'your_api_key_here',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"secret": "JBSWY3DPEHPK3PXP",
"digits": 6,
"period": 30
}),
});
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/totpgenerator",
headers={"x-api-key": "your_api_key_here"},
json={
"secret": "JBSWY3DPEHPK3PXP",
"digits": 6,
"period": 30
},
timeout=15,
)
res.raise_for_status()
print(res.json()["data"])package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
body := strings.NewReader(`{
"secret": "JBSWY3DPEHPK3PXP",
"digits": 6,
"period": 30
}`)
req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/totpgenerator", 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 |
|---|---|---|
secretRequired | string | Base32-encoded shared secret |
digitsOptional | integer | Number of digits in token default 6 · range 6–8 |
periodOptional | integer | Time period in seconds default 30 · range 1–300 |
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": {
"token": "935324",
"digits": 6,
"period": 30,
"timeRemaining": 25,
"expiresAt": "2025-12-16T22:31:00Z"
}
}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 |
|---|---|---|---|
token | string | "935324" | Generated time-based one-time password token |
digits | number | 6 | Number of digits in the generated token |
period | number | 30 | Time period configured for token generation |
timeRemainingPremium | number | 25 | Seconds remaining until token expires |
expiresAtPremium | string | "2025-12-16T22:31:00Z" | ISO 8601 timestamp when token expires |
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
- 2FA Implementation
- Implement two-factor authentication systems with TOTP token generation
- Authentication Testing
- Test TOTP-based authentication flows in development and QA environments
- Security Integration
- Integrate time-based one-time passwords into security workflows
- MFA Systems
- Build multi-factor authentication systems with standardized TOTP tokens
Other ways to use TOTP Generator
Set up TOTP Generator 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 Generation: