ArtBeat API: New York
Mash up New York Art Beat and base your Web application on the best Art and Design information for your city of choice.
The ArtBeat API is available free of charge for non-commercial applications which do not cause unreasonable traffic.
Your applications based on this API should follow these simple rules
- • The apps should mention that they are “Powered by NY Art Beat”, with a link to www.nyartbeat.com
- • (if applicable) any link for “more information” on events or venues should point to www.nyartbeat.com
- • whenever possible, data retrieved from the API should be cached by your application for at least one hour and no more than one day
Please leave a message on our Art Beat API Google Group if:
- • you have issues with the API
- • you want to share your progress
- • it's time to announce your new application built using the API
Please contact us if:
- • you are developing, or have developed, a commercial application based on the API
- • your application is likely to cause heavy traffic on the API
Note: The ArtBeat API also includes data for Tokyo Art Beat. Check the Tokyo Art Beat API page for more details.
ArtBeat API XML Output
The ArtBeat API uses a consistent XML format for all the lists and methods returning a list of events.
The XML output formats lists <Events> (as root element) with children as described below:
Element | Children | Value, Notes |
---|---|---|
Event | Name, Venue, Description, Image, Karma, Price, DateStart, DateEnd, PermanentEvent, Distance, Datum, Latitude, Longitude | Holds all the info for a single event |
Venue | Name, Type | Holds all the info for an event's venue |
Name | Name of event/venue, in the chosen/default language | |
Type | Type of venue (Museum, etc) | |
Media | Note: an Event can have several Media | |
Description | escaped as CDATA | |
Image | embed the poster / image of the event. May have a width attribute, in pixels. Note: an Event can have several Images (several sizes) | |
Karma | Popularity of the events decided by the MyTAB users | |
Price | Entry price for the event. Has a "free" attribute equal to 1 if the event is free, 0 otherwise. | |
DateStart | YYYY-MM-DD | |
DateEnd | YYYY-MM-DD | |
PermanentEvent | 1 = permanent event; 0 = non-permanent event | |
Distance | Distance from the searched location. Not returned in non-search lists. | in meters |
Datum | Datum of latitude/longitude coordinates. world for the worldwide standard WGS84 geolocation datum, or tokyo for Tokyo Datum used by a number of services in Japan. | |
Latitude | decimal coordinates | |
Longitude | decimal coordinates |
Changelog
As of August 2008, the ArtBeat API uses the version 0.1 (beta) of its XML result format. This is the first version of the format.
Sample Output
<?xml version="1.0"?> <Events> <Event xml:lang="en" id="2008/249F" href="http://www.nyartbeat.com/event/2008/249F"> <Name>"Take Me Out to the Ballgame" Exhibition</Name> <Venue href="http://www.nyartbeat.com/venue/3C79FC1F"> <Name>The New York Public Library for the Performing Arts</Name> <Type>Other</Type> </Venue> <Description><![CDATA[An exhibition for the whole family! To celebrate the 100th anniversary of baseball theme songs, The New York Public Library for the Performing Arts presents ...]]></Description> <Image src="http://www.nyartbeat.com/media/event/2008/32B2-30" width="30" /> <Image src="http://www.nyartbeat.com/media/event/2008/32B2-80" width="80" /> <Image src="http://www.nyartbeat.com/media/event/2008/32B2-170" width="170" /> <Karma>0</Karma> <Price free="0">Adults 4$, Students 2$</Price> <DateStart>2008-07-08</DateStart> <DateEnd>2008-10-28</DateEnd> <DaysBeforeEnd>88</DaysBeforeEnd> <PermanentEvent>0</PermanentEvent> <Distance>177.0156764</Distance> <Datum>wgs84</Datum> <Latitude>40.772258</Latitude> <Longitude>-73.983194</Longitude> </Event> </Events>
API Method: event_searchNear
The event_searchNear method is available at the following URL:
http://www.nyartbeat.com/list/event_searchNear
Requests are made with the GET HTTP method, with REST-style parameters sent in the query string.
Parameters
Location Search Parameters | |
---|---|
Latitude (required) | coordinates in decimal (xxx.xxxxxx) format up to 6 digit precision. Anything beyond that precision is ignored |
Longitude (required) | coordinates in decimal (xxx.xxxxxx) format up to 6 digit precision. Anything beyond that precision is ignored |
Data Selection Parameters | |
Schedule |
|
SearchRange |
|
Description |
|
Free |
|
Result Parameters | |
Language |
|
MaxResults | "5", "10", "20" or "50" |
SortOrder |
|
Note: All parameters and values are case-INsensitive to be user-friendly.
Samples Queries
- http://www.nyartbeat.com/list/event_searchNear?latitude=40.719130&longitude=-73.980000
nearest events to the location specified - http://www.nyartbeat.com/list/event_searchNear?latitude=40.719130&longitude=-73.980000&MaxResults=5&SortOrder=distance&free=1
(Nearest free events, max 5 results) - http://www.nyartbeat.com/list/event_searchNear?latitude=40.719130&longitude=-73.980000&Schedule=upcoming&SortOrder=mostpopular
(Most popular upcoming events) - http://www.nyartbeat.com/list/event_searchNear?latitude=40.719130&longitude=-73.980000&SortOrder=mostpopular&Free=1
(Most popular events, free only) - http://www.nyartbeat.com/list/event_searchNear?latitude=40.719130&longitude=-73.980000&SortOrder=closingsoon
(Events closing soon)
AS3 Wrapper
The AS3 Artbeat API is a handy Actionscript 3.0 wrapper that any flash developer can use to access our Art Beat APIs.
More details and download from Reuben Stanton's AS3 Artbeat API site.
Sites & Applications
A few apps and websites have already surfaced that make use of the Artbeat API:
- a flyer collection site
- Search for nearby Tokyo events from your keitai: 携帯Art Map
- Tokyo Art Island (click on the map)
- 駅’si VISION
- a simple and practical iPhone site for Tokyo. And another one!
- Binbo Date ("cheap dates") which locates nearby art exhibitions (especially the free ones) and bars etc as cheap date spots in Tokyo.
- a Windows Explorer plugin