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

README.md

Resources

The App.net Stream API is a JSON API.

Guiding principles are:

  • Always return JSON. If you are using JSONP, the returned JSON will be wrapped in a function call.
  • 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.

Hostname

Please use https://alpha-api.app.net/ to access the APIs.

Users

Path HTTP Method Authentication Required? Description
/stream/0/users/[user_id] GET Yes Retrieve a User
/stream/0/users/[user_id]/follow POST Yes Follow a User
/stream/0/users/[user_id]/follow DELETE Yes Unfollow a User
/stream/0/users/[user_id]/following GET Yes List users a User is following
/stream/0/users/[user_id]/followers GET Yes List users following a User
/stream/0/users/[user_id]/mute POST Yes Mute a User
/stream/0/users/[user_id]/mute DELETE Yes Unmute a User
/stream/0/users/me/muted GET Yes List muted Users
/stream/0/users/search GET Yes Search for Users
/stream/0/posts/[post_id]/reposters GET Yes List Users who have reposted a Post
/stream/0/posts/[post_id]/stars GET Yes List Users who have starred a Post

Token

Path HTTP Method Authentication Required? Description
/stream/0/token GET Yes Check current Token

Posts

Path HTTP Method Authentication Required? Description
/stream/0/posts POST Yes Create a Post
/stream/0/posts/[post_id] GET No Retrieve a Post
/stream/0/posts/[post_id] DELETE Yes Delete a Post
/stream/0/posts/[post_id]/replies GET Yes Retrieve the replies to a Post
/stream/0/users/[user_id]/posts GET No Retrieve Posts created by a User
/stream/0/posts/[post_id]/repost POST Yes Repost a Post
/stream/0/posts/[post_id]/repost DELETE Yes Unrepost a Post
/stream/0/posts/[post_id]/star POST Yes Star a Post
/stream/0/posts/[post_id]/star DELETE Yes Unstar a Post
/stream/0/users/[user_id]/stars GET Yes Retrieve Posts starred by a User
/stream/0/users/[user_id]/mentions GET Yes Retrieve Posts mentioning a User
/stream/0/posts/stream GET Yes Retrieve a User's personalized stream
/stream/0/posts/stream/global GET No Retrieve the Global stream
/stream/0/posts/tag/[hashtag] GET No 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