intro · auth · errors · endpoints · schemas
Welcome to the botfights documentation! With the exception of registration, all interactions with botfights happen over the REST-ish API.
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.
As much as possible we try to rely on HTTP. So, check response codes and react appropriately.
The four resources are: user, game, fight, tournament. For the most part, you can GET, PUT, and PATCH these resources as expected.
fight · game · options · tournament · user
| fight_id | string | fight identifier | abcd1234 | |
| options | string | |||
| score | string | |||
| state | string | |||
| status | string | |||
| time_created | string | |||
| time_finished | string | |||
| tournament_id | string | |||
| user_id | string | |||
| version | string |
| default_options | string | default options for new fights for game | {'wordlist': 'wordlist-big', 'n': 1000} | |
| game_id | string | game identifier | wordle | |
| name | string | friendly name of game | Wordle |
| score_reduce_algo | string | |||
| score_sort_asc | string |
| description | string | |||
| game_id | string | game_id of game | wordle | |
| options | string | |||
| status | string | current status of tournament | ||
| time_end | string | |||
| time_start | string | |||
| title | string | |||
| tournament_id | string | tournament identifier | botfights_ii |
| btc_address | string | bitcoin wallet for payments | 3CU1HBTNpBYVFC9LBdhGP3kZStbkaiNzdu | |
| description | string | text description for user | lorem ipso | |
| display_name | string | friendly name displayed on website | Sally | |
| github | string | github username | colinmsaunders | |
| link | string | www link associated with user | https://www.youtube.com/watch?v=dQw4w9WgXcQ | |
| user_id | string | user identifier | abcd123 |