v1 Sports API Documentation

 

12.06.10:

We officially announced the release of API v1. We will continue to support the original version of our API (you can access associated docs under Deprecated Documentation) but will not be adding additional features to the original version. Therefore, we encourage you to migrate over to the new version of our API.

 

Getting Started:

 

The call structure is http://api.fanfeedr.com/{tier}/v1/{method}?format={json|xml|html}&{method_parameters}&appId=<your-api-key>

 

tier = basic, gold, platinum, or unlimited. You may register for a developer account and API key here.

 

article

Get the full text of an article if available. Supports multiple article resources.

Supported formats: json, xml, html

Sample call: http://api.fanfeedr.com/{tier}/v1/article?resource=article://nba/wednesdays_recaps/2010/11/10/spurs_beat_reeling_clippers_to_win_5th_straight

Return type: FullArticle

resourceTEST A resource pointer to an article or recap.

 

article_details

Get the details about an article, photo, and/or video resource. Supports multiple criteria.

Supported formats: json, xml

Sample call: http://api.fanfeedr.com/TIER/v1/article_details?resource=article://nba/2011/01/09/wages_of_winning_in_2011

Return type: FeedItem

resource An individual or list of resources.

boxscore

Get the boxscore for a event. Supports multiple events. [Note: EPL boxscores are currently not supported]

Supported formats: json, html

Sample call: http://api.fanfeedr.com/{tier}/v1/boxscore?resource=event://nfl/2010/11/14/games/kansas_city_chiefs_denver_broncos

Return type: BoxscoreFile

mini Abbreviated box score return. [default=false]
resource The resource pointer of the event to get the boxscore for.

game_details

Get a information about a specific game. Supports multiple event resources.

Supported formats: json, xml

Sample call: http://api.fanfeedr.com/{tier}/v1/game_details?resource=event://soccer/2010/04/14/games/marseille_sochaux

Return type: GameDetails

resource An event resource

games_on_date

For any given date, get a list of all games. Supports multiple resources.

Supported formats: json, xml

Sample call: http://api.fanfeedr.com/{tier}/v1/games_on_date?date=2010-11-16

Return type: Game

date A date string formatted as YYYY-MM-DD.
resource An individual or list of resources.

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.

Supported formats: json, xml

Sample call: http://api.fanfeedr.com/{tier}/v1/geo_feed?lat=39.7500&long=-104.8700

Return type: FeedItem

lat Latitude of the user. Defualts to low resolution GeoIP.
long Longitude of the user. Defualts to low resolution GeoIP.
rows The number of results to return.
start Offset for the query used for paging.

hot_blogs

Gets a list of the hottest blogs over the past hour, each with the hottest article published by that blog.

Supported formats: json, xml

Sample call: http://api.fanfeedr.com/{tier}/v1/hot_blogs

Return type: HotBlog

rows The number of results to return.
start Offset for the query used for paging.

hot_topics

Gets a list of the hottest teams and players over the past hour, each with the hottest article related to that team or player right now.

Supported formats: json, xml

Sample call: http://api.fanfeedr.com/{tier}/v1/hot_topics

Return type: HotTopic

rows The number of results to return.
start Offset for the query used for paging.

latest_game

Get the latest game for a team, league, list of teams, or list of leagues. Returns the past game if a game has been played in the last 3 days. Otherwise, the next game on schedule is returned.

Supported formats: json, xml

Sample calls: http://api.fanfeedr.com/{tier}/v1/latest_game?resource=team://nhl/sj_sharks

http://api.fanfeedr.com/{tier}/v1/latest_game?resource=team://nfl/baltimore_ravens&resource=team://nfl/dallas_cowboys&format=json&appid=?

Return type: Game

resource An individual or list of resources.

live_scores

Scores by resource. Also supports multi resource pattern.

Supported formats: json, xml

Sample call: http://api.fanfeedr.com/{tier}/v1/live_scores?resource=league://nfl

Return type: LiveGame

resource An individual or list of team or league resources.
rows The number of results to return.
start Offset for the query used for paging.

local_news

Shortcut to resource feed for all teams returned by local_teams.

Supported formats: json, xml

Sample call: http://api.fanfeedr.com/{tier}/v1/local_news?q=nyc

Return type: FeedItem

after A minimum timestamp (good for polling latest)
before A maximum timestamp
content_type Set to return all, news, blog, columnists, videos, image, recruiting, fantasy.
date A loose date filter, one of week, all-time, last-hour, last24, year, yesterday, today, month
doc_type Set to return all, articles, video
exclude_content_type Return everything but these content types.
exclude_doc_type Return everything but these types of records.
exclude_origin Return results from all origins except these.
hotness Algorithmic measure of popularity.
exclude_resource Return results from all resources except these.
lat Latitude of the user. Defualts to low resolution GeoIP.
level One of college, professional
long Longitude of the user. Defualts to low resolution GeoIP.
origin Only query against these origins
q Geocoding query
radius Radius to search within in miles.
resource An individual or list of resources.
rows The number of results to return.
sort The sort. One of search, newest, most-comments, by-hotness, lowest-rated, highest-rated, fewest-views, most-views, fewest-comments
start Offset for the query used for paging.
strictness One of strict, severe

local_scoreboard

Shortcut for getting the latest events for all teams returned by local_teams.

Supported formats: json, xml

Sample call: http://api.fanfeedr.com/{tier}/v1/local_scoreboard?lat=39.7625&long=-104.777068

Return type: Game

lat Latitude of the user. Defualts to low resolution GeoIP.
level Limit results to only pro or college
long Longitude of the user. Defualts to low resolution GeoIP.
radius Radius to search within in miles.
rows The number of results to return.
start Offset for the query used for paging.

local_teams

Get a list of professional and college teams within a radius around a lat/long point.

Supported formats: json, xml

Sample call: http://api.fanfeedr.com/{tier}/v1/local_teams?lat=39.7625&long=-104.777068

Return type: LocalTeams

lat Latitude of the user. Defualts to low resolution GeoIP.
level college or professional
long Longitude of the user. Defualts to low resolution GeoIP.
radius Radius to search within in miles.
rows The number of results to return.
start Offset for the query used for paging.

recap

Returns the recap for a given event resource. Supports multiple events.

Supported formats: json, xml, html

Sample call: http://api.fanfeedr.com/{tier}/v1/recap?resource=event://nfl/2010/11/11/games/baltimore_ravens_atlanta_falcons

Return type: FullArticle

resource A resource pointer to a recap.

related_entities

Returns an entity mapping to related entities:

league -> conferences, teams, divisions
conference -> divisions, teams
division -> teams
teams -> players

Supported formats: json, xml

Sample call: http://api.fanfeedr.com/{tier}/v1/related_entities?resource=league://nfl

Return type: EntityDetails

resource A league, conference, team, or division resource. Also supports metro resources.
rows The number of results to return.
start Offset for the query used for paging.
type Specifies return for a given resource. One of player, team, division, conference, or league.

resource_feed

Returns the news feed for a given resource

Supported formats: json, xml

Sample call: http://api.fanfeedr.com/{tier}/v1/resource_feed?resource=league://nfl

Return type: FeedItem

after A minimum timestamp (good for polling latest)
before A maximum timestamp
content_type Returns all, news, blog, columnists, videos, image, recruiting, fantasy, updates
date A loose date filter - week, all-time, last-hour, last24, year, yesterday, today, month
disjunctive Applies OR/AND operators to multiple resource queries. [default=true (OR)]
doc_type Returns all, articles, video
exclude_content_type Return everything but these content types.
exclude_doc_type Return everything but these types of records.
exclude_origin

Return results from all origins except these.
origin Only query against these origins
resource An individual or list of resources.
rows The number of results to return.
sort The sort filter - newest, by-hotness, most-comments, lowest-rated, highest-rated, fewest-views, most-views, fewest-comments
start Offset for the query used for paging.
strictness One of strict, severe. Severe is a more restrictive filter that only returns results where the entity specified is the most prominent in article.

schedule

Get a schedule for a team, league, conference, or division. Currently supported resources are: NFL, NBA, NHL, MLB, NCAA (football/basketball), and soccer. 

Supported formats: json, xml, html

Sample call: http://api.fanfeedr.com/{tier}/v1/schedule?resource=conference://soccer/champions_league

Return type: Game

resource

A team, league, conference, or division resource.
start

Index location for start of method. [Default=0]
rows

Number of rows to return. [Default=50]
start_date

YYYY-MM-DD format for range start date. [If left blank, defaults to beginning of season.]
end_date

YYYY-MM-DD format for range end date. [If left blank, defaults to end of season.]
future_only

Upcoming games on schedule. [Default=false. Set as true to return future games.]

scores

Scores by resource. Also supports multi resource pattern for teams.

Supported formats: json, xml

Sample call: http://api.fanfeedr.com/{tier}/v1/scores?resource=league://nfl

Return type: FeedItem

resource An individual or list of team or league resources.
rows The number of results to return.
start Offset for the query used for paging.

search

Advanced search. More powerful (and recommended) to use a combination of suggest and resource_feed.

Supported formats: json, xml

Sample call: http://api.fanfeedr.com/{tier}/v1/search?q=jets

Return type: FeedItem

after A minimum timestamp (good for polling latest)
before A maximum timestamp
content_type All, news, blog, columnists, videos, image, Twitter, recruiting, fantasy
date One of week, all-time, last-hour, last24, year, yesterday, today, month
exclude_content_type Return everything but these content types.
exclude_origin Return results from all origins except these.
exclude_origin

Return results from all origins except these.
filter One of search, newest, most-comments, by-hotness, lowest-rated, highest-rated, fewest-views, most-views, fewest-comments
origin Only query against these origins
q Your query
resource An individual or list of resources.
rows The number of results to return.
sort The sort filter - newest, by-hotness, most-comments, lowest-rated, highest-rated, fewest-views, most-views, fewest-comments
start Offset for the query used for paging.
strictness One of strict, severe. Severe is a more restrictive filter that only returns results where the entity is most prominent in content_type

standings

Get standings as a struct or formatted HTML.

Supported formats: json, xml, html

Sample call: http://api.fanfeedr.com/{tier}/v1/standings?resource=league://nba

Return type: League, Conference, Division or TeamWithStandings

resource A league, conference, team, or division resource.

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.

Supported formats: json, xml

Sample call: http://api.fanfeedr.com/{tier}/v1/suggest?q=red

Return type: SuggestItem

q Your query
rows The number of results to return.
start Offset for the query used for paging.

version 117 as of 8 months ago by Benn

0 Comments

Please sign in to post a comment.