Dice Roller API
Overview
To use Dice Roller, 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/dicerollerExample
How to call the Dice Roller API in different programming languages.
curl -X GET \
"https://api.apiverve.com/v1/diceroller?dice=3d6&modifier=5" \
-H "X-API-Key: your_api_key_here"const response = await fetch('https://api.apiverve.com/v1/diceroller?dice=3d6&modifier=5', {
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/diceroller?dice=3d6&modifier=5', 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/diceroller?dice=3d6&modifier=5", 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": {
"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"
}
}Authentication
The Dice Roller 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 Dice Roller API directly in your browser with live requests and responses.
Parameters
The following parameters are available for the Dice Roller API:
Roll Dice
| Parameter | Type | Required | Description | Default | Example |
|---|---|---|---|---|---|
dice | string | optional | Dice notation in XdY format (e.g., 3d6, 2d20, default: 1d6) | ||
modifier | integer | optional | Modifier to add to the total (can be negative) | - |
Response
The Dice Roller 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>
<dice_notation>3d6</dice_notation>
<num_dice>3</num_dice>
<num_sides>6</num_sides>
<modifier>5</modifier>
<rolls>
<roll>6</roll>
<roll>4</roll>
<roll>4</roll>
</rolls>
<total>14</total>
<total_with_modifier>19</total_with_modifier>
<min_roll>4</min_roll>
<max_roll>6</max_roll>
<average_roll>4.67</average_roll>
<theoretical_min>3</theoretical_min>
<theoretical_max>18</theoretical_max>
<theoretical_average>10.5</theoretical_average>
<expression>3d6+5</expression>
</data>
</response>
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
| key | value |
|---|---|
| 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 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 |
|---|---|---|---|
dice_notation | string | The dice notation used for this roll request | |
num_dice | number | Total count of individual dice rolled | |
num_sides | number | Number of sides on each die rolled | |
modifier | number | Modifier value added to final total | |
rolls | array | Array containing individual result values for each die | |
total | number | Sum of all dice rolls before modifier applied | |
total_with_modifierPremium | number | Final total after applying the modifier value | |
min_rollPremium | number | Lowest individual die value in this roll | |
max_rollPremium | number | Highest individual die value in this roll | |
average_rollPremium | number | Calculated mean value of all individual rolls | |
theoretical_minPremium | number | Lowest possible sum without any modifiers applied | |
theoretical_maxPremium | number | Highest possible sum without any modifiers applied | |
theoretical_averagePremium | number | Expected mean value based on probability distribution | |
expression | string | Complete expression including dice notation and modifier |
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 Dice Roller through GraphQL to combine it with other API calls in a single request. Query only the dice roller 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 {
diceroller(
input: {
dice: "3d6"
modifier: 5
}
) {
dice_notation
num_dice
num_sides
modifier
rolls
total
total_with_modifier
min_roll
max_roll
average_roll
theoretical_min
theoretical_max
theoretical_average
expression
}
}Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.
CORS Support
The Dice Roller 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
Dice Roller 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 Dice Roller 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 Dice Roller
Official Dice Roller packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →
No-Code Integrations
Dice Roller 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 Dice Roller?
How many credits does Dice Roller cost?
Each successful Dice Roller 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 dice roller lookups.
Can I use Dice Roller in production?
The free plan is for testing and development only. For production use of Dice Roller, 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 Dice Roller from a browser?
What happens if I exceed my Dice Roller credit limit?
When you reach your monthly credit limit, Dice Roller 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.








