From 512b722b08445e5ed63a1c4868b292d446c03c65 Mon Sep 17 00:00:00 2001
From: Abzie <the.mrabz@gmail.com>
Date: Tue, 24 Jan 2017 00:07:20 +0000
Subject: [PATCH] Added API doc

---
 API.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 API.md

diff --git a/API.md b/API.md
new file mode 100644
index 0000000..52491b6
--- /dev/null
+++ b/API.md
@@ -0,0 +1,34 @@
+## URL ##
+
+All API endpoints are based off of `/api` if you access Radarr via `http://localhost:7878` the API root would be `http://localhost:7878/api`
+
+
+## Authentication ##
+
+All requests made to the api endpoint require API Key authentication using the X-Api-Key header.
+
+### API Key ###
+
+- Can be accessed and reset via Settings -> General
+- Stored in Config.xml
+- alpha-numeric (lower case)
+
+## Dates & Times ##
+
+- All dates/timestamps are ISO-8601 formatted in UTC `2014-01-27T01:30:00Z`
+- Movies (and missing & calendar) also include the airdate in the original timezone for display purposes
+- Date parameters should be ISO-8601 UTC dates to ensure proper handling by Radarr
+
+## Content Type ##
+
+- All POST/PUT requests require all parameters to be JSON encoded in the body, unless otherwise noted.
+- All GET requests will return a JSON encoded response
+
+## Endpoints ##
+
+- Calendar
+- Command
+- Diskspace
+- History
+- Movies
+- System-Status