Overview
Dice Roller works by parsing dice notation (e.g., 3d6+5), simulating random dice rolls, and calculating totals with modifiers. Returns individual roll results, statistics, and theoretical probability ranges.
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 "https://api.apiverve.com/v1/diceroller?dice=3d6&modifier=5" \
-H "x-api-key: your_api_key_here"const res = await fetch('https://api.apiverve.com/v1/diceroller?dice=3d6&modifier=5', {
headers: { 'x-api-key': 'your_api_key_here' },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const { data } = await res.json();
console.log(data);import requests
res = requests.get(
"https://api.apiverve.com/v1/diceroller?dice=3d6&modifier=5",
headers={"x-api-key": "your_api_key_here"},
timeout=15,
)
res.raise_for_status()
print(res.json()["data"])package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/diceroller?dice=3d6&modifier=5", nil)
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 in the query string. Premium parameters are accepted on every plan but only take effect on plans that include them.
| Parameter | Type | Description |
|---|---|---|
diceOptional | string | Dice notation in XdY format (e.g., 3d6, 2d20, default: 1d6) default 1d6 |
modifierOptional | integer | Modifier to add to the total (can be negative) |
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": {
"dice_notation": "3d6",
"num_dice": 3,
"num_sides": 6,
"modifier": 5,
"rolls": [
6,
4,
4
],
"total": 14,
"total_with_modifier": 19,
"min_roll": 4,
"max_roll": 6,
"average_roll": 4.67,
"theoretical_min": 3,
"theoretical_max": 18,
"theoretical_average": 10.5,
"expression": "3d6+5"
}
}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 |
|---|---|---|---|
dice_notation | string | "3d6" | The dice notation used for this roll request |
num_dice | number | 3 | Total count of individual dice rolled |
num_sides | number | 6 | Number of sides on each die rolled |
modifier | number | 5 | Modifier value added to final total |
rolls | array | [6, ...] | Array containing individual result values for each die |
total | number | 14 | Sum of all dice rolls before modifier applied |
total_with_modifierPremium | number | 19 | Final total after applying the modifier value |
min_rollPremium | number | 4 | Lowest individual die value in this roll |
max_rollPremium | number | 6 | Highest individual die value in this roll |
average_rollPremium | number | 4.67 | Calculated mean value of all individual rolls |
theoretical_minPremium | number | 3 | Lowest possible sum without any modifiers applied |
theoretical_maxPremium | number | 18 | Highest possible sum without any modifiers applied |
theoretical_averagePremium | number | 10.5 | Expected mean value based on probability distribution |
expression | string | "3d6+5" | Complete expression including dice notation and modifier |
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
- RPG Gaming
- Roll dice for tabletop RPGs, D&D sessions, and role-playing game mechanics
- Game Development
- Implement dice rolling mechanics in digital games and gaming applications
- Probability
- Demonstrate probability concepts and dice statistics for educational purposes
- Simulations
- Generate random numbers with dice distributions for simulations and testing
Other ways to use Dice Roller
Set up Dice Roller 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 Games: