FUTEF API

FUTEF API provides a search API to explore and find Wikipedia content - including faceted categories. This API is presented as a RESTful Web Service - for more background information on RESTful web services checkout Yahoo! Developer Network To use this api - you must register for an Application ID. To register for an Application ID simply send an e-mail to appid-request@futef.com. This API is available only for NON COMMERICAL - LOW VOLUME usage. For other uses, questions or feedback please contact us at api@futef.com.

REQUEST

REQUEST URL

http://api.futef.com/api/v1

query	string (required)	simple keywords, phrases, field search, faceted navigation
appid	string (required)	Application ID - get an an AppID send email to appid@futef.com
begin	number: default 0	The starting position to return (0 based).
end	number: default begin + 10	The ending positions. If end - begin < 10, then it will be truncated to begin + 10
bbox	lat,lng,lat,long	Give a Lat/Long bounding box that limits the results that have geo coordinates with in the resulting bounding box
func	string	The name of the callback function to wrap the around the JSON data.

QUERY LANGUAGE

keyword	new york	http://api.futef.com/api/v1?query=new%20york&appid=7367004ee9f71de584b2caee2da324b33e9
phrases	"new york"	http://api.futef.com/api/v1?query=%22new%20york%22&appid=7367004ee9f71de584b2caee2da324b33e9
facets	cats:[Living people]	http://api.futef.com/api/v1?query=cats%3A%5BLiving%20people%5D&appid=7367004ee9f71de584b2caee2da324b33e9

"new york" baseball cats:[Living people]	All of these forms can be combined into a single query.
-"new york" cats:[Living people]	Additionally, there is a not operator by prepending the query term w/ -

RESPONSE

Results are return in JSON format. A object/hash is return w/ the following elements.

begin	number	beginning offset - everything is zero based
end	number	ending offset
qtime	number	ms to complete query
total_hits	number	total number of results
tokens	array of strings	that represent a tokenized version of the query parameter that was submitted.
records	array of objects/hashes	title string Title of Wikipedia article text string first 250 characters of the Wikipedia article cats string list of categories - separated w/ ; - may not be present in all cases url string URL to Wikipedia article lat number Latitude lng number Longitude
facets	object/hash of array w/ object/hash	field-name - "cats" "cats" -> array of object/hash w/ Additional facets maybe added in the future but "cats" is currently the only one available. term string count number - estimate of items in the sub query

---

EXAMPLES

• A simple query - "web 2.0" http://api.futef.com/api/v1?query=%22web+2.0%22&appid=7367004ee9f71de584b2caee2da324b33e9 { "total_hits" : 220, "begin" : 0, "end" : 10, "qtime" : 15, "tokens" : [ "\"web 2.0\""], "records" : [ { "title" : "Web 2.0", "url" : "http:\/\/en.wikipedia.org\/wiki\/Web_2%2E0", "text" : "Web 2.0, a phrase coined by O'Reilly Media in 2004, refers to a supposed second generation of Internet-based servicessuch as social networking sites, wikis, communication tools, and folksonomiesthat emphasize online collaboration and sharing am", "cats" : "Buzzwords; World Wide Web; Web services; Web 2.0" }, { "title" : "Enterprise social software", "url" : "http:\/\/en.wikipedia.org\/wiki\/Enterprise_social_software", "text" : "Enterprise social software refers to social software used in enterprise business contexts. Enterprise 2.0 or Enterprise Web 2.0<ref>\n\"Enterprise 2.0\" was coined by Andrew McAfee of Harvard Business School in the Spring 2006 MIT Sloan Management Revi", "cats" : "Buzzwords; Business; Innovation; Web 2.0" }, { "title" : "Web 2.0 Conference (2004)", "url" : "http:\/\/en.wikipedia.org\/wiki\/Web_2%2E0_Conference_%282004%29", "text" : "The first Web 2.0 conference was held October 5-7, 2004 at the Hotel Nikko in San Francisco, and is believed to be the point at which the term Web 2.0 came into popular usage.\n \n Speakers at Web 2.0 Conference 2.0, 2004 \n*Jeff Bezos\n*Mark Cuban\n*John", "cats" : "Computer conferences; 2004 conferences; Web 2.0; 2004 in the United States" }, { "title" : "Web 2.0 Toolbar", "url" : "http:\/\/en.wikipedia.org\/wiki\/Web_2%2E0_Toolbar", "text" : "The Web 2.0 Toolbar is a toolbar or browser add on for Internet Explorer and FireFox based out of Boston, Massachusetts that has received attention from bloggers around the world. The toolbar is a single-point resource for keeping up on, contributin", "cats" : "Internet toolbar" }, { "title" : "Web 2.0 Conference", "url" : "http:\/\/en.wikipedia.org\/wiki\/Web_2%2E0_Conference", "text" : "Web 2.0 Conference could mean:\n*Web 2.0 Conference (2004)\n*Web 2.0 Conference (2005)\n\n" }, { "title" : "Web 2.0 Conference (2005)", "url" : "http:\/\/en.wikipedia.org\/wiki\/Web_2%2E0_Conference_%282005%29", "text" : "The Web 2.0 Conference (2005) was a conference held in 2005 about the transition from the world wide web, or Web 1.0, to the emerging Web 2.0.\n\n Speakers at WebCon 2.0, 2005 \n\n*Stewart Butterfield, Yahoo! Inc. \t\n*Mark Cuban, HDNet\n*Bran Ferren, Appli", "cats" : "Computer conferences; 2005 conferences; Web 2.0" }, { "title" : "History of virtual learning environments", "url" : "http:\/\/en.wikipedia.org\/wiki\/History_of_virtual_learning_environments", "text" : "A Virtual Learning Environment (VLE) is a system that creates an environment designed to facilitate teachers in the management of educational courses for their students, especially a system using computer hardware and software, especially involving d" }, { "title" : "World Wide Web", "url" : "http:\/\/en.wikipedia.org\/wiki\/World_Wide_Web", "text" : ":\"The Web\" and \"WWW\" redirect here. For other uses, see Web and WWW (disambiguation). For the world's first browser, see WorldWideWeb.\n\n \n\nThe World Wide Web (\"WWW\" or simply the \"Web\") is a system of interlinked, hypertext documents that runs over ", "cats" : "World Wide Web; English inventions; Internet history" }, { "title" : "Library 2.0", "url" : "http:\/\/en.wikipedia.org\/wiki\/Library_2%2E0", "text" : "Library 2.0 is a loosely defined model for a modernized form of library service that reflects a transition within the library world in the way that services are delivered to users. The concept of Library 2.0 borrows from that of Business 2.0 and Web ", "cats" : "Library and information science; Library 2.0; Web 2.0; Neologisms" }, { "title" : "Web application", "url" : "http:\/\/en.wikipedia.org\/wiki\/Web_application", "text" : "A Web Application (also known as a Web app, webapp or webware) is an application which is accessed through a Web browser over a network such as the Internet or an intranet. \n\nWeb applications are popular due to the ubiquity of the browser as a client", "cats" : "World Wide Web; Software architecture; Web applications" } ], "facets" : { "cats" : [ { "term" : "Web 2.0" , "count" : 30 } , { "term" : "Living people" , "count" : 22 } , { "term" : "Online social networking" , "count" : 11 } , { "term" : "World Wide Web" , "count" : 7 } , { "term" : "American bloggers" , "count" : 7 } , { "term" : "Year of birth missing" , "count" : 6 } , { "term" : "Blogs" , "count" : 6 } , { "term" : "Web services" , "count" : 5 } , { "term" : "Buzzwords" , "count" : 4 } , { "term" : "Neologisms" , "count" : 4 }] } }
• Just the facets please
  submit w/ begin=0 and end=0 http://api.futef.com/api/v1?query=api%20programming&begin=0&end=0&appid=7367004ee9f71de584b2caee2da324b33e9 returns
  { "total_hits" : 669, "begin" : 0, "end" : 0, "qtime" : 32, "tokens" : [ "api", "programming"], "records" : [], "facets" : { "cats" : [ { "term" : "Application programming interfaces" , "count" : 65 } , { "term" : "Java platform" , "count" : 34 } , { "term" : "Microsoft APIs" , "count" : 30 } , { "term" : "3D computer graphics" , "count" : 19 } , { "term" : "Java specification requests" , "count" : 19 } , { "term" : "3D Scenegraph APIs" , "count" : 12 } , { "term" : "PHP programming language" , "count" : 12 } , { "term" : "BASIC programming language family" , "count" : 11 } , { "term" : "Domain-specific programming languages" , "count" : 11 } , { "term" : "Java programming language" , "count" : 11 } ] } }
• Search for the term "london" in the bounding box of 51.464686,-0.259261,51.551426,0.009817
  submit w/ begin=0 and end=0 http://api.futef.com/api/v1?appid=7367004ee9f71de584b2caee2da324b33e9&query=london&bbox=51.464686,-0.259261,51.551426,0.009817&begin=0&end=10 returns
  { "total_hits" : 281, "begin" : 0, "end" : 10, "qtime" : 280, "tokens" : [ "london"], "records" : [{"lat" : "51.508056", "lng" : "-0.124722", "title" : "London", "url" : "http:\/\/en.wikipedia.org\/wiki\/London", "text" : " London (pronounced ) is the capital city of England and the United Kingdom. An important settlement for around two millennia, London is today one of the world s most important business, financial and cultural centres, and its influence in polit", "cats" : "Geo Coordinates" }, {"lat" : "51.515278", "lng" : "-0.100000", "title" : "London Stock Exchange", "url" : "http:\/\/en.wikipedia.org\/wiki\/London_Stock_Exchange", "text" : " __NOTOC__ The London Stock Exchange ( LSE ) is a stock exchange located in London, England. Founded in 1801, it is one of the largest stock exchanges in the world, with many overseas listings as well as UK companies. History The trade in shar", "cats" : "City of London; Stock exchanges; Stock market; Economy of London; Financial services companies of the United Kingdom; Stock exchanges in Europe; Companies based in London; Companies listed on the London Stock Exchange; 1801 establishments; Geo Coordinates" }, {"lat" : "51.511944", "lng" : "-0.121389", "title" : "Covent Garden", "url" : "http:\/\/en.wikipedia.org\/wiki\/Covent_Garden", "text" : " Covent Garden is a district in central London straddling the easternmost parts of the City of Westminster and the southwest corner of the London Borough of Camden. The area is dominated by shopping and entertainment facilities and contains an ent", "cats" : "Districts of London; Markets in London; Piazzas outside Italy; Westminster; Busking venues; Neighbourhoods of Camden; Geo Coordinates" }, {"lat" : "51.509167", "lng" : "-0.139444", "title" : "Royal Academy", "url" : "http:\/\/en.wikipedia.org\/wiki\/Royal_Academy", "text" : " The Royal Academy of Arts is an art institution based in Piccadilly, London. History The Royal Academy was formed to rival the Society of Artists after an unseemly leadership dispute between two leading architects, Sir William Chambers and James", "cats" : "Art museums and galleries in London; Art schools in London; Art schools in the United Kingdom; Arts in the United Kingdom; British art; Learned societies of the United Kingdom; Westminster; 1768 establishments; Geo Coordinates" }, {"lat" : "51.508056", "lng" : "-0.087778", "title" : "London Bridge", "url" : "http:\/\/en.wikipedia.org\/wiki\/London_Bridge", "text" : " London Bridge is a bridge in London, England over the River Thames, between the City of London and Southwark. It is between Cannon Street Railway Bridge and Tower Bridge; it also forms the western end of the Pool of London. London s original bridg", "cats" : "Transport in City of London; Transport in Southwark; Bridges completed in the 1st century; Bridges completed in the 1200s; Bridges completed in 1973; Visitor attractions in London; Bridges across the River Thames; Geo Coordinates" }, {"lat" : "51.505000", "lng" : "-0.086111", "title" : "London Bridge station", "url" : "http:\/\/en.wikipedia.org\/wiki\/London_Bridge_station", "text" : " London Bridge station is a National Rail and London Underground station in the London Borough of Southwark, which occupies a large area on two levels immediately south-east of London Bridge and 1.6 miles (2.6 km) east of Charing Cross. It is one of ", "cats" : "Jubilee Line stations; Northern Line stations; Railway termini in London; Transport in Southwark; London Travelcard zone 1; Network Rail managed stations; Geo Coordinates" }, {"lat" : "51.518611", "lng" : "-0.081389", "title" : "Liverpool Street station", "url" : "http:\/\/en.wikipedia.org\/wiki\/Liverpool_Street_station", "text" : " Liverpool Street station , also called London Liverpool Street , is a mainline railway station serving eastern areas of England. It has a connected London Underground station in the north eastern corner of the City of London, the main financial di", "cats" : "Central Line stations; Circle Line stations; Hammersmith & City Line stations; Metropolitan Line stations; Railway termini in London; Crossrail; Transport in City of London; London Travelcard zone 1; Network Rail managed stations; Geo Coordinates" }, {"lat" : "51.533333", "lng" : "-0.166667", "title" : "London Borough of Camden", "url" : "http:\/\/en.wikipedia.org\/wiki\/London_Borough_of_Camden", "text" : " The London Borough of Camden is an inner-London borough created in 1965 to replace the metropolitan boroughs of Hampstead, Holborn, and St Pancras. General The area is in the north side of the city, reaching from Holborn and Bloomsbury in the sou", "cats" : "Districts of London; Camden; Geo Coordinates" }, {"lat" : "51.507778", "lng" : "-0.127500", "title" : "Trafalgar Square", "url" : "http:\/\/en.wikipedia.org\/wiki\/Trafalgar_Square", "text" : "Trafalgar Square is a square in central London that commemorates the Battle of Trafalgar (1805), a British naval victory of the Napoleonic Wars. The original name was to have been \"King William the Fourth s Square\", but George Ledwell Ta", "cats" : "1845 architecture; Squares in London; Regency London; Visitor attractions in London; Westminster; Art gallery places; National Gallery, London; Geo Coordinates" }, {"lat" : "51.503278", "lng" : "-0.113500", "title" : "Waterloo station", "url" : "http:\/\/en.wikipedia.org\/wiki\/Waterloo_station", "text" : "London Waterloo railway station is a major railway station and transport interchange complex in London, England. It is located in the London Borough of Lambeth, near to the South Bank. The complex comprises four linked railway stations and a bus ", "cats" : "Geo Coordinates" }], "facets" : { "cats" : [ { "term" : "Geo Coordinates" , "count" : 281 } , { "term" : "London Travelcard zone 2" , "count" : 58 } , { "term" : "London Travelcard zone 1" , "count" : 32 } , { "term" : "Westminster" , "count" : 29 } , { "term" : "Transport in Tower Hamlets" , "count" : 26 } , { "term" : "Grade I listed buildings in London" , "count" : 25 } , { "term" : "Docklands Light Railway stations" , "count" : 22 } , { "term" : "District Line stations" , "count" : 20 } , { "term" : "Visitor attractions in London" , "count" : 18 } , { "term" : "Transport in Westminster" , "count" : 18 } , { "term" : "Northern Line stations" , "count" : 17 } , { "term" : "Hammersmith & City Line stations" , "count" : 17 } , { "term" : "Transport in Camden" , "count" : 17 } , { "term" : "Jubilee Line stations" , "count" : 16 } , { "term" : "Central Line stations" , "count" : 16 }] }, "minlat" : "51.464686", "maxlat" : "51.551426", "minlng" : "-0.259261", "maxlng" : "0.009817"}

Update: Mon Mar 19 18:54:52 EDT 2007

©2007 FUTEF - About FUTEF - FUTEF Blog - feedback@futef.com - Wikipedia - Donate to Wikipedia - Sitemap