Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Tree: 062d55a695
Fetching contributors…

Cannot retrieve contributors at this time

534 lines (373 sloc) 13.93 kB

BleacherApi

A Ruby interface to the Bleacher Report API.

Requirements

gem install bleacher_api

Table of Contents

GET /api/article/article.json

Parameters

  • id - Article ID (required)
  • article - When given any value, action includes article body in JSON output
  • article[entry_id] - Changes article body to a quick hit or live blog entry
  • article[only] - When given comma-separated parameters, returns only values for the parameters in JSON output
  • comments[page] - When given a page number, action includes comments in JSON output
  • comments[order] = When given an order (in sql syntax), action includes comments in JSON output sorted by order
  • related_content - When given any value, action includes related content in JSON output

Returns

An object with any of the following keys: article, comments, related_content.

The article value is an object with the keys body and object.

Ruby Example

BleacherApi::Article.article(595888, :article => true, :comments => { :page => 1 }, :related_content => true)

HTTP Example

http://bleacherreport.com/api/article/article.json?id=595888&article=1&comments[page]=1&related_content=1

GET /api/authenticate/login

Parameters

  • redirect_url
  • type (optional) - Optional values for this include: "fantasy"

HTTP Example

http://bleacherreport.com/api/authenticate/login?redirect_url=http://bleacherreport.com&type=fantasy

Redirect

A redirect_url parameter is mandatory. B/R will redirect the request back to that URL, passing basic information from the User API as GET parameters.

POST /api/authenticate/login.json

Parameters

  • user[email]
  • user[password]

Returns

Output similar to the User API.

Ruby Example

BleacherApi::Authenticate.login('email', 'password')

HTTP Example

http://bleacherreport.com/api/authenticate/login.json?user[email]=your@email.com&user[password]=your_password

Please note that any request with a password should be sent as a POST, despite this example using GET.

GET /api/authenticate/logout.json

Parameters

  • redirect_url (optional)

Returns

Returns true if succeeded, false if not.

Ruby Example

BleacherApi::Authenticate.logout

HTTP Example

http://bleacherreport.com/api/authenticate/logout.json

Redirect

When a redirect_url parameter is specified, B/R will redirect the request back to that URL, passing a fail=1 parameter if the logout failed.

GET /api/authenticate/signup

Parameters

  • redirect_url
  • type (optional) - Optional values for this include: "fantasy"

Returns

An HTML page with a sign up form.

HTTP Example

http://bleacherreport.com/api/authenticate/signup?redirect_url=http://bleacherreport.com&type=fantasy

Redirect

A redirect_url parameter is mandatory. B/R will redirect the request back to that URL, passing basic information from the User API as GET parameters.

POST /api/authenticate/forgot_password

Parameters

  • email
  • redirect_url (optional)
  • format (optional) - json or not

Returns

Either json of success/error, html status of 200 or 404 (for ajax), or redirect.

HTTP Example

http://bleacherreport.com/api/authenticate/forgot_password.json?email=bherman@bleacherreport.com

Paramter Info

Email parameter is mandatory.

If requesting json, redirect_url will be ignored. If non-json and redirect_url, the request will be treated as html and redirect to the specified url. If no params, it will be treated as an html request, but only return a status code of 200 for success or 404 for error (which could be an inability to find the email or any other error).

GET /api/front/lead_articles.json

Parameters

  • tags - Optional; comma separated list of team permalinks
  • devicetype - Optional; currently supports 'ipad'
  • appversion - Optional;
  • page - Optional
  • perpage - Optional
  • limit - Optional; deprecated - use perpage

Returns

An array of article objects with the following keys: permalink, primary_image_650x440, primary_image_311x210, title and tag (the tag of the teamstream from which the article came).

The array of articles represents the articles currently on the lead module of the front page.

For appversion >= '1.4' and devicetype = 'ipad', specifying one or more tags will return an array of articles, with the articles currently on the lead module of the front page merged with articles from the team streams of the specified teams.

Ruby Example

BleacherApi::Front.lead_articles(:limit => 2)

HTTP Example

http://bleacherreport.com/api/front/lead_articles.json?limit=2
http://bleacherreport.com/api/front/lead_articles.json?tags=san-francisco-49ers,oakland-raiders&devicetype=ipad&appversion=1.4&page=1&perpage=10

GET /api/front/v2/lead_articles.json

Parameters

  • tags - Optional; comma separated list of team permalinks
  • devicetype - Optional; currently supports 'ipad'
  • appversion - Optional
  • page - Optional
  • perpage - Optional; default 5

Returns

An object containing: 1) a variable with the maximun number of articles available for the query, disregarding the perpage parameter, and 2) an array of article objects with the following keys: permalink, primary_image_650x440, primary_image_311x210, title and tag (the tag of the teamstream from which the article came).

The array of articles represents the articles currently on the lead module of the front page.

For devicetype = 'ipad', specifying one or more tags will return an array of articles, with the articles currently on the lead module of the front page merged with articles from the team streams of the specified teams.

{
  all_articles: 53,
  articles: 
    [
      {
        permalink: "979252-nba-rumors-roundup-chris-paul-to-clippers-latest-on-dwight-howard-and-more",
        primary_image_311x210: "http://img.bleacherreport.net/img/images/photos/001/484/347/326afbbaae76d91b000f6a706700345b_0_original_crop_exact.jpg?w=311&h=210&q=85",
        title: "NBA Trade Rumor Roundup ",
        primary_image_650x440: "http://img.bleacherreport.net/img/images/photos/001/484/347/326afbbaae76d91b000f6a706700345b_0_original_crop_exact.jpg?w=650&h=440&q=85"
      },
      {
        primary_image_650x440: "http://img.bleacherreport.net/img/images/photos/001/484/172/135247305_crop_exact.jpg?w=650&h=440&q=85",
        title: "Crabtree and Edwards Steam after Loss",
        tag: "san-francisco-49ers",
        permalink: "http://www.csnbayarea.com/blog/niners-talk/post/49ers-frustration-evident-after-loss-to-?blockID=610322",
        primary_image_311x210: "http://img.bleacherreport.net/img/images/photos/001/484/172/135247305_crop_exact.jpg?w=311&h=210&q=85"
      },
      {
        primary_image_650x440: "http://img.bleacherreport.net/img/images/photos/001/483/828/135507905_crop_exact.jpg?w=650&h=440&q=85",
        title: "Ask the Experts: Is Carson Palmer the Long-Term Answer for the Raiders?",
        tag: "oakland-raiders",
        permalink: "979066-ask-the-experts-is-carson-palmer-the-long-term-answer-for-the-raiders",
        primary_image_311x210: "http://img.bleacherreport.net/img/images/photos/001/483/828/135507905_crop_exact.jpg?w=311&h=210&q=85"
      },
      ...
    ]
}

Ruby Example

BleacherApi::Front.lead_articles(:limit => 2)

HTTP Example

http://bleacherreport.com/api/front/v2/lead_articles.json?limit=2
http://bleacherreport.com/api/front/v2/lead_articles.json?tags=san-francisco-49ers,oakland-raiders&devicetype=ipad&appversion=1.4&page=1&perpage=10

GET /api/geolocation/teams.json

Parameters

  • city
  • state
  • country
  • dma - Designated Market Area code
  • ip - IP Address (defaults to IP of requesting machine, only used if city, state, country, and dma are empty)
  • limit - Limit number of results (defaults to 5)

All parameters are optional.

Returns

A hash of team information, similar to the team information in the User API:

{
  "Dallas Mavericks": {
    "uniqueName": "dallas-mavericks",
    "logo": "dallas_mavericks.png",
    "displayName": "Dallas Mavericks",
    "shortName": "Mavericks"
  },
  "Dallas Cowboys": {
    "uniqueName": "dallas-cowboys",
    "logo": "dallas_cowboys.png",
    "displayName": "Dallas Cowboys",
    "shortName": "Cowboys"
  }
}

Ruby Examples

BleacherApi::Geolocation.teams(
  :city => 'Dallas',
  :dma => 623,
  :state => 'Texas',
  :country => 'US',
  :limit => 10
)
BleacherApi::Geolocation.teams(
  :ip => '64.55.149.162'
)
BleacherApi::Geolocation.teams(
  :lat => '37.787082',
  :long => '-122.400929'
)

HTTP Example

http://bleacherreport.com/api/geolocation/teams.json?city=Dallas&dma=623&state=Texas&country=USA&limit=10
http://bleacherreport.com/api/geolocation/teams.json?ip=64.55.149.162
http://bleacherreport.com/api/geolocation/teams.json?lat=37.787082&long=-122.400929

GET /api/related/channel.json

Parameters

  • article_id - Article ID, must be present if no tag_id specified
  • tag_id - Tag ID, must be present if no article_id specified
  • page - Optional

Returns

An array of article objects with the following keys: permalink, channel_primary_image, and title.

Ruby Example

BleacherApi::Related.channel(:article_id => 595888, :page => 2)

HTTP Example

http://bleacherreport.com/api/related/channel.json?article_id=595888&page=2

GET /api/related/channel_next.json

Parameters

  • article_id - Article ID, must be present if no tag_id specified
  • tag_id - Tag ID, must be present if no article_id specified
  • limit - Limit number of results, defaults to 1

Returns

An array of article objects with the following keys: permalink, channel_primary_image_150x100, and dynamic_hook.

These article objects represent the next items in the channel (after the passed article_id).

Ruby Example

BleacherApi::Related.channel_next(:article_id => 595888, :tag_id => 19, :limit => 2)

HTTP Example

http://bleacherreport.com/api/related/channel_next.json?article_id=696286&tag_id=19&limit=2

GET /api/stream/first.json

Parameters

  • tags - comma-delimited list of tag permalinks

Returns

An object whose keys are the permalinks passed in via the tags parameter.

Each value of that object is another object with the following keys:

  • title
  • published_at
  • image
  • label

This object represents the first item in that team's stream.

Ruby Example

BleacherApi::Stream.first('san-francisco-49ers')

HTTP Example

http://bleacherreport.com/api/stream/first.json?tags=san-francisco-49ers,dallas-cowboys

GET /api/user/user.json

Parameters

  • token - Token obtained from /api/authenticate/login

Returns

A user object with the following keys:

  • id
  • email
  • first_name
  • last_name
  • permalink
  • token
  • api

The api value contains extra information especially for the API. Example output:

{
  "teams": {
    "Dallas Mavericks": {
      "uniqueName": "dallas-mavericks",
      "logo": "dallas_mavericks.png",
      "displayName": "Dallas Mavericks",
      "shortName": "Mavericks"
    },
    "Dallas Cowboys": {
      "uniqueName": "dallas-cowboys",
      "logo": "dallas_cowboys.png",
      "displayName": "Dallas Cowboys",
      "shortName": "Cowboys"
    }
  }
}

Ruby Example

BleacherApi::User.user('token')

HTTP Example

http://bleacherreport.com/api/user/user.json?token=TOKEN_OBTAINED_FROM_LOGIN_GOES_HERE

Running Specs

Here is an example of the options available when running the specs:

LOGIN=user@user.com PASSWORD=password URL=http://localhost ONLY=geolocation spec spec

LOGIN and PASSWORD are required.

URL defaults to "http://bleacherreport.com".

ONLY is optional, and allows you to only run a specific group of specs.

Jump to Line
Something went wrong with that request. Please try again.