Dice RollerDice Roller API

OnlineCredit Usage:1 per callRefreshed 1 month ago
avg: 119ms|p50: 115ms|p75: 122ms|p90: 130ms|p99: 148ms

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

URL
https://api.apiverve.com/v1/diceroller

Example

How to call the Dice Roller API in different programming languages.

cURL Request
curl -X GET \
  "https://api.apiverve.com/v1/diceroller?dice=3d6&modifier=5" \
  -H "X-API-Key: your_api_key_here"
JavaScript (Fetch API)
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);
Python (Requests)
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)
Go (net/http)
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))
}
Example 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"
  }
}

Authentication

The Dice Roller API requires authentication via API key. Include your API key in the request header:

Required Header
X-API-Key: your_api_key_here

Learn more about authentication →

Interactive 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

ParameterTypeRequiredDescriptionDefaultExample
dicestringoptional
Dice notation in XdY format (e.g., 3d6, 2d20, default: 1d6)
1d63d6
modifierintegeroptional
Modifier to add to the total (can be negative)
-5

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 Response
200 OK
<?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>
YAML Response
200 OK
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
CSV Response
200 OK
keyvalue
dice_notation3d6
num_dice3
num_sides6
modifier5
rolls[6,4,4]
total14
total_with_modifier19
min_roll4
max_roll6
average_roll4.67
theoretical_min3
theoretical_max18
theoretical_average10.5
expression3d6+5

Response Structure

All API responses follow a consistent structure with the following fields:

FieldTypeDescriptionExample
statusstringIndicates whether the request was successful ("ok") or failed ("error")ok
errorstring | nullContains error message if status is "error", otherwise nullnull
dataobject | nullContains 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:

Response fields marked with Premium are available exclusively on paid plans.View pricing
FieldTypeSample ValueDescription
dice_notationstring"3d6"
The dice notation used for this roll request
num_dicenumber3
Total count of individual dice rolled
num_sidesnumber6
Number of sides on each die rolled
modifiernumber5
Modifier value added to final total
rollsarray[6, ...]
Array containing individual result values for each die
totalnumber14
Sum of all dice rolls before modifier applied
total_with_modifierPremiumnumber19
Final total after applying the modifier value
min_rollPremiumnumber4
Lowest individual die value in this roll
max_rollPremiumnumber6
Highest individual die value in this roll
average_rollPremiumnumber4.67
Calculated mean value of all individual rolls
theoretical_minPremiumnumber3
Lowest possible sum without any modifiers applied
theoretical_maxPremiumnumber18
Highest possible sum without any modifiers applied
theoretical_averagePremiumnumber10.5
Expected mean value based on probability distribution
expressionstring"3d6+5"
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.

Test Dice Roller in the GraphQL Explorer to confirm availability and experiment with queries.

Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.

GraphQL Endpoint
POST https://api.apiverve.com/v1/graphql
GraphQL Query Example
query {
  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?
Sign up for a free account at dashboard.apiverve.com. Your API key will be automatically generated and available in your dashboard. The same key works for Dice Roller and all other APIVerve APIs. The free plan includes 1,000 credits plus a 500 credit bonus.
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?
Yes! The Dice Roller API supports CORS with wildcard configuration, so you can call it directly from browser-based JavaScript without needing a proxy server. See the CORS section above for details.
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.

What's Next?

Continue your journey with these recommended resources

Was this page helpful?