Getting Started with the Leaguevine REST API

The Leaguevine REST API offers read/write access to almost all of Leaguevine's data. The goal is to give you the opportunity to quickly and easily build rich, interesting applications that tie into and contribute to a central pool of data. By abstracting away the boiler plate stuff such as Organizations/Leagues/Seasons/Teams/Tournaments/Pools/etc., you can focus on the fun parts. This API makes it easier to build things such as mobile stats taking apps, web widgets, scoreboards, or anything else that collects, analyzes, or displays Ultimate data.

Further, any data written to the API will automatically be seen by other apps built on top of the API as well as leaguevine.com and Leaguevine Mobile.

How to quickly explore the API

To quickly see how this API works, visit the REST API Reference. If you are logged in, you have read/write access to the API and you can simulate HTTP requests by choosing a method, entering parameters and clicking a button to try it out. When you submit requests from this interactive API reference, we show you the URL that you made the request to, along with any headers you should use when you send an HTTP request yourself.

How to make API requests from your app

1. Login or create an account

You first need a regular Leaguevine account. Login if you have one, or create a new one if you don't.

2. Register an app

We track which application every API request comes from so that in the case someone tries to abuse the service, we can block a single app (or even single user) without having to interrupt service for everyone else.

To register your app, visit your applications page and create a new application. We immediately give you back some confidential information which you can then use to interact with the API.

3. Obtain access_tokens using OAuth2

Your app needs to authenticate itself using the OAuth2 protocol. Look at our OAuth2 authentication guide and decide which kind of app yours is. It will either be a Client-Side Application, a Web Application, or a Read-only Application. After determining the appropriate type, follow the instructions in the guide to implement the required workflow.

4. Make HTTP requests

Once you have obtained access_tokens you can make HTTP requests to read (GET), update (PUT), create (POST), or delete (DELETE) objects.

GET requests can be made by simply typing the appropriate URL into your browser. PUT, POST, and DELETE requests require you to use some sort of HTTP client. We recommend REST Client which works for OSX or Windows, but there are many other options.

Limitations

Your ability to make write requests to the API depends on the permissions the logged in user has. All users can read any live data, and can create just about any data as well. Users have permission to edit or remove anything they create. However, users by default cannot edit or remove other users' objects. The one exception to this is if the person who created a tournament makes another user a tournament admin via the leaguevine.com tournament interface.

Open Source projects

We are big fans of Open Source projects, and we are an active part of a group of developers committed to building Open Source apps on top of the Leaguevine API. We'd love for you to join us, and the group is open to anyone so you can invite friends if you'd like.