View
 

TLists API Documentation

Page history last edited by Sam 6 months, 3 weeks ago

Getting started

We've designed the API to make it as quick as possible to integrate into your applications: 

  • HTTP Based

  • JSON and XML output formats
  • Access key required. Contact api@tlists.com to request a key.
 
You can access it directly from the command line, for example:
curl http://api.tlists.com/api/v2/lists/search.json?q=tech 
 

Methods 

The API contains a variety of methods for accessing information about lists, users, and categories.

 

Searching & displaying lists

lists/search

lists/featured

lists/recent

lists/show

lists/members

Search for lists by keyword

Show currently featured lists

Show recently created lists

Show details about a list

Show the members of a list

 

Searching & displaying users

users/search

users/show

users/lists

users/memberships

users/expertise_profile

users/interest_profile

Search for users by keyword

Show details about a user

Show lists a user has curated

Show lists a user is a member of

Show categories a user has been listed in

Show categories a user is interested in

 

Browsing by category

categories/search

categories/lists

categories/children

categories/users

categories/superlist

categories/show

categories/icon

Search for categories by keyword

Show lists within a category

Show subcategories under a category

Show most-listed users within a category

Show the "superlist" for a category

Show details about a category

Show icon for a particular top-level category

  

General Information 

account/health_check

check that all parts of our API are functioning correctly

 

Many api calls accept parameters to filter the returned results for efficiency. If fields is specified, only the given fields will be returned. If omit_fields is specified, everything but the given fields will be returned. Both expect a comma-separated list of field names. You can access nested attributes using a period, e.g. field_1.sub_field_2.sub_sub_field_3. Some examples:

http://api.tlists.com/api/v2/categories/all/sports/baseball/tweets?filter=all&fields=user.id,user.screen_name,text

http://api.tlists.com/api/v2/categories/all/sports/baseball/tweets?filter=all&omit_fields=user.id,user.screen_name,text
 

 

Let us know if you'd benefit from this sort of filtering on a method we've missed.

 

Api calls that return tweets accept max_id and since_id parameters, just like the Twitter api. They also accept the parameter ignore_tweeters which takes a comma separated list of twitter user ids to filter out. For example, http://api.tlists.com/api/v2/categories/all/sports/baseball/tweets?ignore_tweeters=39391379

 

Data structures and return values  

The three main types of resources are lists, users, categories, and tweets.

 

Response codes and errors 

The API returns useful information through HTTP status codes and error messages.

 

 

Rate limit guidelines

The API is currently rate limited at 0 requests per hour, per user. If you would like your rate limit increased, please contact us at api@tlists.com. Include in your email the IP(s) you would like whitelisted, how many requests per hour you would like, and a description of your company and application.

 

Comments (0)

You don't have permission to comment on this page.