BOTFIGHTS.ai

dox

intro · auth · errors · endpoints · schemas

introduction

Welcome to the botfights documentation! With the exception of registration, all interactions with botfights happen over the REST-ish API.

authn/authz

Authentication is handled via HTTP Basic Authentication. Register to get your credentials. If you lose your credentials ping me on discord and I'll generate you another set.

error handling

As much as possible we try to rely on HTTP. So, check response codes and react appropriately.

endpoints

The four resources are: user, game, fight, tournament. For the most part, you can GET, PUT, and PATCH these resources as expected.

schemas

fight · game · options · tournament · user

fight

fight_idstringfight identifierabcd1234
optionsstring
scorestring
statestring
statusstring
time_createdstring
time_finishedstring
tournament_idstring
user_idstring
versionstring

game

default_optionsstringdefault options for new fights for game{'wordlist': 'wordlist-big', 'n': 1000}
game_idstringgame identifierwordle
namestringfriendly name of gameWordle

options

score_reduce_algostring
score_sort_ascstring

tournament

descriptionstring
game_idstringgame_id of gamewordle
optionsstring
statusstringcurrent status of tournament
time_endstring
time_startstring
titlestring
tournament_idstringtournament identifierbotfights_ii

user

btc_addressstringbitcoin wallet for payments3CU1HBTNpBYVFC9LBdhGP3kZStbkaiNzdu
descriptionstringtext description for userlorem ipso
display_namestringfriendly name displayed on websiteSally
githubstringgithub usernamecolinmsaunders
linkstringwww link associated with userhttps://www.youtube.com/watch?v=dQw4w9WgXcQ
user_idstringuser identifierabcd123

 

Tip — Don't flood the API! You will get throttled. Sleep at least a second between requests.

 


© Scrimsha, LLC · about · games · tournaments · dox · discord⤴