Fanfeedr.com Documentation

The FanFeedr API provides a simple RESTful interface with lightweight JSON or XML formatted responses to use many of the FanFeedr website's features, including blog posts, player tweets, articles from local newspapers and videos, and much more. This document provides information to developers on how to integrate with the FanFeedr API.

Concepts

HTTP Requests

The FanFeedr API uses a RESTful calling style that works with standard HTTP GET calls. Any web programming language (PHP, Ruby, Perl, Python, Java...) should be able to make and receive HTTP networking calls.

Tiering

The FanFeedr API is also tier-based. This allows the FanFeedr API to be more flexible for developer needs. There are four tiers currently available:

  • Basic (Free)
  • Daily (Free)
  • Gold ($250/month)
  • Platinum ($1,220/month)

When you register for a developer account and create a new application, you will automatically have a Basic tier key issued and can get up and running in just a few minutes.

For more detailled information and a list of features for each tier, please see Plans & Pricing.

Rate Limiting

Rate limits vary by tier.

  • Basic (100 queries/hour)
  • Daily (1,500 queries/day)
  • Gold (250 queries/hour)
  • Platinum (2,500 queries/hour)

You will receive an automated email when you approach a limit. If your application needs more than the allotted amount of calls, contact us at info@fanfeedr.com with a description of the application and an estimate on call usage. We're more than happy to work with you to establish a setup that works best for your application. If you find you are running into query limits often, you may want to investigate using caching in your application to keep the number of calls to a minimum, and make your application faster.

URL Structure

The basic URL structure is: http://api.fanfeedr.com/{tier}/{method}?format={json|xml}&{method_params...}&appId=<your-api-key>

API Methods

suggest

This call provides typeahead suggestion for entity resource lookups, ie for the query red you recieve path and resource info for the Red Sox, Chris Redman, and Detriot Red Wings.

Method Name suggest
HTTP Method GET
Parameters
Name Required Default Type
q Y string

all_scores

A news feed of all the most recent scores for all teams.

Method Name all_scores
HTTP Method GET
Parameters
Name Required Default Type
start N 0 int
rows N 20 int

scores

Call to return the scores for a given league resource.

Method Name scores
HTTP Method GET
Parameters
NameRequiredDefaultType
resource Y Resource
start N 0 int
rows N 20 int

geo_feed

Provides a news feed based on teams found near a given geo location. This is particulary useful if you have access to geolocation data from ip lookups or from an iPhone app.

Method Name geo_feed
HTTP Method GET
Parameters
NameRequiredDefaultType
start N 0 int
rows N 20 int
lat N decimal
long N decimal

Provides a news feed for a given query string.

Method Name search
HTTP Method GET
Parameters
NameRequiredDefaultType
q Y string
start N 0 int
rows N 20 int
filter N search ApiSearchSort
date N all-time ApiDateFilter
content_type N all ApiContentTypeFilter

article

Provides formatted article text for a given article resource

Method Name article
HTTP Method GET
Parameters
NameRequiredDefaultType
resource Y resource

recap

Gets the recap of an event

Method Name recap
HTTP Method GET
Parameters
NameRequiredDefaultType
resource Y Resource

boxscore

Gets the boxscore of an event

Method Name boxscore
HTTP Method GET
Parameters
NameRequiredDefaultType
resource Y Resource

schedule

Gets the schedule for a team resource.

Method Name schedule
HTTP Method GET
Parameters
NameRequiredDefaultType
resource Y Resource

resource_feed

Gets a list of articles for a resource

Method Name resource_feed
HTTP Method GET
Parameters
NameRequiredDefaultType
resource Y Resource