seatgeek
v0.3.8
Published
A wrapper library for the SeatGeek Platform API
Downloads
28
Readme
seatgeek.js
Common JS & Browser library for the SeatGeek Platform API.
Installation
Just include the script. The seatgeek
object is automagically added to your environment. No need for new
or any other sort of initialization. In the browser do the following:
<script src="seatgeek.js"></script>
or if you're using seatgeek.js with node.js
$ npm -g install seatgeek
Then require the "seatgeek" module:
var seatgeek = require("seatgeek");
Usage
The SeatGeek API (and seatgeek.js) supports sorting, pagination, geolocation, filtering, and affiliates.
Please refer to the SeatGeek Platform API documentation for accepted arguments.
Response Formats
The API provides two basic types of response documents: (i) a single resource response document and (ii) a bulk resource response document. The former returns a single document of the requested resource.
A bulk resource response document will include an array of single resource documents along with some additional meta information about the response. If no resources are found, meta information will be returned with an empty resources array.
Events
Please refer to SeatGeek Events API for accepted arguments.
Events Usage
Paginated List of All Events
seatgeek.events(function(err, events) {
if (err) return console.log(err);
console.log(events);
});
Single Event Document
seatgeek.events({ id : 801255 }, function (err, event) {
if (err) return console.log(err);
console.log(event);
});
Performers
Please refer to SeatGeek Performers API for accepted arguments.
Performers Usage
Paginated List of All Performers
seatgeek.performers(function(err, performers) {
if (err) return console.log(err);
console.log(performers);
});
Single Performer Document
seatgeek.performers({ id : 2079 }, function(err, performer) {
if (err) return console.log(err);
console.log(performer);
});
Venues
Please refer to SeatGeek Venues API for accepted arguments.
Venues Usage
Paginated List of All Venues
seatgeek.venues(function(err, venues) {
if (err) return console.log(err);
console.log(venues);
});
Single Venue Document
seatgeek.venues({ id : 8 }, function(err, venue) {
if (err) return console.log(err);
console.log(venues);
});
Taxonomies
Please refer to SeatGeek Taxonomies API for accepted arguments.
Taxonomies Usage
Retrieve All Taxonomies
seatgeek.taxonomies(function(err, taxonomies) {
if (err) return console.log(err);
console.log(taxonomies);
});
TODO
- datetime: support local vs utc, and ISO 8601
- support for javascript chaining
- handle paging, multi-ids as well