The Node Alliance
The Node Alliance is a Node.js wrapper for The Blue Alliance API, using an XMLHTTPRequest object. It is a constructor initialized with your application ID that TBA requires with all API requests. Since it was originally created with Express and body-parser in mind, each method passes the data from TBA through a callback.
Setup
This is all you need to get started:
var TheNodeAlliance = ;var TBA = "team955:api-example:v01"; // Do the things down here
If you want to see how to do it with Express...
var express = ;var bodyParser = ;var app = ;var TheNodeAlliance = ;var TBA = "teamXXXX:testing-api:v01"; app; app
Documentation
For documentation, take a look over here.
Data Methods
The methods of the TBA object require the data
object argument to have different properties.
While not every method uses the same properties, there is a shared pool.
To see which properties a method requires, look at its documentation.
pageNum
The page number of the list. Pages start with page 0 and each contain 500 teams.
// For example: pageNum: "1"
teamKey
The official team number, WITHOUT frc
prepended to it, as The Blue Alliance specifies.
We do that for you, just let it happen.
// For example: teamKey: "955"
year
The year of the thing you want, as a number.
// For example: year: "2015"
eventKey
The official event code.
// For example: eventKey: "cmp"
matchKey
The unique key for each match. Match keys can be obtained with the Event Match request.
//For example: matchKey: "f1m1" // Or "qf3m2", or "qm25", etc...
districtKey
The shorthand district name.
// For example: districtKey: "fim"