Coin Flipper API
Overview
To use Coin Flipper, 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/coinflipperExample
How to call the Coin Flipper API in different programming languages.
curl -X GET \
"https://api.apiverve.com/v1/coinflipper?flips=10" \
-H "X-API-Key: your_api_key_here"const response = await fetch('https://api.apiverve.com/v1/coinflipper?flips=10', {
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/coinflipper?flips=10', 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/coinflipper?flips=10", 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": {
"total_flips": 10,
"flips": [
"Tails",
"Heads",
"Heads",
"Tails",
"Tails",
"Heads",
"Tails",
"Tails",
"Tails",
"Tails"
],
"heads_count": 3,
"tails_count": 7,
"heads_percentage": 30,
"tails_percentage": 70,
"longest_streak": {
"length": 4,
"type": "Tails"
},
"first_flip": "Tails",
"last_flip": "Tails",
"is_fair": false
}
}Authentication
The Coin Flipper 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 Coin Flipper API directly in your browser with live requests and responses.
Parameters
The following parameters are available for the Coin Flipper API:
Flip Coins
| Parameter | Type | Required | Description | Default | Example |
|---|---|---|---|---|---|
flipsPremium | integer | optional | Number of coins to flip Range: 1 - 10000 |
Response
The Coin Flipper 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>
<total_flips>10</total_flips>
<flips>
<flip>Tails</flip>
<flip>Heads</flip>
<flip>Heads</flip>
<flip>Tails</flip>
<flip>Tails</flip>
<flip>Heads</flip>
<flip>Tails</flip>
<flip>Tails</flip>
<flip>Tails</flip>
<flip>Tails</flip>
</flips>
<heads_count>3</heads_count>
<tails_count>7</tails_count>
<heads_percentage>30</heads_percentage>
<tails_percentage>70</tails_percentage>
<longest_streak>
<length>4</length>
<type>Tails</type>
</longest_streak>
<first_flip>Tails</first_flip>
<last_flip>Tails</last_flip>
<is_fair>false</is_fair>
</data>
</response>
status: ok
error: null
data:
total_flips: 10
flips:
- Tails
- Heads
- Heads
- Tails
- Tails
- Heads
- Tails
- Tails
- Tails
- Tails
heads_count: 3
tails_count: 7
heads_percentage: 30
tails_percentage: 70
longest_streak:
length: 4
type: Tails
first_flip: Tails
last_flip: Tails
is_fair: false
| key | value |
|---|---|
| total_flips | 10 |
| flips | [Tails,Heads,Heads,Tails,Tails,Heads,Tails,Tails,Tails,Tails] |
| heads_count | 3 |
| tails_count | 7 |
| heads_percentage | 30 |
| tails_percentage | 70 |
| longest_streak | {length:4,type:Tails} |
| first_flip | Tails |
| last_flip | Tails |
| is_fair | false |
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 |
|---|---|---|---|
total_flips | number | Total number of coin flips performed in simulation | |
flips | array | Array of individual flip results as Heads or Tails | |
heads_count | number | Total count of heads outcomes from all flips | |
tails_count | number | Total count of tails outcomes from all flips | |
heads_percentagePremium | number | Percentage of heads outcomes as decimal | |
tails_percentagePremium | number | Percentage of tails outcomes as decimal | |
longest_streak | object | - | |
â”” lengthPremium | number | Length of longest consecutive streak in results | |
â”” typePremium | string | Outcome type of longest streak (Heads or Tails) | |
first_flip | string | Result of the first coin flip performed | |
last_flip | string | Result of the last coin flip performed | |
is_fairPremium | boolean | Statistical indicator of fair coin flip distribution |
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 Coin Flipper through GraphQL to combine it with other API calls in a single request. Query only the coin flipper 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 {
coinflipper(
input: {
flips: 10
}
) {
total_flips
flips
heads_count
tails_count
heads_percentage
tails_percentage
longest_streak {
length
type
}
first_flip
last_flip
is_fair
}
}Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.
CORS Support
The Coin Flipper 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
Coin Flipper 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 Coin Flipper 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 Coin Flipper
Official Coin Flipper packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →
No-Code Integrations
Coin Flipper 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 Coin Flipper?
How many credits does Coin Flipper cost?
Each successful Coin Flipper 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 coin flipper lookups.
Can I use Coin Flipper in production?
The free plan is for testing and development only. For production use of Coin Flipper, 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 Coin Flipper from a browser?
What happens if I exceed my Coin Flipper credit limit?
When you reach your monthly credit limit, Coin Flipper 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.








