Hypetech logo
API docs by Redocly

Hypetech Games - API (1.0.0)

Download OpenAPI specification:Download

Hypetech Support: [email protected] URL: https://hypetech.games License: Apache 2.0

Introduction to the Hypetech Developer API. This API is designed so that our partners can access our games and more.

About Hypetech API

The Hypetech API seeks to respect the terminology Provably Fair. In this sense, our games have a high degree of reliability.

Following the defined standards, our system has the following characteristics:

  • Fair play
  • Accountability
  • Guaranteed anti-cheating
  • Instant payouts
  • Open platform

To get access to the games provided by Hypetech please contact the support team via the email address provided in the header.

Error handling

The Hypetech API returns HTTP status codes to indicate success or failure of requests. 2xx codes indicate success. 4xx codes indicate failures caused by the information sent by the player or the current state of the entities. 5xx codes indicate service problems on the Hypetech API side. Error responses include in the body details of the error following the RFC 7807 schema. The primary purpose is only to identify the type of error.

Below are listed the error types and possible violations of the Hypetech API.

Error Types

This section gathers errors that could be returned by any endpoints listed in the Hypetech API.

Bad Request

Forbiden

  • Meaning: Authenticated participant request that violates some authorization rule.
  • HTTP Status Code: 403 Forbidden.

Not Found

Gone

  • Meaning: Indicates that the entity existed but has been permanently removed.
  • HTTP Status Code: 410 Gone.

Internal Server Error

Service Unavailable

  • Meaning: Service is currently unavailable. Requested service may be under maintenance or out of the operating window.
  • HTTP Status Code: 503 Service Unavailable.

Gateway Timeout

  • Meaning: Indicates that the service took longer than expected to return.
  • HTTP Status Code: 504 Gateway Timeout.

Setting up Webhooks

This section contains information on how to set up webhooks on the client side. These endpoints will provide the necessary information for integration with the Hypetech API, through user balance inquiry, bet registration and confirmation of withdrawals in the games.

Bet Placing Webhook

Endpoint triggered when a user registers a bet during a game match.

https://yourdomain.com/webhooks/hypetech/register

Request Body schema: application/json
user_id
string

ID of the user placing the bet (same ID stored on the client platform).

currency
string

Currency used on transaction.

amount
double

Amount that will be wagered by the user.

provider
string

Reference to the platform on which the bet is being made.

provider_tx_id
string

Transaction ID generated by the user.

game
string

Name of the game that the bet is being made.

action
string

Indicates the action that generated the transaction.

action_id
string

ID of the round that the bet was made.

session_token
string

User session token generated by Hypetech API.

platform
string

Platform where the bet was placed.

Responses

Request samples

Content type
application/json
{
  • "user_id": "26",
  • "currency": "USD",
  • "amount": 200,
  • "provider": "hypetech_rocket",
  • "provider_tx_id": "559",
  • "game": "rocket",
  • "action": "bet",
  • "action_id": "255",
  • "session_token": "b72afc9470d1899d9a993d378733cfea",
  • "platform": "desktop"
}

Response samples

Content type
application/json
{
  • "operator_tx_id": "559",
  • "new_balance": "2050.00",
  • "old_balance": "2300.00",
  • "user_id": "13",
  • "currency": "BRL",
  • "provider": "hypetech_rocket",
  • "provider_tx_id": "559"
}

Register Earnings Webhook

This endpoint is triggered whenever the user wins a bet.

https://yourdomain.com/webhooks/hypetech/rewards

Request Body schema: application/json
user_id
string

ID of the user who places the bet (same ID stored on the client platform).

currency
string

Currency used on transaction.

amount
double

Amount that will be received by the user.

provider
string

Reference to the platform on which the bet is being placed.

provider_tx_id
string

ID of the transaction generated by the user.

game
string

Name of the game that the bet was made.

action
string

Indicates the action that generated the transaction.

action_id
string

ID of the round that the bet was made.

session_token
string

User session token generated by the Hypetech API.

Responses

Request samples

Content type
application/json
{
  • "user_id": "26",
  • "currency": "USD",
  • "amount": 200,
  • "provider": "hypetech_rocket",
  • "provider_tx_id": "600",
  • "game": "rocket",
  • "action": "bet",
  • "action_id": "177",
  • "session_token": "b72afc9470d1899idea993d378733cfa"
}

Response samples

Content type
application/json
{
  • "operator_tx_id": "559",
  • "new_balance": "2300.00",
  • "old_balance": "2100.00",
  • "user_id": "13",
  • "currency": "BRL",
  • "provider": "hypetech_rocket",
  • "provider_tx_id": "559"
}

Register Losses (optional) Webhook

This endpoint is triggered whenever the user loses a bet. By default, it is fundamentally not necessary to use it, since you will only need bets and wins.

https://yourdomain.com/webhooks/hypetech/loses

Request Body schema: application/json
user_id
string

ID of the user who places the bet (same ID stored on the client platform).

currency
string

Currency used on transaction.

amount
double

Amount that will be lose by the user.

provider
string

Reference to the platform on which the bet is being placed.

provider_tx_id
string

ID of the transaction generated by the user.

game
string

Name of the game that the bet was made.

action
string

Indicates the action that generated the transaction.

action_id
string

ID of the round that the bet was made.

session_token
string

User session token generated by the Hypetech API.

Responses

Request samples

Content type
application/json
{
  • "user_id": "26",
  • "currency": "BRL",
  • "amount": 200,
  • "provider": "hypetech_rocket",
  • "provider_tx_id": "559",
  • "game": "rocket",
  • "action": "bet",
  • "action_id": "255",
  • "session_token": "b72afc9470d1899d9a993d378733cfea"
}

Response samples

Content type
application/json
{
  • "operator_tx_id": "559",
  • "new_balance": "2100.00",
  • "old_balance": "2300.00",
  • "user_id": "13",
  • "currency": "BRL",
  • "provider": "hypetech_rocket",
  • "provider_tx_id": "559"
}

Revert Bet Webhook

Endpoint triggered when there are cancellations of user bets on the Hypetech API.

https://yourdomain.com/webhooks/hypetech/rollback

Request Body schema: application/json
user_id
string

User ID.

amount
double

Amount that will be removed/allocated.

provider
string

Reference to the platform on which the bet is being placed.

currency
string

Currency used on transaction.

provider_tx_id
string

Rollback Transaction ID.

rollback_provider_tx_id
string

Transaction ID to be rolledback.

game
string

Name of the game the bet is being placed on.

action_id
string

ID of the round where the bet was placed.

session_token
string

User session token generated by the Hypetech API.

Responses

Request samples

Content type
application/json
{
  • "user_id": "26",
  • "amount": 200,
  • "provider": "hypetech_rocket",
  • "currency": "BRL",
  • "provider_tx_id": "559",
  • "rollback_provider_tx_id": "651",
  • "game": "rocket",
  • "action_id": "255",
  • "session_token": "b72afc9470d1899d9a993d378733cfea"
}

Response samples

Content type
application/json
{
  • "user_id": "26",
  • "operator_tx_id": "193",
  • "provider": "hypetech_rocket",
  • "provider_tx_id": "559",
  • "currency": "BRL",
  • "old_balance": "2500.00",
  • "new_balance": "1950.00"
}

Accessing the Games

This endpoint is responsible for receiving data related to the client platform user and the game that will be displayed. To get access to a specific game, contact the support team at the email specified in the document header, if everything goes well they will inform the 'game_token' to allow access to the game on the platform.

Get Game URL

This endpoint returns a URL that allows a user of the customer platform to place bets. Each URL is unique and contains user session information; they expire as soon as the user logs in for the first time to ensure their security.

Before using this endpoint, make sure that all hooks related to balance checking and betting are configured correctly.

Authorizations:
accessToken
Request Body schema: application/json
game
string

Specifies the game instance that will be returned to the user

user_id
string

Specifies the user id on the client platform. This parameter will be used to check balance, withdrawal and confirm bet results using webhooks.

lang
string

Parameter that defines the language in the game interface.

balance
double

Current user balance on the platform.

currency
string

Specifies the currency that will be used during bets.

username
string

The username is used when placing a bet on the games side panel

avatar_url
string

The avatar/image of the user, like the name, has a purely visual function, it will be shown in the side panel, and if it is not informed, the initials of the user's name will be used.

Responses

Request samples

Content type
application/json
{
  • "game": "rocket",
  • "user_id": "99e27bf0-35da-46e2-a82d-07c492d1ed25",
  • "lang": "pt",
  • "balance": "20.00",
  • "currency": "USD",
  • "username": "Jhon Doe",
  • "avatar_url": "https://gravatar.com/avatar/example"
}

Response samples

Content type
application/json
{}