Match
A Match is a time-bound, gameplay session tied to a specific Field, during which events are tracked, points are awarded, and fan interactions occur. It represents a game instance—such as a football match, chess round, or tournament heat—scheduled via the Calendar
object and hosted on a defined Field
.
Examples:
PSG vs. Manchester City
Green Bay Packers vs Chicago Bears
Magnus Carlsen vs Hikaru Nakamura
new_match
POST
https://api.bws.ninja/v1/call
Request Body
solution*
string
BWS.NFT.GameCube
operation*
string
new_match
parameters*
JSON
check method parameters
new_match Method Parameters
calendarId*
string
Calendar Id the match should be included in.
startTimeInMillis*
number
The expected match start time in milliseconds.
name
string
The match short name.
description
string
Match description.
image
string
An image base64 encoded string to announce the match.
team1Name
string
The team name (e.g. Manchester City)
team1Flag
string
An image base64 ecoded string representing the team flag.
team2Name
string
The team name (e.g. LA Lakers)
team2Flag
string
An image base64 ecoded string representing the team flag.
status
string
The match status. Use one of the following values: "scheduled", "playing", "finished", "canceled".
priceInCents
number
The default price in USD cents for all the cubes if no specific price is defined for a cube (e.g. 1000 for 10 USD).
new_match API Call Example
new_match Call Response
When the API call is successfully executed, it returns thematchId
for the newly created match.
update_match
POST
https://api.bws.ninja/v1/call
Request Body
solution*
string
BWS.NFT.GameCube
operation*
string
update_match
parameters*
JSON
check method parameters
update_match Method Parameters
calendarId*
string
Calendar Id the match is included in.
matchId*
string
The Match Id we want to update.
startTimeInMillis
number
The expected match start time in milliseconds.
name
string
The match short name.
description
string
Match description.
image
string
An image base64 encoded string to announce the match.
team1Name
string
The team name (e.g. Manchester City)
team1Flag
string
An image base64 ecoded string representing the team flag.
team2Name
string
The team name (e.g. LA Lakers)
team2Flag
string
An image base64 ecoded string representing the team flag.
status
string
The match status. Use one of the following values: "scheduled", "playing", "finished", "canceled"
priceInCents
number
The price in USD cents (e.g. 1000 for 10 USD)
update_match API Call Example
update_match Call Response
When the API call is successfully executed, it returns thematchId
for the updated match.
list_matches
POST
https://api.bws.ninja/v1/call
Request Body
solution*
string
BWS.NFT.GameCube
operation*
string
list_matches
parameters
JSON
check method parameters
list_matches Method Parameters (optional)
calendar_id
string
The Calendar Id the match is linked to.
matchId
string
(optional) The Match Id we want to list.
list_matches API Call Example
list_matches Call Response
When the API call is successfully executed, it returns the matches for the provided calendar. If we give a Match Id, it will just return the match we want to list.
delete_match
POST
https://api.bws.ninja/v1/call
Request Body
solution*
string
BWS.NFT.GameCube
operation*
string
delete_calendar
parameters*
JSON
check method parameters
delete_match Method Parameters
matchId
string
The Match Id of the match we want to delete.
calendarId
string
The Calendar Id the match is linked to.
delete_match API Call Example
delete_match Call Response
When the API call is executed without errors, it returns a successful status code.
Last updated
Was this helpful?