bet-api-types

Simple type definitions for the Quikcess Bet API.

Installation

npm install @quikcess/bet-api-types
// or
yarn add @quikcess/bet-api-types
// or
pnpm add @quikcess/bet-api-types

Getting Started

Using these type definitions is simple. You just need to specify the appropriate version of the API by appending /v* to the import path, where * represents your desired API version. Here are some usage examples:

// Importing the API definitions for version 1
import { APIBet, BetStatus } from 'bet-api-types/v1';

You can also import only the specific parts of the module that you need. Here are some examples:

// Importing specific types for bets and scams in version 1
import { APIBet, APIScam } from 'bet-api-types/v1';

Note: The v* exports (bet-api-types/v*) include the relevant version of types for bet, blacklist, scam, credential, and status, along with utilities and helpers.

Project Structure

he exported types for each API version are organized into two main categories:

Types with an API prefix represent payloads you may receive from the REST API. Types with a REST prefix represent data that is sent to and received from the REST API. For endpoint options in the REST category, they follow a specific structure: REST<HTTP Method><Action><Type>, where the type indicates the expected return data. For example, RESTPostAPIBetCreateBody or RESTGetAPICredentialResponse.

If a type name ends with Response, it represents the expected result when calling its corresponding route. In this structure, the REST types are used to define the data sent in requests (e.g., creating a bet ), while the API types represent the data received in responses from the API (e.g., the details of a bet). This makes the distinction clear between what is transmitted to the API and what is returned after a request is made.