API

Current Version: 0.5.1

API Root: https://api.pnut.io/v0

Last Updated 2017-04-30

Welcome to the documentation for the pnut.io API.

If this is your first time here, it is recommended that you become familiar with a few universal tools dictated here in the Implementation section, and then read through the areas of Authentication that you will want to use.

The How To section has some examples and explanation of more nuanced situations.

Note that user objects are included in JSON in the documentation frequently enough that they are simply included as {...}, except in the user sections specifically requesting user objects.

External Resources

Developer Chat

You are welcome to talk over the API in the Developer Channel. Questions, requests, floating ideas--any development-related conversation is encouraged!

If you are developing an app for iOS, @dasdom has a testing account @testuser to let Apple review your app. PM @pnutapi to get access to it.

Libraries

List of libraries to interact with the API from your language of choice easily.

API Documentation

GitHub has a mirror of our API documentation. That is the recommended way to formally submit bugs and feature requests.

Object Metadata

A repository for object metadata to coordinate common channel and Raw types.