This is a work in progress please keep that in mind.

In this guide I will attempt to explain what the API is, using examples give the user a basic idea of how to use the API, and lay down some best practices for its use. This guide is not here to teach you basic programming concepts; but it will cover some “advanced” ideas that will be necessary for your code to not interfere with other scripts.

What is the API?

What we as the community refer to as the API is actually a complicated scripting system of many different parts.

Here is some terminology I will for each part of what we call the API:

• The Environment or Sandbox – You can think of this as a virtual machine that runs the code you enter into the scripting window.
• The API (Application programming interface) –The actual API is a JavaScript library that gives access to the inner workings of Roll20.

Prior Knowledge

To understand this guide I expect you to have a basic understanding of general programming, without this there is no point in reading any more of this guide.

To start learning about general programming and more specifically JavaScript please check out codecademy.