README.md

qKast

qKast API documentation and examples

qKast API provides programmatic access to qKast.com functionality and content. Version 1 of the API is limited to the essentials of the website's functionality: allowing for the creation of new widgets, accessing UI internals, and getting information.

The information API is REST The return format for all endpoints is JSON.

---

Checklist

• Grab the bookmarklet
• Familiarize yourself with the API functionality
• Hack away
• Use the import tool

---

Examples

• AngularJS
• React
• jQuery
• Vue

Changes

• 12-9-16 qKast API documentation launched.

Endpoints

Widget

• GET widget
• GET widget/:id

Channel

• GET channel
• GET channel/:id

FAQ

How do I connect to the qkast.com API?

Generally, reading any data is done through a request with the GET method. If you want our server to create, update or delete a given resource, POST or PUT methods are required on supported end points.

What return formats do you support?

qKast API currently returns data in JSON format.

What kind of authentication is required?

There is no authentication required right now.

Is there a request rate limit?

Nope.

• REST software pattern: http://en.wikipedia.org/wiki/Representational_State_Transfer
• JSON: http://json.org
• quick tutorial: http://www.webmonkey.com/2010/02/get_started_with_json/

API Terms of Use