Work in progress.. Contact us to request an API key.

Basics

Every API call requires an endpoint, format, and a method. Additional arguments may be required per-method. You will also need to pass your API key.

To query the API, construct your request as so:

http://www.nibbits.com/api/ENDPOINT.FORMAT?method=METHOD

Required Params

method

The endpoint's method which you wish to call.

api_key

Your unique API key.

Formats

• json
• xml
• pkl

Endpoints

maps

maps.search

Returns 10 maps matching query.

http://www.nibbits.com/api/maps.xml?method=search

query

Queries against map_filename.

game

Game short name (e.g. sc2).
Optional

mode

Search mode: contains, exact, or startswith.
Optional, Default: 'contains'

maps.list

Returns 10 maps from offset.

http://www.nibbits.com/api/maps.xml?method=list

game

Game short name (e.g. sc2).

sort

Sort mode: date or ranking.
Optional, Default: 'date'

order

Order mode: asc or desc.
Optional, Default: 'desc'

offset

Offset to list from.
Optional, Default: 0

is_blizzard

Restrict to Blizzard official maps.
Optional, Default: 0

replays

replays.list

Returns 10 StarCraft 2 replays from offset.

http://www.nibbits.com/api/replays.xml?method=list

sort

Sort mode: date or ranking.
Optional, Default: 'date'

order

Order mode: asc or desc.
Optional, Default: 'desc'

offset

Offset to list from.
Optional, Default: 0

---

Support Nibbits by linking to us: