Resources

The App.net 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. The current API version is version 0.

Hostname

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

User

Description Method Path Token
Retrieve a User GET /stream/0/users/{user_id} None
Update a User PUT /stream/0/users/me User
Partially Update a User PATCH /stream/0/users/me User
Retrieve a User's avatar image GET /stream/0/users/{user_id}/avatar None
Update a User's avatar image POST /stream/0/users/me/avatar User
Retrieve a User's cover image GET /stream/0/users/{user_id}/cover None
Update a User's cover image POST /stream/0/users/me/cover User
Follow a User POST /stream/0/users/{user_id}/follow User
Unfollow a User DELETE /stream/0/users/{user_id}/follow User
Mute a User POST /stream/0/users/{user_id}/mute User
Unmute a User DELETE /stream/0/users/{user_id}/mute User
Block a User POST /stream/0/users/{user_id}/block User
Unblock a User DELETE /stream/0/users/{user_id}/block User
Retrieve multiple Users GET /stream/0/users Any
Search for Users GET /stream/0/users/search Any
Retrieve Users a User is following GET /stream/0/users/{user_id}/following Any
Retrieve Users following a User GET /stream/0/users/{user_id}/followers Any
Retrieve IDs of Users a User is following GET /stream/0/users/{user_id}/following/ids Any
Retrieve IDs of Users following a User GET /stream/0/users/{user_id}/followers/ids Any
Retrieve muted Users GET /stream/0/users/{user_id}/muted Any
Retrieve muted User IDs for multiple Users GET /stream/0/users/muted/ids App
Retrieve blocked Users GET /stream/0/users/{user_id}/blocked Any
Retrieve blocked User IDs for multiple Users GET /stream/0/users/blocked/ids App
Retrieve Users who reposted a Post GET /stream/0/posts/{post_id}/reposters Any
Retrieve Users who starred a Post GET /stream/0/posts/{post_id}/stars Any

Post

Description Method Path Token
Create a Post POST /stream/0/posts User
Retrieve a Post GET /stream/0/posts/{post_id} None
Delete a Post DELETE /stream/0/posts/{post_id} User
Repost a Post POST /stream/0/posts/{post_id}/repost User
Unrepost a Post DELETE /stream/0/posts/{post_id}/repost User
Star a Post POST /stream/0/posts/{post_id}/star User
Unstar a Post DELETE /stream/0/posts/{post_id}/star User
Retrieve multiple Posts GET /stream/0/posts Any
Retrieve a User's posts GET /stream/0/users/{user_id}/posts None
Retrieve a User's starred posts GET /stream/0/users/{user_id}/stars None
Retrieve Posts mentioning a User GET /stream/0/users/{user_id}/mentions Any
Retrieve Posts containing a hashtag GET /stream/0/posts/tag/{hashtag} None
Retrieve replies to a Post GET /stream/0/posts/{post_id}/replies Any
Retrieve a User's personalized stream GET /stream/0/posts/stream User
Retrieve a User's unified stream GET /stream/0/posts/stream/unified User
Retrieve the Global stream GET /stream/0/posts/stream/global None
Report a Post POST /stream/0/posts/{post_id}/report User
Search for Posts GET /stream/0/posts/search Any

Channel

Description Method Path Token
Get current user's subscribed channels GET /stream/0/channels User
Create a Channel POST /stream/0/channels User
Retrieve a Channel GET /stream/0/channels/{channel_id} Varies
Retrieve multiple Channels GET /stream/0/channels Any
Retrieve my Channels GET /stream/0/users/me/channels User
Retrieve number of unread PM Channels GET /stream/0/users/me/channels/pm/num_unread User
Retrieve number of unread Broadcast Channels GET /stream/0/users/me/channels/broadcast/num_unread User
Mark all Broadcast Channels as read DELETE /stream/0/users/me/channels/broadcast/num_unread User
Update a Channel PUT /stream/0/channels/{channel_id} User
Deactivate a Channel DELETE /stream/0/channels/{channel_id} User
Subscribe to a Channel POST /stream/0/channels/{channel_id}/subscribe User
Unsubscribe from a Channel DELETE /stream/0/channels/{channel_id}/subscribe User
Retrieve users subscribed to a Channel GET /stream/0/channels/{channel_id}/subscribers Varies
Retrieve user ids subscribed to a Channel GET /stream/0/channels/{channel_id}/subscribers/ids Varies
Retrieve user ids subscribed to multiple Channels GET /stream/0/channels/subscribers/ids Varies
Mute a Channel POST /stream/0/channels/{channel_id}/mute User
Unmute a Channel DELETE /stream/0/channels/{channel_id}/mute User
Get current user's muted Channels GET /stream/0/users/me/channels/muted User
Search for Channels GET /stream/0/channels/search User

Message

Description Method Path Token
Retrieve the Messages in a Channel GET /stream/0/channels/{channel_id}/messages Varies
Create a Message POST /stream/0/channels/{channel_id}/messages User
Retrieve a Message GET /stream/0/channels/{channel_id}/messages/{message_id} Varies
Retrieve multiple Messages GET /stream/0/channels/messages Any
Retrieve my Messages GET /stream/0/users/me/messages User
Delete a Message DELETE /stream/0/channels/{channel_id}/messages/{message_id} User
Search for Messages GET /stream/0/channels/messages/search Any

File

Description Method Path Token
Create a File POST /stream/0/files User
Create a Derived File POST /stream/0/files/{file_id}/{derived_key} User
Retrieve a File GET /stream/0/files/{file_id} Varies
Retrieve multiple Files GET /stream/0/files User
Delete a File DELETE /stream/0/files/{file_id} User
Retrieve my Files GET /stream/0/users/me/files User
Update a File PUT /stream/0/files/{file_id} User
Get File content GET /stream/0/files/{file_id}/content User
Set File content PUT /stream/0/files/{file_id}/content User
Set Derived File content PUT /stream/0/files/{file_id}/content/{derived_key} User

App Stream

Description Method Path Token
Create an App Stream POST /stream/0/streams App
Retrieve an App Stream GET /stream/0/streams/{stream_id} App
Update an App Stream PUT /stream/0/streams/{stream_id} App
Delete an App Stream DELETE /stream/0/streams/{stream_id} App
Retrieve all App Streams for the current Token GET /stream/0/streams App
Delete all App Streams for the current Token DELETE /stream/0/streams App

User Stream

Description Method Path Token
Delete a User Stream DELETE /stream/0/users/me/streams/{connection_id} User
Delete a User Stream subscription DELETE /stream/0/users/me/streams/{connection_id}/{subscription_id} User

Filter

Description Method Path Token
Create a Filter POST /stream/0/filters User
Retrieve a Filter GET /stream/0/filters/{filter_id} User
Update a Filter PUT /stream/0/filters/{filter_id} User
Delete a Filter DELETE /stream/0/filters/{filter_id} User
Get the current User's Filters GET /stream/0/filters User
Delete the current User's Filters DELETE /stream/0/filters User

Interaction

Description Method Path Token
Retrieve Interactions with the current User GET /stream/0/users/me/interactions User

Stream Marker

Description Method Path Token
Update a Stream Marker POST /stream/0/posts/marker User

Text Processor

Description Method Path Token
Process text POST /stream/0/text/process Any

Token

Description Method Path Token
Retrieve the current token GET /stream/0/token Any
Retrieve authorized User IDs for an app GET /stream/0/apps/me/tokens/user_ids App
Retrieve authorized User tokens for an app GET /stream/0/apps/me/tokens App

Place

Description Method Path Token
Retrieve a Place GET /stream/0/places/{factual_id} Any
Search for Places GET /stream/0/places/search User

Explore Stream

Description Method Path Token
Retrieve all Explore Streams GET /stream/0/posts/stream/explore None
Retrieve an Explore Stream GET /stream/0/posts/stream/explore/{slug} None

Configuration

Description Method Path Token
Retrieve the Configuration object GET /stream/0/config None