Getting Started

Welcome to the Sqwiggle API, it's great to have you taking a look at how to integrate with Sqwiggle, we think our API allows for some pretty neat hacks, apps and more!

The API is architected in a REST style - it is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which can be understood by off-the-shelf HTTP clients.


In order to use the Sqwiggle API you'll first need to create a client and generate a token, you can do so here:


All API requests are made to and all requests are served over HTTPS.


At this time the only response format support is JSON and as such is the default format returned by the API.


All contributions are welcome, however small! If you've spotted a grammatical error or mistake in a response object we'd love to know about it. This documentation is open-source on GitHub.