ArtBeat API: Tokyo

Mash up Tokyo 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 Tokyo Art Beat”, with a link to www.tokyoartbeat.com
  • • (if applicable) any link for “more information” on events or venues should point to www.tokyoartbeat.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 New York Art Beat. Check the New York 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:

ElementChildrenValue, Notes
EventName, Venue, Description, Image, Karma, Price, DateStart, DateEnd, PermanentEvent, Distance, Datum, Latitude, LongitudeHolds all the info for a single event
VenueName, TypeHolds all the info for an event's venue
NameName of event/venue, in the chosen/default language
TypeType of venue (Museum, etc)
MediaNote: an Event can have several Media
Descriptionescaped as CDATA
Imageembed the poster / image of the event. May have a width attribute, in pixels. Note: an Event can have several Images (several sizes)
KarmaPopularity of the events decided by the MyTAB users
Priceprice of entry. Has a "free" attribute equal to 1 if the event is free, 0 otherwise
DateStartYYYY-MM-DD
DateEndYYYY-MM-DD
PermanentEvent1 = permanent event; 0 = non-permanent event
DistanceDistance from the searched location. Not returned in non-search lists.in meters
DatumDatum 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
Latitudedecimal coordinates
Longitudedecimal 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/D38F" href="http://dev.tokyoartbeat.com/event/2008/D38F">
  <Name>Hugues Reip &quot;Parallel Worlds&quot;</Name>
  <Venue href="http://dev.tokyoartbeat.com/venue/2008/D38F">
    <Name>Museum of Contemporary Art, Tokyo</Name>
    <Type>Museum</Type>
  </Venue>
  <Media>Installation</Media>
  <Media>Other</Media>
  <Description><![CDATA[Can fiction become fact? French artist Hugues Reip invites you on a “fantastic voyage” to parallel worlds. 
Reip will construct worlds of the imagination by ...]]></Description>
  <Image src="http://www.tokyoartbeat.com/media/event/2008/32B2-30" width="30" />
  <Image src="http://www.tokyoartbeat.com/media/event/2008/32B2-80" width="80" />
  <Image src="http://www.tokyoartbeat.com/media/event/2008/32B2-170" width="170" />
  <Karma>11.693</Karma>
  <Price free="0">Adults 짜1500, Students 짜1000</Price>
  <DateStart>2008-07-26</DateStart>
  <DateEnd>2008-09-28</DateEnd>
  <DaysBeforeEnd>63</DaysBeforeEnd>
  <PermanentEvent>0</PermanentEvent>
  <Distance>5.127138362401</Distance>
  <Datum>tokyo</Datum>
  <Latitude>35.676344</Latitude>
  <Longitude>139.810483</Longitude>
 </Event>
</Events>

API Method: event_searchNear

The event_searchNear method is available at the following URL:

http://www.tokyoartbeat.com/list/event_searchNear

Requests are made with the GET HTTP method, with REST-style parameters sent in the query string.

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
Datum
  1. "world" = WGS84/Google (default)
  2. "tokyo" = Yahoo! Japan/Navitime
Data Selection Parameters
Schedule
  1. "current" = currently open events (default)
  2. "upcoming" = events opening today or later
SearchRange
  1. 500m (default),
  2. 1000m,
  3. 1500m
  4. ,
  5. 3000m
Description
  1. "" = only events with a description (default)
  2. "all" = all events even those without a description
Free
  1. "1" = free events only
  2. "0" = all events regarless of price (default)
Result Parameters
Language
  1. "ja" = Japanese (default)
  2. "en" = English
ResultDatum
  1. "world" = WGS84/Google
  2. "tokyo" = Yahoo! Japan/Navitime
Note: By default ResultDatum is equal to the value of the Datum
MaxResults "5", "10", "20" or "50"
SortOrder
  1. "distance" = nearest events (default)
  2. "closingsoon" = events that close the sooner first
  3. "mostpopular" = events with the most bookmarks first

Note: All parameters and values are case-INsensitive to be user-friendly.

Samples Queries

  • http://www.tokyoartbeat.com/list/event_searchNear?Latitude=35.671208&Longitude=139.76517
    (Default output (nearest events) in Japanese)
  • http://www.tokyoartbeat.com/list/event_searchNear?Latitude=35.671208&Longitude=139.76517&Language=en
    (Default output (nearest events) in English)
  • http://www.tokyoartbeat.com/list/event_searchNear?Latitude=35.671208&Longitude=139.76517&MaxResults=5&SortOrder=distance&free=1
    (Nearest free events, max 5 results)
  • http://www.tokyoartbeat.com/list/event_searchNear?Latitude=35.671208&Longitude=139.76517&Schedule=upcoming&SortOrder=mostpopular
    (Most popular upcoming events)
  • http://www.tokyoartbeat.com/list/event_searchNear?Latitude=35.671208&Longitude=139.76517&SortOrder=mostpopular&Free=1
    (Most popular events, free only)
  • http://www.tokyoartbeat.com/list/event_searchNear?Latitude=35.671208&Longitude=139.76517&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 TAB API:

The Best of TAB in your Inbox
Our favorite reviews, shows & news, every two weeks!

  • All content on this site is © their respective owner(s).
    Tokyo Art Beat (2004 - 2014) - About - Contact - Privacy - Terms of Use