BWS API Docs
Contact UsCreate AccountSign In
  • Welcome!
    • Developer Grants
  • Quick Start
  • Platform Fees
    • Fees Calculator
  • API How Tos
    • API Endpoint
    • Authentication
      • Get your API Key
    • Main API Methods
      • 'call' API Method
      • 'fetch' API Method
    • API Responses
      • Error Status Codes
  • Certificate Of Trust
  • Media Assets
    • BWS Logo
    • Snapshots
      • BWS.IPFS.Upload
  • PLATFORM APIs
    • BWS.IPFS.Upload
      • Solution Overview
      • Operations
    • BWS.Blockchain.Save
      • Solution Overview
      • Operations
    • BWS.Blockchain.Hash
      • Solution Overview
      • Operations
    • BWS.NFT.zK
      • Solution Overview
        • NFT Ownership
        • NFT Data Location
        • Available Networks
      • Operations
        • Create NFT
        • List NFTs
        • Transfer NFT
        • Send NFT by Email
      • NFT Attributes (traits)
  • Marketplace Solutions
    • BWS.Blockchain.Badges
      • Badges User Interface
      • Badges API
        • Issuers
        • Badges
        • Awards (Credentials)
    • BWS.NFT.GameCube
      • NFT Game Overview
      • NFT Game Cube API
        • Calendar
        • Field
        • Cubes
        • Plays (Field-Calendar)
        • Match
        • Prizes
        • Event Types
        • Live Events
    • BWS.ESG.Credits
      • Solution Overview
      • ESG Credits API
        • Taxonomy
        • Translations
        • Currencies
        • Frameworks
        • Projects
        • Issuers
        • Assets
        • Investors
        • Positions
        • Portfolios
        • Impacts
        • Blockchain
        • Users
  • TELEGRAM BOTS
    • X BOT
      • Install
        • BYOK (X API Token)
      • How does it work?
      • Commands
Powered by GitBook
On this page
  • new_event
  • Request Body
  • new_event API Call Example

Was this helpful?

  1. Marketplace Solutions
  2. BWS.NFT.GameCube
  3. NFT Game Cube API

Live Events

LiveEvent is the base API object used to record an in-match event that occurs at a specific coordinate (x, y) on a Field during a scheduled Match (Calendar). It is the primary mechanism by which game data—such as goals, moves, fouls, or plays—is captured and mapped to corresponding Cubes for scoring and reward processing.

This API serves as a trusted interface to power fan engagement:

  • Manually via the organizer dashboard or solution UI (BWS Solution Interface)

  • Automatically via BWS-provided machine learning models that detect and push game events in real time (e.g., AI-driven goal recognition, chess move capture)

  • Through your application.

new_event

POST https://api.bws.ninja/v1/call

Request Body

Name
Type
Description

solution*

string

BWS.NFT.GameCube

operation*

string

new_event

parameters*

JSON

check method parameters

new_event Method Parameters

Parameter
Type
Desciption

matchId

string

The Match Id for which you want to register the event.

fieldId

string

The Field Id the match is linked to.

calendarId

string

The calendar Id the match is linked to.

event

JSON

check event parameter

new_event Event Parameter

Parameter
Type
Desciption

coordinates

JSON

check coordinates parameter

eventTypeId

string

The Event Type Id of the event you want to register.

new_event Coordinates Parameter

Parameter
Type
Desciption

x

string

The 2D x coordinate of the event.

y

string

The 2D y coordinate of the event.

new_event API Call Example

const axios = require('axios');

/* build request to use BWS Badges solution */
const request = {
{
  "solution": "BWS.NFT.GameCube",
  "operation": "new_event",
  "parameters":  {
      "matchId": "e16d3f98-4eeb-44b9-837c-eddbbfe305ee",
      "fieldId": "5a1486f3-753c-4194-b2d4-ea68b6e420c2",
      "calendarId": "8a7324f4-311d-43a8-a28f-87d9c424c354",
      "event":  {
        "coordinates": {
          "x": "45",
          "y": "40"
        },
      "eventTypdId": "34339c99-43cf-4fe9-b632-4f8606e3c1bc"
      }
  }
}

/* call BWS API using Axios */
let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.bws.ninja/v1/call',
  headers: { 
    'X-Api-Key': 'XqaLg...... A5k2V729v', /* use your API key here! */
    'Content-Type': 'application/json'
  },
  data : JSON.stringify(request)
};

axios.request(config)
  .then((response) => {
    console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
    console.log(error);
  });

new_event Call Response

When the API call is executed without errors, it returns a successful status code.

{
  "statusCode": 200
}

PreviousEvent TypesNextBWS.ESG.Credits

Last updated 1 month ago

Was this helpful?