Difference between revisions of "API"
(→Format) |
(→Latest Runs) |
||
| Line 250: | Line 250: | ||
===== default ===== | ===== default ===== | ||
If GET[format] isn't specified, then a comma-separated list of pretty-printed run descriptions is returned. | If GET[format] isn't specified, then a comma-separated list of pretty-printed run descriptions is returned. | ||
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 16:35, 3 April 2019
The HaloRuns API is entirely contained in the subdirectory /api/ for the time being. There are some conventions that multiple API calls follow.
Contents
Game Numbers
| Game | Number |
|---|---|
| Halo: Combat Evolved | 01 |
| Halo 2 | 02 |
| Halo 3 | 03 |
| Halo 3: ODST | 04 |
| Halo: Reach | 05 |
| Halo 4 | 06 |
| Halo 2 MCC | 07 |
| Halo 5 | 08 |
Level Numbers
Halo: Combat Evolved
| Level | Number |
|---|---|
| Pillar of Autumn | 01 |
| Halo | 02 |
| Truth and Reconciliation | 03 |
| The Silent Cartographer | 04 |
| Assault on the Control Room | 05 |
| 343 Guilty Spark | 06 |
| The Library | 07 |
| Two Betrayals | 08 |
| Keyes | 09 |
| The Maw | 10 |
Halo 2
| Level | Number |
|---|---|
| Cairo Station | 01 |
| Outskirts | 02 |
| Metropolis | 03 |
| The Arbiter | 04 |
| Oracle | 05 |
| Delta Halo | 06 |
| Regret | 07 |
| Sacred Icon | 08 |
| Quarantine Zone | 09 |
| Gravemind | 10 |
| Uprising | 11 |
| High Charity | 12 |
| The Great Journey | 13 |
Halo 3
| Level | Number |
|---|---|
| Sierra 117 | 01 |
| Crows Nest | 02 |
| Tsavo Highway | 03 |
| The Storm | 04 |
| Floodgate | 05 |
| The Ark | 06 |
| The Covenant | 07 |
| Cortana | 08 |
| Halo | 09 |
Halo 3: ODST
| Level | Number |
|---|---|
| Prepare to Drop | 01 |
| Tayari Plaza | 02 |
| Uplift Reserve | 03 |
| Kizingo Blvd. | 04 |
| ONI Alpha Site | 05 |
| NMPD HQ | 06 |
| Kilowani Station | 07 |
| Data Hive | 08 |
| Coastal Highway | 09 |
Halo: Reach
| Level | Number |
|---|---|
| Winter Contingency | 01 |
| ONI: Sword Base | 02 |
| Nightfall | 03 |
| Tip of the Spear | 04 |
| Long Night of Solace | 05 |
| Exodus | 06 |
| New Alexandria | 07 |
| The Package | 08 |
| The Pillar of Autumn | 09 |
Halo 4
| Level | Number |
|---|---|
| Dawn | 01 |
| Requiem | 02 |
| Forerunner | 03 |
| Infinity | 04 |
| Reclaimer | 05 |
| Shutdown | 06 |
| Composer | 07 |
| Midnight | 08 |
Halo 5
| Level | Number |
|---|---|
| Osiris | 01 |
| Blue Team | 02 |
| Glassed | 03 |
| Unconfirmed | 04 |
| Evacuation | 05 |
| Reunion | 06 |
| Swords of Sanghelios | 07 |
| Enemy Lines | 08 |
| Battle of Sunaion | 09 |
| Genesis | 10 |
| The Breaking | 11 |
| Guardians | 12 |
Global Modifiers
Format
Specifies how the API call's response will be formatted
json
JSON format. Example: https://haloruns.com/api/request?query=recentRuns&format=json
prettyjson
JSON format, where each item in the object is a pretty printed string. Example: https://haloruns.com/api/request?query=recentRecords&format=prettyjson
country
TBD
Latest Runs
GET /api/request?query=recentRuns[&format=format&limit=N]
Returns a list of the most recent verified runs submitted to the site. If GET[limit] isn't specified as a number below 50, the 50 latest times are returned.
default
If GET[format] isn't specified, then a comma-separated list of pretty-printed run descriptions is returned.
