Tinker helps you discover events people are Twittering about.
Join today to stay on top of the latest trends.
Already using Tinker?  Sign in here

API Documentation


Introduction

Tinker exposes some of its functionality via an Application Programming Interface (API). This document is a reference for that functionality, and aims to serve as a reference for developers building tools that talk to Tinker.


Table of Contents


  1. Introduction
  2. Table of Contents
  3. Status Methods
    1. public_timeline
    2. event_timeline
    3. user_timeline
    4. event_list
    5. status/update
  4. User Methods
    1. users/followingevent
    2. users/filter/list.format
    3. users/filter/list/created/events.format
    4. users/filter/list/follow/events.format
  5. Event Methods
    1. event/filter/list.format
    2. event/filter/list/created/category.format
    3. event/filter/list/follow/category.format
    4. event/filter/list/all/category.format
  6. Account Methods
    1. Verify Credentials
  7. Return Elements
    1. Status element
    2. Event element
    3. EventMap element

 


Status Methods

 

public_timeline
Returns the 15 most recent statuses


URL: http://api.tinker.com/public_timeline.format
Formats: xml, json, rss
Methods(s): GET
Parameters: 

  • page. Optional. Ex: http://api.tinker.com/public_timeline.xml?page=2

Returns: list of status elements


event_timeline
Returns the 15 most recent statuses


URL: http://api.tinker.com/event_timeline.format
Formats: xml, json, rss
Methods(s): GET
Parameters: 

  • event_id. Required. Specify the event_id of the event for which to return the event_timeline.
    Example:
    http://api.tinker.com/event_timeline.xml?event_id=30
    http://api.tinker.com/event_timeline/30.xml
    http://api.tinker.com/event_timeline/2009sxsw.xml

  • page. Optional. Ex: http://api.tinker.com/event_timeline.xml?event_id=30&page=2

Returns: list of status elements


user_timeline
Returns the 15 most recent statuses


URL: http://api.tinker.com/user_timeline.format
Formats: xml, json, rss
Methods(s): GET
Parameters: 

  • user_id. Required. The User Id or Username of the user.
    Examples:
    http://api.tinker.com/user_timeline.xml?user_id=105
    http://api.tinker.com/user_timeline/105.xml
    http://api.tinker.com/user_timeline/eman.xml

  • event_id. Optional. Specify event_id of the event to return the user timeline for that specific event.
    Examples:
    http://api.tinker.com/user_timeline.xml?user_id=105&event_id=30

  • list_id. Optional. Specify list_id of the user timeline to return the user timeline for that specific list.
    Examples:
    http://api.tinker.com/user_timeline.xml?user_id=105&list_id=created
    http://api.tinker.com/user_timeline.xml?user_id=105&list_id=follow

  • page. Optional.
    Example:
    http://api.tinker.com/user_timeline.xml?&user_id=105&page=2

Returns: list of status elements


event_list
Returns the 15 most recent events


URL: http://api.tinker.com/event_list.format
Formats: xml, json, rss
Methods(s): GET
Parameters: 

  • event_id. optional. The event id or eventname of the event used to return event list
    Examples:
    http://api.tinker.com/event_list.xml?event_id=30
    http://api.tinker.com/event_list/30.xml
    http://api.tinker.com/event_list/2009sxsw.xml

  • user_id. Optional. The user id or username of the user used to return event list specific to that user
    Examples:
    http://api.tinker.com/event_list.xml?user_id=105

  • list_id. Optional. Specify the List ID (created, follow, all) to return the event list for a user. user_id is required to use list_id.
    Example:
    http://api.tinker.com/event_timeline.xml?user_id=105&list_id=created
    http://api.tinker.com/event_timeline.xml?user_id=105&list_id=follow

  • category. Optional. Specify the Category.
    Example:
    http://api.tinker.com/event_list.xml?category=Awards
  • page. Optional.
    Example:
    http://api.tinker.com/event_list.xml?page=2

Returns: list of event elements


status/update Updates the authenticating user's status. Requires the status paramenter specified below. Request must be a POST.


URL: http://api.tinker.com/status/update.format
Formats: xml, json
Methods(s): POST
Parameters: 

  • status. required. 140 character to update the user's status
  • event_id. required. The event id for which to update status on.
  • email. required. email is used for authentication
  • password. required. password is used for authentication


Users Methods

 

users/followingevent
Used to check if user is following an event.

URL: http://api.tinker.com/users/followingevent.format
Formats: xml, json
Methods(s): GET
Parameters: 

  • user_id. Required. The user id or username is required to specify which user you want to find out if following a specific event.
    Examples:
    http://api.tinker.com/users/followingevent.xml?user_id=105
    http://api.tinker.com/users/followingevent/105.xml
    http://api.tinker.com/users/followingevent/bob.xml

  • event_id. Required. The event id or eventname is required to specify the event you want to find out if is being followed by a specific user.
    Examples:
    http://api.tinker.com/users/followingevent.xml?event_id=30

Returns: event map element


users/filter/list
Returns the users filter list

URL: http://api.tinker.com/users/filter/list.format
Formats: xml, json, rss
Methods(s): GET
Parameters: 

  • user_id. Required. The user id or username is required to specify which user you want to return the filter list.
    Examples:
    http://api.tinker.com/users/filter/list.xml?user_id=105
    http://api.tinker.com/users/filter/list/105.xml
    http://api.tinker.com/users/filter/list/bob.xml

Returns: filter List element


users/filter/list/created/events

URL: http://api.tinker.com/users/filter/list/created/events.format
Formats: xml, json, rss
Methods(s): GET
Parameters: 

  • user_id. Required. The user id or username is required to specify which user you want to retrieve the list of created events.
    Examples:
    http://api.tinker.com/users/filter/list/created/events.xml?user_id=105
    http://api.tinker.com/users/filter/list/created/events/105.xml
    http://api.tinker.com/users/filter/list/created/bob.xml

  • category. Optional. The category is returns you with events in those category.
    Examples:
    http://api.tinker.com/users/filter/list/created/events.xml?category=Awards

Returns: event element
Note:An additional element <requesturl> is available for the subsequence request to obtain the data


users/filter/list/follow/events

URL: http://api.tinker.com/users/filter/list/follow/events.format
Formats: xml, json, rss
Methods(s): GET
Parameters: 

  • user_id. Required. The user id or username is required to specify which user you want to retrieve the list of created events.
    Examples:
    http://api.tinker.com/users/filter/list/follow/events.xml?user_id=105
    http://api.tinker.com/users/filter/list/follow/events/105.xml
    http://api.tinker.com/users/filter/list/follow/bob.xml

  • category. Optional. The category is returns you with events in those category.
    Examples:
    http://api.tinker.com/users/filter/list/follow/events.xml?category=Awards

Returns: event element
Note:An additional element <requesturl> is available for the subsequence request to obtain the data


Event Methods

 

event/filter/list
Returns the event filter list

URL: http://api.tinker.com/event/filter/list.format
Formats: xml, json, rss
Methods(s): GET
Parameters: 

  • user_id. Optional. The user id or username is required to specify which user you want to return the filter list.
    Examples:
    http://api.tinker.com/event/filter/list.xml?user_id=105
    http://api.tinker.com/event/filter/list/105.xml
    http://api.tinker.com/event/filter/list/bob.xml

Returns: filter List element


event/filter/list/created/category

URL: http://api.tinker.com/event/filter/list/created/category.format
Formats: xml, json, rss
Methods(s): GET
Parameters: 

  • user_id. Required. The user id or username is required to specify which user you want to retrieve the list of created event's category.
    Examples:
    http://api.tinker.com/events/filter/list/created/category.xml?user_id=105
    http://api.tinker.com/event/filter/list/created/category/105.xml
    http://api.tinker.com/event/filter/list/created/category/bob.xml

Returns: event element
Note:An additional element <requesturl> is available for the subsequence request to obtain the data


event/filter/list/follow/category

URL: http://api.tinker.com/event/filter/list/follow/category.format
Formats: xml, json, rss
Methods(s): GET
Parameters: 

  • user_id. Required. The user id or username is required to specify which user you want to retrieve the list of follow event's category.
    Examples:
    http://api.tinker.com/event/filter/list/follow/category.xml?user_id=105
    http://api.tinker.com/event/filter/list/follow/category/105.xml
    http://api.tinker.com/event/filter/list/follow/category/bob.xml

Returns: event element
Note:An additional element <requesturl> is available for the subsequence request to obtain the data


event/filter/list/all/category

URL: http://api.tinker.com/event/filter/list/all/category.format
Formats: xml, json, rss
Methods(s): GET

Returns: event element
Note:An additional element <requesturl> is available for the subsequence request to obtain the data


Account Methods

 

account/verify_credentials

Returns an HTTP 200 OK response code and a representation of teh requesting user if authentication was successful; returns a 401 status code and an error message if not. Use this method to test if supplied user credentials are valid.


URL: http://api.tinker.com/account/verify_credentials.format
Formats: xml, json
Method(s): POST
Returns: user account element


Return Elements

Almost all API calls return well-formed elements of data.

 

Status Element
A status element consists of information on a status, with a nested element to describe the author and a nested element to describe the event.

<status>
created
timestamp
id
text
full_text
source
guid
image
<user>
name
profile_image_url
<event>
id
name
url
image_url
location
<user>
id
name

Event Element
An event element consists of information on an event.

<event>
id
name
description
location
image_url
url
created_data
created_timestamp
start_date
start_timestamp
end_date
end_timestamp

Filter List Element

<option>
name
requesturl

Event Map Element
An event map element consists of information on an event map linking Users and Event.

<event>
id
status
type
created_data
created_timestamp
user_id
event_id
eventname

User Account Element
A user account element consists of information on the authenticated user

<user>
id
name
profileImageUrl
url