In general, methods are named based on the
Tweetworks API URL
they invoke. See the pydoc
-generated
documentation. Methods typically
return a list of User, Post, or Group objects, as appropriate.
Some methods require Tweetworks authentication to use. In this case,
create your API object with the additional username
and
password
arguments specified to act as that user.
Common method arguments:
group
- string - Tweetworks group nameusername
- string - Tweetworks usernamequery
- string - Search term(s)id
- int - Tweetworks unique identifiersort_by_updated
- boolean - Whether the resulting list should be ordered by creation date descending or by most recent reply descendingpages
- int[] - Specific pages to query; generally not usedall
- boolean - Whether to retrieve all items, or only the first page. Exclusive with pages
.before_id
- int - Retrieve only posts made before this one. Exclusive with after_id
.after_id
- int - Retrieve only posts made after this one. Exclusive with before_id
.
Errors throw a tweetworks.API.TweetworksException
.