The user's Apple ID(s) used for authentication and any other uniquely identifying credentials.

The user's Discord ID(s) used for authentication and any other uniquely identifying credentials.

The user's email address(es) used for authentication.

The user's Epic Games ID(s) used for authentication and any other uniquely identifying credentials.

The user's ERC-20 wallet address(es) used for authentication.

The user's Facebook ID(s) used for authentication and any other uniquely identifying credentials.

The user's Google ID(s) used for authentication and any other uniquely identifying credentials.

The user's phone number(s) used for authentication. Format will follow symbol-stripped international numbering.

The user's Steam ID(s) used for authentication and any other uniquely identifying credentials.

All of the in-game IDs associated with the request body's 'apple' array.

All of the in-game IDs associated with the request body's 'discord' array.

All of the in-game IDs associated with the request body's 'email' array.

All of the in-game IDs associated with the request body's 'epic' array.

All of the in-game IDs associated with the request body's 'erc20Address' array.

All of the in-game IDs associated with the request body's 'facebook' array.

All of the in-game IDs associated with the request body's 'google' array.

All of the in-game IDs associated with the request body's 'phone' array.

All of the in-game IDs associated with the request body's 'steam' array.

If your callback requires authentication, you can provide the API key for BluMint to use and how that API key is specified in the request to the callback endpoint.

The key to put the actual API-key under (i.e. the header name, the query parameter key name or the JSON body key).

Location of the API key (header, queryParam, or body).

Optional prefix to be added before the API key value.

Optional suffix to be added after the API key value.

A date range with optional start and end values. The range can be bounded or unbounded on either end, depending on whether the start and/or end values are provided.

The end of the date range (exclusive). If not provided, the range will be unbounded on this end, and all tournaments from the start value onwards will be included in the results.

The start of the date range (inclusive). If not provided, the range will be unbounded on this end, and all tournaments up to the end value will be included in the results.

The current time in milliseconds since the Unix epoch

A number range with optional minimum and maximum values. The range can be bounded or unbounded on either end, depending on whether the minimum and/or maximum values are provided.

The maximum value of the number range (exclusive). If not provided, the range will be unbounded on this end, and all values from the minimum onwards will be included in the results.

The minimum value of the number range (inclusive). If not provided, the range will be unbounded on this end, and all values up to the maximum will be included in the results.

The player's in-game ID, which is specific and unique to each game.

The player's additional stats, which are also specific and unique to each game.

The player's participation status in the match. 'absent' if the player is not in the match. 'present-not-ready' if the player is in the lobby but has not yet ready-up'ed for match. 'present-ready' if the player is actively playing in the match or is in the lobby and ready for the match to start.

The team's score in the match. If a boolean is used, true represents a win and false represents a loss. A higher score is better and determines the winner of the match.

kebab-case title of the tournament's parent game

X-Api-Key

Welcome to the BluMint API Reference! Below you will find detailed documentation on each of our available endpoints. <br/><br/> If you are a game partner looking to integrate onto the BluMint platform, please see our <a href="/docs/game-guide" target="_blank">Game Integration Guide</a>. <br/><br/>If you have any questions or would like to request an API key, do not hesitate to <a href="/contact" target="_blank">contact us</a>.

Apache 2.0

BluMint API

Send Coinflow BuyerChallengeEvent for nSure fraud model training

Events sent, or skipped when no client IP is determinable

Send Coinflow SignUpEvent (once) + SignInEvent for nSure fraud model training

Fetch per-method withdrawal fee quote from Coinflow

Invalid email or message, or undeterminable client IP

Submit a contact-us message, relayed to the team Slack channel

Triggers a revalidation of the specified page path. Requires a secret token for authorization.

The secret token for authorizing the revalidation request.

secret

The URL path to revalidate (e.g., /my-page/slug). Should be encoded.

path

Page revalidation initiated successfully.

Internal server error during revalidation.

Missing url, or url does not match the deployment's exact protocol + host

Persist a short-link mapping for a BluMint URL and return the short URL

Inspects the request User-Agent and 302-redirects to the matching native store (iOS App Store / Google Play), the interim install page when a platform has no listing, or the web app for desktop / unknown clients. Uncacheable and `Vary`-ed on User-Agent so a shared cache never pins one platform's redirect for another. Encoded by the install QR / button.


Redirect to the resolved store / web destination.

Smart app-store redirect for QR / "get the app" links.

This endpoint accepts a jobId and an imageUint8Array, saves the image to a bucket, and updates the TemplateJob document with the image URL.

Submit a filled-in Figma template graphic

This endpoint returns an array of TemplateJob documents with resultUrl field of value null.

This endpoint returns the current time in milliseconds since the Unix epoch.

This operation receives the createMatchUrl. The createMatchUrl should be a POST endpoint in your game server to handle match creation requests from BluMint. This endpoint should accept all the parameters defined in the 'matchCreation' callback. Upon successful match creation, your endpoint should return a response as defined in the 'matchCreation' callback. If a game has already set its createMatchUrl previously, it will be replaced.

Successfully set the match creation callback URL.

Bad request. The request was unacceptable, often due to missing a required parameter.

Not Found - The game associated with the given API key does not exist in our database.

Internal Server Error. Something went wrong on BluMint's end.

This operation receives the retrieveMatchStatusUrl. The retrieveMatchStatusUrl should be a POST endpoint in your game server to handle match status requests from BluMint. This endpoint should accept all the parameters defined in the 'matchStatus' callback. Upon success, your endpoint should return a response as defined in the 'matchStatus' callback.

Successfully set the match status callback URL.

Sets a callback URL for retrieving match status.

This endpoint accepts the results of a game match or a request to restart the match, intended to facilitate the automation of tournament progression within BluMint's system. It requires either information about the match and the teams involved with specific scores for each team and optional individual player statistics, or a flag to indicate the match must be restarted.


Successfully received match results for a tied match. Created a tiebreaker match.

Not Found. The match with the provided ID was not found in the database.

Conflict. The match with the provided ID has already been updated.

Restart or submits the result for a match.

Returns a list of tournaments (see the Schema Tournament entry).
This endpoint supports cursor-based pagination, allows filtering based on multiple criteria,
and supports sorting as well.

There are several filter query parameters named after the tournament field they correspond to.
If a filter field ends in the 'Range' suffix, then it can be filtered to belong within a min and max range of values.
See the Schema DateRange and NumberRange entries.
If a filter field doesn't end in the 'Range' suffix, then it accepts an array of values.
If a tournament has the same corresponding field value as any of the array values, it will be included in the response.
For example, the query parameter gameId with values raini-the-lords-of-light and mokens-league will return
all tournaments with gameId equal to either 'raini-the-lords-of-light' or 'mokens-league'.

Tournament results can be sorted by one of the field values listed under the available values of the sort query parameter.
The order (ascending or descending) of the sorted results is specified by the order query parameter.

Pagination can be controlled by the cursor and perPage query parameters.
The response will include the following information about the returned pagination:
the 'cursor', which is the last tournament id in the current results.


sort

The order of sorting (ascending or descending).

order

the tournament id after which this query should start.

cursor

perPage

gameId

title

dateRange

endDateRange

sponsorName

type

competitorCountRange

region

bracketType

maxTeamCountRange

phase

checkInTimeRange

readyTimeRange

A list of Tournament objects is successfully returned. The response contains the requested tournaments, their details, and pagination information.

Method Not Allowed - Only GET method is allowed for this endpoint.

This operation receives the lookupPlayerUrl. The lookupPlayerUrl should be a POST endpoint in your game server to lookup the in-game player ID(s) of a BluMint user given an object literal map of authentication providers (sign-in methods) to authentication provider IDs. The endpoint should accept all the parameters defined in the 'lookupPlayer' callback. If a game has already set its lookupPlayerUrl previously, it will be replaced.

Successfully set the player lookup callback URL.

Internal Server Error. Something went wrong on our end.

Sets a callback URL for looking up in-game player IDs.

Server-side proxy to the Twitch Helix `GET /helix/streams` endpoint (authenticated with an app access token). Returns live status, viewer count, and the preview thumbnail for each requested username. Channels absent from Helix's response are reported offline. Keeps the Twitch client secret server-side.


Comma-separated Twitch usernames to resolve

usernames

Resolve current Twitch stream state for one or more channels