API Documentation is a developer-friendly social infrastructure platform. Our API is the primary interface by which developers interact with the platform. The documentation is broken into two parts: these guides and our full API reference.

Quick Start

The API is powerful and flexible – if you’re new to the API, we suggest you start with these guides.

Quick Start: Broadcast

Send a broadcast with the API.

Quick Start: Authentication

Learn how to make authenticated requests to the API.

Notable API features

Identity & Authentication

Use’s identity layer to authenticate users and populate user profiles. For more information, see the Authentication reference and User reference.

Social Graph has a asymmetrical (follower-following) social graph which can be used to solve the “cold start” problem when a user signs into your app. The Following reference has more details.


Channels are like chat rooms. They’re a time ordered series of messages that can be public, private, or restricted to a group of users. The messages inside of channels can take advantage of files, places, and anything else the API provides. Chat rooms, Broadcasts, and private messages are all built on top of Messaging.

Places has a location database that can be integrated with your app. This allows you to add location to Posts or Message to enable location aware apps. See the Places reference for more information.


Annotations are machine readable metadata that can be attached to most objects (posts, messages, users, and more). They power checkins, photos and other rich posts on See the Annotations introduction to get started.

Files gives each user space to store and share files. These files can be shared publicly, attached to posts, or sent as a private message to a friend. All apps share the same file storage space so if a new photo or video app comes along, you can check it out and not have to worry about migrating all your old data. See the Files reference for more information.

Tracking news and announcements

To see the latest updates to the API, follow @adnapi. You may also want to subscribe to the blog for general news and the API Updates Broadcast channel for developer related news.

Getting help and providing feedback

There are numerous ways for developers to get help utilizing the platform and to provide feedback.

  • Developers (including staff) are often chatting in the Developer Channel.
  • For developer inquiries about the API, our Terms of Service, letting us know about something you’re working on, etc., email
  • For general inquiries about account/service related issues, email
  • In addition to the above, you can report bugs and provide feedback on the API using the issue tracker.
  • This documentation is open source. If you find an error or something that’s unclear, let us know with a pull request or issue on the Github repo for the documentation.

Your hosts