3594 views

 

74% puke7

::|CONTENTS

1. Basic Syntax
2. Commands
3. Examples
4. Response Formats

Battle of the Bits offers a fully public API. Please do not abuse; request throttling and/or api access tokens might be implemented in the future. Please enjoy.

Basic Syntax

---

battleofthebits.com/api/v1/{object_type}/{command}(/{param0}(/{param1}(/{param2(..))))

Current object types : botbr, entry, battle, format, lyceum_article

Commands

---

load
battleofthebits.com/api/v1/{object_type}/load/{object_id}

list
battleofthebits.com/api/v1/{object_type}/list(/{page_number=0}(/{page_length=25}))

Lists can be sorted by property values by using the GET method
?sort={object_property}&desc=true
The desc variable is optional; defaults to ascending.

Filters can be applied using the GET method.
?filters={defined_filters}
Filters are defined by pairing a key and value with ~. Multiple filters can be defined by using ^ for separation.
(example: /api/v1/botbr/list/?filters=level~17^class~chipist)
*this may be deprecated in future versions

Conditionals can be applied using the POST method. The API expects an array of objects in JSON format. These are much more versatile than the Filters using GET.

"conditions": [
{ "property": "title", "operator": "LIKE", "operand": "%ass%" },
{ "property": "score_favs", "operator": ">", "operand": "40" },
{ "property": "format_token", "operator": "like", "operand": "%mod%" },
{ "property": "yt", "operator": "is", "operand": "NULL" }
]

Pagination is optional. The page_number is zero based and the default page_length is 25 objects. The maximum number of objects that can be pulled in a single call is 250.

Examples

---

Here are some example-requests to make it more clear:

Getting all currently ongoing battles:
https://battleofthebits.com/api/v1/battle/current
Search for a battle by name:
https://battleofthebits.com/api/v1/battle/search/Winter+Chip+II
Search for a lyceum article by name:
https://battleofthebits.com/api/v1/lyceum_article/search/API
Get a BotBr by name:
https://battleofthebits.com/api/v1/botbr/list?filters=name~puke7
https://battleofthebits.com/api/v1/botbr/search/puke7
Get a random entry:
https://battleofthebits.com/api/v1/entry/random
Get an entry by id:
https://battleofthebits.com/api/v1/entry/load/12345
Get the top 5 BotBr:
https://battleofthebits.com/api/v1/botbr/list/0/5?sort=points&desc=true
Get the top 5 BotBr filtered by class Chipist:
https://battleofthebits.com/api/v1/botbr/list/0/5?filters=class~Chipist&sort=points&desc=true
Get all (or the first 250) entries of a battle:
https://battleofthebits.com/api/v1/entry/list/0/250?filters=battle_id~1234

Response Formats

---

The BotB API v1 default response format is a JSON object. XML is also available by either setting the format via GET ?format=xml or adding the .xml extension to the URI.