Switch branches/tags
Nothing to show
Find file History
Pull request Compare This branch is 213 commits behind appdotnet:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
..
Failed to load latest commit information.
README.md
filters.md
posts.md
streams.md
subscriptions.md
users.md

README.md

Resources

The App.net Stream API is a JSON API.

Guiding principles are:

  • Always return JSON.
  • Utilize HTTP error codes and methods.
  • In general, required parameters are in URLs; optional parameters are specified in the query string. This is not always the case.
  • If we need complex data structures from you, you should send them as a JSON string. We don't need any more conventions for putting arrays and dictionaries directly into URL-encoded GET/POST values.
  • We follow a convention of including the API version number in the resource path. API calls of version 0 are subject to change throughout the process. Once we promote something to version 1, we hope to keep its implementation stable.

Users

Path HTTP Method Description
/stream/0/users/[user_id] GET Retrieve a User
/stream/0/users/[user_id]/follow POST Follow a User
/stream/0/users/[user_id]/follow DELETE Unfollow a User
/stream/0/users/[user_id]/following GET List users a User is following
/stream/0/users/[user_id]/followers GET List users following a User

Posts

Path HTTP Method Description
/stream/0/posts POST Create a Post
/stream/0/posts/[post_id] GET Retrieve a Post
/stream/0/posts/[post_id] DELETE Delete a Post
/stream/0/posts/[post_id]/replies GET Retrieve the replies to a Post
/stream/0/users/[user_id]/posts GET Retrieve Posts created by a User
/stream/0/users/[user_id]/mentions GET Retrieve Posts mentioning a User
/stream/0/posts/stream GET Retrieve a User's personalized stream
/stream/0/posts/stream/global GET Retrieve the Global stream
/stream/0/posts/tag/[hashtag] GET Retrieve tagged Posts

Streams -- coming soon

Path HTTP Method Description
/stream/0/streams/user GET Retrieve a real-time, personalized Stream for a User
/stream/0/streams/app GET Retrieve a real-time, personalized Stream for multiple Users
/stream/0/streams/public GET Retrieve a public Stream of real-time posts
/stream/0/streams/[stream_id] GET Get Stream status
/stream/0/streams/[stream_id] POST Control a Stream

Real-time updates -- coming soon

Path HTTP Method Description
/stream/0/subscriptions GET List Subscriptions
/stream/0/subscriptions POST Create a Subscription
/stream/0/subscriptions/[subscription_id] DELETE Delete a Subscription
/stream/0/subscriptions DELETE Delete all Subscriptions

Filters -- coming soon

Path HTTP Method Description
/stream/0/filters GET Get current user's Filters
/stream/0/filters POST Create a Filter
/stream/0/filters/[filter_id] GET Retrieve a Filter
/stream/0/filters/[filter_id] DELETE Delete a Filter